Search PostgreSQL documentation

pg_available_extensionsManual ChaptersPG18The pg_available_extensions view lists the extensions that are available for installation. See also the pg_extension catalog, which shows the extensions currently installed. Table 53.3. pg_a… pg_backend_memory_contextsManual ChaptersPG18The view pg_backend_memory_contexts displays all the memory contexts of the server process attached to the current session. pg_backend_memory_contexts contains one row for each memory contex… pg_backgroundExtensionsExtensionsTime series · ExtensionsRun SQL queries in the background pg_background Time series pg_background_queueExtensionsExtensionsTime series · ExtensionsTopic-aware background SQL task queue with concurrency limits and retries. queue background-worker retry scheduler pg_background_queue Time series pg_backtraceExtensionsExtensionsMonitoring · ExtensionsShow backtrace for errors and signals backtrace debugging error pg_backtrace Monitoring pg_backup_complianceExtensionsExtensionsSecurity · ExtensionsMonitor backup-related sessions and expose captured operations as SQL views audit backup pg_backup_compliance Security pg_base58ExtensionsExtensionsFunctions and aggregates · ExtensionsBase58 Encoder/Decoder Extension for PostgreSQL pgrx pg_base58 Functions and aggregates pg_base62ExtensionsExtensionsUtilities · ExtensionsEncode UUID values to URL-safe Base62 strings and decode them back. base62 pgrx postgresql rust uuidv7 pg_base62 Utilities pg_basebackupCommand-line ToolsPG18take a base backup of a PostgreSQL cluster Synopsis pg_basebackup [option...] pg_basebackupManual ChaptersPG18take a base backup of a PostgreSQL cluster Synopsis pg_basebackup [option...] pg_basebackup --checkpoint={fast|spread}Command-line ToolsPG18pg_basebackup › Optionsc {fast|spread}--checkpoint={fast|spread} Sets checkpoint mode to fast (immediate) or spread (the default) (see Section 25.3.4). pg_basebackup --compress=[{client|server}-]method[:detail]Command-line ToolsPG18pg_basebackup › OptionsZ 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 wher… pg_basebackup --create-slotCommand-line ToolsPG18pg_basebackup › OptionsC--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 --dbname=connstrCommand-line ToolsPG18pg_basebackup › Optionsd 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 --dbname… pg_basebackup --format=formatCommand-line ToolsPG18pg_basebackup › OptionsF 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 direct… pg_basebackup --gzipCommand-line ToolsPG18pg_basebackup › Optionsz--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 add… pg_basebackup --helpCommand-line ToolsPG18pg_basebackup › Options?--help Shows help about pg_basebackup command line arguments, and exits. pg_basebackup --host=hostCommand-line ToolsPG18pg_basebackup › Optionsh 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 i… pg_basebackup --incremental=old_manifest_fileCommand-line ToolsPG18pg_basebackup › Optionsi 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 wi… pg_basebackup --label=labelCommand-line ToolsPG18pg_basebackup › Optionsl 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 --manifest-checksums=algorithmCommand-line ToolsPG18pg_basebackup › Optionsmanifest-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, SHA22… pg_basebackup --manifest-force-encodeCommand-line ToolsPG18pg_basebackup › Optionsmanifest-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 intended … pg_basebackup --max-rate=rateCommand-line ToolsPG18pg_basebackup › Optionsr 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 k… pg_basebackup --no-cleanCommand-line ToolsPG18pg_basebackup › Optionsn--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 di… pg_basebackup --no-estimate-sizeCommand-line ToolsPG18pg_basebackup › Optionsno-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 alway… pg_basebackup --no-manifestCommand-line ToolsPG18pg_basebackup › Optionsno-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 ma… pg_basebackup --no-passwordCommand-line ToolsPG18pg_basebackup › Optionsw--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 attemp… pg_basebackup --no-slotCommand-line ToolsPG18pg_basebackup › Optionsno-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 replicat… pg_basebackup --no-syncCommand-line ToolsPG18pg_basebackup › OptionsN--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 subse… pg_basebackup --no-verify-checksumsCommand-line ToolsPG18pg_basebackup › Optionsno-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 result … pg_basebackup --passwordCommand-line ToolsPG18pg_basebackup › OptionsW--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 password… pg_basebackup --pgdata=directoryCommand-line ToolsPG18pg_basebackup › OptionsD 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 alre… pg_basebackup --port=portCommand-line ToolsPG18pg_basebackup › Optionsp 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 --progressCommand-line ToolsPG18pg_basebackup › OptionsP--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 approx… pg_basebackup --slot=slotnameCommand-line ToolsPG18pg_basebackup › OptionsS 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 --status-interval=intervalCommand-line ToolsPG18pg_basebackup › Optionss 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 f… pg_basebackup --sync-method=methodCommand-line ToolsPG18pg_basebackup › Optionssync-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 f… pg_basebackup --tablespace-mapping=olddir=newdirCommand-line ToolsPG18pg_basebackup › OptionsT 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 --target=targetCommand-line ToolsPG18pg_basebackup › Optionst 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 i… pg_basebackup --username=usernameCommand-line ToolsPG18pg_basebackup › OptionsU username--username=username Specifies the user name to connect as.