# TiCDC 的使用 - 公共参数

__*TiCDC 使用*__
__*TiCDC 公共参数*__

+ --changefeed-id:同步任务的 ID
+ --sink-uri:同步任务下游的地址
+ --start-ts:指定 changefeed 的开始 TSO
+ --target-ts:指定 changefeed 的目标 TSO
+ --sort-engine:指定 changefeed 使用的排序引擎
+ --config:指定 changefeed 配置文件

-------------------------------------------------------------
--changefeed-id:同步任务的 ID,格式需要符合正则表达式 ^[a-zA-Z0-9]+(\-[a-zA-Z0-9]+)*$。如果不指定该 ID,TiCDC 会自动生成一个 UUID（version 4 格式）作为 ID。

--sink-uri:同步任务下游的地址,需要按照以下格式进行配置,目前 scheme 支持 mysql/tidb/kafka/pulsar。
[scheme]://[userinfo@][host]:[port][/path]?[query_parameters]
URI 中包含特殊字符时,需要以 URL 编码对特殊字符进行处理。

--start-ts:指定 changefeed 的开始 TSO。TiCDC 集群将从这个 TSO 开始拉取数据。默认为当前时间。

--target-ts:指定 changefeed 的目标 TSO。TiCDC 集群拉取数据直到这个 TSO 停止。默认为空,即 TiCDC 不会自动停止。

--sort-engine:指定 changefeed 使用的排序引擎。因 TiDB 和 TiKV 使用分布式架构,TiCDC 需要对数据变更记录进行排序后才能输出。该项支持 unified（默认）/memory/file:
unified:优先使用内存排序,内存不足时则自动使用硬盘暂存数据。该选项默认开启。
memory:在内存中进行排序。 不建议使用,同步大量数据时易引发 OOM。
file:完全使用磁盘暂存数据。已经弃用,不建议在任何情况使用。

--config:指定 changefeed 配置文件。

--sort-dir: 用于指定排序器使用的临时文件目录。自 TiDB v4.0.13, v5.0.3 和 v5.1.0 起已经无效,请不要使用。