1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00

Document the compression-algorithms connection option; WL #14012

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350583 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
2020-09-17 21:41:10 +00:00
parent d5cf6264ad
commit b0a34b2fce

View File

@@ -97,6 +97,22 @@
This option was added in version 8.0.20.
</para>
</listitem>
<listitem>
<para>
The optional <literal>compression-algorithms</literal> attribute defines
the desired compression algorithms (and their preferred usage order):
<literal>zstd_stream</literal> (alias: zstd),
<literal>lz4_message</literal> (alias: lz4), or
<literal>deflate_stream</literal> (aliases: deflate or zlib).
By default, the order used (depending on system availability) is lz4_message, zstd_stream, then deflate_stream.
For example, passing in compression-algorithms=[lz4,zstd_stream] uses lz4 if it's available, otherwise
zstd_stream is used. If both are unavailable then behavior depends on the compression value
e.g., if compression=required then it'll fail with an error.
</para>
<para>
This option was added in version 8.0.22.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
@@ -117,6 +133,7 @@ mysqlx://foobar?ssl-ca=(/path/to/ca.pem)&amp;ssl-crl=(/path/to/crl.pem)
mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061]?ssl-mode=disabled
mysqlx://foo:bar@localhost:33160/?connect-timeout=0
mysqlx://foo:bar@localhost:33160/?connect-timeout=10&amp;compression=required
mysqlx://foo:bar@localhost:33160/?connect-timeout=10&amp;compression=required&amp;compression-algorithms=[lz4,zstd_stream]
</programlisting>
</example>