This repository has been archived by the owner on Sep 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
pglogrepl.go
773 lines (683 loc) · 22.9 KB
/
pglogrepl.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
// Copyright 2024 Redpanda Data, Inc.
//
// Licensed as a Redpanda Enterprise file under the Redpanda Community
// License (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// https://github.com/redpanda-data/connect/blob/main/licenses/rcl.md
package pglogicalstream
// Package pglogrepl implements PostgreSQL logical replication client functionality.
//
// pglogrepl uses package github.com/jackc/pgconn as its underlying PostgreSQL connection.
// Use pgconn to establish a connection to PostgreSQL and then use the pglogrepl functions
// on that connection.
//
// Proper use of this package requires understanding the underlying PostgreSQL concepts.
// See https://www.postgresql.org/docs/current/protocol-replication.html.
import (
"context"
"database/sql/driver"
"encoding/binary"
"fmt"
"strconv"
"strings"
"time"
"github.com/jackc/pgio"
"github.com/jackc/pgx/v5/pgconn"
"github.com/jackc/pgx/v5/pgproto3"
)
const (
XLogDataByteID = 'w'
PrimaryKeepaliveMessageByteID = 'k'
StandbyStatusUpdateByteID = 'r'
)
type ReplicationMode int
const (
LogicalReplication ReplicationMode = iota
PhysicalReplication
)
// String formats the mode into a postgres valid string
func (mode ReplicationMode) String() string {
if mode == LogicalReplication {
return "LOGICAL"
} else {
return "PHYSICAL"
}
}
// LSN is a PostgreSQL Log Sequence Number. See https://www.postgresql.org/docs/current/datatype-pg-lsn.html.
type LSN uint64
// String formats the LSN value into the XXX/XXX format which is the text format used by PostgreSQL.
func (lsn LSN) String() string {
return fmt.Sprintf("%X/%X", uint32(lsn>>32), uint32(lsn))
}
func (lsn *LSN) decodeText(src string) error {
lsnValue, err := ParseLSN(src)
if err != nil {
return err
}
*lsn = lsnValue
return nil
}
// Scan implements the Scanner interface.
func (lsn *LSN) Scan(src interface{}) error {
if lsn == nil {
return nil
}
switch v := src.(type) {
case uint64:
*lsn = LSN(v)
case string:
if err := lsn.decodeText(v); err != nil {
return err
}
case []byte:
if err := lsn.decodeText(string(v)); err != nil {
return err
}
default:
return fmt.Errorf("can not scan %T to LSN", src)
}
return nil
}
// Value implements the Valuer interface.
func (lsn LSN) Value() (driver.Value, error) {
return driver.Value(lsn.String()), nil
}
// ParseLSN parses the given XXX/XXX text format LSN used by PostgreSQL.
func ParseLSN(s string) (LSN, error) {
var upperHalf uint64
var lowerHalf uint64
var nparsed int
nparsed, err := fmt.Sscanf(s, "%X/%X", &upperHalf, &lowerHalf)
if err != nil {
return 0, fmt.Errorf("failed to parse LSN: %w", err)
}
if nparsed != 2 {
return 0, fmt.Errorf("failed to parsed LSN: %s", s)
}
return LSN((upperHalf << 32) + lowerHalf), nil
}
// IdentifySystemResult is the parsed result of the IDENTIFY_SYSTEM command.
type IdentifySystemResult struct {
SystemID string
Timeline int32
XLogPos LSN
DBName string
}
// IdentifySystem executes the IDENTIFY_SYSTEM command.
func IdentifySystem(ctx context.Context, conn *pgconn.PgConn) (IdentifySystemResult, error) {
return ParseIdentifySystem(conn.Exec(ctx, "IDENTIFY_SYSTEM"))
}
// ParseIdentifySystem parses the result of the IDENTIFY_SYSTEM command.
func ParseIdentifySystem(mrr *pgconn.MultiResultReader) (IdentifySystemResult, error) {
var isr IdentifySystemResult
results, err := mrr.ReadAll()
if err != nil {
return isr, err
}
if len(results) != 1 {
return isr, fmt.Errorf("expected 1 result set, got %d", len(results))
}
result := results[0]
if len(result.Rows) != 1 {
return isr, fmt.Errorf("expected 1 result row, got %d", len(result.Rows))
}
row := result.Rows[0]
if len(row) != 4 {
return isr, fmt.Errorf("expected 4 result columns, got %d", len(row))
}
isr.SystemID = string(row[0])
timeline, err := strconv.ParseInt(string(row[1]), 10, 32)
if err != nil {
return isr, fmt.Errorf("failed to parse timeline: %w", err)
}
isr.Timeline = int32(timeline)
isr.XLogPos, err = ParseLSN(string(row[2]))
if err != nil {
return isr, fmt.Errorf("failed to parse xlogpos as LSN: %w", err)
}
isr.DBName = string(row[3])
return isr, nil
}
// TimelineHistoryResult is the parsed result of the TIMELINE_HISTORY command.
type TimelineHistoryResult struct {
FileName string
Content []byte
}
// TimelineHistory executes the TIMELINE_HISTORY command.
func TimelineHistory(ctx context.Context, conn *pgconn.PgConn, timeline int32) (TimelineHistoryResult, error) {
sql := fmt.Sprintf("TIMELINE_HISTORY %d", timeline)
return ParseTimelineHistory(conn.Exec(ctx, sql))
}
// ParseTimelineHistory parses the result of the TIMELINE_HISTORY command.
func ParseTimelineHistory(mrr *pgconn.MultiResultReader) (TimelineHistoryResult, error) {
var thr TimelineHistoryResult
results, err := mrr.ReadAll()
if err != nil {
return thr, err
}
if len(results) != 1 {
return thr, fmt.Errorf("expected 1 result set, got %d", len(results))
}
result := results[0]
if len(result.Rows) != 1 {
return thr, fmt.Errorf("expected 1 result row, got %d", len(result.Rows))
}
row := result.Rows[0]
if len(row) != 2 {
return thr, fmt.Errorf("expected 2 result columns, got %d", len(row))
}
thr.FileName = string(row[0])
thr.Content = row[1]
return thr, nil
}
type CreateReplicationSlotOptions struct {
Temporary bool
SnapshotAction string
Mode ReplicationMode
}
// CreateReplicationSlotResult is the parsed results the CREATE_REPLICATION_SLOT command.
type CreateReplicationSlotResult struct {
SlotName string
ConsistentPoint string
SnapshotName string
OutputPlugin string
}
// CreateReplicationSlot creates a logical replication slot.
func CreateReplicationSlot(
ctx context.Context,
conn *pgconn.PgConn,
slotName string,
outputPlugin string,
options CreateReplicationSlotOptions,
) (CreateReplicationSlotResult, error) {
var temporaryString string
if options.Temporary {
temporaryString = "TEMPORARY"
}
var snapshotString string
if options.SnapshotAction == "export" {
snapshotString = "(SNAPSHOT export)"
} else {
snapshotString = options.SnapshotAction
}
sql := fmt.Sprintf("CREATE_REPLICATION_SLOT %s %s %s %s %s", slotName, temporaryString, options.Mode, outputPlugin, snapshotString)
return ParseCreateReplicationSlot(conn.Exec(ctx, sql))
}
// ParseCreateReplicationSlot parses the result of the CREATE_REPLICATION_SLOT command.
func ParseCreateReplicationSlot(mrr *pgconn.MultiResultReader) (CreateReplicationSlotResult, error) {
var crsr CreateReplicationSlotResult
results, err := mrr.ReadAll()
if err != nil {
return crsr, err
}
if len(results) != 1 {
return crsr, fmt.Errorf("expected 1 result set, got %d", len(results))
}
result := results[0]
if len(result.Rows) != 1 {
return crsr, fmt.Errorf("expected 1 result row, got %d", len(result.Rows))
}
row := result.Rows[0]
if len(row) != 4 {
return crsr, fmt.Errorf("expected 4 result columns, got %d", len(row))
}
crsr.SlotName = string(row[0])
crsr.ConsistentPoint = string(row[1])
crsr.SnapshotName = string(row[2])
crsr.OutputPlugin = string(row[3])
return crsr, nil
}
type DropReplicationSlotOptions struct {
Wait bool
}
// DropReplicationSlot drops a logical replication slot.
func DropReplicationSlot(ctx context.Context, conn *pgconn.PgConn, slotName string, options DropReplicationSlotOptions) error {
var waitString string
if options.Wait {
waitString = "WAIT"
}
sql := fmt.Sprintf("DROP_REPLICATION_SLOT %s %s", slotName, waitString)
_, err := conn.Exec(ctx, sql).ReadAll()
return err
}
type StartReplicationOptions struct {
Timeline int32 // 0 means current server timeline
Mode ReplicationMode
PluginArgs []string
}
// StartReplication begins the replication process by executing the START_REPLICATION command.
func StartReplication(ctx context.Context, conn *pgconn.PgConn, slotName string, startLSN LSN, options StartReplicationOptions) error {
var timelineString string
if options.Timeline > 0 {
timelineString = fmt.Sprintf("TIMELINE %d", options.Timeline)
options.PluginArgs = append(options.PluginArgs, timelineString)
}
sql := fmt.Sprintf("START_REPLICATION SLOT %s %s %s ", slotName, options.Mode, startLSN)
if options.Mode == LogicalReplication {
if len(options.PluginArgs) > 0 {
sql += fmt.Sprintf("(%s)", strings.Join(options.PluginArgs, ", "))
}
} else {
sql += timelineString
}
conn.Frontend().SendQuery(&pgproto3.Query{String: sql})
err := conn.Frontend().Flush()
if err != nil {
return fmt.Errorf("failed to send START_REPLICATION: %w", err)
}
for {
msg, err := conn.ReceiveMessage(ctx)
if err != nil {
return fmt.Errorf("failed to receive message: %w", err)
}
switch msg := msg.(type) {
case *pgproto3.NoticeResponse:
case *pgproto3.ErrorResponse:
return pgconn.ErrorResponseToPgError(msg)
case *pgproto3.CopyBothResponse:
// This signals the start of the replication stream.
return nil
default:
return fmt.Errorf("unexpected response type: %T", msg)
}
}
}
type BaseBackupOptions struct {
// Request information required to generate a progress report, but might as such have a negative impact on the performance.
Progress bool
// Sets the label of the backup. If none is specified, a backup label of 'wal-g' will be used.
Label string
// Request a fast checkpoint.
Fast bool
// 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.
WAL bool
// 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.
NoWait bool
// Limit (throttle) the maximum amount of data transferred from server to client per unit of time (kb/s).
MaxRate int32
// Include information about symbolic links present in the directory pg_tblspc in a file named tablespace_map.
TablespaceMap bool
// Disable checksums being verified during a base backup.
// Note that NoVerifyChecksums=true is only supported since PG11
NoVerifyChecksums bool
}
func (bbo BaseBackupOptions) sql(serverVersion int) string {
var parts []string
if bbo.Label != "" {
parts = append(parts, "LABEL '"+strings.ReplaceAll(bbo.Label, "'", "''")+"'")
}
if bbo.Progress {
parts = append(parts, "PROGRESS")
}
if bbo.Fast {
if serverVersion >= 15 {
parts = append(parts, "CHECKPOINT 'fast'")
} else {
parts = append(parts, "FAST")
}
}
if bbo.WAL {
parts = append(parts, "WAL")
}
if bbo.NoWait {
if serverVersion >= 15 {
parts = append(parts, "WAIT false")
} else {
parts = append(parts, "NOWAIT")
}
}
if bbo.MaxRate >= 32 {
parts = append(parts, fmt.Sprintf("MAX_RATE %d", bbo.MaxRate))
}
if bbo.TablespaceMap {
parts = append(parts, "TABLESPACE_MAP")
}
if bbo.NoVerifyChecksums {
if serverVersion >= 15 {
parts = append(parts, "VERIFY_CHECKSUMS false")
} else if serverVersion >= 11 {
parts = append(parts, "NOVERIFY_CHECKSUMS")
}
}
if serverVersion >= 15 {
return "BASE_BACKUP(" + strings.Join(parts, ", ") + ")"
}
return "BASE_BACKUP " + strings.Join(parts, " ")
}
// BaseBackupTablespace represents a tablespace in the backup
type BaseBackupTablespace struct {
OID int32
Location string
Size int8
}
// BaseBackupResult will hold the return values of the BaseBackup command
type BaseBackupResult struct {
LSN LSN
TimelineID int32
Tablespaces []BaseBackupTablespace
}
func serverMajorVersion(conn *pgconn.PgConn) (int, error) {
verString := conn.ParameterStatus("server_version")
dot := strings.IndexByte(verString, '.')
if dot == -1 {
return 0, fmt.Errorf("bad server version string: '%s'", verString)
}
return strconv.Atoi(verString[:dot])
}
// StartBaseBackup begins the process for copying a basebackup by executing the BASE_BACKUP command.
func StartBaseBackup(ctx context.Context, conn *pgconn.PgConn, options BaseBackupOptions) (result BaseBackupResult, err error) {
serverVersion, err := serverMajorVersion(conn)
if err != nil {
return result, err
}
sql := options.sql(serverVersion)
conn.Frontend().SendQuery(&pgproto3.Query{String: sql})
err = conn.Frontend().Flush()
if err != nil {
return result, fmt.Errorf("failed to send BASE_BACKUP: %w", err)
}
// From here Postgres returns result sets, but pgconn has no infrastructure to properly capture them.
// So we capture data low level with sub functions, before we return from this function when we get to the CopyData part.
result.LSN, result.TimelineID, err = getBaseBackupInfo(ctx, conn)
if err != nil {
return result, err
}
result.Tablespaces, err = getTableSpaceInfo(ctx, conn)
return result, err
}
// getBaseBackupInfo returns the start or end position of the backup as returned by Postgres
func getBaseBackupInfo(ctx context.Context, conn *pgconn.PgConn) (start LSN, timelineID int32, err error) {
for {
msg, err := conn.ReceiveMessage(ctx)
if err != nil {
return start, timelineID, fmt.Errorf("failed to receive message: %w", err)
}
switch msg := msg.(type) {
case *pgproto3.RowDescription:
if len(msg.Fields) != 2 {
return start, timelineID, fmt.Errorf("expected 2 column headers, received: %d", len(msg.Fields))
}
colName := string(msg.Fields[0].Name)
if colName != "recptr" {
return start, timelineID, fmt.Errorf("unexpected col name for recptr col: %s", colName)
}
colName = string(msg.Fields[1].Name)
if colName != "tli" {
return start, timelineID, fmt.Errorf("unexpected col name for tli col: %s", colName)
}
case *pgproto3.DataRow:
if len(msg.Values) != 2 {
return start, timelineID, fmt.Errorf("expected 2 columns, received: %d", len(msg.Values))
}
colData := string(msg.Values[0])
start, err = ParseLSN(colData)
if err != nil {
return start, timelineID, fmt.Errorf("cannot convert result to LSN: %s", colData)
}
colData = string(msg.Values[1])
tli, err := strconv.Atoi(colData)
if err != nil {
return start, timelineID, fmt.Errorf("cannot convert timelineID to int: %s", colData)
}
timelineID = int32(tli)
case *pgproto3.NoticeResponse:
case *pgproto3.CommandComplete:
return start, timelineID, nil
case *pgproto3.ErrorResponse:
return start, timelineID, fmt.Errorf("error response sev=%q code=%q message=%q detail=%q position=%d", msg.Severity, msg.Code, msg.Message, msg.Detail, msg.Position)
default:
return start, timelineID, fmt.Errorf("unexpected response type: %T", msg)
}
}
}
// getBaseBackupInfo returns the start or end position of the backup as returned by Postgres
func getTableSpaceInfo(ctx context.Context, conn *pgconn.PgConn) (tbss []BaseBackupTablespace, err error) {
for {
msg, err := conn.ReceiveMessage(ctx)
if err != nil {
return tbss, fmt.Errorf("failed to receive message: %w", err)
}
switch msg := msg.(type) {
case *pgproto3.RowDescription:
if len(msg.Fields) != 3 {
return tbss, fmt.Errorf("expected 3 column headers, received: %d", len(msg.Fields))
}
colName := string(msg.Fields[0].Name)
if colName != "spcoid" {
return tbss, fmt.Errorf("unexpected col name for spcoid col: %s", colName)
}
colName = string(msg.Fields[1].Name)
if colName != "spclocation" {
return tbss, fmt.Errorf("unexpected col name for spclocation col: %s", colName)
}
colName = string(msg.Fields[2].Name)
if colName != "size" {
return tbss, fmt.Errorf("unexpected col name for size col: %s", colName)
}
case *pgproto3.DataRow:
if len(msg.Values) != 3 {
return tbss, fmt.Errorf("expected 3 columns, received: %d", len(msg.Values))
}
if msg.Values[0] == nil {
continue
}
tbs := BaseBackupTablespace{}
colData := string(msg.Values[0])
OID, err := strconv.Atoi(colData)
if err != nil {
return tbss, fmt.Errorf("cannot convert spcoid to int: %s", colData)
}
tbs.OID = int32(OID)
tbs.Location = string(msg.Values[1])
if msg.Values[2] != nil {
colData := string(msg.Values[2])
size, err := strconv.Atoi(colData)
if err != nil {
return tbss, fmt.Errorf("cannot convert size to int: %s", colData)
}
tbs.Size = int8(size)
}
tbss = append(tbss, tbs)
case *pgproto3.CommandComplete:
return tbss, nil
default:
return tbss, fmt.Errorf("unexpected response type: %T", msg)
}
}
}
// NextTableSpace consumes some msgs so we are at start of CopyData
func NextTableSpace(ctx context.Context, conn *pgconn.PgConn) (err error) {
for {
msg, err := conn.ReceiveMessage(ctx)
if err != nil {
return fmt.Errorf("failed to receive message: %w", err)
}
switch msg := msg.(type) {
case *pgproto3.CopyOutResponse:
return nil
case *pgproto3.CopyData:
return nil
case *pgproto3.ErrorResponse:
return pgconn.ErrorResponseToPgError(msg)
case *pgproto3.NoticeResponse:
case *pgproto3.RowDescription:
default:
return fmt.Errorf("unexpected response type: %T", msg)
}
}
}
// FinishBaseBackup wraps up a backup after copying all results from the BASE_BACKUP command.
func FinishBaseBackup(ctx context.Context, conn *pgconn.PgConn) (result BaseBackupResult, err error) {
// From here Postgres returns result sets, but pgconn has no infrastructure to properly capture them.
// So we capture data low level with sub functions, before we return from this function when we get to the CopyData part.
result.LSN, result.TimelineID, err = getBaseBackupInfo(ctx, conn)
if err != nil {
return result, err
}
// Base_Backup done, server send a command complete response from pg13
vmaj, err := serverMajorVersion(conn)
if err != nil {
return
}
var (
pack pgproto3.BackendMessage
ok bool
)
if vmaj > 12 {
pack, err = conn.ReceiveMessage(ctx)
if err != nil {
return
}
_, ok = pack.(*pgproto3.CommandComplete)
if !ok {
err = fmt.Errorf("expect command_complete, got %T", pack)
return
}
}
// simple query done, server send a ready for query response
pack, err = conn.ReceiveMessage(ctx)
if err != nil {
return
}
_, ok = pack.(*pgproto3.ReadyForQuery)
if !ok {
err = fmt.Errorf("expect ready_for_query, got %T", pack)
return
}
return
}
type PrimaryKeepaliveMessage struct {
ServerWALEnd LSN
ServerTime time.Time
ReplyRequested bool
}
// ParsePrimaryKeepaliveMessage parses a Primary keepalive message from the server.
func ParsePrimaryKeepaliveMessage(buf []byte) (PrimaryKeepaliveMessage, error) {
var pkm PrimaryKeepaliveMessage
if len(buf) != 17 {
return pkm, fmt.Errorf("PrimaryKeepaliveMessage must be 17 bytes, got %d", len(buf))
}
pkm.ServerWALEnd = LSN(binary.BigEndian.Uint64(buf))
pkm.ServerTime = pgTimeToTime(int64(binary.BigEndian.Uint64(buf[8:])))
pkm.ReplyRequested = buf[16] != 0
return pkm, nil
}
type XLogData struct {
WALStart LSN
ServerWALEnd LSN
ServerTime time.Time
WALData []byte
}
// ParseXLogData parses a XLogData message from the server.
func ParseXLogData(buf []byte) (XLogData, error) {
var xld XLogData
if len(buf) < 24 {
return xld, fmt.Errorf("XLogData must be at least 24 bytes, got %d", len(buf))
}
xld.WALStart = LSN(binary.BigEndian.Uint64(buf))
xld.ServerWALEnd = LSN(binary.BigEndian.Uint64(buf[8:]))
xld.ServerTime = pgTimeToTime(int64(binary.BigEndian.Uint64(buf[16:])))
xld.WALData = buf[24:]
return xld, nil
}
// StandbyStatusUpdate is a message sent from the client that acknowledges receipt of WAL records.
type StandbyStatusUpdate struct {
WALWritePosition LSN // The WAL position that's been locally written
WALFlushPosition LSN // The WAL position that's been locally flushed
WALApplyPosition LSN // The WAL position that's been locally applied
ClientTime time.Time // Client system clock time
ReplyRequested bool // Request server to reply immediately.
}
// SendStandbyStatusUpdate sends a StandbyStatusUpdate to the PostgreSQL server.
//
// The only required field in ssu is WALWritePosition. If WALFlushPosition is 0 then WALWritePosition will be assigned
// to it. If WALApplyPosition is 0 then WALWritePosition will be assigned to it. If ClientTime is the zero value then
// the current time will be assigned to it.
func SendStandbyStatusUpdate(_ context.Context, conn *pgconn.PgConn, ssu StandbyStatusUpdate) error {
if ssu.WALFlushPosition == 0 {
ssu.WALFlushPosition = ssu.WALWritePosition
}
if ssu.WALApplyPosition == 0 {
ssu.WALApplyPosition = ssu.WALWritePosition
}
if ssu.ClientTime == (time.Time{}) {
ssu.ClientTime = time.Now()
}
data := make([]byte, 0, 34)
data = append(data, StandbyStatusUpdateByteID)
data = pgio.AppendUint64(data, uint64(ssu.WALWritePosition))
data = pgio.AppendUint64(data, uint64(ssu.WALFlushPosition))
data = pgio.AppendUint64(data, uint64(ssu.WALApplyPosition))
data = pgio.AppendInt64(data, timeToPgTime(ssu.ClientTime))
if ssu.ReplyRequested {
data = append(data, 1)
} else {
data = append(data, 0)
}
cd := &pgproto3.CopyData{Data: data}
buf, err := cd.Encode(nil)
if err != nil {
return err
}
return conn.Frontend().SendUnbufferedEncodedCopyData(buf)
}
// CopyDoneResult is the parsed result as returned by the server after the client
// sends a CopyDone to the server to confirm ending the copy-both mode.
type CopyDoneResult struct {
Timeline int32
LSN LSN
}
// SendStandbyCopyDone sends a StandbyCopyDone to the PostgreSQL server
// to confirm ending the copy-both mode.
func SendStandbyCopyDone(_ context.Context, conn *pgconn.PgConn) (cdr *CopyDoneResult, err error) {
// I am suspicious that this is wildly wrong, but I'm pretty sure the previous
// code was wildly wrong too -- wttw <[email protected]>
conn.Frontend().Send(&pgproto3.CopyDone{})
err = conn.Frontend().Flush()
if err != nil {
return
}
for {
var msg pgproto3.BackendMessage
msg, err = conn.Frontend().Receive()
if err != nil {
return cdr, err
}
switch m := msg.(type) {
case *pgproto3.CopyDone:
case *pgproto3.ParameterStatus, *pgproto3.NoticeResponse:
case *pgproto3.CommandComplete:
case *pgproto3.RowDescription:
case *pgproto3.DataRow:
// We are expecting just one row returned, with two columns timeline and LSN
// We should pay attention to RowDescription, but we'll take it on trust.
if len(m.Values) == 2 {
timeline, lerr := strconv.Atoi(string(m.Values[0]))
if lerr == nil {
lsn, lerr := ParseLSN(string(m.Values[1]))
if lerr == nil {
cdr.Timeline = int32(timeline)
cdr.LSN = lsn
}
}
}
case *pgproto3.EmptyQueryResponse:
case *pgproto3.ErrorResponse:
return cdr, pgconn.ErrorResponseToPgError(m)
case *pgproto3.ReadyForQuery:
// Should we eat the ReadyForQuery here, or not?
return cdr, err
}
}
}
const microsecFromUnixEpochToY2K = 946684800 * 1000000
func pgTimeToTime(microsecSinceY2K int64) time.Time {
microsecSinceUnixEpoch := microsecFromUnixEpochToY2K + microsecSinceY2K
return time.Unix(0, microsecSinceUnixEpoch*1000)
}
func timeToPgTime(t time.Time) int64 {
microsecSinceUnixEpoch := t.Unix()*1000000 + int64(t.Nanosecond())/1000
return microsecSinceUnixEpoch - microsecFromUnixEpochToY2K
}