CLI for cdc changefeed

docs/generate_doc/ticloud_serverless.md

@@ -23,6 +23,7 @@ Manage TiDB Cloud Serverless clusters
 * [ticloud serverless authorized-network](ticloud_serverless_authorized-network.md)	 - Manage TiDB Cloud Serverless cluster authorized networks
 * [ticloud serverless branch](ticloud_serverless_branch.md)	 - Manage TiDB Cloud Serverless branches
 * [ticloud serverless capacity](ticloud_serverless_capacity.md)	 - Set capacity for a TiDB Cloud Serverless cluster
+* [ticloud serverless changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
 * [ticloud serverless create](ticloud_serverless_create.md)	 - Create a TiDB Cloud Serverless cluster
 * [ticloud serverless delete](ticloud_serverless_delete.md)	 - Delete a TiDB Cloud Serverless cluster
 * [ticloud serverless describe](ticloud_serverless_describe.md)	 - Describe a TiDB Cloud Serverless cluster

docs/generate_doc/ticloud_serverless_changefeed.md

@@ -0,0 +1,30 @@
+## ticloud serverless changefeed
+
+Manage TiDB Cloud Serverless changefeeds
+
+### Options
+
+```
+  -h, --help   help for changefeed
+```
+
+### 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 changefeed create](ticloud_serverless_changefeed_create.md)	 - Create a changefeed
+* [ticloud serverless changefeed delete](ticloud_serverless_changefeed_delete.md)	 - Delete a changefeed
+* [ticloud serverless changefeed describe](ticloud_serverless_changefeed_describe.md)	 - Describe a changefeed
+* [ticloud serverless changefeed edit](ticloud_serverless_changefeed_edit.md)	 - Edit a changefeed
+* [ticloud serverless changefeed list](ticloud_serverless_changefeed_list.md)	 - List changefeeds
+* [ticloud serverless changefeed pause](ticloud_serverless_changefeed_pause.md)	 - Pause a changefeed
+* [ticloud serverless changefeed resume](ticloud_serverless_changefeed_resume.md)	 - Resume a paused changefeed
+* [ticloud serverless changefeed template](ticloud_serverless_changefeed_template.md)	 - Show changefeed Kafka, MySQL and Filter JSON templates
+

docs/generate_doc/ticloud_serverless_changefeed_create.md

@@ -0,0 +1,48 @@
+## ticloud serverless changefeed create
+
+Create a changefeed
+
+```
+ticloud serverless changefeed create [flags]
+```
+
+### Examples
+
+```
+  Create a changefeed in interactive mode:
+  $ ticloud serverless changefeed create
+
+  Create a changefeed in non-interactive mode:
+  $ 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"}'
+
+  Create a changefeed named "myfeed" with specified start TSO in non-interactive mode:
+  $ ticloud serverless changefeed create -c <cluster-id> --name myfeed --type KAFKA --kafka <kafka-json> --filter <filter-json> --start-tso 458996254096228352
+
+```
+
+### Options
+
+```
+  -c, --cluster-id string     The ID of the cluster.
+  -n, --display-name string   The name of the changefeed.
+      --filter string         Filter in JSON format, use "ticloud serverless changefeed template --type filter" to see templates.
+  -h, --help                  help for create
+      --kafka string          Kafka information in JSON format, use "ticloud serverless changefeed template --type kafka" to see templates.
+      --mysql string          MySQL information in JSON format, use "ticloud serverless changefeed template --type mysql" to see templates.
+      --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.
+      --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.
+      --type string           The type of the changefeed, one of ["KAFKA" "MYSQL"]
+```
+
+### 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_delete.md

@@ -0,0 +1,39 @@
+## ticloud serverless changefeed delete
+
+Delete a changefeed
+
+```
+ticloud serverless changefeed delete [flags]
+```
+
+### Examples
+
+```
+  Delete a changefeed in interactive mode:
+  $ ticloud serverless changefeed delete
+
+  Delete a changefeed in non-interactive mode:
+  $ ticloud serverless changefeed delete -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+### Options
+
+```
+  -f, --changefeed-id string   The changefeed ID.
+  -c, --cluster-id string      The cluster ID.
+      --force                  Delete a changefeed without confirmation.
+  -h, --help                   help for 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_describe.md

@@ -0,0 +1,38 @@
+## ticloud serverless changefeed describe
+
+Describe a changefeed
+
+```
+ticloud serverless changefeed describe [flags]
+```
+
+### Examples
+
+```
+  Get a changefeed in interactive mode:
+  $ ticloud serverless changefeed describe
+
+  Get a changefeed in non-interactive mode:
+  $ ticloud serverless changefeed describe -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+### Options
+
+```
+  -f, --changefeed-id string   The changefeed ID.
+  -c, --cluster-id string      The cluster ID.
+  -h, --help                   help for 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_edit.md

@@ -0,0 +1,43 @@
+## ticloud serverless changefeed edit
+
+Edit a changefeed
+
+```
+ticloud serverless changefeed edit [flags]
+```
+
+### Examples
+
+```
+  Update a changefeed in interactive mode:
+  $ ticloud serverless changefeed edit
+
+  Update the name, kafka, and filter of a changefeed in non-interactive mode:
+  $ ticloud serverless changefeed edit -c <cluster-id> --changefeed-id <changefeed-id> --name newname --kafka <full-specified-kafka> --filter <full-specified-filter>
+
+```
+
+### Options
+
+```
+      --changefeed-id string   The ID of the changefeed to be updated.
+  -c, --cluster-id string      The ID of the cluster.
+  -n, --display-name string    The name of the changefeed.
+      --filter string          Complete filter in JSON format, use "ticloud serverless changefeed template --type filter" to see templates.
+  -h, --help                   help for edit
+      --kafka string           Complete Kafka information in JSON format, use "ticloud serverless changefeed template --type kafka" to see templates.
+      --mysql string           Complete MySQL information in JSON format, use "ticloud serverless changefeed template --type mysql" to see templates.
+```
+
+### 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_list.md

@@ -0,0 +1,41 @@
+## ticloud serverless changefeed list
+
+List changefeeds
+
+```
+ticloud serverless changefeed list [flags]
+```
+
+### Examples
+
+```
+  List all changefeeds in interactive mode:
+  $ ticloud serverless changefeed list
+
+  List all changefeeds in non-interactive mode:
+  $ ticloud serverless changefeed list -c <cluster-id>
+
+  List all changefeeds with json format in non-interactive mode:
+  $ ticloud serverless changefeed list -c <cluster-id> -o json
+```
+
+### Options
+
+```
+  -c, --cluster-id string   The cluster ID of the changefeeds to be listed.
+  -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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_pause.md

@@ -0,0 +1,38 @@
+## ticloud serverless changefeed pause
+
+Pause a changefeed
+
+```
+ticloud serverless changefeed pause [flags]
+```
+
+### Examples
+
+```
+  Pause a changefeed in interactive mode:
+  $ ticloud serverless changefeed pause
+
+  Pause a changefeed in non-interactive mode:
+  $ ticloud serverless changefeed pause -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+### Options
+
+```
+  -f, --changefeed-id string   The changefeed ID.
+  -c, --cluster-id string      The cluster ID.
+  -h, --help                   help for 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_resume.md

@@ -0,0 +1,38 @@
+## ticloud serverless changefeed resume
+
+Resume a paused changefeed
+
+```
+ticloud serverless changefeed resume [flags]
+```
+
+### Examples
+
+```
+  Resume a changefeed in interactive mode:
+  $ ticloud serverless changefeed resume
+
+  Resume a changefeed in non-interactive mode:
+  $ ticloud serverless changefeed resume -c <cluster-id> --changefeed-id <changefeed-id>
+```
+
+### Options
+
+```
+  -f, --changefeed-id string   The changefeed ID.
+  -c, --cluster-id string      The cluster ID.
+  -h, --help                   help for 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_changefeed_template.md

@@ -0,0 +1,38 @@
+## ticloud serverless changefeed template
+
+Show changefeed Kafka, MySQL and Filter JSON templates
+
+```
+ticloud serverless changefeed template [flags]
+```
+
+### Examples
+
+```
+  Show all changefeed templates:
+  $ ticloud serverless changefeed template
+
+  Show Kafka JSON template:
+  $ ticloud serverless changefeed template --type kafka
+```
+
+### Options
+
+```
+      --explain       Show template with explanations.
+  -h, --help          help for template
+      --type string   The type of changefeed template to show, one of ["kafka", "mysql", "filter"].
+```
+
+### 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 changefeed](ticloud_serverless_changefeed.md)	 - Manage TiDB Cloud Serverless changefeeds
+

docs/generate_doc/ticloud_serverless_export_create.md

@@ -50,6 +50,7 @@ ticloud serverless export create [flags]
       --oss.access-key-secret string     The access key secret of the OSS.
       --oss.uri string                   The OSS URI in oss://<bucket>/<path> format. Required when target type is OSS.
       --parquet.compression string       The parquet compression algorithm. One of ["GZIP" "SNAPPY" "ZSTD" "NONE"]. (default "ZSTD")
+      --partitions strings               Filter the exported partition table(s) with specified partition(s).
       --s3.access-key-id string          The access key ID of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key].
       --s3.role-arn string               The role arn of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key].
       --s3.secret-access-key string      The secret access key of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key].

internal/cli/root.go

@@ -179,9 +179,9 @@ func RootCmd(h *internal.Helper) *cobra.Command {
 						color.CyanString(newRelease.Version))
 
 					if config.IsUnderTiUP {
-						fmt.Fprintln(h.IOStreams.Out, color.GreenString("Use `tiup update cloud` to update to the latest version"))
+						fmt.Fprintln(h.IOStreams.Out, color.GreenString("Use \"tiup update cloud\" to update to the latest version"))
 					} else {
-						fmt.Fprintln(h.IOStreams.Out, color.GreenString("Use `ticloud upgrade` to upgrade to the latest version"))
+						fmt.Fprintln(h.IOStreams.Out, color.GreenString("Use \"ticloud upgrade\" to upgrade to the latest version"))
 					}
 				}
 			}