Skip to content

Commit

Permalink
add import
Browse files Browse the repository at this point in the history
  • Loading branch information
shiyuhang0 committed Apr 15, 2024
1 parent 1eafa2c commit 0cfac7d
Show file tree
Hide file tree
Showing 10 changed files with 97 additions and 233 deletions.
5 changes: 1 addition & 4 deletions TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,10 +642,7 @@
- [cancel](/tidb-cloud/ticloud-import-cancel.md)
- [describe](/tidb-cloud/ticloud-import-describe.md)
- [list](/tidb-cloud/ticloud-import-list.md)
- start
- [local](/tidb-cloud/ticloud-import-start-local.md)
- [s3](/tidb-cloud/ticloud-import-start-s3.md)
- [mysql](/tidb-cloud/ticloud-import-start-mysql.md)
- [start](/tidb-cloud/ticloud-import-start.md)
- export
- [create](/tidb-cloud/ticloud-serverless-export-create.md)
- [describe](/tidb-cloud/ticloud-serverless-export-describe.md)
Expand Down
6 changes: 3 additions & 3 deletions tidb-cloud/ticloud-auth-login.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ summary: The reference of `ticloud auth login`.

# ticloud auth login

Authenticate with TiDB Cloud CLI:
Authenticate with TiDB Cloud:

```shell
ticloud auth login [flags]
```

## Examples

To log into TiDB Cloud CLI:
To log into TiDB Cloud:

```shell
ticloud auth login
```

To log into TiDB Cloud CLI with insecure storage:
To log into TiDB Cloud with insecure storage:

```shell
ticloud auth login --insecure-storage
Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/ticloud-auth-logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ summary: The reference of `ticloud auth logout`.

# ticloud auth logout

Log out of TiDB Cloud CLI:
Log out of TiDB Cloud:

```shell
ticloud auth logout [flags]
```

## Examples

To log out of TiDB Cloud CLI:
To log out of TiDB Cloud:

```shell
ticloud auth logout
Expand Down
15 changes: 7 additions & 8 deletions tidb-cloud/ticloud-import-cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,19 @@ ticloud serverless import cancel
Cancel an import task in non-interactive mode:

```shell
ticloud serverless import cancel --project-id <project-id> --cluster-id <cluster-id> --import-id <import-id>
ticloud serverless import cancel --cluster-id <cluster-id> --import-id <import-id>
```

## Flags

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

| Flag | Description | Required | Note |
|-------------------------|---------------------------------------------------------------|----------|------------------------------------------------------|
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
| --force | Cancels the import 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. |
| --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. |
| Flag | Description | Required | Note |
|-------------------------|----------------------------------------------|----------|------------------------------------------------------|
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
| --force | Cancels an import 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. |
| --import-id string | Specifies the ID of the import task. | Yes | Only works in non-interactive mode. |

## Inherited flags

Expand Down
5 changes: 2 additions & 3 deletions tidb-cloud/ticloud-import-describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless import describe`.

# ticloud serverless import describe

Get the import details of a data import task:
Describe a data import task:

```shell
ticloud serverless import describe [flags]
Expand All @@ -28,7 +28,7 @@ ticloud serverless import describe
Describe an import task in non-interactive mode:

```shell
ticloud serverless import describe --project-id <project-id> --cluster-id <cluster-id> --import-id <import-id>
ticloud serverless import describe --cluster-id <cluster-id> --import-id <import-id>
```

## Flags
Expand All @@ -40,7 +40,6 @@ In non-interactive mode, you need to manually enter the required flags. In inter
| -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

Expand Down
5 changes: 2 additions & 3 deletions tidb-cloud/ticloud-import-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ ticloud serverless import list
List import tasks in non-interactive mode:

```shell
ticloud serverless import list --project-id <project-id> --cluster-id <cluster-id>
ticloud serverless import list --cluster-id <cluster-id>
```

List import tasks for a specified cluster in the JSON format:

```shell
ticloud serverless import list --project-id <project-id> --cluster-id <cluster-id> --output json
ticloud serverless import list --cluster-id <cluster-id> --output json
```

## Flags
Expand All @@ -46,7 +46,6 @@ In non-interactive mode, you need to manually enter the required flags. In inter
| -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

Expand Down
65 changes: 0 additions & 65 deletions tidb-cloud/ticloud-import-start-local.md

This file was deleted.

80 changes: 0 additions & 80 deletions tidb-cloud/ticloud-import-start-mysql.md

This file was deleted.

Loading

0 comments on commit 0cfac7d

Please sign in to comment.