Search PostgreSQL documentation

pg_ctl --pgdata=datadirCommand-line ToolsPG18-D datadir--pgdata=datadir Specifies the file system location of the database configuration files. If this option is omitted, the environment variable PGDATA is used.pg_ctl › Options pg_ctl --silentCommand-line ToolsPG18-s--silent Print only errors, no informational messages.pg_ctl › Options pg_ctl --timeout=secondsCommand-line ToolsPG18-t seconds--timeout=seconds Specifies the maximum number of seconds to wait when waiting for an operation to complete (see option -w). Defaults to the value of the PGCTLTIMEOUT environment v…pg_ctl › Options pg_ctl --versionCommand-line ToolsPG18-V--version Print the pg_ctl version and exit.pg_ctl › Options pg_ctl --waitCommand-line ToolsPG18-w--wait Wait for the operation to complete. This is supported for the modes start, stop, restart, promote, and register, and is the default for those modes. When waiting, pg_ctl repeatedly …pg_ctl › Options pg_ctl -e sourceCommand-line ToolsPG18-e source Name of the event source for pg_ctl to use for logging to the event log when running as a Windows service. The default is PostgreSQL. Note that this only controls messages sent fro…pg_ctl › Options › Options for Windows pg_ctl -N servicenameCommand-line ToolsPG18-N servicename Name of the system service to register. This name will be used as both the service name and the display name. The default is PostgreSQL.pg_ctl › Options › Options for Windows pg_ctl -P passwordCommand-line ToolsPG18-P password Password for the user to run the service as.pg_ctl › Options › Options for Windows pg_ctl -p pathCommand-line ToolsPG18-p path Specifies the location of the postgres executable. By default the postgres executable is taken from the same directory as pg_ctl, or failing that, the hard-wired installation directo…pg_ctl › Options pg_ctl -S start-typeCommand-line ToolsPG18-S start-type Start type of the system service. start-type can be auto, or demand, or the first letter of one of these two. If this option is omitted, auto is the default.pg_ctl › Options › Options for Windows pg_ctl -U usernameCommand-line ToolsPG18-U username User name for the user to run the service as. For domain users, use the format DOMAIN\username.pg_ctl › Options › Options for Windows pg_dump --attribute-insertsCommand-line ToolsPG18--column-inserts--attribute-inserts Dump data as INSERT commands with explicit column names (INSERT INTO table (column, ...) VALUES ...). This will make restoration very slow; it is mainly u…pg_dump › Options pg_dump --binary-upgradeCommand-line ToolsPG18--binary-upgrade This option is for use by in-place upgrade utilities. Its use for other purposes is not recommended or supported. The behavior of the option may change in future releases wi…pg_dump › Options pg_dump --blobsCommand-line ToolsPG18-b--large-objects--blobs (deprecated) Include large objects in the dump. This is the default behavior except when --schema, --table, --schema-only, --statistics-only, or --no-data is specifi…pg_dump › Options pg_dump --cleanCommand-line ToolsPG18-c--clean Output commands to DROP all the dumped database objects prior to outputting the commands for creating them. This option is useful when the restore is to overwrite an existing datab…pg_dump › Options pg_dump --compress=methodCommand-line ToolsPG18-Z level-Z method[:detail]--compress=level--compress=method[:detail] Specify the compression method and/or the compression level to use. The compression method can be set to gzip, lz4, zstd,…pg_dump › Options pg_dump --createCommand-line ToolsPG18-C--create Begin the output with a command to create the database itself and reconnect to the created database. (With a script of this form, it doesn't matter which database in the destinati…pg_dump › Options pg_dump --data-onlyCommand-line ToolsPG18-a--data-only Dump only the data, not the schema (data definitions) or statistics. Table data, large objects, and sequence values are dumped. This option is similar to, but for historical re…pg_dump › Options pg_dump --dbname=dbnameCommand-line ToolsPG18-d dbname--dbname=dbname Specifies the name of the database to connect to. This is equivalent to specifying dbname as the first non-option argument on the command line. The dbname can be a c…pg_dump › Options pg_dump --disable-dollar-quotingCommand-line ToolsPG18--disable-dollar-quoting This option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax.pg_dump › Options pg_dump --disable-triggersCommand-line ToolsPG18--disable-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 …pg_dump › Options pg_dump --enable-row-securityCommand-line ToolsPG18--enable-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 d…pg_dump › Options pg_dump --encoding=encodingCommand-line ToolsPG18-E 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 se…pg_dump › Options pg_dump --exclude-extension=patternCommand-line ToolsPG18--exclude-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 …pg_dump › Options pg_dump --exclude-schema=patternCommand-line ToolsPG18-N 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 schem…pg_dump › Options pg_dump --exclude-table-and-children=patternCommand-line ToolsPG18--exclude-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 p…pg_dump › Options pg_dump --exclude-table-data-and-children=patternCommand-line ToolsPG18--exclude-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)…pg_dump › Options pg_dump --exclude-table-data=patternCommand-line ToolsPG18--exclude-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 o…pg_dump › Options pg_dump --exclude-table=patternCommand-line ToolsPG18-T 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 …pg_dump › Options pg_dump --extension=patternCommand-line ToolsPG18-e 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 c…pg_dump › Options pg_dump --extra-float-digits=ndigitsCommand-line ToolsPG18--extra-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 purpose…pg_dump › Options pg_dump --file=fileCommand-line ToolsPG18-f 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 directo…pg_dump › Options pg_dump --filter=filenameCommand-line ToolsPG18--filter=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 correspondin…pg_dump › Options pg_dump --format=formatCommand-line ToolsPG18-F 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 archiv…pg_dump › Options pg_dump --helpCommand-line ToolsPG18-?--help Show help about pg_dump command line arguments, and exit.pg_dump › Options pg_dump --host=hostCommand-line ToolsPG18-h 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 defaul…pg_dump › Options pg_dump --if-existsCommand-line ToolsPG18--if-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…pg_dump › Options pg_dump --include-foreign-data=foreignserverCommand-line ToolsPG18--include-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 --…pg_dump › Options pg_dump --insertsCommand-line ToolsPG18--inserts 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 er…pg_dump › Options pg_dump --jobs=njobsCommand-line ToolsPG18-j 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 databas…pg_dump › Options