aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2013-10-28 10:28:35 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2013-10-28 10:28:35 -0400
commitc2b51cf1903d5ed5e962ed68b4a4eeb40fe037db (patch)
tree02ba970a8fe15a3f54558826b8f0f0ac750f17a5 /doc/src
parent438df52df9bf7ade0c042e73e9c83c0a58adb5bb (diff)
downloadpostgresql-c2b51cf1903d5ed5e962ed68b4a4eeb40fe037db.tar.gz
postgresql-c2b51cf1903d5ed5e962ed68b4a4eeb40fe037db.zip
Improve documentation about usage of FDW validator functions.
SGML documentation, as well as code comments, failed to note that an FDW's validator will be applied to foreign-table options for foreign tables using the FDW. Etsuro Fujita
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/alter_foreign_data_wrapper.sgml12
-rw-r--r--doc/src/sgml/ref/create_foreign_data_wrapper.sgml8
2 files changed, 11 insertions, 9 deletions
diff --git a/doc/src/sgml/ref/alter_foreign_data_wrapper.sgml b/doc/src/sgml/ref/alter_foreign_data_wrapper.sgml
index 7376804403d..91ac1b2f0c9 100644
--- a/doc/src/sgml/ref/alter_foreign_data_wrapper.sgml
+++ b/doc/src/sgml/ref/alter_foreign_data_wrapper.sgml
@@ -91,11 +91,13 @@ ALTER FOREIGN DATA WRAPPER <replaceable class="parameter">name</replaceable> REN
</para>
<para>
- Note that it is possible that after changing the validator the
- options to the foreign-data wrapper, servers, and user mappings
- have become invalid. It is up to the user to make sure that
- these options are correct before using the foreign-data
- wrapper.
+ Note that it is possible that pre-existing options of the foreign-data
+ wrapper, or of dependent servers, user mappings, or foreign tables, are
+ invalid according to the new validator. <productname>PostgreSQL</> does
+ not check for this. It is up to the user to make sure that these
+ options are correct before using the modified foreign-data wrapper.
+ However, any options specified in this <command>ALTER FOREIGN DATA
+ WRAPPER</> command will be checked using the new validator.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/ref/create_foreign_data_wrapper.sgml b/doc/src/sgml/ref/create_foreign_data_wrapper.sgml
index e2d897fb214..cbe50021f4f 100644
--- a/doc/src/sgml/ref/create_foreign_data_wrapper.sgml
+++ b/doc/src/sgml/ref/create_foreign_data_wrapper.sgml
@@ -80,11 +80,11 @@ CREATE FOREIGN DATA WRAPPER <replaceable class="parameter">name</replaceable>
<varlistentry>
<term><literal>VALIDATOR <replaceable class="parameter">validator_function</replaceable></literal></term>
<listitem>
- <para><replaceable class="parameter">validator_function</replaceable> is the
- name of a previously registered function that will be called to
+ <para><replaceable class="parameter">validator_function</replaceable>
+ is the name of a previously registered function that will be called to
check the generic options given to the foreign-data wrapper, as
- well as options for foreign servers and user mappings using the
- foreign-data wrapper. If no validator function or <literal>NO
+ well as options for foreign servers, user mappings and foreign tables
+ using the foreign-data wrapper. If no validator function or <literal>NO
VALIDATOR</literal> is specified, then options will not be
checked at creation time. (Foreign-data wrappers will possibly
ignore or reject invalid option specifications at run time,