Search PostgreSQL documentation
PG 18 · Browse by category, or enter a name or keyword
Popular entries9981
pg_dump --disable-triggersdisable-triggers
This option is relevant only when creating a dump that includes data but does not include schema. It instructs pg_dump to include commands to temporarily disable triggers on…
pg_dump --enable-row-securityenable-row-security
This option is relevant only when dumping the contents of a table which has row security. By default, pg_dump will set row_security to off, to ensure that all data is dum…
pg_dump --encoding=encodingE encoding--encoding=encoding
Create the dump in the specified character set encoding. By default, the dump is created in the database encoding. (Another way to get the same result is to set…
pg_dump --exclude-extension=patternexclude-extension=pattern
Do not dump any extensions matching pattern. The pattern is interpreted according to the same rules as for -e. --exclude-extension can be given more than once to ex…
pg_dump --exclude-schema=patternN pattern--exclude-schema=pattern
Do not dump any schemas matching pattern. The pattern is interpreted according to the same rules as for -n. -N can be given more than once to exclude schema…
pg_dump --exclude-table-and-children=patternexclude-table-and-children=pattern
This is the same as the -T/--exclude-table option, except that it also excludes any partitions or inheritance child tables of the table(s) matching the pat…
pg_dump --exclude-table-data-and-children=patternexclude-table-data-and-children=pattern
This is the same as the --exclude-table-data option, except that it also excludes data of any partitions or inheritance child tables of the table(s) m…
pg_dump --exclude-table-data=patternexclude-table-data=pattern
Do not dump data for any tables matching pattern. The pattern is interpreted according to the same rules as for -t. --exclude-table-data can be given more than onc…
pg_dump --exclude-table=patternT pattern--exclude-table=pattern
Do not dump any tables matching pattern. The pattern is interpreted according to the same rules as for -t. -T can be given more than once to exclude tables m…
pg_dump --extension=patterne pattern--extension=pattern
Dump only extensions matching pattern. When this option is not specified, all non-system extensions in the target database will be dumped. Multiple extensions ca…
pg_dump --extra-float-digits=ndigitsextra-float-digits=ndigits
Use the specified value of extra_float_digits when dumping floating-point data, instead of the maximum available precision. Routine dumps made for backup purposes …
pg_dump --file=filef file--file=file
Send output to the specified file. This parameter can be omitted for file based output formats, in which case the standard output is used. It must be given for the director…
pg_dump --filter=filenamefilter=filename
Specify a filename from which to read patterns for objects to include or exclude from the dump. The patterns are interpreted according to the same rules as the corresponding …
pg_dump --format=formatF format--format=format
Selects the format of the output. format can be one of the following: pplain Output a plain-text SQL script file (the default). ccustom Output a custom-format archive…
pg_dump --help?--help
Show help about pg_dump command line arguments, and exit.
pg_dump --host=hosth host--host=host
Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket. The default…
pg_dump --if-existsif-exists
Use DROP ... IF EXISTS commands to drop objects in --clean mode. This suppresses “does not exist” errors that might otherwise be reported. This option is not valid unless --clean i…
pg_dump --include-foreign-data=foreignserverinclude-foreign-data=foreignserver
Dump the data for any foreign table with a foreign server matching foreignserver pattern. Multiple foreign servers can be selected by writing multiple --in…
pg_dump --insertsinserts
Dump data as INSERT commands (rather than COPY). This will make restoration very slow; it is mainly useful for making dumps that can be loaded into non-PostgreSQL databases. Any erro…
pg_dump --jobs=njobsj njobs--jobs=njobs
Run the dump in parallel by dumping njobs tables simultaneously. This option may reduce the time needed to perform the dump but it also increases the load on the database…
pg_dump --load-via-partition-rootload-via-partition-root
When dumping data for a table partition, make the COPY or INSERT statements target the root of the partitioning hierarchy that contains it, rather than the partition …
pg_dump --lock-wait-timeout=timeoutlock-wait-timeout=timeout
Do not wait forever to acquire shared table locks at the beginning of the dump. Instead fail if unable to lock a table within the specified timeout. The timeout may…
pg_dump --no-aclx--no-privileges--no-acl
Prevent dumping of access privileges (grant/revoke commands).
pg_dump --no-blobsB--no-large-objects--no-blobs (deprecated)
Exclude large objects in the dump. When both -b and -B are given, the behavior is to output large objects, when data is being dumped, see the -b do…
pg_dump --no-commentsno-comments
Do not dump COMMENT commands.
pg_dump --no-datano-data
Do not dump data.
pg_dump --no-ownerO--no-owner
Do not output commands to set ownership of objects to match the original database. By default, pg_dump issues ALTER OWNER or SET SESSION AUTHORIZATION statements to set ownership…
pg_dump --no-passwordw--no-password
Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass file, the connection attempt wil…
pg_dump --no-policiesno-policies
Do not dump row security policies.
pg_dump --no-publicationsno-publications
Do not dump publications.
pg_dump --no-reconnectR--no-reconnect
This option is obsolete but still accepted for backwards compatibility.
pg_dump --no-schemano-schema
Do not dump schema (data definitions).
pg_dump --no-security-labelsno-security-labels
Do not dump security labels.
pg_dump --no-statisticsno-statistics
Do not dump statistics. This is the default.
pg_dump --no-subscriptionsno-subscriptions
Do not dump subscriptions.
pg_dump --no-syncno-sync
By default, pg_dump will wait for all files to be written safely to disk. This option causes pg_dump to return without waiting, which is faster, but means that a subsequent operating…
pg_dump --no-table-access-methodno-table-access-method
Do not output commands to select table access methods. With this option, all objects will be created with whichever table access method is the default during restore. …
pg_dump --no-tablespacesno-tablespaces
Do not output commands to select tablespaces. With this option, all objects will be created in whichever tablespace is the default during restore. This option is ignored when …
pg_dump --no-toast-compressionno-toast-compression
Do not output commands to set TOAST compression methods. With this option, all columns will be restored with the default compression setting.
pg_dump --no-unlogged-table-datano-unlogged-table-data
Do not dump the contents of unlogged tables and sequences. This option has no effect on whether or not the table and sequence definitions (schema) are dumped; it only …
More results
Find definitions in the PostgreSQL manuals, reference library, and extension catalogue.
Searching every version by default. Manual pages are indexed for PostgreSQL 10–20; the reference library and extension catalogue are not version-bound.
all: every version pg17: one version ex: extensions only ↑↓ select ↵ open