ti db update-db-cluster

Updates the display name or monthly spending limit of a TiDB Cloud Starter instance. At least one of --db-cluster-name or --monthly-spending-limit-usd-cents is required. This command only accepts Starter instances.

Syntax

ti db update-db-cluster
  --db-cluster-id <string>
  [--db-cluster-name <string>]
  [--dry-run]
  [--help]
  [--monthly-spending-limit-usd-cents <int32>]
  [--version]

Options

• --db-cluster-id <string>: Starter DB cluster ID. [required]
• --db-cluster-name <string>: New Starter DB cluster display name.
• --dry-run: Validate the request without applying changes.
• --help: Display help information.
• --monthly-spending-limit-usd-cents <int32>: Monthly spending limit in USD cents; omit to leave unchanged.
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• Rename a cluster:

  # Change the TiDB Cloud Starter instance display name without recreating it.
  ti db update-db-cluster --db-cluster-id "<cluster-id>" --db-cluster-name app-db-v2
  

• Preview a spending-limit update:

  # Validate a new monthly limit without applying the change.
  ti db update-db-cluster --db-cluster-id "<cluster-id>" --monthly-spending-limit-usd-cents 1000 --dry-run
  

Related documentation

• TiDB Cloud Starter CLI Command Reference