PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
basebackup.h File Reference
#include "nodes/replnodes.h"
Include dependency graph for basebackup.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  tablespaceinfo
 

Macros

#define MAX_RATE_LOWER   32
 
#define MAX_RATE_UPPER   1048576
 

Functions

void SendBaseBackup (BaseBackupCmd *cmd, struct IncrementalBackupInfo *ib)
 

Macro Definition Documentation

◆ MAX_RATE_LOWER

#define MAX_RATE_LOWER   32

Definition at line 20 of file basebackup.h.

◆ MAX_RATE_UPPER

#define MAX_RATE_UPPER   1048576

Definition at line 21 of file basebackup.h.

Function Documentation

◆ SendBaseBackup()

void SendBaseBackup ( BaseBackupCmd cmd,
struct IncrementalBackupInfo ib 
)

Definition at line 990 of file basebackup.c.

991{
993 bbsink *sink;
995
996 if (status == SESSION_BACKUP_RUNNING)
998 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
999 errmsg("a backup is already in progress in this session")));
1000
1002
1004
1006 {
1007 char activitymsg[50];
1008
1009 snprintf(activitymsg, sizeof(activitymsg), "sending backup \"%s\"",
1010 opt.label);
1011 set_ps_display(activitymsg);
1012 }
1013
1014 /*
1015 * If we're asked to perform an incremental backup and the user has not
1016 * supplied a manifest, that's an ERROR.
1017 *
1018 * If we're asked to perform a full backup and the user did supply a
1019 * manifest, just ignore it.
1020 */
1021 if (!opt.incremental)
1022 ib = NULL;
1023 else if (ib == NULL)
1024 ereport(ERROR,
1025 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
1026 errmsg("must UPLOAD_MANIFEST before performing an incremental BASE_BACKUP")));
1027
1028 /*
1029 * If the target is specifically 'client' then set up to stream the backup
1030 * to the client; otherwise, it's being sent someplace else and should not
1031 * be sent to the client. BaseBackupGetSink has the job of setting up a
1032 * sink to send the backup data wherever it needs to go.
1033 */
1035 if (opt.target_handle != NULL)
1036 sink = BaseBackupGetSink(opt.target_handle, sink);
1037
1038 /* Set up network throttling, if client requested it */
1039 if (opt.maxrate > 0)
1040 sink = bbsink_throttle_new(sink, opt.maxrate);
1041
1042 /* Set up server-side compression, if client requested it */
1044 sink = bbsink_gzip_new(sink, &opt.compression_specification);
1045 else if (opt.compression == PG_COMPRESSION_LZ4)
1046 sink = bbsink_lz4_new(sink, &opt.compression_specification);
1047 else if (opt.compression == PG_COMPRESSION_ZSTD)
1048 sink = bbsink_zstd_new(sink, &opt.compression_specification);
1049
1050 /* Set up progress reporting. */
1051 sink = bbsink_progress_new(sink, opt.progress);
1052
1053 /*
1054 * Perform the base backup, but make sure we clean up the bbsink even if
1055 * an error occurs.
1056 */
1057 PG_TRY();
1058 {
1059 perform_base_backup(&opt, sink, ib);
1060 }
1061 PG_FINALLY();
1062 {
1063 bbsink_cleanup(sink);
1064 }
1065 PG_END_TRY();
1066}
static void parse_basebackup_options(List *options, basebackup_options *opt)
Definition: basebackup.c:698
static void perform_base_backup(basebackup_options *opt, bbsink *sink, IncrementalBackupInfo *ib)
Definition: basebackup.c:234
bbsink * bbsink_copystream_new(bool send_to_client)
bbsink * bbsink_gzip_new(bbsink *next, pg_compress_specification *compress)
bbsink * bbsink_lz4_new(bbsink *next, pg_compress_specification *compress)
bbsink * bbsink_progress_new(bbsink *next, bool estimate_backup_size)
static void bbsink_cleanup(bbsink *sink)
bbsink * BaseBackupGetSink(BaseBackupTargetHandle *handle, bbsink *next_sink)
bbsink * bbsink_throttle_new(bbsink *next, uint32 maxrate)
bbsink * bbsink_zstd_new(bbsink *next, pg_compress_specification *compress)
@ PG_COMPRESSION_GZIP
Definition: compression.h:24
@ PG_COMPRESSION_LZ4
Definition: compression.h:25
@ PG_COMPRESSION_ZSTD
Definition: compression.h:26
int errcode(int sqlerrcode)
Definition: elog.c:853
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define PG_TRY(...)
Definition: elog.h:371
#define PG_END_TRY(...)
Definition: elog.h:396
#define ERROR
Definition: elog.h:39
#define PG_FINALLY(...)
Definition: elog.h:388
#define ereport(elevel,...)
Definition: elog.h:149
#define snprintf
Definition: port.h:238
bool update_process_title
Definition: ps_status.c:31
static void set_ps_display(const char *activity)
Definition: ps_status.h:40
List * options
Definition: replnodes.h:44
pg_compress_specification compression_specification
Definition: basebackup.c:77
const char * label
Definition: basebackup.c:64
pg_compress_algorithm compression
Definition: basebackup.c:76
BaseBackupTargetHandle * target_handle
Definition: basebackup.c:74
void WalSndSetState(WalSndState state)
Definition: walsender.c:3782
@ WALSNDSTATE_BACKUP
SessionBackupState get_backup_status(void)
Definition: xlog.c:9101
SessionBackupState
Definition: xlog.h:286
@ SESSION_BACKUP_RUNNING
Definition: xlog.h:288

References BaseBackupGetSink(), bbsink_cleanup(), bbsink_copystream_new(), bbsink_gzip_new(), bbsink_lz4_new(), bbsink_progress_new(), bbsink_throttle_new(), bbsink_zstd_new(), basebackup_options::compression, basebackup_options::compression_specification, ereport, errcode(), errmsg(), ERROR, get_backup_status(), basebackup_options::incremental, basebackup_options::label, basebackup_options::maxrate, BaseBackupCmd::options, parse_basebackup_options(), perform_base_backup(), PG_COMPRESSION_GZIP, PG_COMPRESSION_LZ4, PG_COMPRESSION_ZSTD, PG_END_TRY, PG_FINALLY, PG_TRY, basebackup_options::progress, basebackup_options::send_to_client, SESSION_BACKUP_RUNNING, set_ps_display(), snprintf, basebackup_options::target_handle, update_process_title, WalSndSetState(), and WALSNDSTATE_BACKUP.

Referenced by exec_replication_command().