ti fs create-layer-checkpoint

Creates a checkpoint in one layer. If --checkpoint-id is omitted, the service generates one.

Syntax

ti fs create-layer-checkpoint
  --layer-id <string>
  [--checkpoint-id <string>]
  [--dry-run]
  [--file-system-id <string>]
  [--fs-token <string>]
  [--help]
  [--label <string>]
  [--version]

Options

• --layer-id <string>: The layer ID identifying the layer. [required]
• --checkpoint-id <string>: Checkpoint ID. Normally it is generated by the service automatically.
• --dry-run: Validate the request without applying changes.
• --file-system-id <string>: Select the file system. You can also set TI_FS_FILE_SYSTEM_ID.
• --fs-token <string>: Set the file system user token. If omitted, uses TI_FS_TOKEN.
• --help: Display help information.
• --label <string>: The checkpoint label.
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• Create a named checkpoint:

  # Record the current layer state under a stable checkpoint ID.
  ti fs create-layer-checkpoint --file-system-id <file-system-id> --layer-id "<layer-id>" --checkpoint-id before-review
  

• Create an automatically identified checkpoint:

  # Let the service assign the checkpoint ID while retaining a human label.
  ti fs create-layer-checkpoint --file-system-id <file-system-id> --layer-id "<layer-id>" --label "before review"
  

Related documentation

• TiDB Cloud Filesystem CLI Command Reference