[Doc]: update pg_pathman doc

dmpgpro · dmpgpro · commit f99f18c58369 · 2017-02-15T16:16:29.000+03:00
diff --git a/doc/src/sgml/pgpathman.sgml b/doc/src/sgml/pgpathman.sgml
@@ -140,7 +140,9 @@ CREATE EXTENSION pg_pathman;
 create_hash_partitions(relation         REGCLASS,
                        attribute        TEXT,
                        partitions_count INTEGER,
-                       partition_data   BOOLEAN DEFAULT TRUE)
+                       partition_data   BOOLEAN DEFAULT TRUE,
+                       partition_names  TEXT[] DEFAULT NULL,
+                       tablespaces      TEXT[] DEFAULT NULL)
 </programlisting>
       <para>
         Performs HASH partitioning for <literal>relation</literal> by
@@ -173,13 +175,18 @@ create_range_partitions(relation       REGCLASS,
 </programlisting>
       <para>
         Performs RANGE partitioning for <literal>relation</literal> by
-        partitioning key <literal>attribute</literal>.
+        partitioning key <literal>attribute</literal>,
         <literal>start_value</literal> argument specifies initial value,
-        <literal>interval</literal> sets the range of values in a single
-        partition, <literal>count</literal> is the number of premade
-        partitions (if not set then pathman tries to determine it based
-        on attribute values). Partition creation callback is invoked for
-        each partition if set beforehand.
+        <literal>p_interval</literal> sets the default range for auto
+        created partitions or partitions created with
+        <literal>append_range_partition()</literal> or
+        <literal>prepend_range_partition()</literal>
+        (if <literal>NULL</literal> then auto partition creation
+        feature will not work), <literal>p_count</literal> is the
+        number of premade partitions (if not set then
+        <literal>pg_pathman</literal> tries to determine it based
+        on attribute values). Partition creation callback is invoked
+        for each partition if set beforehand.
       </para>
       <programlisting>
 create_partitions_from_range(relation       REGCLASS,
@@ -273,6 +280,14 @@ merge_range_partitions(partition1 REGCLASS, partition2 REGCLASS)
         <literal>partition2</literal> is removed.
       </para>
       <programlisting>
+merge_range_partitions(partitions REGCLASS[])
+      </programlisting>
+      <para>
+        Merge several adjacent RANGE partitions (partitions must be specified
+        in ascending or descending order). All the data will be accumulated in
+        the first partition.
+      </para>      
+      <programlisting>
 append_range_partition(p_relation     REGCLASS,
                        partition_name TEXT DEFAULT NULL,
                        tablespace     TEXT DEFAULT NULL)
@@ -299,7 +314,9 @@ add_range_partition(relation       REGCLASS,
 </programlisting>
       <para>
         Create new RANGE partition for <literal>relation</literal> with
-        specified range bounds.
+        specified range bounds. If <literal>start_value</literal>
+        or <literal>end_value</literal> are NULL then corresponding
+        range bound will be infinite.
       </para>
       <programlisting>
 drop_range_partition(partition TEXT, delete_data BOOLEAN DEFAULT TRUE)
@@ -349,6 +366,16 @@ drop_partitions(parent      REGCLASS,
     <sect3 id="additional-parameters">
       <title>Additional parameters</title>
       <programlisting>
+        set_interval(relation REGCLASS, value ANYELEMENT)
+      </programlisting>
+      <para>
+        Update RANGE partitioned table interval. Note that interval must not
+        be negative and it must not be trivial, i.e. its value should be
+        greater than zero for numeric types, at least 1 microsecond for
+        <literal>TIMESTAMP</literal> and at least 1 day
+        for <literal>DATE</literal>.
+      </para>      
+      <programlisting>
 set_enable_parent(relation REGCLASS, value BOOLEAN)
 </programlisting>
       <para>
