Search PostgreSQL documentation

pg_dumpCommand-line ToolsPG18pg_dump pg_dump — export a PostgreSQL database as an SQL script or to other formats Synopsis pg_dump [connection-option...] [option...] [dbname]pg_dump application_nameCommand-line ToolsPG18application_name Specifies a value for the application_name configuration parameter.Database Connection Control Functions › Parameter Key Words channel_bindingCommand-line ToolsPG18channel_binding This option controls the client's use of channel binding. A setting of require means that the connection must employ channel binding, prefer means that the client will choose…Database Connection Control Functions › Parameter Key Words client_encodingCommand-line ToolsPG18client_encoding This sets the client_encoding configuration parameter for this connection. In addition to the values accepted by the corresponding server option, you can use auto to determin…Database Connection Control Functions › Parameter Key Words clusterdbCommand-line ToolsPG18clusterdb clusterdb — cluster a PostgreSQL database Synopsis clusterdb [connection-option...] [option...] [ --table | -t table ] ... [ dbname | -a | --all ]clusterdb clusterdb --allCommand-line ToolsPG18-a--all Cluster all databases.clusterdb › Options clusterdb --echoCommand-line ToolsPG18-e--echo Echo the commands that clusterdb generates and sends to the server.clusterdb › Options clusterdb --helpCommand-line ToolsPG18-?--help Show help about clusterdb command line arguments, and exit.clusterdb › Options clusterdb --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.clusterdb › Options clusterdb --maintenance-db=dbnameCommand-line ToolsPG18--maintenance-db=dbname When the -a/--all is used, connect to this database to gather the list of databases to cluster. If not specified, the postgres database will be used, or if that does …clusterdb › Options clusterdb --no-passwordCommand-line ToolsPG18-w--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 wi…clusterdb › Options clusterdb --passwordCommand-line ToolsPG18-W--password Force clusterdb to prompt for a password before connecting to a database. This option is never essential, since clusterdb will automatically prompt for a password if the server …clusterdb › Options clusterdb --port=portCommand-line ToolsPG18-p port--port=port Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.clusterdb › Options clusterdb --quietCommand-line ToolsPG18-q--quiet Do not display progress messages.clusterdb › Options clusterdb --table=tableCommand-line ToolsPG18-t table--table=table Cluster table only. Multiple tables can be clustered by writing multiple -t switches.clusterdb › Options clusterdb --username=usernameCommand-line ToolsPG18-U username--username=username User name to connect as.clusterdb › Options clusterdb --verboseCommand-line ToolsPG18-v--verbose Print detailed information during processing.clusterdb › Options clusterdb --versionCommand-line ToolsPG18-V--version Print the clusterdb version and exit.clusterdb › Options clusterdb [--dbname=]dbnameCommand-line ToolsPG18[-d] dbname[--dbname=]dbname Specifies the name of the database to be clustered, when -a/--all is not used. If this is not specified, the database name is read from the environment variable …clusterdb › Options connect_timeoutCommand-line ToolsPG18connect_timeout Maximum time to wait while connecting, in seconds (write as a decimal integer, e.g., 10). Zero, negative, or not specified means wait indefinitely. This timeout applies separ…Database Connection Control Functions › Parameter Key Words createdbCommand-line ToolsPG18createdb createdb — create a new PostgreSQL database Synopsis createdb [connection-option...] [option...] [dbname [description]]createdb createdb --builtin-locale=localeCommand-line ToolsPG18--builtin-locale=locale Specifies the locale name when the builtin provider is used. Locale support is described in Section 23.1.createdb › Options createdb --echoCommand-line ToolsPG18-e--echo Echo the commands that createdb generates and sends to the server.createdb › Options createdb --encoding=encodingCommand-line ToolsPG18-E encoding--encoding=encoding Specifies the character encoding scheme to be used in this database. The character sets supported by the PostgreSQL server are described in Section 23.3.1.createdb › Options createdb --helpCommand-line ToolsPG18-?--help Show help about createdb command line arguments, and exit.createdb › Options createdb --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.createdb › Options createdb --icu-locale=localeCommand-line ToolsPG18--icu-locale=locale Specifies the ICU locale ID to be used in this database, if the ICU locale provider is selected.createdb › Options createdb --icu-rules=rulesCommand-line ToolsPG18--icu-rules=rules Specifies additional collation rules to customize the behavior of the default collation of this database. This is supported for ICU only.createdb › Options createdb --lc-collate=localeCommand-line ToolsPG18--lc-collate=locale Specifies the LC_COLLATE setting to be used in this database.createdb › Options createdb --lc-ctype=localeCommand-line ToolsPG18--lc-ctype=locale Specifies the LC_CTYPE setting to be used in this database.createdb › Options createdb --locale-provider={builtin|libc|icu}Command-line ToolsPG18--locale-provider={builtin|libc|icu} Specifies the locale provider for the database's default collation.createdb › Options createdb --locale=localeCommand-line ToolsPG18-l locale--locale=locale Specifies the locale to be used in this database. This is equivalent to specifying --lc-collate, --lc-ctype, and --icu-locale to the same value. Some locales are onl…createdb › Options createdb --maintenance-db=dbnameCommand-line ToolsPG18--maintenance-db=dbname Specifies the name of the database to connect to when creating the new database. If not specified, the postgres database will be used; if that does not exist (or if i…createdb › Options createdb --no-passwordCommand-line ToolsPG18-w--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 wi…createdb › Options createdb --owner=ownerCommand-line ToolsPG18-O owner--owner=owner Specifies the database user who will own the new database. (This name is processed as a double-quoted identifier.)createdb › Options createdb --passwordCommand-line ToolsPG18-W--password Force createdb to prompt for a password before connecting to a database. This option is never essential, since createdb will automatically prompt for a password if the server de…createdb › Options createdb --port=portCommand-line ToolsPG18-p port--port=port Specifies the TCP port or the local Unix domain socket file extension on which the server is listening for connections.createdb › Options createdb --strategy=strategyCommand-line ToolsPG18-S strategy--strategy=strategy Specifies the database creation strategy. See CREATE DATABASE STRATEGY for more details.createdb › Options createdb --tablespace=tablespaceCommand-line ToolsPG18-D tablespace--tablespace=tablespace Specifies the default tablespace for the database. (This name is processed as a double-quoted identifier.)createdb › Options createdb --template=templateCommand-line ToolsPG18-T template--template=template Specifies the template database from which to build this database. (This name is processed as a double-quoted identifier.)createdb › Options