Skip to content

Commit 9d3fa52

Browse files
authored
[docs] [ysql] update docs and CLIs for dump masters addresses (yugabyte#7744)
1 parent a90ab43 commit 9d3fa52

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

docs/content/latest/admin/ysql-dump.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ Create the dump in the specified character set encoding. By default, the dump is
7171

7272
Send output to the specified file. This parameter can be omitted for file-based output formats, in which case the standard output is used.
7373

74+
#### -m *addresses*, --masters=*addresses*
75+
Comma-separated list of YB-Master hosts and ports.
76+
7477
#### -n *schema*, --schema=*schema*
7578

7679
Dump only schemas matching *schema*; this selects both the schema itself, and all its contained objects. When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple `-n|--schema` options. Also, the *schema* parameter is interpreted as a pattern according to the same rules used by the `ysqlsh \d` commands, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

docs/content/latest/manage/backup-restore/snapshot-ysql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ YugabyteDB supports distributed backup and restore of YSQL databases. Backing up
7575
1. Create a backup of the YSQL metadata, including the schema, by running the following `ysql_dump --create` command:
7676

7777
```sh
78-
ysql_dump -h <ip> --include-yb-metadata --serializable-deferrable --create --schema-only --dbname <database_name> --file ysql.schema.sql
78+
ysql_dump -h <ip> --masters <ip1:7100,ip2:7100,ip3:7100> --include-yb-metadata --serializable-deferrable --create --schema-only --dbname <database_name> --file ysql.schema.sql
7979
```
8080

8181
1. Get the current YSQL schema catalog version by running the [`yb-admin ysql_catalog_version`](../../../admin/yb-admin/#ysql-catalog-version) command:

src/postgres/src/bin/pg_dump/pg_dump.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1066,7 +1066,7 @@ help(const char *progname)
10661066
printf(_(" -w, --no-password never prompt for password\n"));
10671067
printf(_(" -W, --password force password prompt (should happen automatically)\n"));
10681068
printf(_(" --role=ROLENAME do SET ROLE before dump\n"));
1069-
printf(_(" -m, --masters=IPS YugaByte Master hosts IP addresses\n"));
1069+
printf(_(" -m, --masters=HOST:PORT comma-separated list of YB-Master hosts and ports\n"));
10701070

10711071
printf(_("\nIf no database name is supplied, then the PGDATABASE environment\n"
10721072
"variable value is used.\n\n"));

src/postgres/src/bin/pg_dump/pg_dumpall.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ help(void)
633633
printf(_(" --use-set-session-authorization\n"
634634
" use SET SESSION AUTHORIZATION commands instead of\n"
635635
" ALTER OWNER commands to set ownership\n"));
636-
printf(_(" -m, --masters=IPS YugaByte Master hosts IP addresses\n"));
636+
printf(_(" -m, --masters=HOST:PORT comma-separated list of YB-Master hosts and ports\n"));
637637

638638
printf(_("\nConnection options:\n"));
639639
printf(_(" -d, --dbname=CONNSTR connect using connection string\n"));

0 commit comments

Comments
 (0)