OS Manuals

/usr/lib/postgresql/17/bin/pg_dump

commercial-spilo-4-fips compat package

From commercial-spilo-4-fips-compat 4.1.2-r9 (enterprise-packages), captured 2026-11-08 by running pg_dump --help (exit 0). permalink

pg_dump dumps a database as a text file or to other formats.

Usage:
  pg_dump [OPTION]... [DBNAME]

General options:
  -f, --file=FILENAME          output file or directory name
  -F, --format=c|d|t|p         output file format (custom, directory, tar,
                               plain text (default))
  -j, --jobs=NUM               use this many parallel jobs to dump
  -v, --verbose                verbose mode
  -V, --version                output version information, then exit
  -Z, --compress=METHOD[:DETAIL]
                               compress as specified
  --lock-wait-timeout=TIMEOUT  fail after waiting TIMEOUT for a table lock
  --no-sync                    do not wait for changes to be written safely to disk
  --sync-method=METHOD         set method for syncing files to disk
  -?, --help                   show this help, then exit

Options controlling the output content:
  -a, --data-only              dump only the data, not the schema
  -b, --large-objects          include large objects in dump
  --blobs                      (same as --large-objects, deprecated)
  -B, --no-large-objects       exclude large objects in dump
  --no-blobs                   (same as --no-large-objects, deprecated)
  -c, --clean                  clean (drop) database objects before recreating
  -C, --create                 include commands to create database in dump
  -e, --extension=PATTERN      dump the specified extension(s) only
  -E, --encoding=ENCODING      dump the data in encoding ENCODING
  -n, --schema=PATTERN         dump the specified schema(s) only
  -N, --exclude-schema=PATTERN do NOT dump the specified schema(s)
  -O, --no-owner               skip restoration of object ownership in
                               plain-text format
  -s, --schema-only            dump only the schema, no data
  -S, --superuser=NAME         superuser user name to use in plain-text format
  -t, --table=PATTERN          dump only the specified table(s)
  -T, --exclude-table=PATTERN  do NOT dump the specified table(s)
  -x, --no-privileges          do not dump privileges (grant/revoke)
  --binary-upgrade             for use by upgrade utilities only
  --column-inserts             dump data as INSERT commands with column names
  --disable-dollar-quoting     disable dollar quoting, use SQL standard quoting
  --disable-triggers           disable triggers during data-only restore
  --enable-row-security        enable row security (dump only content user has
                               access to)
  --exclude-extension=PATTERN  do NOT dump the specified extension(s)
  --exclude-table-and-children=PATTERN
                               do NOT dump the specified table(s), including
                               child and partition tables
  --exclude-table-data=PATTERN do NOT dump data for the specified table(s)
  --exclude-table-data-and-children=PATTERN
                               do NOT dump data for the specified table(s),
                               including child and partition tables
  --extra-float-digits=NUM     override default setting for extra_float_digits
  --filter=FILENAME            include or exclude objects and data from dump
                               based on expressions in FILENAME
  --if-exists                  use IF EXISTS when dropping objects
  --include-foreign-data=PATTERN
                               include data of foreign tables on foreign
                               servers matching PATTERN
  --inserts                    dump data as INSERT commands, rather than COPY
  --load-via-partition-root    load partitions via the root table
  --no-comments                do not dump comments
  --no-publications            do not dump publications
  --no-security-labels         do not dump security label assignments
  --no-subscriptions           do not dump subscriptions
  --no-table-access-method     do not dump table access methods
  --no-tablespaces             do not dump tablespace assignments
  --no-toast-compression       do not dump TOAST compression methods
  --no-unlogged-table-data     do not dump unlogged table data
  --on-conflict-do-nothing     add ON CONFLICT DO NOTHING to INSERT commands
  --quote-all-identifiers      quote all identifiers, even if not key words
  --restrict-key=RESTRICT_KEY  use provided string as psql \restrict key
  --rows-per-insert=NROWS      number of rows per INSERT; implies --inserts
  --section=SECTION            dump named section (pre-data, data, or post-data)
  --serializable-deferrable    wait until the dump can run without anomalies
  --snapshot=SNAPSHOT          use given snapshot for the dump
  --strict-names               require table and/or schema include patterns to
                               match at least one entity each
  --table-and-children=PATTERN dump only the specified table(s), including
                               child and partition tables
  --use-set-session-authorization
                               use SET SESSION AUTHORIZATION commands instead of
                               ALTER OWNER commands to set ownership

Connection options:
  -d, --dbname=DBNAME      database to dump
  -h, --host=HOSTNAME      database server host or socket directory
  -p, --port=PORT          database server port number
  -U, --username=NAME      connect as specified database user
  -w, --no-password        never prompt for password
  -W, --password           force password prompt (should happen automatically)
  --role=ROLENAME          do SET ROLE before dump

If no database name is supplied, then the PGDATABASE environment
variable value is used.

Report bugs to <pgsql-bugs@lists.postgresql.org>.
PostgreSQL home page: <https://www.postgresql.org/>
Options (64)
OptionDescriptionSource
-f, --file FILENAMEoutput file or directory namehelp
-F, --format c|d|t|poutput file format (custom, directory, tar, plain text (default))help
-j, --jobs NUMuse this many parallel jobs to dumphelp
-v, --verboseverbose modehelp
-V, --versionoutput version information, then exithelp
-Z, --compress METHOD[:DETAILcompress as specifiedhelp
--lock-wait-timeout TIMEOUTfail after waiting TIMEOUT for a table lockhelp
--no-syncdo not wait for changes to be written safely to diskhelp
--sync-method METHODset method for syncing files to diskhelp
-?, --helpshow this help, then exithelp
-a, --data-onlydump only the data, not the schemahelp
-b, --large-objectsinclude large objects in dumphelp
--blobs(same as --large-objects, deprecated)help
-B, --no-large-objectsexclude large objects in dumphelp
--no-blobs(same as --no-large-objects, deprecated)help
-c, --cleanclean (drop) database objects before recreatinghelp
-C, --createinclude commands to create database in dumphelp
-e, --extension PATTERNdump the specified extension(s) onlyhelp
-E, --encoding ENCODINGdump the data in encoding ENCODINGhelp
-n, --schema PATTERNdump the specified schema(s) onlyhelp
-O, --no-ownerskip restoration of object ownership in plain-text formathelp
-s, --schema-onlydump only the schema, no datahelp
-S, --superuser NAMEsuperuser user name to use in plain-text formathelp
-t, --table PATTERNdump only the specified table(s)help
-T, --exclude-table PATTERNdo NOT dump the specified table(s)help
-x, --no-privilegesdo not dump privileges (grant/revoke)help
--binary-upgradefor use by upgrade utilities onlyhelp
--column-insertsdump data as INSERT commands with column nameshelp
--disable-dollar-quotingdisable dollar quoting, use SQL standard quotinghelp
--disable-triggersdisable triggers during data-only restorehelp
--enable-row-securityenable row security (dump only content user has access to)help
--exclude-extension PATTERNdo NOT dump the specified extension(s)help
--exclude-table-and-children PATTERNdo NOT dump the specified table(s), including child and partition tableshelp
--exclude-table-data-and-children PATTERNdo NOT dump data for the specified table(s), including child and partition tableshelp
--extra-float-digits NUMoverride default setting for extra_float_digitshelp
--filter FILENAMEinclude or exclude objects and data from dump based on expressions in FILENAMEhelp
--if-existsuse IF EXISTS when dropping objectshelp
--include-foreign-data PATTERNinclude data of foreign tables on foreign servers matching PATTERNhelp
--insertsdump data as INSERT commands, rather than COPYhelp
--load-via-partition-rootload partitions via the root tablehelp
--no-commentsdo not dump commentshelp
--no-publicationsdo not dump publicationshelp
--no-security-labelsdo not dump security label assignmentshelp
--no-subscriptionsdo not dump subscriptionshelp
--no-table-access-methoddo not dump table access methodshelp
--no-tablespacesdo not dump tablespace assignmentshelp
--no-toast-compressiondo not dump TOAST compression methodshelp
--no-unlogged-table-datado not dump unlogged table datahelp
--on-conflict-do-nothingadd ON CONFLICT DO NOTHING to INSERT commandshelp
--quote-all-identifiersquote all identifiers, even if not key wordshelp
--restrict-key RESTRICT_KEYuse provided string as psql \restrict keyhelp
--rows-per-insert NROWSnumber of rows per INSERT;help
--section SECTIONdump named section (pre-data, data, or post-data)help
--serializable-deferrablewait until the dump can run without anomalieshelp
--snapshot SNAPSHOTuse given snapshot for the dumphelp
--strict-namesrequire table and/or schema include patterns to match at least one entity eachhelp
--use-set-session-authorizationuse SET SESSION AUTHORIZATION commands instead of ALTER OWNER commands to set ownershiphelp
-d, --dbname DBNAMEdatabase to dumphelp
-h, --host HOSTNAMEdatabase server host or socket directoryhelp
-p, --port PORTdatabase server port numberhelp
-U, --username NAMEconnect as specified database userhelp
-w, --no-passwordnever prompt for passwordhelp
-W, --passwordforce password prompt (should happen automatically)help
--role ROLENAMEdo SET ROLE before dumphelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.