Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/generate_doc/ticloud_serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Manage TiDB Cloud Serverless clusters
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports
* [ticloud serverless list](ticloud_serverless_list.md) - List all TiDB Cloud Serverless clusters
* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections for dataflow
* [ticloud serverless region](ticloud_serverless_region.md) - List all available regions for TiDB Cloud Serverless
* [ticloud serverless shell](ticloud_serverless_shell.md) - Connect to a TiDB Cloud Serverless cluster
Expand Down
29 changes: 29 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## ticloud serverless migration

Manage TiDB Cloud Serverless migrations

### Options

```
-h, --help help for migration
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
* [ticloud serverless migration create](ticloud_serverless_migration_create.md) - Create a migration
* [ticloud serverless migration delete](ticloud_serverless_migration_delete.md) - Delete a migration
* [ticloud serverless migration describe](ticloud_serverless_migration_describe.md) - Describe a migration
* [ticloud serverless migration list](ticloud_serverless_migration_list.md) - List migrations
* [ticloud serverless migration pause](ticloud_serverless_migration_pause.md) - Pause a migration
* [ticloud serverless migration resume](ticloud_serverless_migration_resume.md) - Resume a paused migration
* [ticloud serverless migration template](ticloud_serverless_migration_template.md) - Show migration JSON templates

39 changes: 39 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## ticloud serverless migration create

Create a migration

```
ticloud serverless migration create [flags]
```

### Examples

```
Create a migration:
$ ticloud serverless migration create -c <cluster-id> --display-name <name> --config-file <file-path> --dry-run
$ ticloud serverless migration create -c <cluster-id> --display-name <name> --config-file <file-path>

```

### Options

```
-c, --cluster-id string The ID of the target cluster.
--config-file string Path to a migration config JSON file. Use "ticloud serverless migration template --mode <mode>" to print templates.
-n, --display-name string Display name for the migration.
--dry-run Run a migration precheck (dry run) with the provided inputs without creating a migration.
-h, --help help for create
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

39 changes: 39 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## ticloud serverless migration delete

Delete a migration

```
ticloud serverless migration delete [flags]
```

### Examples

```
Delete a migration in interactive mode:
$ ticloud serverless migration delete

Delete a migration in non-interactive mode:
$ ticloud serverless migration delete -c <cluster-id> --migration-id <migration-id>
```

### Options

```
-c, --cluster-id string Cluster ID that owns the migration.
--force Delete without confirmation.
-h, --help help for delete
-m, --migration-id string ID of the migration to delete.
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

38 changes: 38 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ticloud serverless migration describe

Describe a migration

```
ticloud serverless migration describe [flags]
```

### Examples

```
Describe a migration in interactive mode:
$ ticloud serverless migration describe

Describe a migration in non-interactive mode:
$ ticloud serverless migration describe -c <cluster-id> --migration-id <migration-id>
```

### Options

```
-c, --cluster-id string Cluster ID that owns the migration.
-h, --help help for describe
-m, --migration-id string ID of the migration to describe.
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

38 changes: 38 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ticloud serverless migration list

List migrations

```
ticloud serverless migration list [flags]
```

### Examples

```
List migrations in interactive mode:
$ ticloud serverless migration list

List migrations in non-interactive mode with JSON output:
$ ticloud serverless migration list -c <cluster-id> -o json
```

### Options

```
-c, --cluster-id string The cluster ID of the migration tasks to list.
-h, --help help for list
-o, --output string Output format, one of ["human" "json"]. For the complete result, please use json format. (default "human")
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

38 changes: 38 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_pause.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ticloud serverless migration pause

Pause a migration

```
ticloud serverless migration pause [flags]
```

### Examples

```
Pause a migration in interactive mode:
$ ticloud serverless migration pause

Pause a migration in non-interactive mode:
$ ticloud serverless migration pause -c <cluster-id> --migration-id <migration-id>
```

### Options

```
-c, --cluster-id string Cluster ID that owns the migration.
-h, --help help for pause
-m, --migration-id string ID of the migration to pause.
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

38 changes: 38 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_resume.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ticloud serverless migration resume

Resume a paused migration

```
ticloud serverless migration resume [flags]
```

### Examples

```
Resume a migration in interactive mode:
$ ticloud serverless migration resume

Resume a migration in non-interactive mode:
$ ticloud serverless migration resume -c <cluster-id> --migration-id <migration-id>
```

### Options

```
-c, --cluster-id string Cluster ID that owns the migration.
-h, --help help for resume
-m, --migration-id string ID of the migration to resume.
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

37 changes: 37 additions & 0 deletions docs/generate_doc/ticloud_serverless_migration_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ticloud serverless migration template

Show migration JSON templates

```
ticloud serverless migration template [flags]
```

### Examples

```
Show the ALL mode migration template:
$ ticloud serverless migration template --mode all

Show the INCREMENTAL migration template:
$ ticloud serverless migration template --mode incremental
```

### Options

```
-h, --help help for template
--mode string Migration mode template to show, one of [all, incremental].
```

### Options inherited from parent commands

```
-D, --debug Enable debug mode
--no-color Disable color output
-P, --profile string Profile to use from your configuration file
```

### SEE ALSO

* [ticloud serverless migration](ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations

Loading
Loading