PostgreSQL Source Code  git master
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)
 

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)

Definition at line 964 of file basebackup.c.

965 {
966  basebackup_options opt;
967  bbsink *sink;
969 
970  if (status == SESSION_BACKUP_RUNNING)
971  ereport(ERROR,
972  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
973  errmsg("a backup is already in progress in this session")));
974 
975  parse_basebackup_options(cmd->options, &opt);
976 
978 
980  {
981  char activitymsg[50];
982 
983  snprintf(activitymsg, sizeof(activitymsg), "sending backup \"%s\"",
984  opt.label);
985  set_ps_display(activitymsg);
986  }
987 
988  /*
989  * If the target is specifically 'client' then set up to stream the backup
990  * to the client; otherwise, it's being sent someplace else and should not
991  * be sent to the client. BaseBackupGetSink has the job of setting up a
992  * sink to send the backup data wherever it needs to go.
993  */
995  if (opt.target_handle != NULL)
996  sink = BaseBackupGetSink(opt.target_handle, sink);
997 
998  /* Set up network throttling, if client requested it */
999  if (opt.maxrate > 0)
1000  sink = bbsink_throttle_new(sink, opt.maxrate);
1001 
1002  /* Set up server-side compression, if client requested it */
1003  if (opt.compression == PG_COMPRESSION_GZIP)
1004  sink = bbsink_gzip_new(sink, &opt.compression_specification);
1005  else if (opt.compression == PG_COMPRESSION_LZ4)
1006  sink = bbsink_lz4_new(sink, &opt.compression_specification);
1007  else if (opt.compression == PG_COMPRESSION_ZSTD)
1008  sink = bbsink_zstd_new(sink, &opt.compression_specification);
1009 
1010  /* Set up progress reporting. */
1011  sink = bbsink_progress_new(sink, opt.progress);
1012 
1013  /*
1014  * Perform the base backup, but make sure we clean up the bbsink even if
1015  * an error occurs.
1016  */
1017  PG_TRY();
1018  {
1019  perform_base_backup(&opt, sink);
1020  }
1021  PG_FINALLY();
1022  {
1023  bbsink_cleanup(sink);
1024  }
1025  PG_END_TRY();
1026 }
static void parse_basebackup_options(List *options, basebackup_options *opt)
Definition: basebackup.c:686
static void perform_base_backup(basebackup_options *opt, bbsink *sink)
Definition: basebackup.c:230
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:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define PG_TRY(...)
Definition: elog.h:370
#define PG_END_TRY(...)
Definition: elog.h:395
#define ERROR
Definition: elog.h:39
#define PG_FINALLY(...)
Definition: elog.h:387
#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:74
const char * label
Definition: basebackup.c:62
pg_compress_algorithm compression
Definition: basebackup.c:73
BaseBackupTargetHandle * target_handle
Definition: basebackup.c:71
void WalSndSetState(WalSndState state)
Definition: walsender.c:3471
@ WALSNDSTATE_BACKUP
SessionBackupState get_backup_status(void)
Definition: xlog.c:8562
SessionBackupState
Definition: xlog.h:275
@ SESSION_BACKUP_RUNNING
Definition: xlog.h:277

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::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().