From 6e08719f3c79c114da5838586b32b7b0f6bcf8b2 Mon Sep 17 00:00:00 2001 From: Docsite Preview Bot <> Date: Thu, 11 Apr 2024 09:27:39 +0000 Subject: [PATCH] Preview PR https://github.com/pingcap/docs/pull/17056 and this preview is triggered from commit https://github.com/pingcap/docs/pull/17056/commits/0a409b2f54df28bda816f372fc639d48807474c9 --- .../master/tidb-cloud/cli-reference.md | 6 +- .../tidbcloud/master/tidb-cloud/ticloud-ai.md | 10 +- .../master/tidb-cloud/ticloud-auth-login.md | 18 +-- .../master/tidb-cloud/ticloud-auth-logout.md | 10 +- .../tidb-cloud/ticloud-branch-create.md | 14 +- .../tidb-cloud/ticloud-branch-delete.md | 18 +-- .../tidb-cloud/ticloud-branch-describe.md | 12 +- .../master/tidb-cloud/ticloud-branch-list.md | 16 +- .../master/tidb-cloud/ticloud-branch-shell.md | 23 +-- .../tidb-cloud/ticloud-cluster-create.md | 18 +-- .../tidb-cloud/ticloud-cluster-delete.md | 16 +- .../tidb-cloud/ticloud-cluster-describe.md | 12 +- .../master/tidb-cloud/ticloud-cluster-list.md | 16 +- .../tidb-cloud/ticloud-config-create.md | 10 +- .../tidb-cloud/ticloud-config-delete.md | 6 +- .../tidb-cloud/ticloud-config-describe.md | 4 +- .../master/tidb-cloud/ticloud-config-edit.md | 4 +- .../master/tidb-cloud/ticloud-config-list.md | 4 +- .../master/tidb-cloud/ticloud-config-set.md | 10 +- .../master/tidb-cloud/ticloud-config-use.md | 4 +- .../tidb-cloud/ticloud-import-cancel.md | 12 +- .../tidb-cloud/ticloud-import-describe.md | 10 +- .../master/tidb-cloud/ticloud-import-list.md | 10 +- .../tidb-cloud/ticloud-import-start-local.md | 4 +- .../tidb-cloud/ticloud-import-start-mysql.md | 22 +-- .../tidb-cloud/ticloud-import-start-s3.md | 14 +- .../master/tidb-cloud/ticloud-project-list.md | 6 +- .../ticloud-serverless-export-cancel.md | 18 +-- .../ticloud-serverless-export-create.md | 36 ++--- .../ticloud-serverless-export-describe.md | 14 +- .../ticloud-serverless-export-download.md | 18 +-- .../ticloud-serverless-export-list.md | 18 +-- .../tidb-cloud/ticloud-serverless-regions.md | 14 +- .../tidb-cloud/ticloud-serverless-shell.md | 20 +-- .../ticloud-serverless-spending-limit.md | 18 +-- .../tidb-cloud/ticloud-serverless-update.md | 20 +-- .../master/tidb-cloud/ticloud-update.md | 4 +- .../tidb-cloud-import-local-files.md | 137 ++++++++++++++++++ 38 files changed, 382 insertions(+), 244 deletions(-) create mode 100644 markdown-pages/en/tidbcloud/master/tidb-cloud/tidb-cloud-import-local-files.md diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/cli-reference.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/cli-reference.md index a577303a..3b4299f1 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/cli-reference.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/cli-reference.md @@ -19,11 +19,11 @@ To use the `ticloud` CLI in your terminal, run `ticloud [command] [subcommand]`. | Command | Subcommand | Description | |--------------------|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| auth | login, logout | Login and logout | | serverless | create, delete, describe, list, update, spending-limit, regions, shell | Manage TiDB Serverless clusters | | serverless branch | create, delete, describe, list, shell | Manage TiDB Serverless branches | -| serverless export | create, describe, list, cancel, download | Manage TiDB Serverless export jobs | -| serverless import | cancel, describe, list, start | Manage [import](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud) tasks | -| auth | login, logout | Login and logout | +| serverless import | cancel, describe, list, start | Manage TiDB Serverless [import](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud) tasks | +| serverless export | create, describe, list, cancel, download | Manage TiDB Serverless export tasks | | ai | - | Chat with TiDB Bot | | completion | bash, fish, powershell, zsh | Generate completion script for specified shell | | config | create, delete, describe, edit, list, set, use | Configure user profiles | diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-ai.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-ai.md index 469ead3d..8b104396 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-ai.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-ai.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud ai`. # ticloud ai -Chat with TiDB Bot +Chat with TiDB Bot: ```shell ticloud ai [flags] @@ -31,16 +31,16 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |--------------------|-----------------------------------|----------|------------------------------------------------------| -| -q, --query string | The query to chat with TiDB Bot | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -q, --query string | Specifies your query to TiDB Bot. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-login.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-login.md index 5c590a44..a27ebdb9 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-login.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-login.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud auth login`. # ticloud auth login -Authenticate with the TiDB Cloud: +Authenticate with TiDB Cloud CLI: ```shell ticloud auth login [flags] @@ -13,16 +13,16 @@ ticloud auth login [flags] ## Examples -To start the login for your account: +To log into TiDB Cloud CLI: ```shell -ticloud auht login +ticloud auth login ``` -Login with insecure storage: +To log into TiDB Cloud CLI with insecure storage: ```shell -ticloud auht login --insecure-storage +ticloud auth login --insecure-storage ``` ## Flags @@ -31,16 +31,16 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |--------------------|---------------------------------------------------------------------------|----------|------------------------------------------------------| -| --insecure-storage | Save authentication credentials in plain text instead of credential store | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| --insecure-storage | Saves authentication credentials in plain text instead of credential store. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-logout.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-logout.md index b5179272..cfec2059 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-logout.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-auth-logout.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud auth logout`. # ticloud auth logout -Log out of the CLI: +Log out of TiDB Cloud CLI: ```shell ticloud auth logout [flags] @@ -13,10 +13,10 @@ ticloud auth logout [flags] ## Examples -To log out of the TiDB Cloud: +To log out of TiDB Cloud CLI: ```shell -ticloud auht logout +ticloud auth logout ``` ## Inherited flags @@ -24,8 +24,8 @@ ticloud auht logout | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-create.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-create.md index 8f6ec1aa..c2f97c8b 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-create.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch create`. # ticloud serverless branch create -Create a branch for a serverless cluster: +Create a [branch](/tidb-cloud/branch-overview.md) for a TiDB Serverless cluster: ```shell ticloud serverless branch create [flags] @@ -13,13 +13,13 @@ ticloud serverless branch create [flags] ## Examples -Create a serverless branch in interactive mode: +Create a branch for a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless branch create ``` -Create a serverless branch in non-interactive mode: +Create a branch for a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless branch create --cluster-id --display-name @@ -31,9 +31,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |---------------------------|------------------------------------------------------------|----------|-----------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster, in which the branch will be created | Yes | Only works in non-interactive mode. | -| -n, --display-name string | The display name of the branch to be created | Yes | Only works in non-interactive mode. | -| -h, --help | Get help information for this command | No | Works in both non-interactive and interactive modes | +| -c, --cluster-id string | Specifies the ID of the cluster, in which the branch will be created. | Yes | Only works in non-interactive mode. | +| -n, --display-name string | Specifies the name of the branch to be created. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes | ## Inherited flags @@ -41,7 +41,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-delete.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-delete.md index 71c87185..51f5d5e2 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-delete.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch delete`. # ticloud serverless branch delete -Delete a branch from your serverless cluster: +Delete a branch from your TiDB Serverless cluster: ```shell ticloud serverless branch delete [flags] @@ -19,13 +19,13 @@ ticloud serverless branch rm [flags] ## Examples -Delete a serverless branch in interactive mode: +Delete a TiDB Serverless branch in interactive mode: ```shell ticloud serverless branch delete ``` -Delete a serverless branch in non-interactive mode: +Delete a TiDB Serverless branch in non-interactive mode: ```shell ticloud branch delete --branch-id --cluster-id @@ -37,18 +37,18 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|--------------------------------------------|----------|------------------------------------------------------| -| -b, --branch-id string | The ID of the branch to be deleted | Yes | Only works in non-interactive mode. | -| --force | Deletes a branch without confirmation | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| -c, --cluster-id string | The cluster ID of the branch to be deleted | Yes | Only works in non-interactive mode. | +| -b, --branch-id string | Specifies the ID of the branch to be deleted. | Yes | Only works in non-interactive mode. | +| --force | Deletes a branch without confirmation. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-describe.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-describe.md index 8c0b7f44..f11a21fd 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-describe.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-describe.md @@ -19,13 +19,13 @@ ticloud serverless branch get [flags] ## Examples -Get the serverless branch information in interactive mode: +Get branch information of a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless branch describe ``` -Get the serverless branch information in non-interactive mode: +Get branch information of a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless branch describe --branch-id --cluster-id @@ -37,9 +37,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|-----------------------------------|----------|------------------------------------------------------| -| -b, --branch-id string | The ID of the branch | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| -c, --cluster-id string | The cluster ID of the branch | Yes | Only works in non-interactive mode. | +| -b, --branch-id string | Specifies the ID of the branch. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | ## Inherited flags @@ -47,7 +47,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-list.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-list.md index d2a2bc39..49285d1e 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-list.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch list`. # ticloud serverless branch list -List all branches for a serverless cluster: +List all branches for a TiDB Serverless cluster: ```shell ticloud serverless branch list [flags] @@ -19,19 +19,19 @@ ticloud serverless branch ls [flags] ## Examples -List all branches for a serverless cluster in interactive mode: +List all branches for a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless branch list ``` -List all branches for a specified serverless cluster in non-interactive mode: +List all branches for a specific TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless branch list -c ``` -List all branches for a specified serverless cluster in the JSON format: +List all branches for a specific TiDB Serverless cluster in the JSON format: ```shell ticloud serverless branch list -o json @@ -43,9 +43,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|--------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| -o, --output string | Output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| -o, --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -53,7 +53,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-shell.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-shell.md index 3be649d7..50c8d637 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-shell.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-branch-shell.md @@ -1,11 +1,12 @@ --- title: ticloud serverless branch shell summary: The reference of `ticloud serverless branch shell`. +aliases: ['/tidbcloud/ticloud-connect'] --- # ticloud serverless branch shell -Connect to a serverless branch +Connect to a branch of a TiDB Serverless cluster: ```shell ticloud serverless branch shell [flags] @@ -13,25 +14,25 @@ ticloud serverless branch shell [flags] ## Examples -Connect to a serverless branch in interactive mode: +Connect to a TiDB Serverless branch in interactive mode: ```shell ticloud serverless branch shell ``` -Connect to a serverless branch with default user in non-interactive mode: +Connect to a TiDB Serverless branch with the default user in non-interactive mode: ```shell ticloud serverless branch shell -c -b ``` -Connect to a serverless branch with default user and password in non-interactive mode: +Connect to a TiDB Serverless branch with the default user and password in non-interactive mode: ```shell ticloud serverless branch shell -c -b --password ``` -Connect to a serverless branch with specific user and password in non-interactive mode: +Connect to a TiDB Serverless branch with a specific user and password in non-interactive mode: ```shell ticloud serverless branch shell -c -b -u --password @@ -43,11 +44,11 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|-----------------------------------|----------|------------------------------------------------------| -| -b, --branch-id string | Branch ID | Yes | Only works in non-interactive mode. | -| -c, --cluster-id string | Cluster ID | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| --password | The password of the user | No | Only works in non-interactive mode. | -| -u, --user string | A specific user for login | No | Only works in non-interactive mode. | +| -b, --branch-id string | Specifies the ID of the branch. | Yes | Only works in non-interactive mode. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| --password | Specifies the password of the user. | No | Only works in non-interactive mode. | +| -u, --user string | Specifies the user for login. | No | Only works in non-interactive mode. | ## Inherited flags @@ -55,7 +56,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-create.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-create.md index a32a40ac..571c92c7 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-create.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless create`. # ticloud serverless create -Create a serverless cluster: +Create a TiDB Serverless cluster: ```shell ticloud serverless create [flags] @@ -13,13 +13,13 @@ ticloud serverless create [flags] ## Examples -Create a serverless cluster in interactive mode: +Create a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless create ``` -Create a serverless cluster in non-interactive mode: +Create a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless create --project-id --display-name --region @@ -31,11 +31,11 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |------------------------------|--------------------------------------------------------------------------------------------|-----------|-----------------------------------------------------| -| -n --display-name string | DisplayName of the cluster to be created | Yes | Only works in non-interactive mode. | -| --spending-limit-monthly int | Maximum monthly spending limit in USD cents | No | Only works in non-interactive mode. | -| -p, --project-id string | The ID of the project, in which the cluster will be created (default is "default project") | No | Only works in non-interactive mode. | -| -r, --region string | Cloud region | Yes | Only works in non-interactive mode. | -| -h, --help | Get help information for this command | No | Works in both non-interactive and interactive modes | +| -n --display-name string | Specifies the name of the cluster to be created. | Yes | Only works in non-interactive mode. | +| --spending-limit-monthly int | Specifies the maximum monthly spending limit in USD cents. | No | Only works in non-interactive mode. | +| -p, --project-id string | Specifies the ID of the project, in which the cluster will be created. The default value is `default project`. | No | Only works in non-interactive mode. | +| -r, --region string | Specifies the Cloud region. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes | ## Inherited flags @@ -43,7 +43,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-delete.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-delete.md index cc852a54..9bda957d 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-delete.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless delete`. # ticloud serverless delete -Delete a serverless cluster from your project: +Delete a TiDB Serverless cluster from your project: ```shell ticloud serverless delete [flags] @@ -19,13 +19,13 @@ ticloud serverless rm [flags] ## Examples -Delete a serverless cluster in interactive mode: +Delete a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless delete ``` -Delete a serverless cluster in non-interactive mode: +Delete a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless delete --cluster-id @@ -37,17 +37,17 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|----------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster to be deleted | Yes | Only works in non-interactive mode. | -| --force | Deletes a cluster without confirmation | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster to be deleted. | Yes | Only works in non-interactive mode. | +| --force | Deletes a cluster without confirmation. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-describe.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-describe.md index 89701471..622a2c64 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-describe.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless describe`. # ticloud serverless describe -Get information about a serverless cluster (such as the cluster configurations, and cluster status): +Get information about a TiDB Serverless cluster (such as the cluster configurations and cluster status): ```shell ticloud serverless describe [flags] @@ -19,13 +19,13 @@ ticloud serverless get [flags] ## Examples -Get the serverless cluster information in interactive mode: +Get information about a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless describe ``` -Get the serverless cluster information in non-interactive mode: +Get information about a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless describe --cluster-id @@ -37,8 +37,8 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|-----------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -46,7 +46,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-list.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-list.md index 9ec5f911..2fc466e8 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-list.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-cluster-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless list`. # ticloud serverless list -List all serverless clusters in a project: +List all TiDB Serverless clusters in a project: ```shell ticloud serverless list [flags] @@ -19,19 +19,19 @@ ticloud serverless ls [flags] ## Examples -List all serverless clusters in interactive mode: +List all TiDB Serverless clusters in interactive mode: ```shell ticloud serverless list ``` -List all serverless clusters in a specified project in non-interactive mode: +List all TiDB Serverless clusters in a specified project in non-interactive mode: ```shell ticloud serverless list -p ``` -List all clusters in a specified project with the JSON format in non-interactive mode: +List all TiDB Serverless clusters in a specified project with the JSON format in non-interactive mode: ```shell ticloud serverless list -p -o json @@ -43,9 +43,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|--------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -p, --project-id string | The ID of the project, in which the cluster will be created | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| -o, --output string | Output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | +| -p, --project-id string | Specifies the ID of the project. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| -o, --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -53,7 +53,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-create.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-create.md index 5675a2f4..74d7a647 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-create.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-create.md @@ -35,10 +35,10 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-----------------------|-----------------------------------------------|----------|-----------------------------------| -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| --private-key string | The private key of the TiDB Cloud API | Yes | Only works in non-interactive mode. | -| --profile-name string | The name of the profile, which must not contain `.` | Yes | Only works in non-interactive mode. | -| --public-key string | The public key of the TiDB Cloud API | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| --private-key string | Specifies the private key of the TiDB Cloud API. | Yes | Only works in non-interactive mode. | +| --profile-name string | Specifies the name of the profile (which must not contain `.`). | Yes | Only works in non-interactive mode. | +| --public-key string | Specifies the public key of the TiDB Cloud API. | Yes | Only works in non-interactive mode. | ## Inherited flags @@ -46,7 +46,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|----------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-delete.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-delete.md index 4d82e41f..e9e35fb5 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-delete.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-delete.md @@ -29,8 +29,8 @@ ticloud config delete | Flag | Description | |------------|---------------------------------------| -| --force | Deletes a profile without confirmation | -| -h, --help | Help information for this command | +| --force | Deletes a profile without confirmation. | +| -h, --help | Shows help information for this command. | ## Inherited flags @@ -38,7 +38,7 @@ ticloud config delete |----------------------|-----------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-describe.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-describe.md index 4c6c3520..802421ce 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-describe.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-describe.md @@ -29,7 +29,7 @@ ticloud config describe | Flag | Description | |------------|--------------------------| -| -h, --help | Help information for this command | +| -h, --help | Shows help information for this command. | ## Inherited flags @@ -37,7 +37,7 @@ ticloud config describe |----------------------|-----------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-edit.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-edit.md index a8c9de2d..83389b8c 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-edit.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-edit.md @@ -29,7 +29,7 @@ ticloud config edit | Flag | Description | |------------|--------------------------| - | -h, --help | Help information for this command | + | -h, --help | Shows help information for this command. | ## Inherited flags @@ -37,7 +37,7 @@ ticloud config edit |----------------------|-------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-list.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-list.md index f194f8f8..549005ed 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-list.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-list.md @@ -29,7 +29,7 @@ ticloud config list | Flag | Description | |------------|--------------------------| -| -h, --help | Help information for this command | +| -h, --help | Shows help information for this command. | ## Inherited flags @@ -37,7 +37,7 @@ ticloud config list |----------------------|-----------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-set.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-set.md index fe29920c..a21d5383 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-set.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-set.md @@ -15,9 +15,9 @@ The properties that can be configured include `public-key`, `private-key`, and ` | Properties | Description | Required | |-------------|--------------------------------------------------------------------|----------| -| public-key | The public key of the TiDB Cloud API | Yes | -| private-key | The private key of the TiDB Cloud API | Yes | -| api-url | The base API URL of TiDB Cloud (`https://api.tidbcloud.com` by default) | No | +| public-key | Specifies the public key of the TiDB Cloud API. | Yes | +| private-key | Specifies the private key of the TiDB Cloud API. | Yes | +| api-url | Specifies the base API URL of TiDB Cloud (`https://api.tidbcloud.com` by default). | No | > **Notes:** > @@ -51,7 +51,7 @@ ticloud config set api-url https://api.tidbcloud.com | Flag | Description | |------------|--------------------------| -| -h, --help | Help information for this command | +| -h, --help | Shows help information for this command. | ## Inherited flags @@ -59,7 +59,7 @@ ticloud config set api-url https://api.tidbcloud.com |----------------------|-----------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-use.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-use.md index 120e9a10..197735ab 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-use.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-config-use.md @@ -23,7 +23,7 @@ ticloud config use test | Flag | Description | |------------|--------------------------| -| -h, --help | Help information for this command | +| -h, --help | Shows help information for this command. | ## Inherited flags @@ -31,7 +31,7 @@ ticloud config use test |----------------------|-----------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-cancel.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-cancel.md index 73a496ab..df2c2bf8 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-cancel.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-cancel.md @@ -31,11 +31,11 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|----------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | Cluster ID | Yes | Only works in non-interactive mode. | -| --force | Deletes a profile without confirmation | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| --import-id string | The ID of the import task | Yes | Only works in non-interactive mode. | -| -p, --project-id string | Project ID | Yes | Only works in non-interactive mode. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| --force | Deletes a profile without confirmation. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| --import-id string | Specifies the ID of the import task. | Yes | Only works in non-interactive mode. | +| -p, --project-id string | Specifies the ID of the project. | Yes | Only works in non-interactive mode. | ## Inherited flags @@ -43,7 +43,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|-------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-describe.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-describe.md index 15be0a96..1e6de71d 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-describe.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-describe.md @@ -37,10 +37,10 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|-----------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | Cluster ID | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| --import-id string | The ID of the import task | Yes | Only works in non-interactive mode. | -| -p, --project-id string | Project ID | Yes | Only works in non-interactive mode. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| --import-id string | Specifies the ID of the import task. | Yes | Only works in non-interactive mode. | +| -p, --project-id string | Specifies the ID of the project. | Yes | Only works in non-interactive mode. | ## Inherited flags @@ -48,7 +48,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-list.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-list.md index bf1997b0..3fc5ca08 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-list.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-list.md @@ -43,10 +43,10 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|--------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | Cluster ID | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| -o, --output string | Output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | -| -p, --project-id string | Project ID | Yes | Only works in non-interactive mode. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| -o, --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | +| -p, --project-id string | Specifies the ID of the project. | Yes | Only works in non-interactive mode. | ## Inherited flags @@ -54,7 +54,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-local.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-local.md index c9c9c710..e4db9a5f 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-local.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-local.md @@ -45,7 +45,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter | -c, --cluster-id string | Specifies the cluster ID. | Yes | Only works in non-interactive mode. | | --data-format string | Specifies the data format. Currently, only `CSV` is supported. | Yes | Only works in non-interactive mode. | | --delimiter string | Specifies the delimiter used for quoting for CSV files. The default value is `"`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | -| -h, --help | Displays help information for this command. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | -p, --project-id string | Specifies the project ID. | Yes | Only works in non-interactive mode. | | --separator string | Specifies the field separator for CSV files. The default value is `,`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | | --target-database string | Specifies the target database to import data to. | Yes | Only works in non-interactive mode. | @@ -58,7 +58,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-mysql.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-mysql.md index 0de75420..6a6a3000 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-mysql.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-mysql.md @@ -54,18 +54,18 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |--------------------------|------------------------------------------------------------------------------|----------|------------------------------------------------------| | -c, --cluster-id string | Specifies the cluster ID. | Yes | Only works in non-interactive mode. | -| -h, --help | Displays help information for this command. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | -p, --project-id string | Specifies the project ID. | Yes | Only works in non-interactive mode. | | --skip-create-table | Skips creating the target table if it already exists in the target database. | No | Only works in non-interactive mode. | -| --source-database string | The name of the source MySQL database. | Yes | Only works in non-interactive mode. | -| --source-host string | The host of the source MySQL instance. | Yes | Only works in non-interactive mode. | -| --source-password string | The password for the source MySQL instance. | Yes | Only works in non-interactive mode. | -| --source-port int | The port of the source MySQL instance. | Yes | Only works in non-interactive mode. | -| --source-table string | The source table name in the source MySQL database. | Yes | Only works in non-interactive mode. | -| --source-user string | The user to log in to the source MySQL instance. | Yes | Only works in non-interactive mode. | -| --target-database string | The target database name in the TiDB Serverless cluster. | Yes | Only works in non-interactive mode. | -| --target-password string | The password for the target TiDB Serverless cluster. | Yes | Only works in non-interactive mode. | -| --target-user string | The user to log in to the target TiDB Serverless cluster. | No | Only works in non-interactive mode. | +| --source-database string | Specifies the name of the source MySQL database. | Yes | Only works in non-interactive mode. | +| --source-host string | Specifies the host of the source MySQL instance. | Yes | Only works in non-interactive mode. | +| --source-password string | Specifies the password for the source MySQL instance. | Yes | Only works in non-interactive mode. | +| --source-port int | Specifies the port of the source MySQL instance. | Yes | Only works in non-interactive mode. | +| --source-table string | Specifies the source table name in the source MySQL database. | Yes | Only works in non-interactive mode. | +| --source-user string | Specifies the user to log in to the source MySQL instance. | Yes | Only works in non-interactive mode. | +| --target-database string | Specifies the target database name in the TiDB Serverless cluster. | Yes | Only works in non-interactive mode. | +| --target-password string | Specifies the password for the target TiDB Serverless cluster. | Yes | Only works in non-interactive mode. | +| --target-user string | Specifies the user to log in to the target TiDB Serverless cluster. | No | Only works in non-interactive mode. | ## Inherited flags @@ -73,7 +73,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-s3.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-s3.md index 334af550..c38e8da6 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-s3.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-import-start-s3.md @@ -42,23 +42,23 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------| | --aws-role-arn string | Specifies the AWS role ARN that is used to access the Amazon S3 data source. | Yes | Only works in non-interactive mode. | -| --backslash-escape | Whether to parse backslashes inside fields as escape characters for CSV files. The default value is `true`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | -| -c, --cluster-id string | Specifies the cluster ID. | Yes | Only works in non-interactive mode. | +| --backslash-escape | Controls whether to parse backslashes inside fields as escape characters for CSV files. The default value is `true`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | +| -c, --cluster-id string | Specifies the ID the cluster. | Yes | Only works in non-interactive mode. | | --data-format string | Specifies the data format. Valid values are `CSV`, `SqlFile`, `Parquet`, or `AuroraSnapshot`. | Yes | Only works in non-interactive mode. | | --delimiter string | Specifies the delimiter used for quoting for CSV files. The default value is `"`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | -| -h, --help | Displays help information for this command. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | -p, --project-id string | Specifies the project ID. | Yes | Only works in non-interactive mode. | | --separator string | Specifies the field separator for CSV files. The default value is `,`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | -| --source-url string | The S3 path where the source data files are stored. | Yes | Only works in non-interactive mode. | -| --trim-last-separator | Whether to treat separators as line terminators and trim all trailing separators for CSV files. The default value is `false`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | +| --source-url string | Specifies the S3 path where the source data files are stored. | Yes | Only works in non-interactive mode. | +| --trim-last-separator | Controls whether to treat separators as line terminators and trim all trailing separators for CSV files. The default value is `false`. | No | Only works in non-interactive mode when `--data-format CSV` is specified. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| -| --no-color | Disables color in output | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | +| --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-project-list.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-project-list.md index ec347827..da1fba93 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-project-list.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-project-list.md @@ -37,8 +37,8 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |---------------------|--------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| -o, --output string | Output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| -o, --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -46,7 +46,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-cancel.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-cancel.md index 1941b5e6..777ec668 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-cancel.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-cancel.md @@ -3,9 +3,9 @@ title: ticloud serverless export cancel summary: The reference of `ticloud serverless export cancel`. --- -# ticloud serverless export describe +# ticloud serverless export cancel -Cancel a serverless cluster export +Cancel a data export task: ```shell ticloud serverless export cancel [flags] @@ -13,13 +13,13 @@ ticloud serverless export cancel [flags] ## Examples -Cancel an export in interactive mode: +Cancel an export task in interactive mode: ```shell ticloud serverless export cancel ``` -Cancel an export in non-interactive mode: +Cancel an export task in non-interactive mode: ```shell ticloud serverless export cancel -c -e @@ -31,10 +31,10 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|----------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The cluster ID of the export to be described | Yes | Only works in non-interactive mode. | -| -e, --export-id string | The ID of the export to be described | Yes | Only works in non-interactive mode. | -| --force | Cancel an export without confirmation | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -e, --export-id string | Specifies the ID of the export task. | Yes | Only works in non-interactive mode. | +| --force | Cancels an export task without confirmation | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -42,7 +42,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-create.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-create.md index 3ebea754..ca7859d4 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-create.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export create`. # ticloud serverless export create -Create a serverless cluster export +Export data from a TiDB Serverless cluster: ```shell ticloud serverless export create [flags] @@ -13,21 +13,21 @@ ticloud serverless export create [flags] ## Examples -Create an export in interactive mode: +Export data from a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless export create ``` -Create an export with local type in non-interactive mode: +Export data from a TiDB Serverless cluster to local storage in non-interactive mode: -``` -ticloud serverless export create -c --databsae +```shell +ticloud serverless export create -c --database ``` -Create an export with s3 type in non-interactive mode: +Export data from a TiDB Serverless cluster to Amazon S3 in non-interactive mode: -``` +```shell ticloud serverless export create -c --s3.bucket-uri --s3.access-key-id --s3.secret-access-key ``` @@ -37,16 +37,16 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------------|--------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster, in which the export will be created | Yes | Only works in non-interactive mode. | -| --file-type string | The exported file type. One of ["CSV" "SQL"] (default "CSV") | No | Only works in non-interactive mode. | -| --database string | The database name you want to export (default "*") | No | Only works in non-interactive mode. | -| --table string | The table name you want to export (default "*") | No | Only works in non-interactive mode. | -| --target-type string | The exported Target. One of ["LOCAL" "S3"] (default "LOCAL") | No | Only works in non-interactive mode. | -| --s3.bucket-uri string | The bucket URI of the S3. Required when target type is S3 | No | Only works in non-interactive mode. | -| --s3.access-key-id string | The access key ID of the S3 bucket. Required when target type is S3 | NO | Only works in non-interactive mode. | -| --s3.secret-access-key string | The secret access key of the S3 bucket. Required when target type is S3 | No | Only works in non-interactive mode. | -| --compression string | The compression algorithm of the export file. One of ["GZIP" "SNAPPY" "ZSTD" "NONE"] (default "GZIP") | No | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster, from which you want to export data. | Yes | Only works in non-interactive mode. | +| --file-type string | Specifies the format of the exported file. The supported formats include `CSV` and `SQL`. The default value is `SQL`. | No | Only works in non-interactive mode. | +| --database string | Specifies the database from which you want to export data. The default value is `*`. This flag is required when you export data to local storage. | No | Only works in non-interactive mode. | +| --table string | Specifies the table from which you want to export data. The default value is `*`. | No | Only works in non-interactive mode. | +| --target-type string | Specifies the exported location. The supported location includes `LOCAL` and `S3`. The default value is `LOCAL`. | No | Only works in non-interactive mode. | +| --s3.bucket-uri string | Specifies the bucket URI of the S3. This flag is required when you export data to Amazon S3. | No | Only works in non-interactive mode. | +| --s3.access-key-id string | Specifies the access key ID of the S3 bucket. This flag is required when you export data to Amazon S3. | NO | Only works in non-interactive mode. | +| --s3.secret-access-key string | Specifies the secret access key of the S3 bucket. This flag is required when you export data to Amazon S3. | No | Only works in non-interactive mode. | +| --compression string | Specifies the compression algorithm of the export file. The supported algorithms include `GZIP` `SNAPPY` `ZSTD` `NONE`. The default value is `GZIP`. | No | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -54,7 +54,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-describe.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-describe.md index 96f9fd75..4a074c72 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-describe.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export describe`. # ticloud serverless export describe -Describe a serverless cluster export +Get the export information of a TiDB Serverless cluster: ```shell ticloud serverless export describe [flags] @@ -19,13 +19,13 @@ ticloud serverless export get [flags] ## Examples -Get an export in interactive mode: +Get the export information in interactive mode: ```shell ticloud serverless export describe ``` -Get an export in non-interactive mode: +Get the export information in non-interactive mode: ```shell ticloud serverless export describe -c -e @@ -37,9 +37,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|----------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The cluster ID of the export to be described | Yes | Only works in non-interactive mode. | -| -e, --export-id string | The ID of the export to be described | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -e, --export-id string | Specifies the ID of the export task. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -47,7 +47,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-download.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-download.md index a32ec4f8..b50db484 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-download.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-download.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export download`. # ticloud serverless export describe -Download the local type export +Download the exported data from a TiDB Serverless cluster to your local storage: ```shell ticloud serverless export download [flags] @@ -13,13 +13,13 @@ ticloud serverless export download [flags] ## Examples -Download the local type export in interactive mode: +Download the exported data in interactive mode: ```shell ticloud serverless export download ``` -Download the local type export in non-interactive mode: +Download the exported data in non-interactive mode: ```shell ticloud serverless export download -c -e @@ -31,11 +31,11 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The cluster ID of the export | Yes | Only works in non-interactive mode. | -| -e, --export-id string | The ID of the export | Yes | Only works in non-interactive mode. | -| --output-path string | Where you want to download to. If not specified, download to the current directory | No | Only works in non-interactive mode. | -| --auto-approve | Download without confirmation | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -e, --export-id string | Specifies the ID of the export task. | Yes | Only works in non-interactive mode. | +| --output-path string | Specifies the destination path for saving the downloaded data. If not specified, the data is downloaded to the current directory. | No | Only works in non-interactive mode. | +| --auto-approve | Downloads the exported data without confirmation. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -43,7 +43,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-list.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-list.md index eef59f52..68976f86 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-list.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-export-list.md @@ -3,9 +3,9 @@ title: ticloud serverless export list summary: The reference of `ticloud serverless export list`. --- -# ticloud serverless export describe +# ticloud serverless export list -List serverless cluster exports +List data export tasks of TiDB Serverless clusters: ```shell ticloud serverless export list [flags] @@ -19,19 +19,19 @@ ticloud serverless export ls [flags] ## Examples -List all exports in interactive mode: +List all export tasks in interactive mode: ```shell ticloud serverless export list ``` -List all exports in non-interactive mode: +List export tasks for a specified cluster in non-interactive mode: ```shell ticloud serverless export list -c ``` -List all exports with json format in non-interactive mode: +List export tasks for a specified cluster in the JSON format in non-interactive mode: ```shell ticloud serverless export list -c -o json @@ -43,9 +43,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|--------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The cluster ID of the export to be listed | Yes | Only works in non-interactive mode. | -| -o, --output string | Output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -o, --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -53,7 +53,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-regions.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-regions.md index ca5f9beb..5a08a2d6 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-regions.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-regions.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless regions`. # ticloud serverless regions -List all available regions for serverless clusters +List all available regions for TiDB Serverless clusters: ```shell ticloud serverless regions [flags] @@ -13,13 +13,13 @@ ticloud serverless regions [flags] ## Examples -List all available regions for serverless clusters: +List all available regions for TiDB Serverless clusters: ```shell ticloud serverless regions ``` -List all available regions for serverless clusters in the JSON format: +List all available regions for TiDB Serverless clusters in the JSON format: ```shell ticloud serverless regions -o json @@ -31,16 +31,16 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |---------------------|--------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------| -| -o, --output string | Output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -o, --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-shell.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-shell.md index 7e99eae0..1789b90f 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-shell.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-shell.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless shell`. # ticloud serverless shell -Connect to a serverless cluster +Connect to a TiDB Serverless cluster: ```shell ticloud serverless shell [flags] @@ -13,25 +13,25 @@ ticloud serverless shell [flags] ## Examples -Connect to a serverless cluster in interactive mode: +Connect to a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless shell ``` -Connect to a serverless cluster with default user in non-interactive mode: +Connect to a TiDB Serverless cluster with the default user in non-interactive mode: ```shell ticloud serverless shell -c ``` -Connect to a serverless cluster with default user and password in non-interactive mode: +Connect to a TiDB Serverless cluster with the default user and password in non-interactive mode: ```shell ticloud serverless shell -c --password ``` -Connect to a serverless cluster with specific user and password in non-interactive mode: +Connect to a TiDB Serverless cluster with a specific user and password in non-interactive mode: ```shell ticloud connect -c -u --password @@ -43,10 +43,10 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|-----------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | Cluster ID | Yes | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | -| --password | The password of the user | No | Only works in non-interactive mode. | -| -u, --user string | A specific user for login | No | Only works in non-interactive mode. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | +| --password | Specifies the password of the user. | No | Only works in non-interactive mode. | +| -u, --user string | Specifies the user for login. | No | Only works in non-interactive mode. | ## Inherited flags @@ -54,7 +54,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-spending-limit.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-spending-limit.md index 282a6970..72b9acad 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-spending-limit.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-spending-limit.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless spending-limit`. # ticloud serverless spending-limit -Set spending limit for a serverless cluster +Set the maximum monthly [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for a TiDB Serverless cluster: ```shell ticloud serverless spending-limit [flags] @@ -13,13 +13,13 @@ ticloud serverless spending-limit [flags] ## Examples -Set spending limit for a serverless clusters in interactive mode: +Set the spending limit for a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless spending-limit ``` -Set spending limit for a serverless clusters in non-interactive mode: +Set the spending limit for a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless spending-limit -c --monthly @@ -31,18 +31,18 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|---------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster | Yes | Only works in non-interactive mode. | -| --monthly int32 | Maximum monthly spending limit in USD cents | Yes | Only works in non-interactive mode. | -| --force | Deletes a cluster without confirmation | No | Works in both non-interactive and interactive modes. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| --monthly int32 | Specifies the maximum monthly spending limit in USD cents. | Yes | Only works in non-interactive mode. | +| --force | Deletes a cluster without confirmation. | No | Works in both non-interactive and interactive modes. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags | Flag | Description | Required | Note | |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | -| -P, --profile string | The active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-update.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-update.md index fae7390c..e2d52a18 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-update.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-serverless-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless update`. # ticloud serverless update -Update a serverless cluster: +Update a TiDB Serverless cluster: ```shell ticloud serverless update [flags] @@ -13,19 +13,19 @@ ticloud serverless update [flags] ## Examples -Update a serverless cluster in interactive mode: +Update a TiDB Serverless cluster in interactive mode: ```shell ticloud serverless update ``` -Update displayName of a serverless cluster in non-interactive mode: +Update the name of a TiDB Serverless cluster in non-interactive mode: ```shell ticloud serverless update -c --display-name ``` -Update labels of a serverless cluster in non-interactive mode +Update labels of a TiDB Serverless cluster in non-interactive mode ```shell ticloud serverless update -c --labels "{\"label1\":\"value1\"}" @@ -37,11 +37,11 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |--------------------------|-------------------------------------------------------|----------|------------------------------------------------------| -| -c, --cluster-id string | The ID of the cluster to be updated | Yes | Only works in non-interactive mode. | -| -n --display-name string | The new displayName of the cluster to be updated | No | Only works in non-interactive mode. | -| --annotations string | The annotations of the cluster to be added or updated | No | Only works in non-interactive mode. | -| --labels string | The labels of the cluster to be added or updated | No | Only works in non-interactive mode. | -| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. | +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| -n --display-name string | Specifies a new name for the cluster. | No | Only works in non-interactive mode. |. +| --annotations string | Specifies new annotations for the cluster | No | Only works in non-interactive mode. | +| --labels string | Specifies new labels for the cluster. | No | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags @@ -49,7 +49,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-update.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-update.md index 6bfa41a0..cd00acbf 100644 --- a/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-update.md +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/ticloud-update.md @@ -23,7 +23,7 @@ ticloud update | Flag | Description | |------------|-----------------------------------| - | -h, --help | Help information for this command | + | -h, --help | Shows help information for this command. | ## Inherited flags @@ -31,7 +31,7 @@ ticloud update |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | -| -D, --debug | Enable debug mode | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | ## Feedback diff --git a/markdown-pages/en/tidbcloud/master/tidb-cloud/tidb-cloud-import-local-files.md b/markdown-pages/en/tidbcloud/master/tidb-cloud/tidb-cloud-import-local-files.md new file mode 100644 index 00000000..8232efef --- /dev/null +++ b/markdown-pages/en/tidbcloud/master/tidb-cloud/tidb-cloud-import-local-files.md @@ -0,0 +1,137 @@ +--- +title: Import Local Files to TiDB Cloud +summary: Learn how to import local files to TiDB Cloud. +--- + +# Import Local Files to TiDB Cloud + +You can import local files to TiDB Cloud directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage bucket path and Role ARN. The whole importing process is quick and smooth. + +Currently, this method supports importing one CSV file for one task into either an existing table or a new table. + +## Limitations + +- Currently, TiDB Cloud only supports importing a local file in CSV format within 50 MiB for one task. +- Importing local files is supported only for TiDB Serverless clusters, not for TiDB Dedicated clusters. +- You cannot run more than one import task at the same time. +- When you import a CSV file into an existing table in TiDB Cloud and the target table has more columns than the source file, the extra columns are handled differently depending on the situation: + - If the extra columns are not the primary keys or the unique keys, no error will be reported. Instead, these extra columns will be populated with their [default values](/data-type-default-values.md). + - If the extra columns are the primary keys or the unique keys and do not have the `auto_increment` or `auto_random` attribute, an error will be reported. In that case, it is recommended that you choose one of the following strategies: + - Provide a source file that includes these the primary keys or the unique keys columns. + - Set the attributes of the primary key or the unique key columns to `auto_increment` or `auto_random`. +- If a column name is a reserved [keyword](/keywords.md) in TiDB, TiDB Cloud automatically adds backticks `` ` `` to enclose the column name. For example, if the column name is `order`, TiDB Cloud automatically adds backticks `` ` `` to change it to `` `order` `` and imports the data into the target table. + +## Import local files + +1. Open the **Import** page for your target cluster. + + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. + + > **Tip:** + > + > If you have multiple projects, you can click in the lower-left corner and switch to another project. + + 2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane. + +2. On the **Import** page, you can directly drag and drop your local file to the upload area, or click the upload area to select and upload the target local file. Note that you can upload only one CSV file of less than 50 MiB for one task. If your local file is larger than 50 MiB, see [How to import a local file larger than 50 MiB?](#how-to-import-a-local-file-larger-than-50-mib). + +3. In the **Target** area, select the target database and the target table, or enter a name directly to create a new database or a new table. The name must start with letters (a-z and A-Z) or numbers (0-9), and can contain letters (a-z and A-Z), numbers (0-9), and the underscore (_) character. Click **Preview**. + +4. Check the table. + + You can see a list of configurable table columns. Each line shows the table column name inferred by TiDB Cloud, the table column type inferred, and the previewed data from the CSV file. + + - If you import data into an existing table in TiDB Cloud, the column list is extracted from the table definition, and the previewed data is mapped to the corresponding columns by column names. + + - If you want to create a new table, the column list is extracted from the CSV file, and the column type is inferred by TiDB Cloud. For example, if the previewed data is all integers, the inferred column type will be **int** (integer). + +5. Configure the column names and data types. + + If the first row in the CSV file records the column names, make sure that **Use first row as column name** is selected, which is selected by default. + + If the CSV file does not have a row for the column names, do not select **Use first row as column name**. In this case: + + - If the target table already exists, the columns in the CSV file will be imported into the target table in order. Extra columns will be truncated and missing columns will be filled with default values. + + - If you need TiDB Cloud to create the target table, input the name for each column. The column name must meet the following requirements: + + * The name must be composed of only letters (a-z and A-Z), numbers (0-9), characters (such as Chinese and Japanese), and the underscore (`_`) character. + * Other special characters are not supported. + * The length of the name must be less than 65 characters. + + You can also change the data type if needed. + +6. For a new target table, you can set the primary key. You can select a column as the primary key, or select multiple columns to create a composite primary key. The composite primary key will be formed in the order in which you select the column names. + + > **Note:** + > + > - The primary key of the table is a clustered index and cannot be deleted after creation. + > - Ensure that the data corresponding to the primary key field is unique and not empty. Otherwise, the import task will result in data inconsistency. + +7. Edit the CSV configuration if needed. + + You can also click **Edit CSV configuration** to configure Backslash Escape, Separator, and Delimiter for more fine-grained control. For more information about the CSV configuration, see [CSV Configurations for Importing Data](/tidb-cloud/csv-config-for-import-data.md). + +8. On the **Preview** page, you can have a preview of the data. Click **Start Import**. + + You can view the import progress on the **Import Task Detail** page. If there are warnings or failed tasks, you can check to view the details and solve them. + +9. After the import task is completed, you can click **Explore your data by Chat2Query** to query your imported data. For more information about how to use Chat2Query, see [Explore Your Data with AI-Powered Chat2Query](/tidb-cloud/explore-data-with-chat2query.md). + +10. On the **Import** page, you can click **View** in the **Action** column to check the import task detail. + +## FAQ + +### Can I only import some specified columns by the Import feature in TiDB Cloud? + +No. Currently, you can only import all columns of a CSV file into an existing table when using the Import feature. + +To import only some specified columns, you can use the MySQL client to connect your TiDB cluster, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: + +```sql +CREATE TABLE `import_test` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `name` varchar(64) NOT NULL, + `address` varchar(64) NOT NULL, + PRIMARY KEY (`id`) +) ENGINE=InnoDB; +LOAD DATA LOCAL INFILE 'load.txt' INTO TABLE import_test FIELDS TERMINATED BY ',' (name, address); +``` + +If you use `mysql` and encounter `ERROR 2068 (HY000): LOAD DATA LOCAL INFILE file request rejected due to restrictions on access.`, you can add `--local-infile=true` in the connection string. + +### Why can't I query a column with a reserved keyword after importing data into TiDB Cloud? + +If a column name is a reserved [keyword](/keywords.md) in TiDB, TiDB Cloud automatically adds backticks `` ` `` to enclose the column name and then imports the data into the target table. When you query the column, you need to add backticks `` ` `` to enclose the column name. For example, if the column name is `order`, you need to query the column with `` `order` ``. + +### How to import a local file larger than 50 MiB? + +If the file is larger than 50 MiB, you can use the `split [-l ${line_count}]` utility to split it into multiple smaller files (for Linux or macOS only). For example, run `split -l 100000 tidb-01.csv small_files` to split a file named `tidb-01.csv` by line length `100000`, and the split files are named `small_files${suffix}`. Then, you can import these smaller files to TiDB Cloud one by one. + +Refer to the following script: + +```bash +#!/bin/bash +n=$1 +file_path=$2 +file_extension="${file_path##*.}" +file_name="${file_path%.*}" +total_lines=$(wc -l < $file_path) +lines_per_file=$(( (total_lines + n - 1) / n )) +split -d -a 1 -l $lines_per_file $file_path $file_name. +for (( i=0; i<$n; i++ )) +do + mv $file_name.$i $file_name.$i.$file_extension +done +``` + +You can input `n` and a file name, and then run the script. The script will divide the file into `n` equal parts while keeping the original file extension. For example: + +```bash +> sh ./split.sh 3 mytest.customer.csv +> ls -h | grep mytest +mytest.customer.0.csv +mytest.customer.1.csv +mytest.customer.2.csv +mytest.customer.csv +```