TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

ticloud branch describe

Get information about a branch (such as the endpoints, user name prefix, and usages):

ticloud branch describe [flags]

Or use the following alias command:

ticloud branch get [flags]

Examples

Get the branch information in interactive mode:

ticloud branch describe

Get the branch information in non-interactive mode:

ticloud branch describe --branch-id <branch-id> --cluster-id <cluster-id>

Flags

In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.

FlagDescriptionRequiredNote
-b, --branch-id stringThe ID of the branchYesOnly works in non-interactive mode.
-h, --helpHelp information for this commandNoWorks in both non-interactive and interactive modes.
-c, --cluster-id stringThe cluster ID of the branchYesOnly works in non-interactive mode.

Inherited flags

FlagDescriptionRequiredNote
--no-colorDisables color in output.NoOnly works in non-interactive mode. In interactive mode, disabling color might not work with some UI components.
-P, --profile stringSpecifies the active user profile used in this command.NoWorks in both non-interactive and interactive modes.

Feedback

If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.