docs - review zstd doc additions, misc related edits (#4170)

* docs - review zstd doc additions, misc related edits * modify ddl storage example 1 to use zstd

docs - review zstd doc additions, misc related edits (#4170)
* docs - review zstd doc additions, misc related edits * modify ddl storage example 1 to use zstd
ce407afa · Lisa Owen · David Yozie · 1c85430f · ce407afa · ce407afa
6 changed file
--- a/gpdb-doc/dita/admin_guide/ddl/ddl-storage.xml
+++ b/gpdb-doc/dita/admin_guide/ddl/ddl-storage.xml
@@ -217,10 +217,10 @@
      <p>Performance with compressed append-optimized tables depends on hardware, query tuning
        settings, and other factors. You should perform comparison testing to determine
        the actual performance in your environment.</p>
-	<note type="note">Zstd compression level can be set between 1 and 19.
+	<note type="note">Zstd compression level can be set to values between 1 and 19.
-	QuickLZ compression level can only be set to level 1; no other options are
+	QuickLZ compression level can only be set to level 1; no other values are
-        available. Compression level with zlib can be set at values from 1 - 9. Compression level
+        available. Compression level with zlib can be set to values from 1 - 9. Compression level
-        with RLE can be set at values from 1 - 4.<p>An <codeph>ENCODING</codeph> clause specifies
+        with RLE can be set to values from 1 - 4.<p>An <codeph>ENCODING</codeph> clause specifies
          compression type and level for individual columns. When an <codeph>ENCODING</codeph>
          clause conflicts with a <codeph>WITH</codeph> clause, the <codeph>ENCODING</codeph> clause
          has higher precedence than the <codeph>WITH</codeph> clause.</p></note>
@@ -370,6 +370,13 @@
              </entry>
              <entry colname="col2" morerows="2">Compression level.</entry>
              <entry colname="col3"><codeph>zlib</codeph> compression:
+                  <codeph>1</codeph>-<codeph>9</codeph></entry>
+              <entry colname="col4"><codeph>1</codeph> is the fastest method with the least
+                compression. <codeph>1</codeph> is the default.<p><codeph>9</codeph> is the slowest
+                  method with the most compression.</p></entry>
+            </row>
+            <row>
+              <entry colname="col3"><codeph>zstd</codeph> compression:
                  <codeph>1</codeph>-<codeph>19</codeph></entry>
              <entry colname="col4"><codeph>1</codeph> is the fastest method with the least
                compression. <codeph>1</codeph> is the default.<p><codeph>19</codeph> is the slowest
@@ -491,12 +498,12 @@
      <topic id="topic48" xml:lang="en">
        <title>Example 1 </title>
        <body>
-          <p>In this example, column <codeph>c1</codeph> is compressed using <codeph>zlib</codeph>
+          <p>In this example, column <codeph>c1</codeph> is compressed using <codeph>zstd</codeph>
            and uses the block size defined by the system. Column <codeph>c2</codeph> is compressed
            with <codeph>quicklz</codeph>, and uses a block size of <codeph>65536</codeph>. Column
              <codeph>c3</codeph> is not compressed and uses the block size defined by the
            system.</p>
-          <codeblock>CREATE TABLE T1 (c1 int ENCODING (compresstype=zlib),
+          <codeblock>CREATE TABLE T1 (c1 int ENCODING (compresstype=zstd),
                  c2 char ENCODING (compresstype=quicklz, blocksize=65536),
                   c3 char     WITH (appendonly=true, orientation=column);</codeblock>
        </body>

--- a/gpdb-doc/dita/best_practices/schema.xml
+++ b/gpdb-doc/dita/best_practices/schema.xml
@@ -130,7 +130,7 @@
        compression. </p>
      <p>Data compression should never be used for data that is stored on a compressed file system. </p>
      <p>Test different compression types and ordering methods to determine the best compression for
-        your specific data. For example, you might start zstd compression at level 4 or 5 and adjust
+        your specific data. For example, you might start zstd compression at level 8 or 9 and adjust
        for best results. RLE compression works best with files that contain repetitive data.</p>
    </body>
  </topic>

--- a/gpdb-doc/dita/ref_guide/config_params/guc-list.xml
+++ b/gpdb-doc/dita/ref_guide/config_params/guc-list.xml
@@ -2943,7 +2943,7 @@
                  2097152 </p><p><cmdname>CHECKSUM</cmdname>= <codeph>TRUE</codeph> |
                    <codeph>FALSE</codeph>
                </p><p><cmdname>COMPRESSTYPE</cmdname>= <codeph>ZLIB</codeph> |
-                    <codeph>ZSTD</codeph><sup>2</sup> |
+                    <codeph>ZSTD</codeph> |
                    <codeph>QUICKLZ</codeph><sup>2</sup> |
                    <codeph>RLE</codeph>_<codeph>TYPE</codeph> | <codeph>NONE</codeph>
                </p><p><cmdname>COMPRESSLEVEL</cmdname>= integer between 0 and

--- a/gpdb-doc/dita/ref_guide/sql_commands/CREATE_TABLE.xml
+++ b/gpdb-doc/dita/ref_guide/sql_commands/CREATE_TABLE.xml
@@ -386,10 +386,10 @@
            performed.</pd>
          <pd><b>COMPRESSTYPE</b> — Set to <codeph>ZLIB</codeph> (the default), <codeph>ZSTD</codeph>,
              <codeph>RLE-TYPE</codeph>, or <codeph>QUICKLZ</codeph><sup>1</sup> to specify the type
-              of compression used. The value <codeph>NONE</codeph>disables compression. Zstd provides
+              of compression used. The value <codeph>NONE</codeph> disables compression. Zstd provides
-	      for both speed or a good compression ratio, tunable with the compression level option.
+	      for both speed or a good compression ratio, tunable with the <codeph>COMPRESSLEVEL</codeph> option.
-	      QuickLZ and zlib are provided for backwards-compatibility, they are less flexible and
+	      QuickLZ and zlib are provided for backwards-compatibility. Zstd outperforms these
-	      zstd outperforms them on usual workloads. This option
+              compression types on usual workloads. The <codeph>COMPRESSTYPE</codeph> option
            is only valid if <codeph>APPENDONLY=TRUE</codeph>.<p>
              <note type="note"><sup>1</sup>QuickLZ compression is available only in the commercial
                release of Pivotal Greenplum Database.</note>
@@ -407,12 +407,12 @@
              order.</p><p>For information about using table compression, see "Choosing the Table
              Storage Model" in the <cite>Greenplum Database Administrator Guide</cite>.</p></pd>
              <pd><b>COMPRESSLEVEL</b> — For Zstd compression of append-optimized tables, set to an
-	      integer values between 1 (fastest compression) to 19 (highest compression ratio).
+	      integer value from 1 (fastest compression) to 19 (highest compression ratio).
-	      For zlib compression, the valid range is between 1 and 9. QuickLZ
+	      For zlib compression, the valid range is from 1 to 9. QuickLZ
            compression level can only be set to 1. If not declared, the default is 1. For
-              <codeph>RLE_TYPE</codeph>, the compression level can be set an integer value between 1
+              <codeph>RLE_TYPE</codeph>, the compression level can be set an integer value from 1
            (fastest compression) to 4 (highest compression ratio). </pd>
-          <pd>This option is valid only if <codeph>APPENDONLY=TRUE</codeph>.</pd>
+          <pd>The <codeph>COMPRESSLEVEL</codeph> option is valid only if <codeph>APPENDONLY=TRUE</codeph>.</pd>
          <pd><b>FILLFACTOR</b> — See <codeph><xref href="CREATE_INDEX.xml#topic1" type="topic"
                format="dita"/></codeph> for more information about this index storage parameter. </pd>
          <pd><b>OIDS</b> — Set to <codeph>OIDS=FALSE</codeph> (the default) so that rows do not

--- a/gpdb-doc/dita/ref_guide/sql_commands/CREATE_TABLE_AS.xml
+++ b/gpdb-doc/dita/ref_guide/sql_commands/CREATE_TABLE_AS.xml
@@ -71,31 +71,32 @@
            its indexes. Note that you can also set different storage parameters on a particular
            partition or subpartition by declaring the <codeph>WITH</codeph> clause in the partition
            specification. The following storage options are available:</pd>
-          <pd>APPENDONLY — Set to <codeph>TRUE</codeph> to create the table as an append-optimized
+          <pd><b>APPENDONLY</b> — Set to <codeph>TRUE</codeph> to create the table as an append-optimized
            table. If <codeph>FALSE</codeph> or not declared, the table will be created as a regular
            heap-storage table.</pd>
-          <pd>BLOCKSIZE — Set to the size, in bytes for each block in a table. The <codeph>BLOCKSIZE
+          <pd><b>BLOCKSIZE</b> — Set to the size, in bytes for each block in a table. The <codeph>BLOCKSIZE
            </codeph>must be between 8192 and 2097152 bytes, and be a multiple of 8192. The default
            is 32768.</pd>
-          <pd>ORIENTATION — Set to <codeph>column</codeph> for column-oriented storage, or
+          <pd><b>ORIENTATION</b> — Set to <codeph>column</codeph> for column-oriented storage, or
              <codeph>row</codeph> (the default) for row-oriented storage. This option is only valid
            if <codeph>APPENDONLY=TRUE</codeph>. Heap-storage tables can only be row-oriented.</pd>
-          <pd>COMPRESSTYPE — Set to <codeph>ZLIB</codeph> (the default), <codeph>ZSTD</codeph>, or
+          <pd><b>COMPRESSTYPE</b> — Set to <codeph>ZLIB</codeph> (the default), <codeph>ZSTD</codeph>, or
              <codeph>QUICKLZ</codeph><sup>1</sup> to specify the type of compression used. The
-            value <codeph>NONE</codeph>disables compression. Zstd provides for both speed or a good
+            value <codeph>NONE</codeph> disables compression. Zstd provides for both speed or a
-            compression ratio, tunable with the compression level option. QuickLZ and zlib are
+            good compression ratio, tunable with the <codeph>COMPRESSLEVEL</codeph> option.
-            provided for backwards-compatibility, they are less flexible and zstd outperforms them
+            QuickLZ and zlib are provided for backwards-compatibility. Zstd outperforms these
-            on usual workloads. This option is only valid if <codeph>APPENDONLY=TRUE</codeph>.<note
+            compression types on usual workloads. The <codeph>COMPRESSTYPE</codeph> option is
+            valid only if <codeph>APPENDONLY=TRUE</codeph>.<note
              type="note"><sup>1</sup>QuickLZ compression is available only in the commercial
              release of Pivotal Greenplum Database.</note></pd>
          <pd><b>COMPRESSLEVEL</b> — For Zstd compression of append-optimized tables, set to an
-            integer values between 1 (fastest compression) to 19 (highest compression ratio). For
+            integer value from 1 (fastest compression) to 19 (highest compression ratio). For
-            zlib compression, the valid range is between 1 and 9. QuickLZ compression level can only
+            zlib compression, the valid range is from 1 to 9. QuickLZ compression level can only
-            be set to 1. If not declared, the default is 1. This option is valid only if
+            be set to 1. If not declared, the default is 1. The <codeph>COMPRESSLEVEL</codeph>
-              <codeph>APPENDONLY=TRUE</codeph>.</pd>
+            option is valid only if <codeph>APPENDONLY=TRUE</codeph>.</pd>
-          <pd>FILLFACTOR — See <codeph><xref href="CREATE_INDEX.xml#topic1" type="topic"
+          <pd><b>FILLFACTOR</b> — See <codeph><xref href="CREATE_INDEX.xml#topic1" type="topic"
                format="dita"/></codeph> for more information about this index storage parameter. </pd>
-          <pd>OIDS — Set to <codeph>OIDS=FALSE</codeph> (the default) so that rows do not have
+          <pd><b>OIDS</b> — Set to <codeph>OIDS=FALSE</codeph> (the default) so that rows do not have
            object identifiers assigned to them. Greenplum strongly recommends that you do not
            enable OIDS when creating a table. On large tables, such as those in a typical Greenplum
            Database system, using OIDs for table rows can cause wrap-around of the 32-bit OID

--- a/gpdb-doc/dita/ref_guide/system_catalogs/pg_appendonly.xml
+++ b/gpdb-doc/dita/ref_guide/system_catalogs/pg_appendonly.xml
@@ -59,7 +59,7 @@
            <entry colname="col4">The compression level, with compression ratio increasing from 1 to
              19. <p otherprops="pivotal">When <codeph>quicklz</codeph><sup>1</sup> is specified for
                compresstype, valid values are 1 or 3. With <codeph>zlib</codeph> specified, valid
-                values are 1-9. </p></entry>
+                values are 1-9. When <codeph>zstd</codeph> is specified, valid values are 1-19.</p></entry>
          </row>
          <row>
            <entry colname="col1">