From cb3810b6691fe6069714a1fcf17ed952d0cb8311 Mon Sep 17 00:00:00 2001 From: VaibhaveS Date: Tue, 6 Aug 2024 17:31:18 +0530 Subject: [PATCH] Update the docs. --- docs/ref/pgcopydb_clone.rst | 14 ++++++++++++++ docs/ref/pgcopydb_copy.rst | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/docs/ref/pgcopydb_clone.rst b/docs/ref/pgcopydb_clone.rst index f945462d..79bc6f96 100644 --- a/docs/ref/pgcopydb_clone.rst +++ b/docs/ref/pgcopydb_clone.rst @@ -671,6 +671,14 @@ The following options are available to ``pgcopydb clone``: __ https://www.postgresql.org/docs/current/app-pgrecvlogical.html +--use-copy-binary + + Use the COPY WITH (FORMAT BINARY) instead of the COPY command. + + See also documentation for `COPY`__. + + __ https://www.postgresql.org/docs/current/sql-copy.html + --origin Logical replication target system needs to track the transactions that @@ -831,6 +839,12 @@ PGCOPYDB_SKIP_CTID_SPLIT then pgcopydb skips the CTID split operation during the clone process, same as when using the ``--skip-split-by-ctid`` option. +PGCOPYDB_USE_COPY_BINARY + + When true (or *yes*, or *on*, or 1, same input as a Postgres boolean) + then pgcopydb uses the COPY WITH (FORMAT BINARY) instead of the COPY + command, same as when using the ``--use-copy-binary`` option. + PGCOPYDB_SNAPSHOT Postgres snapshot identifier to re-use, see also ``--snapshot``. diff --git a/docs/ref/pgcopydb_copy.rst b/docs/ref/pgcopydb_copy.rst index f51a40be..0d08edf9 100644 --- a/docs/ref/pgcopydb_copy.rst +++ b/docs/ref/pgcopydb_copy.rst @@ -356,6 +356,14 @@ The following options are available to ``pgcopydb copy`` sub-commands: ``pg_export_snapshot()`` it is possible for pgcopydb to re-use an already exported snapshot. +--use-copy-binary + + Use the COPY WITH (FORMAT BINARY) instead of the COPY command. + + See also documentation for `COPY`__. + + __ https://www.postgresql.org/docs/current/sql-copy.html + --verbose Increase current verbosity. The default level of verbosity is INFO. In @@ -447,6 +455,12 @@ PGCOPYDB_SNAPSHOT Postgres snapshot identifier to re-use, see also ``--snapshot``. +PGCOPYDB_USE_COPY_BINARY + + When true (or *yes*, or *on*, or 1, same input as a Postgres boolean) + then pgcopydb uses the COPY WITH (FORMAT BINARY) instead of the COPY + command, same as when using the ``--use-copy-binary`` option. + TMPDIR The pgcopydb command creates all its work files and directories in