Skip to content

Commit 0ddf354

Browse files
shiyuhang0shiyuhang0
authored
TiDB Cloud Cli v1.0.0-beta.4 (#20838)
1 parent 622cc50 commit 0ddf354

6 files changed

+215
-1
lines changed

‎TOC-tidb-cloud.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -732,6 +732,11 @@
732732
- [delete](/tidb-cloud/ticloud-serverless-sql-user-delete.md)
733733
- [list](/tidb-cloud/ticloud-serverless-sql-user-list.md)
734734
- [update](/tidb-cloud/ticloud-serverless-sql-user-update.md)
735+
- authorized-network
736+
- [create](/tidb-cloud/ticloud-serverless-authorized-network-create.md)
737+
- [delete](/tidb-cloud/ticloud-serverless-authorized-network-delete.md)
738+
- [list](/tidb-cloud/ticloud-serverless-authorized-network-list.md)
739+
- [update](/tidb-cloud/ticloud-serverless-authorized-network-update.md)
735740
- [ai](/tidb-cloud/ticloud-ai.md)
736741
- [completion](/tidb-cloud/ticloud-completion.md)
737742
- config

‎tidb-cloud/ticloud-serverless-authorized-network-create.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: ticloud serverless authorized-network create
3+
summary: The reference of `ticloud serverless authorized-network create`.
4+
---
5+
6+
# ticloud serverless authorized-network create
7+
8+
Create an authorized network:
9+
10+
```shell
11+
ticloud serverless authorized-network create [flags]
12+
```
13+
14+
## Examples
15+
16+
Create an authorized network in interactive mode:
17+
18+
```shell
19+
ticloud serverless authorized-network create
20+
```
21+
22+
Create an authorized network in non-interactive mode:
23+
24+
```shell
25+
ticloud serverless authorized-network create -c <cluster-id> --display-name <display-name> --start-ip-address <start-ip-address> --end-ip-address <end-ip-address>
26+
```
27+
28+
## Flags
29+
30+
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.
31+
32+
| Flag | Description | Required | Note |
33+
|-------------------------|------------------------------------------|----------|------------------------------------------------------|
34+
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
35+
| --display-name string | Specifies the name of the authorized network. | Yes | Only works in non-interactive mode. |
36+
| --start-ip-address string | Specifies the start IP address of the authorized network. | Yes | Only works in non-interactive mode. |
37+
| --end-ip-address string | Specifies the end IP address of the authorized network. | Yes | Only works in non-interactive mode. |
38+
| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. |
39+
40+
## Inherited flags
41+
42+
| Flag | Description | Required | Note |
43+
|----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------|
44+
| --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. |
45+
| -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. |
46+
| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. |
47+
48+
## Feedback
49+
50+
If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions.

‎tidb-cloud/ticloud-serverless-authorized-network-delete.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: ticloud serverless authorized-network delete
3+
summary: The reference of `ticloud serverless authorized-network delete`.
4+
---
5+
6+
# ticloud serverless authorized-network delete
7+
8+
Delete an authorized network:
9+
10+
```shell
11+
ticloud serverless authorized-network delete [flags]
12+
```
13+
14+
## Examples
15+
16+
Delete an authorized network in interactive mode:
17+
18+
```shell
19+
ticloud serverless authorized-network delete
20+
```
21+
22+
Delete an authorized network in non-interactive mode:
23+
24+
```shell
25+
ticloud serverless authorized-network delete -c <cluster-id> --start-ip-address <start-ip-address> --end-ip-address <end-ip-address>
26+
```
27+
28+
## Flags
29+
30+
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.
31+
32+
| Flag | Description | Required | Note |
33+
|-------------------------|------------------------------------------|----------|------------------------------------------------------|
34+
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
35+
| --force string | Delete an authorized network without confirmation. | No | Only works in non-interactive mode. |
36+
| --start-ip-address string | Specifies the start IP address of the authorized network. | Yes | Only works in non-interactive mode. |
37+
| --end-ip-address string | Specifies the end IP address of the authorized network. | Yes | Only works in non-interactive mode. |
38+
| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. |
39+
40+
## Inherited flags
41+
42+
| Flag | Description | Required | Note |
43+
|----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------|
44+
| --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. |
45+
| -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. |
46+
| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. |
47+
48+
## Feedback
49+
50+
If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions.

‎tidb-cloud/ticloud-serverless-authorized-network-list.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: ticloud serverless authorized-network list
3+
summary: The reference of `ticloud serverless authorized-network list`.
4+
---
5+
6+
# ticloud serverless authorized-network list
7+
8+
List all authorized networks:
9+
10+
```shell
11+
ticloud serverless authorized-network list [flags]
12+
```
13+
14+
## Examples
15+
16+
List all authorized networks in interactive mode:
17+
18+
```shell
19+
ticloud serverless authorized-network list
20+
```
21+
22+
List all authorized networks in non-interactive mode:
23+
24+
```shell
25+
ticloud serverless authorized-network list -c <cluster-id>
26+
```
27+
28+
## Flags
29+
30+
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.
31+
32+
| Flag | Description | Required | Note |
33+
|-------------------------|------------------------------------------|----------|------------------------------------------------------|
34+
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
35+
| --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. |
36+
| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. |
37+
38+
## Inherited flags
39+
40+
| Flag | Description | Required | Note |
41+
|----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------|
42+
| --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. |
43+
| -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. |
44+
| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. |
45+
46+
## Feedback
47+
48+
If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions.

‎tidb-cloud/ticloud-serverless-authorized-network-update.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: ticloud serverless authorized-network update
3+
summary: The reference of `ticloud serverless authorized-network update`.
4+
---
5+
6+
# ticloud serverless authorized-network update
7+
8+
Update an authorized network:
9+
10+
```shell
11+
ticloud serverless authorized-network update [flags]
12+
```
13+
14+
## Examples
15+
16+
Update an authorized network in interactive mode:
17+
18+
```shell
19+
ticloud serverless authorized-network update
20+
```
21+
22+
Update an authorized network in non-interactive mode:
23+
24+
```shell
25+
ticloud serverless authorized-network update -c <cluster-id> --start-ip-address <start-ip-address> --end-ip-address <end-ip-address> --new-start-ip-address <new-start-ip-address> --new-end-ip-address <new-end-ip-address>
26+
```
27+
28+
## Flags
29+
30+
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.
31+
32+
| Flag | Description | Required | Note |
33+
|-------------------------|------------------------------------------|----------|------------------------------------------------------|
34+
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
35+
| --start-ip-address string | Specifies the starting IP address of the authorized network. | Yes | Only works in non-interactive mode. |
36+
| --end-ip-address string | Specifies the ending IP address of the authorized network. | Yes | Only works in non-interactive mode. |
37+
| --new-display-name string | Specifies the new name of the authorized network. | No | Only works in non-interactive mode. |
38+
| --new-start-ip-address string | Specifies the new start IP address of the authorized network. | No | Only works in non-interactive mode. |
39+
| --new-end-ip-address string | Specifies the new end IP address of the authorized network. | No | Only works in non-interactive mode. |
40+
| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. |
41+
42+
## Inherited flags
43+
44+
| Flag | Description | Required | Note |
45+
|----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------|
46+
| --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. |
47+
| -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. |
48+
| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. |
49+
50+
## Feedback
51+
52+
If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions.

‎tidb-cloud/ticloud-serverless-export-create.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ Export data from a TiDB Cloud Serverless cluster to Azure Blob Storage in non-in
4343
ticloud serverless export create -c <cluster-id> --azblob.uri <uri> --azblob.sas-token <sas-token> --filter <database.table>
4444
```
4545

46+
Export data from a TiDB Cloud Serverless cluster to Alibaba Cloud OSS in non-interactive mode:
47+
48+
```shell
49+
ticloud serverless export create -c <cluster-id> --oss.uri <uri> --oss.access-key-id <access-key-id> --oss.access-key-secret <access-key-secret> --filter <database.table>
50+
```
51+
4652
Export data to a Parquet file and compress it with `SNAPPY` in non-interactive mode:
4753

4854
```shell
@@ -63,7 +69,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter
6369
|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------|
6470
| -c, --cluster-id string | Specifies the ID of the cluster, from which you want to export data. | Yes | Only works in non-interactive mode. |
6571
| --file-type string | Specifies the export file type. One of ["SQL" "CSV" "PARQUET"]. (default "CSV") | No | Only works in non-interactive mode. |
66-
| --target-type string | Specifies the export target. One of [`"LOCAL"` `"S3"` `"GCS"` `"AZURE_BLOB"`]. The default value is `"LOCAL"`. | No | Only works in non-interactive mode. |
72+
| --target-type string | Specifies the export target. One of [`"LOCAL"` `"S3"` `"GCS"` `"AZURE_BLOB"` `"OSS"`]. The default value is `"LOCAL"`. | No | Only works in non-interactive mode. |
6773
| --s3.uri string | Specifies the S3 URI in `s3://<bucket>/<file-path>` format. Required when the target type is S3. | No | Only works in non-interactive mode. |
6874
| --s3.access-key-id string | Specifies the access key ID of Amazon S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key]. | NO | Only works in non-interactive mode. |
6975
| --s3.secret-access-key string | Specifies the secret access key of Amazon S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key]. | No | Only works in non-interactive mode. |
@@ -72,6 +78,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter
7278
| --gcs.service-account-key string | Specifies the base64 encoded service account key of GCS. | No | Only works in non-interactive mode. |
7379
| --azblob.uri string | Specifies the Azure Blob URI in `azure://<account>.blob.core.windows.net/<container>/<file-path>` format. Required when the target type is AZURE_BLOB. | No | Only works in non-interactive mode. |
7480
| --azblob.sas-token string | Specifies the SAS token of Azure Blob. | No | Only works in non-interactive mode. |
81+
| --oss.uri string | Specifies the Alibaba Cloud OSS URI in `oss://<bucket>/<file-path>` format. Required when the export `target-type` is `"OSS"`. | No | Only works in non-interactive mode. |
82+
| --oss.access-key-id string | Specifies the AccessKey ID to access Alibaba Cloud OSS. | No | Only works in non-interactive mode. |
83+
| --oss.access-key-secret string | Specifies the AccessKey secret to access Alibaba Cloud OSS. | No | Only works in non-interactive mode. |
7584
| --csv.delimiter string | Specifies the delimiter of string type variables in CSV files. (default "\"") | No | Only works in non-interactive mode. |
7685
| --csv.null-value string | Specifies the representation of null values in CSV files. (default "\\N") | No | Only works in non-interactive mode. |
7786
| --csv.separator string | Specifies the separator of each value in CSV files. (default ",") | No | Only works in non-interactive mode. |

0 commit comments

Comments
 (0)