Clarify documentation for CLUSTER on partitioned tables.
authorJeff Davis <[email protected]>
Thu, 26 Jan 2023 04:23:32 +0000 (20:23 -0800)
committerJeff Davis <[email protected]>
Thu, 26 Jan 2023 04:23:32 +0000 (20:23 -0800)
Author: Nathan Bossart
Discussion: https://postgr.es/m/20230114224000.GA2505377@nathanxps13

doc/src/sgml/ref/cluster.sgml

index b9f2acb1decd5b587a98d8c0ed5b19dd84ad130c..29f0f1fd9016acb03deab36ac07519ed1ad267c8 100644 (file)
@@ -67,7 +67,8 @@ CLUSTER [VERBOSE]
   </para>
 
   <para>
-   <command>CLUSTER</command> without any parameter reclusters all the
+   <command>CLUSTER</command> without a
+   <replaceable class="parameter">table_name</replaceable> reclusters all the
    previously-clustered tables in the current database that the calling user
    has privileges for.  This form of <command>CLUSTER</command> cannot be
    executed inside a transaction block.
@@ -211,7 +212,8 @@ CLUSTER [VERBOSE]
    <para>
     Clustering a partitioned table clusters each of its partitions using the
     partition of the specified partitioned index.  When clustering a partitioned
-    table, the index may not be omitted.
+    table, the index may not be omitted.  <command>CLUSTER</command> on a
+    partitioned table cannot be executed inside a transaction block.
    </para>
 
  </refsect1>