From c2b51cf1903d5ed5e962ed68b4a4eeb40fe037db Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Mon, 28 Oct 2013 10:28:35 -0400 Subject: 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 --- doc/src/sgml/ref/alter_foreign_data_wrapper.sgml | 12 +++++++----- doc/src/sgml/ref/create_foreign_data_wrapper.sgml | 8 ++++---- 2 files changed, 11 insertions(+), 9 deletions(-) (limited to 'doc/src') 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 name REN - 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. 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 ALTER FOREIGN DATA + WRAPPER command will be checked using the new validator. 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 name VALIDATOR validator_function - validator_function is the - name of a previously registered function that will be called to + validator_function + 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 NO + well as options for foreign servers, user mappings and foreign tables + using the foreign-data wrapper. If no validator function or NO VALIDATOR 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, -- cgit v1.2.3