Document recovery point API

Open Beginner friendly

#5,697 opened on Jul 6, 2026 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 2/5
Estimated time: 1-2 days
Newbie friendliness: 68/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Quiet
Tech stack: lua
Domain: documentation

Research direction

Start by finding the existing documentation for box.backup and its info() API, then add the box.backup.recovery_point.create() entry point and the recovery_points field. Document the result fields, optional label, persistence and replication behavior, and the backup-in-progress example shown in the issue.

Written by the indexing model from the issue text.

Description

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
...

Requested by @nshy in https://github.com/tarantool/tarantool/commit/73b2b4bff1629c21288258536b5607b02a680994.

Dominant language: CSS
Stars: 15
Forks: 49
Avg merge: 1d 13h
Merged PRs (30d): 3

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

Document that a SQLite trail allows only one writer Open

documentation help wanted

Difficulty 2/5 1-3 hours Newbie friendliness 90/100

rajfirke/provena#202 · Opened Sep 22, 2026
Gateway 3.16 Linux install: GPG key URL 404s (public_keys has no "316" entry, falls back to legacy key) Open

user-reported

Difficulty 2/5 1-3 hours Newbie friendliness 85/100

Kong/developer.konghq.com#7316 · Opened Sep 22, 2026
custom-resources teaches static verbs without the authorization obligation Open

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

HarperFast/skills#96 · Opened Sep 22, 2026
Client support matrix inclusion Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 68/100

modelcontextprotocol/ext-tasks#22 · Opened Sep 22, 2026
Document Hot Rod migration version compatibility for Data Grid 8.6 Open

Difficulty 2/5 1-3 hours Newbie friendliness 82/100

infinispan/infinispan#18150 · Opened Sep 21, 2026