Documents
checkpoint
checkpoint
Type
External
Status
Published
Created
Mar 11, 2026
Updated
Mar 25, 2026
Updated by
Dosu Bot
Source
View

import { Code } from '@astrojs/starlight/components';
import createCheckpoint from '/../examples/src/create_checkpoint.rs?raw';
import refreshCheckpoint from '/../examples/src/refresh_checkpoint.rs?raw';
import deleteCheckpoint from '/../examples/src/delete_checkpoint.rs?raw';

Creating a Checkpoint#

To create a checkpoint, use the create_checkpoint function provided by SlateDB.
This operation captures a consistent and durable view of the database state, anchored to a specific manifest version.

Refreshing a Checkpoint#

To extend the lifetime of an existing checkpoint, use Admin::refresh_checkpoint.
This updates the checkpoint’s expiration time, ensuring that the referenced SSTs remain protected from garbage collection for the specified duration.

Deleting a Checkpoint#

To remove a checkpoint, use Admin::delete_checkpoint.
This deletes the checkpoint metadata from the manifest, allowing the garbage collector to eventually reclaim any unreferenced SST files associated with that checkpoint.