tarantool / tarantool / 28806648384

88%

Build Type

push

github

Committed by sergepetrenko

Commit Message

box: introduce recovery point API

Closes #11729

@TarantoolBot document
Title: Document recovery point API
Product: Tarantool
Since: 3.8

`box.backup.recovery_point.create()` is introduced to create
recovery point. Recovery point is point in xlog to which one can
truncate it to produce committed state at the time of point creation. The
recovery point has `replica_id`, `lsn` pair which unambiguously specify
a statement in xlog. The statement itself should be included on
truncation.

The result is table:

```
tarantool> box.backup.recovery_point.create()
---
- lsn: 46
  timestamp: 1782208661.7946
  replica_id: 1
...
```

Result fields are:
- `timestamp` - Unix-time of recovery point in seconds. It is less than
  or equal to commit time of recovery point entry and larger than or
equal to time of recovery point creation API call.
- `replica_id` - replica_id of recovery point statement in xlog.
- `lsn` - lsn of recovery point statement in xlog.

Create can also take a label as options parameter:

```
tarantool> box.backup.recovery_point.create({label = 'label-1'})
- lsn: 46
  timestamp: 1782208661.7946
  replica_id: 1
  label: label-1
```

Recovery points are persistent and replicated.

New `box.backup.info().recovery_points` field shows all created recovery
points that resides in xlogs of backup in progress.

```
tarantool> box.backup.recovery_point.create()
tarantool> box.backup.recovery_point.create({label = 'label-1'})
tarantool> box.backup.start()
tarantool> box.backup.info().recovery_points
---
- - lsn: 1
    timestamp: 1782208906.2023
    replica_id: 1
  - lsn: 3
    timestamp: 1782208908.4776
    replica_id: 1
    label: label-1
...
```

Coverage Stats

71027 of 119288 branches covered (59.54%)

96 of 108 new or added lines in 2 files covered. (88.89%)

268 existing lines in 12 files now uncovered.

106591 of 121475 relevant lines covered (87.75%)

1387667.42 hits per line