Search PostgreSQL documentation

pg_amcheck --table=patternCommand-line ToolsPG18-t pattern--table=pattern Check tables matching the specified pattern, unless they are otherwise excluded. This option can be specified more than once. This is similar to the --relation opti…pg_amcheck › Options pg_amcheck --username=usernameCommand-line ToolsPG18-U--username=username User name to connect as.pg_amcheck › Options pg_amcheck --verboseCommand-line ToolsPG18-v--verbose Print more messages. In particular, this will print a message for each relation being checked, and will increase the level of detail shown for server errors.pg_amcheck › Options pg_amcheck --versionCommand-line ToolsPG18-V--version Print the pg_amcheck version and exit.pg_amcheck › Options pg_basebackupCommand-line ToolsPG18pg_basebackup pg_basebackup — take a base backup of a PostgreSQL cluster Synopsis pg_basebackup [option...]pg_basebackup pg_basebackup --checkpoint={fast|spread}Command-line ToolsPG18-c {fast|spread}--checkpoint={fast|spread} Sets checkpoint mode to fast (immediate) or spread (the default) (see Section 25.3.4).pg_basebackup › Options pg_basebackup --compress=[{client|server}-]method[:detail]Command-line ToolsPG18-Z level-Z [{client|server}-]method[:detail]--compress=level--compress=[{client|server}-]method[:detail] Requests compression of the backup. If client or server is included, it specifies whe…pg_basebackup › Options pg_basebackup --create-slotCommand-line ToolsPG18-C--create-slot Specifies that the replication slot named by the --slot option should be created before starting the backup. An error is raised if the slot already exists.pg_basebackup › Options pg_basebackup --dbname=connstrCommand-line ToolsPG18-d connstr--dbname=connstr Specifies parameters used to connect to the server, as a connection string; these will override any conflicting command line options. This option is called --dbnam…pg_basebackup › Options pg_basebackup --format=formatCommand-line ToolsPG18-F format--format=format Selects the format for the output. format can be one of the following: pplain Write the output as plain files, with the same layout as the source server's data direc…pg_basebackup › Options pg_basebackup --gzipCommand-line ToolsPG18-z--gzip Enables gzip compression of tar file output, with the default compression level. Compression is only available when using the tar format, and the suffix .gz will automatically be ad…pg_basebackup › Options pg_basebackup --helpCommand-line ToolsPG18-?--help Shows help about pg_basebackup command line arguments, and exits.pg_basebackup › Options pg_basebackup --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 a Unix domain socket. The default …pg_basebackup › Options pg_basebackup --incremental=old_manifest_fileCommand-line ToolsPG18-i old_manifest_file--incremental=old_manifest_file Performs an incremental backup. The backup manifest for the reference backup must be provided, and will be uploaded to the server, which w…pg_basebackup › Options pg_basebackup --label=labelCommand-line ToolsPG18-l label--label=label Sets the label for the backup. If none is specified, a default value of “pg_basebackup base backup” will be used.pg_basebackup › Options pg_basebackup --manifest-checksums=algorithmCommand-line ToolsPG18--manifest-checksums=algorithm Specifies the checksum algorithm that should be applied to each file included in the backup manifest. Currently, the available algorithms are NONE, CRC32C, SHA…pg_basebackup › Options pg_basebackup --manifest-force-encodeCommand-line ToolsPG18--manifest-force-encode Forces all filenames in the backup manifest to be hex-encoded. If this option is not specified, only non-UTF8 filenames are hex-encoded. This option is mostly intende…pg_basebackup › Options pg_basebackup --max-rate=rateCommand-line ToolsPG18-r rate--max-rate=rate Sets the maximum transfer rate at which data is collected from the source server. This can be useful to limit the impact of pg_basebackup on the server. Values are in …pg_basebackup › Options pg_basebackup --no-cleanCommand-line ToolsPG18-n--no-clean By default, when pg_basebackup aborts with an error, it removes any directories it might have created before discovering that it cannot finish the job (for example, the target d…pg_basebackup › Options pg_basebackup --no-estimate-sizeCommand-line ToolsPG18--no-estimate-size Prevents the server from estimating the total amount of backup data that will be streamed, resulting in the backup_total column in the pg_stat_progress_basebackup view alw…pg_basebackup › Options pg_basebackup --no-manifestCommand-line ToolsPG18--no-manifest Disables generation of a backup manifest. If this option is not specified, the server will generate and send a backup manifest which can be verified using pg_verifybackup. The …pg_basebackup › Options pg_basebackup --no-passwordCommand-line ToolsPG18-w--no-password Prevents issuing 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 attem…pg_basebackup › Options pg_basebackup --no-slotCommand-line ToolsPG18--no-slot Prevents the creation of a temporary replication slot for the backup. By default, if log streaming is selected but no slot name is given with the -S option, then a temporary replic…pg_basebackup › Options pg_basebackup --no-syncCommand-line ToolsPG18-N--no-sync By default, pg_basebackup will wait for all files to be written safely to disk. This option causes pg_basebackup to return without waiting, which is faster, but means that a subs…pg_basebackup › Options pg_basebackup --no-verify-checksumsCommand-line ToolsPG18--no-verify-checksums Disables verification of checksums, if they are enabled on the server the base backup is taken from. By default, checksums are verified and checksum failures will resul…pg_basebackup › Options pg_basebackup --passwordCommand-line ToolsPG18-W--password Forces pg_basebackup to prompt for a password before connecting to the source server. This option is never essential, since pg_basebackup will automatically prompt for a passwor…pg_basebackup › Options pg_basebackup --pgdata=directoryCommand-line ToolsPG18-D directory--pgdata=directory Sets the target directory to write the output to. pg_basebackup will create this directory (and any missing parent directories) if it does not exist. If it alr…pg_basebackup › Options pg_basebackup --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. Defaults to the PGPORT environment variable, if set, or…pg_basebackup › Options pg_basebackup --progressCommand-line ToolsPG18-P--progress Enables progress reporting. Turning this on will deliver an approximate progress report during the backup. Since the database may change during the backup, this is only an appro…pg_basebackup › Options pg_basebackup --slot=slotnameCommand-line ToolsPG18-S slotname--slot=slotname This option can only be used together with -X stream. It causes WAL streaming to use the specified replication slot. If the base backup is intended to be used as a…pg_basebackup › Options pg_basebackup --status-interval=intervalCommand-line ToolsPG18-s interval--status-interval=interval Specifies the number of seconds between status packets sent back to the source server. Smaller values allow more accurate monitoring of backup progress …pg_basebackup › Options pg_basebackup --sync-method=methodCommand-line ToolsPG18--sync-method=method When set to fsync, which is the default, pg_basebackup will recursively open and synchronize all files in the backup directory. When the plain format is used, the search…pg_basebackup › Options pg_basebackup --tablespace-mapping=olddir=newdirCommand-line ToolsPG18-T olddir=newdir--tablespace-mapping=olddir=newdir Relocates the tablespace in directory olddir to newdir during the backup. To be effective, olddir must exactly match the path specification…pg_basebackup › Options pg_basebackup --target=targetCommand-line ToolsPG18-t target--target=target Instructs the server where to place the base backup. The default target is client, which specifies that the backup should be sent to the machine where pg_basebackup …pg_basebackup › Options pg_basebackup --username=usernameCommand-line ToolsPG18-U username--username=username Specifies the user name to connect as.pg_basebackup › Options pg_basebackup --verboseCommand-line ToolsPG18-v--verbose Enables verbose mode. Will output some extra steps during startup and shutdown, as well as show the exact file name that is currently being processed if progress reporting is als…pg_basebackup › Options pg_basebackup --versionCommand-line ToolsPG18-V--version Prints the pg_basebackup version and exits.pg_basebackup › Options pg_basebackup --wal-method=methodCommand-line ToolsPG18-X method--wal-method=method Includes the required WAL (write-ahead log) files in the backup. This will include all write-ahead logs generated during the backup. Unless the method none is sp…pg_basebackup › Options pg_basebackup --waldir=waldirCommand-line ToolsPG18--waldir=waldir Sets the directory to write WAL (write-ahead log) files to. By default WAL files will be placed in the pg_wal subdirectory of the target directory, but this option can be use…pg_basebackup › Options pg_basebackup --write-recovery-confCommand-line ToolsPG18-R--write-recovery-conf Creates a standby.signal file and appends connection settings to the postgresql.auto.conf file in the target directory (or within the base archive file when using tar…pg_basebackup › Options