PostgreSQL Source Code  git master
streamutil.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * streamutil.h
4  *
5  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
6  *
7  * IDENTIFICATION
8  * src/bin/pg_basebackup/streamutil.h
9  *-------------------------------------------------------------------------
10  */
11 
12 #ifndef STREAMUTIL_H
13 #define STREAMUTIL_H
14 
15 #include "access/xlogdefs.h"
16 #include "datatype/timestamp.h"
17 #include "libpq-fe.h"
18 #include "pqexpbuffer.h"
19 
20 extern const char *progname;
21 extern char *connection_string;
22 extern char *dbhost;
23 extern char *dbuser;
24 extern char *dbport;
25 extern char *dbname;
26 extern int dbgetpassword;
27 extern uint32 WalSegSz;
28 
29 /* Connection kept global so we can disconnect easily */
30 extern PGconn *conn;
31 
32 extern PGconn *GetConnection(void);
33 
34 /* Replication commands */
35 extern bool CreateReplicationSlot(PGconn *conn, const char *slot_name,
36  const char *plugin, bool is_temporary,
37  bool is_physical, bool reserve_wal,
38  bool slot_exists_ok, bool two_phase);
39 extern bool DropReplicationSlot(PGconn *conn, const char *slot_name);
40 extern bool RunIdentifySystem(PGconn *conn, char **sysid,
41  TimeLineID *starttli,
42  XLogRecPtr *startpos,
43  char **db_name);
44 
45 extern void AppendPlainCommandOption(PQExpBuffer buf,
46  bool use_new_option_syntax,
47  char *option_name);
48 extern void AppendStringCommandOption(PQExpBuffer buf,
49  bool use_new_option_syntax,
50  char *option_name, char *option_value);
51 extern void AppendIntegerCommandOption(PQExpBuffer buf,
52  bool use_new_option_syntax,
53  char *option_name, int32 option_value);
54 
55 extern bool GetSlotInformation(PGconn *conn, const char *slot_name,
56  XLogRecPtr *restart_lsn,
57  TimeLineID *restart_tli);
58 extern bool RetrieveWalSegSize(PGconn *conn);
59 extern TimestampTz feGetCurrentTimestamp(void);
60 extern void feTimestampDifference(TimestampTz start_time, TimestampTz stop_time,
61  long *secs, int *microsecs);
62 
63 extern bool feTimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time,
64  int msec);
65 extern void fe_sendint64(int64 i, char *buf);
66 extern int64 fe_recvint64(char *buf);
67 
68 #endif /* STREAMUTIL_H */
uint32
unsigned int uint32
Definition: c.h:490
int32
signed int int32
Definition: c.h:478
TimestampTz
int64 TimestampTz
Definition: timestamp.h:39
i
int i
Definition: isn.c:73
start_time
static time_t start_time
Definition: pg_ctl.c:94
slot_exists_ok
static bool slot_exists_ok
Definition: pg_receivewal.c:50
two_phase
static bool two_phase
Definition: pg_recvlogical.c:38
plugin
static const char * plugin
Definition: pg_recvlogical.c:53
startpos
static XLogRecPtr startpos
Definition: pg_recvlogical.c:42
buf
static char * buf
Definition: pg_test_fsync.c:67
AppendIntegerCommandOption
void AppendIntegerCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, int32 option_value)
Definition: streamutil.c:776
dbgetpassword
int dbgetpassword
Definition: streamutil.c:52
RetrieveWalSegSize
bool RetrieveWalSegSize(PGconn *conn)
Definition: streamutil.c:268
dbhost
char * dbhost
Definition: streamutil.c:48
fe_recvint64
int64 fe_recvint64(char *buf)
Definition: streamutil.c:854
CreateReplicationSlot
bool CreateReplicationSlot(PGconn *conn, const char *slot_name, const char *plugin, bool is_temporary, bool is_physical, bool reserve_wal, bool slot_exists_ok, bool two_phase)
Definition: streamutil.c:575
feGetCurrentTimestamp
TimestampTz feGetCurrentTimestamp(void)
Definition: streamutil.c:789
dbport
char * dbport
Definition: streamutil.c:50
feTimestampDifference
void feTimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: streamutil.c:808
AppendPlainCommandOption
void AppendPlainCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name)
Definition: streamutil.c:732
AppendStringCommandOption
void AppendStringCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, char *option_value)
Definition: streamutil.c:753
fe_sendint64
void fe_sendint64(int64 i, char *buf)
Definition: streamutil.c:843
connection_string
char * connection_string
Definition: streamutil.c:47
GetConnection
PGconn * GetConnection(void)
Definition: streamutil.c:62
feTimestampDifferenceExceeds
bool feTimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time, int msec)
Definition: streamutil.c:830
GetSlotInformation
bool GetSlotInformation(PGconn *conn, const char *slot_name, XLogRecPtr *restart_lsn, TimeLineID *restart_tli)
Definition: streamutil.c:481
progname
const char * progname
Definition: main.c:45
DropReplicationSlot
bool DropReplicationSlot(PGconn *conn, const char *slot_name)
Definition: streamutil.c:683
dbname
char * dbname
Definition: streamutil.c:51
conn
PGconn * conn
Definition: streamutil.c:54
RunIdentifySystem
bool RunIdentifySystem(PGconn *conn, char **sysid, TimeLineID *starttli, XLogRecPtr *startpos, char **db_name)
Definition: streamutil.c:400
dbuser
char * dbuser
Definition: streamutil.c:49
WalSegSz
uint32 WalSegSz
Definition: streamutil.c:34
pg_conn
Definition: libpq-int.h:351
XLogRecPtr
uint64 XLogRecPtr
Definition: xlogdefs.h:21
TimeLineID
uint32 TimeLineID
Definition: xlogdefs.h:59