Skip to content

Commit 1886dc2

Browse files
shiyuhang0shiyuhang0
authored
CLI for cdc changefeed (#283)
1 parent 71cfb79 commit 1886dc2

27 files changed

Lines changed: 2513 additions & 8 deletions

‎docs/generate_doc/ticloud_serverless.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Manage TiDB Cloud Serverless clusters
2323
* [ticloud serverless authorized-network](ticloud_serverless_authorized-network.md) - Manage TiDB Cloud Serverless cluster authorized networks
2424
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches
2525
* [ticloud serverless capacity](ticloud_serverless_capacity.md) - Set capacity for a TiDB Cloud Serverless cluster
26+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
2627
* [ticloud serverless create](ticloud_serverless_create.md) - Create a TiDB Cloud Serverless cluster
2728
* [ticloud serverless delete](ticloud_serverless_delete.md) - Delete a TiDB Cloud Serverless cluster
2829
* [ticloud serverless describe](ticloud_serverless_describe.md) - Describe a TiDB Cloud Serverless cluster

‎docs/generate_doc/ticloud_serverless_changefeed.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## ticloud serverless changefeed
2+
3+
Manage TiDB Cloud Serverless changefeeds
4+
5+
### Options
6+
7+
```
8+
-h, --help help for changefeed
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
-D, --debug Enable debug mode
15+
--no-color Disable color output
16+
-P, --profile string Profile to use from your configuration file
17+
```
18+
19+
### SEE ALSO
20+
21+
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
22+
* [ticloud serverless changefeed create](ticloud_serverless_changefeed_create.md) - Create a changefeed
23+
* [ticloud serverless changefeed delete](ticloud_serverless_changefeed_delete.md) - Delete a changefeed
24+
* [ticloud serverless changefeed describe](ticloud_serverless_changefeed_describe.md) - Describe a changefeed
25+
* [ticloud serverless changefeed edit](ticloud_serverless_changefeed_edit.md) - Edit a changefeed
26+
* [ticloud serverless changefeed list](ticloud_serverless_changefeed_list.md) - List changefeeds
27+
* [ticloud serverless changefeed pause](ticloud_serverless_changefeed_pause.md) - Pause a changefeed
28+
* [ticloud serverless changefeed resume](ticloud_serverless_changefeed_resume.md) - Resume a paused changefeed
29+
* [ticloud serverless changefeed template](ticloud_serverless_changefeed_template.md) - Show changefeed Kafka, MySQL and Filter JSON templates
30+

‎docs/generate_doc/ticloud_serverless_changefeed_create.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## ticloud serverless changefeed create
2+
3+
Create a changefeed
4+
5+
```
6+
ticloud serverless changefeed create [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Create a changefeed in interactive mode:
13+
$ ticloud serverless changefeed create
14+
15+
Create a changefeed in non-interactive mode:
16+
$ ticloud serverless changefeed create -c <cluster-id> --type KAFKA --kafka '{"network_info":{"network_type":"PUBLIC"},"broker":{"kafka_version":"VERSION_2XX","broker_endpoints":"52.34.156.155:9092","compression":"NONE"},"authentication":{"auth_type":"DISABLE"},"topic_partition_config":{"dispatch_type":"ONE_TOPIC","default_topic":"default-topic","replication_factor":1,"partition_num":1,"partition_dispatchers":[{"partition_type":"TABLE","matcher":["*.*"]}]},"data_format":{"protocol":"CANAL_JSON"}}' --filter '{"filterRule":["test.*"], "mode": "IGNORE_NOT_SUPPORT_TABLE"}'
17+
18+
Create a changefeed named "myfeed" with specified start TSO in non-interactive mode:
19+
$ ticloud serverless changefeed create -c <cluster-id> --name myfeed --type KAFKA --kafka <kafka-json> --filter <filter-json> --start-tso 458996254096228352
20+
21+
```
22+
23+
### Options
24+
25+
```
26+
-c, --cluster-id string The ID of the cluster.
27+
-n, --display-name string The name of the changefeed.
28+
--filter string Filter in JSON format, use "ticloud serverless changefeed template --type filter" to see templates.
29+
-h, --help help for create
30+
--kafka string Kafka information in JSON format, use "ticloud serverless changefeed template --type kafka" to see templates.
31+
--mysql string MySQL information in JSON format, use "ticloud serverless changefeed template --type mysql" to see templates.
32+
--start-time string Start Time for the changefeed (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If both start-tso and start-time are provided, start-tso will be used.
33+
--start-tso uint Start TSO for the changefeed, default to current TSO. See https://docs.pingcap.com/tidb/stable/tso/ for more information about TSO.
34+
--type string The type of the changefeed, one of ["KAFKA" "MYSQL"]
35+
```
36+
37+
### Options inherited from parent commands
38+
39+
```
40+
-D, --debug Enable debug mode
41+
--no-color Disable color output
42+
-P, --profile string Profile to use from your configuration file
43+
```
44+
45+
### SEE ALSO
46+
47+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
48+

‎docs/generate_doc/ticloud_serverless_changefeed_delete.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless changefeed delete
2+
3+
Delete a changefeed
4+
5+
```
6+
ticloud serverless changefeed delete [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Delete a changefeed in interactive mode:
13+
$ ticloud serverless changefeed delete
14+
15+
Delete a changefeed in non-interactive mode:
16+
$ ticloud serverless changefeed delete -c <cluster-id> --changefeed-id <changefeed-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-f, --changefeed-id string The changefeed ID.
23+
-c, --cluster-id string The cluster ID.
24+
--force Delete a changefeed without confirmation.
25+
-h, --help help for delete
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-D, --debug Enable debug mode
32+
--no-color Disable color output
33+
-P, --profile string Profile to use from your configuration file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
39+

‎docs/generate_doc/ticloud_serverless_changefeed_describe.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ticloud serverless changefeed describe
2+
3+
Describe a changefeed
4+
5+
```
6+
ticloud serverless changefeed describe [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Get a changefeed in interactive mode:
13+
$ ticloud serverless changefeed describe
14+
15+
Get a changefeed in non-interactive mode:
16+
$ ticloud serverless changefeed describe -c <cluster-id> --changefeed-id <changefeed-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-f, --changefeed-id string The changefeed ID.
23+
-c, --cluster-id string The cluster ID.
24+
-h, --help help for describe
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-D, --debug Enable debug mode
31+
--no-color Disable color output
32+
-P, --profile string Profile to use from your configuration file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
38+

‎docs/generate_doc/ticloud_serverless_changefeed_edit.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## ticloud serverless changefeed edit
2+
3+
Edit a changefeed
4+
5+
```
6+
ticloud serverless changefeed edit [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Update a changefeed in interactive mode:
13+
$ ticloud serverless changefeed edit
14+
15+
Update the name, kafka, and filter of a changefeed in non-interactive mode:
16+
$ ticloud serverless changefeed edit -c <cluster-id> --changefeed-id <changefeed-id> --name newname --kafka <full-specified-kafka> --filter <full-specified-filter>
17+
18+
```
19+
20+
### Options
21+
22+
```
23+
--changefeed-id string The ID of the changefeed to be updated.
24+
-c, --cluster-id string The ID of the cluster.
25+
-n, --display-name string The name of the changefeed.
26+
--filter string Complete filter in JSON format, use "ticloud serverless changefeed template --type filter" to see templates.
27+
-h, --help help for edit
28+
--kafka string Complete Kafka information in JSON format, use "ticloud serverless changefeed template --type kafka" to see templates.
29+
--mysql string Complete MySQL information in JSON format, use "ticloud serverless changefeed template --type mysql" to see templates.
30+
```
31+
32+
### Options inherited from parent commands
33+
34+
```
35+
-D, --debug Enable debug mode
36+
--no-color Disable color output
37+
-P, --profile string Profile to use from your configuration file
38+
```
39+
40+
### SEE ALSO
41+
42+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
43+

‎docs/generate_doc/ticloud_serverless_changefeed_list.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## ticloud serverless changefeed list
2+
3+
List changefeeds
4+
5+
```
6+
ticloud serverless changefeed list [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
List all changefeeds in interactive mode:
13+
$ ticloud serverless changefeed list
14+
15+
List all changefeeds in non-interactive mode:
16+
$ ticloud serverless changefeed list -c <cluster-id>
17+
18+
List all changefeeds with json format in non-interactive mode:
19+
$ ticloud serverless changefeed list -c <cluster-id> -o json
20+
```
21+
22+
### Options
23+
24+
```
25+
-c, --cluster-id string The cluster ID of the changefeeds to be listed.
26+
-h, --help help for list
27+
-o, --output string Output format, one of ["human" "json"]. For the complete result, please use json format. (default "human")
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-D, --debug Enable debug mode
34+
--no-color Disable color output
35+
-P, --profile string Profile to use from your configuration file
36+
```
37+
38+
### SEE ALSO
39+
40+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
41+

‎docs/generate_doc/ticloud_serverless_changefeed_pause.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ticloud serverless changefeed pause
2+
3+
Pause a changefeed
4+
5+
```
6+
ticloud serverless changefeed pause [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Pause a changefeed in interactive mode:
13+
$ ticloud serverless changefeed pause
14+
15+
Pause a changefeed in non-interactive mode:
16+
$ ticloud serverless changefeed pause -c <cluster-id> --changefeed-id <changefeed-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-f, --changefeed-id string The changefeed ID.
23+
-c, --cluster-id string The cluster ID.
24+
-h, --help help for pause
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-D, --debug Enable debug mode
31+
--no-color Disable color output
32+
-P, --profile string Profile to use from your configuration file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
38+

‎docs/generate_doc/ticloud_serverless_changefeed_resume.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ticloud serverless changefeed resume
2+
3+
Resume a paused changefeed
4+
5+
```
6+
ticloud serverless changefeed resume [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Resume a changefeed in interactive mode:
13+
$ ticloud serverless changefeed resume
14+
15+
Resume a changefeed in non-interactive mode:
16+
$ ticloud serverless changefeed resume -c <cluster-id> --changefeed-id <changefeed-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
-f, --changefeed-id string The changefeed ID.
23+
-c, --cluster-id string The cluster ID.
24+
-h, --help help for resume
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-D, --debug Enable debug mode
31+
--no-color Disable color output
32+
-P, --profile string Profile to use from your configuration file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
38+

‎docs/generate_doc/ticloud_serverless_changefeed_template.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ticloud serverless changefeed template
2+
3+
Show changefeed Kafka, MySQL and Filter JSON templates
4+
5+
```
6+
ticloud serverless changefeed template [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Show all changefeed templates:
13+
$ ticloud serverless changefeed template
14+
15+
Show Kafka JSON template:
16+
$ ticloud serverless changefeed template --type kafka
17+
```
18+
19+
### Options
20+
21+
```
22+
--explain Show template with explanations.
23+
-h, --help help for template
24+
--type string The type of changefeed template to show, one of ["kafka", "mysql", "filter"].
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-D, --debug Enable debug mode
31+
--no-color Disable color output
32+
-P, --profile string Profile to use from your configuration file
33+
```
34+
35+
### SEE ALSO
36+
37+
* [ticloud serverless changefeed](ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
38+

0 commit comments

Comments
 (0)