Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce import mysql #13778

Merged
merged 17 commits into from
Jun 9, 2023
Merged

Introduce import mysql #13778

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
03dc546
Introduce import mysql
xuanyu66 Jun 5, 2023
a5b738b
fix lint
xuanyu66 Jun 5, 2023
a389643
polish
xuanyu66 Jun 5, 2023
681aefd
Update tidb-cloud/ticloud-import-start-mysql.md
xuanyu66 Jun 5, 2023
c9c3dd6
Merge branch 'release-6.5' into import-mysql
xuanyu66 Jun 5, 2023
e87398e
fix unclosed tag
xuanyu66 Jun 5, 2023
ddd6591
Apply suggestions from code review
xuanyu66 Jun 6, 2023
a545d6b
polish
xuanyu66 Jun 6, 2023
3a20666
Apply suggestions from code review
zhangyangyu Jun 6, 2023
d5e4769
Apply suggestions from code review
qiancai Jun 7, 2023
88ec6cb
Add mysql installation instruction
xuanyu66 Jun 7, 2023
616b013
Update tidb-cloud/ticloud-import-start-mysql.md
xuanyu66 Jun 7, 2023
40c24cf
Merge branch 'release-6.5' into import-mysql
xuanyu66 Jun 7, 2023
43da4d3
Apply suggestions from code review
xuanyu66 Jun 7, 2023
c46a8a1
Apply suggestions from code review
xuanyu66 Jun 8, 2023
fec319e
Apply suggestions from code review
xuanyu66 Jun 9, 2023
24e9fa8
Apply suggestions from code review
xuanyu66 Jun 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions TOC-tidb-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,7 @@
- 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)
- project
- [list](/tidb-cloud/ticloud-project-list.md)
- [update](/tidb-cloud/ticloud-update.md)
Expand Down
22 changes: 22 additions & 0 deletions tidb-cloud/get-started-with-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,26 @@ For macOS or Linux, you can install `ticloud` using any of the following methods

To set up `ticloud` in GitHub Action, use [`setup-tidbcloud-cli`](https://github.com/tidbcloud/setup-tidbcloud-cli).

Install the MySQL command-line client if you do not have it. You can install it via your package manager:

- Debian-based distributions:

```shell
sudo apt-get install mysql-client
```

- RPM-based distributions:

```shell
sudo yum install mysql
```

- macOS:

```shell
brew install mysql-client
```

</div>

<div label="Windows">
Expand All @@ -56,6 +76,8 @@ For Windows, you can install `ticloud` using either of the following methods:

To set up `ticloud` in GitHub Actions, use [`setup-tidbcloud-cli`](https://github.com/tidbcloud/setup-tidbcloud-cli).

Install the MySQL command-line client if you do not have it. You can refer to the instructions in [MySQL Installer for Windows](https://dev.mysql.com/doc/refman/8.0/en/mysql-installer.html) for the installation. To launch `ticloud connect` on Windows, you need to have the directory containing `mysql.exe` in the PATH environment variable.

</div>
</SimpleTab>

Expand Down
32 changes: 16 additions & 16 deletions tidb-cloud/ticloud-import-start-local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,25 +39,25 @@ ticloud import start local <file-path> --project-id <project-id> --cluster-id <c

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 | Cluster ID | Yes | Only works in non-interactive mode. |
| --data-format string | Data format (Currently, only `CSV` is supported) | Yes | Only works in non-interactive mode. |
| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. |
| -p, --project-id string | Project ID | Yes | Only works in non-interactive mode. |
| --target-database string | Target database to import data to | Yes | Only works in non-interactive mode. |
| --target-table string | Target table to import data to | Yes | Only works in non-interactive mode. |
| Flag | Description | Required | Note |
|---|---|---|---|
| --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. |
| --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. |
| -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. |
| --target-table string | Specifies the target table to import data to. | 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. |

## Inherited flags

| Flag | Description | Required | Note |
|-----------------------|------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------|
| --backslash-escape | Parses backslashes inside fields as escape characters (`true` by default) for CSV files | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| --delimiter string | Specifies the delimiter used for quoting (`"` by default) for CSV files | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| --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. |
| --separator string | Specifies the field separator of CSV files (`,` by default) | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| --trim-last-separator | Treats separators as the line terminators and trims all trailing separators for CSV files | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| 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. |
xuanyu66 marked this conversation as resolved.
Show resolved Hide resolved
| -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. |

## Feedback

Expand Down
79 changes: 79 additions & 0 deletions tidb-cloud/ticloud-import-start-mysql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: ticloud import start mysql
summary: The reference of `ticloud import start mysql`.
---

# ticloud import start mysql

Import a table from a MySQL-compatible database to a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster:

```shell
ticloud import start mysql [flags]
```

> **Note:**
>
> - Before running this command, make sure that you have installed the MySQL command-line tool first. For more details, see [Installation](/tidb-cloud/get-started-with-cli.md#installation).
> - If the target table already exists in the target database, to use this command for table import, make sure that the target table name is the same as the source table name and add the `skip-create-table` flag in the command.
> - If the target table does not exist in the target database, executing this command automatically creates a table with the same name as the source table in the target database.

## Examples

- Start an import task in interactive mode:

```shell
ticloud import start mysql
```

- Start an import task in non-interactive mode (using the TiDB Serverless cluster default user `<username-prefix>.root`):

```shell
ticloud import start mysql --project-id <project-id> --cluster-id <cluster-id> --source-host <source-host> --source-port <source-port> --source-user <source-user> --source-password <source-password> --source-database <source-database> --source-table <source-table> --target-database <target-database> --target-password <target-password>
```

- Start an import task in non-interactive mode (using a specific user):

```shell
ticloud import start mysql --project-id <project-id> --cluster-id <cluster-id> --source-host <source-host> --source-port <source-port> --source-user <source-user> --source-password <source-password> --source-database <source-database> --source-table <source-table> --target-database <target-database> --target-password <target-password> --target-user <target-user>
```

- Start an import task that skips creating the target table if it already exists in the target database:

```shell
ticloud import start mysql --project-id <project-id> --cluster-id <cluster-id> --source-host <source-host> --source-port <source-port> --source-user <source-user> --source-password <source-password> --source-database <source-database> --source-table <source-table> --target-database <target-database> --target-password <target-password> --skip-create-table
```

> **Note:**
>
> MySQL 8.0 uses `utf8mb4_0900_ai_ci` as the default collation, which is currently not supported by TiDB. If your source table uses the `utf8mb4_0900_ai_ci` collation, before the import, you need to either alter the source table collation to a [supported collation of TiDB](/character-set-and-collation.md#character-sets-and-collations-supported-by-tidb) or manually create the target table in TiDB.

## 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 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. |
| -p, --project-id string | Specifies the project ID | Yes | Only works in non-interactive mode. |
xuanyu66 marked this conversation as resolved.
Show resolved Hide resolved
| --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. |

## 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 | 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. |

## Feedback

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.
32 changes: 16 additions & 16 deletions tidb-cloud/ticloud-import-start-s3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,25 +39,25 @@ ticloud import start s3 --project-id <project-id> --cluster-id <cluster-id> --aw

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 |
|-------------------------|----------------------------------------------------------|----------|-----------------------------------|
| --aws-role-arn string | AWS S3 IAM Role ARN | Yes | Only works in non-interactive mode. |
| -c, --cluster-id string | Cluster ID | Yes | Only works in non-interactive mode. |
| --data-format string | Data format. Valid values are `CSV`, `SqlFile`, `Parquet`, or `AuroraSnapshot`. | Yes | Only works in non-interactive mode. |
| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. |
| -p, --project-id string | Project ID | Yes | Only works in non-interactive mode. |
| --source-url string | The S3 path where the source data files are stored | Yes | Only works in non-interactive mode. |
| Flag | Description | Required | Note |
|---|---|---|---|
| --aws-role-arn string | The specific AWS role ARN that needs to be assumed to access the Amazon S3 data source. | Yes | Only works in non-interactive mode. |
xuanyu66 marked this conversation as resolved.
Show resolved Hide resolved
| --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. |
| --data-format string | Specifies the data format. Valid values are `CSV`, `SqlFile`, `Parquet`, or `AuroraSnapshot`. | Yes | Only works in non-interactive mode. |
xuanyu66 marked this conversation as resolved.
Show resolved Hide resolved
| --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. |
| -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. |

## Inherited flags

| Flag | Description | Required | Note |
|-----------------------|------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------|
| --backslash-escape | Parses backslashes inside fields as escape characters (`true` by default) for CSV files | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| --delimiter string | Specifies the delimiter used for quoting (`"` by default) for CSV files | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| --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. |
| --separator string | Specifies the field separator of CSV files (`,` by default) | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| --trim-last-separator | Treats separators as the line terminators and trims all trailing separators for CSV files | No | Only works in non-interactive mode when `--data-format CSV` is specified. |
| 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 | 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. |

## Feedback

Expand Down