云数据库 TiDB 版
云数据库 TiDB 版
文档指南
请输入
- 文档首页
云数据库 TiDB 版API 参考导入任务管理PrecheckImportTask - 预检查导入文件
复制全文
下载 pdfPrecheckImportTask - 预检查导入文件
文档反馈
问问助手调用 PrecheckImportTask 接口预检查导入文件。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：PrecheckImportTask
要执行的操作，取值：PrecheckImportTask。
Version string 必选 示例值：2026-06-30
API的版本，取值：2026-06-30。
ImportOptions object 必选 示例值：ImportOptions
导入选项。
NeedDropTable boolean 可选 示例值：true
是否先删除目标表（仅 tutorial 场景使用）。取值如下：
- true：删除。
- false：不删除。
FileType string 可选 示例值：CSV
数据格式。取值如下：
- CSV：CSV 格式。
- Parquet：Parquet 格式。
- AURORA_SNAPSHOT：AURORA_SNAPSHOT 格式。
- SQL：SQL 格式。
CsvFormat object 可选
CSV 格式配置。
Header boolean 可选 示例值：true
是否包含首行表头。取值如下:
- true：包含。
- false：不包含。
NotNull boolean 可选 示例值：true
是否禁止列为 NULL。取值如下：
- true：禁止。
- false：不禁止。
NullValue string 可选 示例值：\\N
NULL 的字符串表示。
BackslashEscape boolean 可选 示例值：true
是否转义反斜杠。取值如下:
- true：转义。
- false：不转义。
TrimLastSeparator boolean 可选 示例值：true
是否去除行尾多余分隔符。取值如下:
- true：去除。
- false：不去除。
Separator string 可选 示例值：,
列分隔符。
Delimiter string 可选 示例值：\"
包裹符。
Source object 必选 示例值：{ "Type": "TOS", "Tos": { "Uri": "tos://test-tidb/CVS/", "AuthType": "ACCESS_KEY", "AccessKey": { "Id": "AKLTNGRlYWNiMzJhMTYy******", "Secret": "TWpVME9HUTBOR0UzT0Rk******" } }, "TargetTableInfos": [ { "TargetTable": { "Database": "tpcc_db", "Table": "customer10" }, "CustomFile": "tpcc_db.customer10*.csv" } ], "Local": { "UploadId": "upload-882fa31e-76b2-4411-b721******", "TargetDatabase": "biz_local_db", "TargetTable": "local_temp_table", "FileName": "local_sample.csv", "Columns": [ { "ColumnName": "id", "ColumnType": "BIGINT UNSIGNED" }, { "ColumnName": "c_name", "ColumnType": "VARCHAR(64)" }, { "ColumnName": "create_time", "ColumnType": "DATETIME" } ], "PkColumns": [ "id" ] } }
导入数据源配置。
Type string 可选 示例值：TOS
数据源类型。
Tos object 可选
TOS 源配置。
Uri string 可选
TOS URI。
AuthType string 可选
固定为 ACCESS_KEY。
AccessKey object 可选
访问凭证。
Id string 可选
AccessKey ID。
Secret string 可选
AccessKey Secret。
TargetTableInfos object[] 可选
导入目标表信息。
TargetTable object 可选
目标表信息。
Database string 可选
数据库名。
Table string 可选
表名。
CustomFile string 可选
自定义文件，为空时使用默认规则导入数据。
Local object 可选
本地文件导入源配置。
UploadId string 可选
上传文件的 upload_id。
TargetDatabase string 可选
目标数据库。
TargetTable string 可选
目标表。
FileName string 可选
导入文件名（只读）。
Columns object[] 可选
目标表列定义（仅输入，目标表不存在时用于建表）。
ColumnName string 可选
列名。
ColumnType string 可选
列类型。
PkColumns string[] 可选
主键列（仅输入）。
ProjectName string 可选 示例值：default
项目名称。
InstanceId string 必选 示例值：tidb‑544c96a2******
实例 ID。
返回参数
TargetTables object[] 示例值：{ "Database": "example", "Table": "example" }
匹配到数据文件的目标表列表。
TargetTable object
目标表。
Database string
数据库名。
Table string
表名。
ErrorMessage string
错误信息。
MatchedDataFiles string[]
匹配到的数据文件。
MatchedSchemaFile string
匹配到的 schema 文件。
UseSchemaFile boolean
是否使用匹配到的 schema 文件。
ErrorMessage string 示例值：
未匹配表的错误信息。
TotalDataFilesCount string 示例值：2
数据文件总数（uint64 字符串）。
TotalTablesCount string 示例值：2
表总数（uint64 字符串）。
Status string 示例值：COMPLETED
预检查状态。
请求示例
返回示例
错误码
最近更新时间：2026.10.30 11:06:01
这个页面对您有帮助吗？
有用
有用
无用
无用