Enhance document of postgresql_fdw.
authorShigeru Hanada <hanada@metrosystems.co.jp>
Thu, 24 Feb 2011 12:34:50 +0000 (21:34 +0900)
committerShigeru Hanada <hanada@metrosystems.co.jp>
Thu, 24 Feb 2011 12:34:50 +0000 (21:34 +0900)
doc/src/sgml/postgresql-fdw.sgml

index fc25e77a1c67e86fda9cdfc8271e408ad24dda6e..60dcdd0100e56046b4385cd6d75f88420c431951 100644 (file)
@@ -27,7 +27,7 @@
       <function>postgresql_fdw_handler</function> is a foreign-data wrapper
       handler function which returns foreign-data wrapper handler for
       PostgreSQL in type of <type>fdw_handler</type>.
-      Since fdw_hanlder is a pseudo type, postgresql_fdw_handler can't be
+      Since fdw_handler is a pseudo type, postgresql_fdw_handler can't be
       called from a SQL statement.
      </para>
      <para>
   <title>Details of postgresql_fdw</title>
 
   <sect3>
-   <title>Connection options</title>
+   <title>Object name options</title>
    <para>
-    The postgresql_fdw retrieves connection information from generic options of
-    user mapping and foriegn server.  All of generic options of these objects
-    are passed to <function>PQconnectdbParams()</function>.
+    The postgresql_fdw accepts <literal>nspname</literal> and
+    <literal>rename</literal> options which can be used to specify object name
+    used in the remote query. The <literal>nspname</literal> is used as schema
+    name, and <literal>relname</literal> is used as relation name.
+    If these options are omitted, local catalog names are used.
+    These options can be specified for foreign tables.
    </para>
+  </sect3>
+
+  <sect3>
+   <title>Connection options</title>
    <para>
-    Currently, all of the generic options which are allowed in the context of
-    user mapping and foreign server are libpq connection options.
+    The postgresql_fdw accepts all libpq connection options. 
+    <literal>user</literal> and <literal>password</literal> can be specified
+    only for user mapping, and other options can be specified for only foreign
+    server.
    </para>
   </sect3>