↑↓ select ↵ open ⌫ change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Wiki / Statistics & Metrics / pg_stat_progress_basebackup

pg_stat_progress_basebackup.backup_total

Total amount of data that will be streamed. This is estimated and reported as of the beginning of streaming database files phase. Note that this is only an approximation since the database may change during streaming database files phase and WAL log…

Reading PostgreSQL 18.6.

Description

Total amount of data that will be streamed. This is estimated and reported as of the beginning of streaming database files phase. Note that this is only an approximation since the database may change during streaming database files phase and WAL log may be included in the backup later. This is always the same value as backup_streamed once the amount of data streamed exceeds the estimated total size. If the estimation is disabled in pg_basebackup (i.e., --no-estimate-size option is specified), this is NULL.

View
pg_stat_progress_basebackup
Field
backup_total
SQL type
bigint
Units named in the field definition
Not specified
Reset observation
No stats_reset field is documented for this view

Usage

SELECT backup_total FROM pg_catalog.pg_stat_progress_basebackup;

View semantics

Whenever an application like pg_basebackup is taking a base backup, the pg_stat_progress_basebackup view will contain a row for each WAL sender process that is currently running the BASE_BACKUP replication command and streaming the backup. The tables below describe the information that will be reported and provide information about how to interpret it.

Collection and reset context

Read the same-version statistics collection and view documentation below for reset scope and visibility. No per-field reset rule is inferred from the field name.

Inspect this field

Example query; no execution result or measured value is asserted.

SELECT backup_total FROM pg_catalog.pg_stat_progress_basebackup;

Related entries

Documentation and source

Source build
Version
18.6
Build
https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
Source fingerprint
555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f

Compare versions

PostgreSQL 12 → 13: added.

--- PostgreSQL 12
+++ PostgreSQL 13
@@ -1 +1,6 @@
-Not recorded in this version
+{
+  "field": "backup_total",
+  "sql_type": "bigint",
+  "units_mentioned": [],
+  "view": "pg_stat_progress_basebackup"
+}

Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.

Related entries

Export JSON · Back to Statistics & Metrics · Recorded in PostgreSQL 13 through 20; the first sample is not necessarily its introduction.