doc: Review for "Allow TRUNCATE command to truncate foreign tables".

Typos, corrections and language improvements in the docs.

Author: Justin Pryzby, Fujii Masao
Reviewed-by: Bharath Rupireddy, Justin Pryzby, Fujii Masao
Discussion: https://postgr.es/m/20210411041658[email protected]

diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index e08441ec8bce4cf7380d874801f1113b37c42c3f..8aa7edfe4af103a40c327a1a2ece76efe09b2b52 100644 (file)
--- a/doc/src/sgml/fdwhandler.sgml
+++ b/doc/src/sgml/fdwhandler.sgml
@@ -1076,27 +1076,25 @@ ExecForeignTruncate(List *rels,
                     bool restart_seqs);
 
 
-     Truncate a set of foreign tables specified in rels.
-     This function is called when  is executed
-     on foreign tables.  rels is the list of
-     Relation data structure that indicates
-     a foreign table to truncate.
+     Truncate foreign tables.  This function is called when
+      is executed on a foreign table.
+     rels is a list of Relation
+     data structures of foreign tables to truncate.
     
 
     
-     behavior defines how foreign tables should
-     be truncated, using as possible values DROP_RESTRICT,
-     which means that RESTRICT option is specified,
-     and DROP_CASCADE, which means that
-     CASCADE option is specified, in
-     TRUNCATE command.
+     behavior is either DROP_RESTRICT
+     or DROP_CASCADE indicating that the
+     RESTRICT or CASCADE option was
+     requested in the original TRUNCATE command,
+     respectively.
     
     
     
-     restart_seqs is set to true
-     if RESTART IDENTITY option is specified in
-     <command>TRUNCATE command.  It is false
-     if CONTINUE IDENTITY option is specified.
+     If restart_seqs is true,
+     the original TRUNCATE command requested the
+     <literal>RESTART IDENTITY behavior, otherwise the
+     CONTINUE IDENTITY behavior was requested.
     
 
     
@@ -1109,11 +1107,10 @@ ExecForeignTruncate(List *rels,
     
 
     
-     TRUNCATE invokes
-     ExecForeignTruncate once per foreign server
-     that foreign tables to truncate belong to.  This means that all foreign
-     tables included in rels must belong to the same
-     server.
+     ExecForeignTruncate is invoked once per
+     foreign server for which foreign tables are to be truncated.
+     This means that all foreign tables included in rels
+     must belong to the same server.
     
 
     

diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index b0806c1274e833ddc838bfdb095fdc4093727c16..839126c4efe79a6d57d6832da88324be2de62b00 100644 (file)
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -459,11 +459,17 @@ OPTIONS (ADD password_required 'false');
      
       
        This option controls whether postgres_fdw allows
-       foreign tables to be truncated using TRUNCATE
+       foreign tables to be truncated using the TRUNCATE
        command. It can be specified for a foreign table or a foreign server.
        A table-level option overrides a server-level option.
        The default is true.
       
+
+      
+       Of course, if the remote table is not in fact truncatable, an error
+       would occur anyway.  Use of this option primarily allows the error to
+       be thrown locally without querying the remote server.
+      
      
     
    

diff --git a/doc/src/sgml/ref/truncate.sgml b/doc/src/sgml/ref/truncate.sgml
index acf3633be4608fd018690d541af29cf1a1e4d165..9d846f88c9f604eaf591f474549a67cd01b201da 100644 (file)
--- a/doc/src/sgml/ref/truncate.sgml
+++ b/doc/src/sgml/ref/truncate.sgml
@@ -173,7 +173,7 @@ TRUNCATE [ TABLE ] [ ONLY ] name [
 
   
    TRUNCATE can be used for foreign tables if
-   the foreign data wrapper supports, for instance,
+   supported by the foreign data wrapper, for instance,
    see .