The unique system identifier identifying the cluster. This can be used to check that the base backup used to initialize the standby came from the same cluster.

Current timeline ID. Also useful to check that the standby is consistent with the primary.

Current WAL flush location. Useful to get a known location in the write-ahead log where streaming can start.

Database connected to or null.

The name of a run-time parameter. Available parameters are documented in Chapter 18.

File name of the timeline history file, e.g., 00000002.history.

Contents of the timeline history file.

The name of the slot to create. Must be a valid replication slot name (see Section 25.2.6.1).

The name of the output plugin used for logical decoding (see Section 47.6).

Specify that this replication slot is a temporary one. Temporary slots are not saved to disk and are automatically dropped on error or when the session has finished.

Specify that this physical replication slot reserves WAL immediately. Otherwise, WAL is only reserved upon connection from a streaming replication client.

Decides what to do with the snapshot created during logical slot initialization. EXPORT_SNAPSHOT, which is the default, will export the snapshot for use in other sessions. This option can't be used inside a transaction. USE_SNAPSHOT will use the snapshot for the current transaction executing the command. This option must be used in a transaction, and CREATE_REPLICATION_SLOT must be the first command run in that transaction. Finally, NOEXPORT_SNAPSHOT will just use the snapshot for logical decoding as normal but won't do anything else with it.

The name of the newly-created replication slot.

The WAL location at which the slot became consistent. This is the earliest location from which streaming can start on this replication slot.

The identifier of the snapshot exported by the command. The snapshot is valid until a new command is executed on this connection or the replication connection is closed. Null if the created slot is physical.

The name of the output plugin used by the newly-created replication slot. Null if the created slot is physical.

The name of the slot to stream changes from. This parameter is required, and must correspond to an existing logical replication slot created with CREATE_REPLICATION_SLOT in LOGICAL mode.

The WAL location to begin streaming at.

The name of an option passed to the slot's logical decoding output plugin. See Section 51.5 for options that are accepted by the standard (pgoutput) plugin.

Optional value, in the form of a string constant, associated with the specified option.

The name of the slot to drop.

This option causes the command to wait if the slot is active until it becomes inactive, instead of the default behavior of raising an error.

Sets the label of the backup. If none is specified, a backup label of base backup will be used. The quoting rules for the label are the same as a standard SQL string with standard_conforming_strings turned on.

Request information required to generate a progress report. This will send back an approximate size in the header of each tablespace, which can be used to calculate how far along the stream is done. This is calculated by enumerating all the file sizes once before the transfer is even started, and might as such have a negative impact on the performance. In particular, it might take longer before the first data is streamed. Since the database files can change during the backup, the size is only approximate and might both grow and shrink between the time of approximation and the sending of the actual files.

Request a fast checkpoint.

Include the necessary WAL segments in the backup. This will include all the files between start and stop backup in the pg_wal directory of the base directory tar file.

By default, the backup will wait until the last required WAL segment has been archived, or emit a warning if log archiving is not enabled. Specifying NOWAIT disables both the waiting and the warning, leaving the client responsible for ensuring the required log is available.

Limit (throttle) the maximum amount of data transferred from server to client per unit of time. The expected unit is kilobytes per second. If this option is specified, the value must either be equal to zero or it must fall within the range from 32 kB through 1 GB (inclusive). If zero is passed or the option is not specified, no restriction is imposed on the transfer.

Include information about symbolic links present in the directory pg_tblspc in a file named tablespace_map. The tablespace map file includes each symbolic link name as it exists in the directory pg_tblspc/ and the full path of that symbolic link.

By default, checksums are verified during a base backup if they are enabled. Specifying NOVERIFY_CHECKSUMS disables this verification.

When this option is specified with a value of yes or force-encode, a backup manifest is created and sent along with the backup. The manifest is a list of every file present in the backup with the exception of any WAL files that may be included. It also stores the size, last modification time, and optionally a checksum for each file. A value of force-encode forces all filenames to be hex-encoded; otherwise, this type of encoding is performed only for files whose names are non-UTF8 octet sequences. force-encode is intended primarily for testing purposes, to be sure that clients which read the backup manifest can handle this case. For compatibility with previous releases, the default is MANIFEST 'no'.

Specifies the checksum algorithm that should be applied to each file included in the backup manifest. Currently, the available algorithms are NONE, CRC32C, SHA224, SHA256, SHA384, and SHA512. The default is CRC32C.

The OID of the tablespace, or null if it's the base directory.

The full path of the tablespace directory, or null if it's the base directory.

The approximate size of the tablespace, in kilobytes (1024 bytes), if progress report has been requested; otherwise it's null.