接入前需要确认
接入前请核对
请将输入整理为受支持的INSERT行,并检查带引号标识符与字面值。
接入前请核对
空自定义模板可能返回帮助文本;生产使用前请明确模板及其转义规则。
代码示例
这些示例以 multipart/form-data 发送样例,并原样保存响应字节。请先设置环境变量 TABLECONVERT_API_KEY。
SQL INSERT文本 转 自定义文本模板 API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/sql-to-magic' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=CREATE TABLE records (sku TEXT, item TEXT, quantity TEXT);
INSERT INTO records VALUES ('\''P101'\'', '\''Notebook'\'', '\''12'\'');
INSERT INTO records VALUES ('\''P102'\'', '\''Marker'\'', '\''8'\'');' \
--form-string 'output[headerTpl]={F |}
' \
--form-string 'output[rowsTpl]={F |}
' \
--form-string 'output[footerTpl]={F |}' \
--form-string 'output[builtin]=' \
--output 'sql-to-magic.txt'需要 cURL。若示例采用文件上传,请先下载输入样例。
SQL INSERT文本 转 自定义文本模板 API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/sql-to-magic"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "CREATE TABLE records (sku TEXT, item TEXT, quantity TEXT);\nINSERT INTO records VALUES ('P101', 'Notebook', '12');\nINSERT INTO records VALUES ('P102', 'Marker', '8');"),
"output[headerTpl]": (None, "{F |}\n"),
"output[rowsTpl]": (None, "{F |}\n"),
"output[footerTpl]": (None, "{F |}"),
"output[builtin]": (None, ""),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("sql-to-magic.txt").write_bytes(response.content)需要 Python 3 与 requests,可通过 pip install requests 安装。
SQL INSERT文本 转 自定义文本模板 API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "CREATE TABLE records (sku TEXT, item TEXT, quantity TEXT);\nINSERT INTO records VALUES ('P101', 'Notebook', '12');\nINSERT INTO records VALUES ('P102', 'Marker', '8');");
form.set("output[headerTpl]", "{F |}\n");
form.set("output[rowsTpl]", "{F |}\n");
form.set("output[footerTpl]", "{F |}");
form.set("output[builtin]", "");
const response = await fetch("https://api.tableconvert.com/v2/convert/sql-to-magic", {
method: "POST",
headers: { Authorization: "Bearer " + process.env.TABLECONVERT_API_KEY },
body: form,
signal: AbortSignal.timeout(40_000),
});
if (!response.ok) {
throw new Error("HTTP " + response.status + ": " + await response.text());
}
await writeFile("sql-to-magic.txt", Buffer.from(await response.arrayBuffer()));需要 Node.js 20 或更新版本,使用内置 fetch、FormData 和 Blob。
身份验证
发送 Authorization: Bearer YOUR_API_KEY。请让 HTTP 客户端设置 multipart 边界,不要手动指定 Content-Type。
生产环境的 API Key 请保存在服务端环境变量中。
请求参数
将受支持的INSERT语句及其列清单按表格文本解析;API不会在数据库中执行SQL。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
data | string | — | 直接发送 SQL 表格内容;data、file、url 三种来源任选其一。 |
file | binary | — | 通过 multipart/form-data 上传 sql 文件。 |
url | string | — | 可公开访问的受支持文件 HTTP 或 HTTPS URL。 |
使用 data、file 或 url 提供一种输入来源。页面示例使用适合该格式的来源模式。
输出选项
对表格记录应用TableConvert Magic行模板;Magic用于自定义文本替换,不是独立文件格式,也不是AI转换。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
output[headerTpl] | string | 空字符串 | 用于自定义文本导出首行或头部的模板。 |
output[rowsTpl] | string | 空字符串 | 为自定义导出中的中间数据行重复应用的模板。 |
output[footerTpl] | string | 空字符串 | 用于自定义文本导出末行或尾部的模板。 |
output[builtin] | string | 空字符串 | 使用内置预设填入自定义模板;显式模板字段仍为最终依据。 |
转换规则
| 情况 | 处理方式 |
|---|---|
| 映射规则 1 | 受支持的INSERT列名与值元组成为表头和数据行,不执行SQL。 |
| 映射规则 2 | 模板将单元格与行计数替换到头部、重复行主体与尾部。 |
| 映射规则 3 | 请将解析后的INSERT列绑定到自定义占位符;模板不是SQL引擎,不能求值源表达式。 |
输入读取方式
- 为获得可预期的列映射,请使用明确的INSERT列清单与受支持的值元组。
- 这里进行文本解析,不求值任意SQL查询,也不迁移schema或访问数据库。
- 导入前请处理计算表达式、方言专用字面量与复杂转储。
- 提取后可能需要清理带引号的标识符文本与源字面量语义;请核对null和转义。
输出生成方式
- 可配置headerTpl、rowsTpl与footerTpl,或选择内置模板。
- 列占位符使用表格位置、表头与行计数,不遍历任意对象树。
- 目标语法与转义由模板负责;请先测试小型样本。
适用场景
此转换的实际用途
以受支持的SQL INSERT导出文本为起始数据,准备应用专用文本导出。请将输入整理为受支持的INSERT行,并检查带引号标识符与字面值。
自定义文本模板
生成重复文本,例如URL列表、命令片段或应用专用导入行。
响应与错误
| HTTP 状态 | 说明 |
|---|---|
200 | text/plain; charset=utf-8 |
400 | 输入或转换参数无效。 |
402 | 积分不足,无法处理此请求。 |
403 | API Key 缺失或无效。 |
413 | 输入超过已配置的请求限制。 |
415 | 不支持的输入媒体类型。 |
429 | 请求超过频率限制。 |
500 | 转换未能完成。 |
503 | 渲染服务不可用或请求超时。 |
重试前请先检查响应。新的 HTTP 请求属于新的转换,可能再次消耗积分。
限制、计费与版本
本地预览最多接受 200 KB。当前 API 实现允许上传一个不超过 50 MiB 的文件,multipart 中每个文本字段限制为 1 MiB,v2 转换任务的截止时间为 30 秒。部署环境可能设置更严格的限制。重试前请先检查错误内容;部分解析或渲染失败会返回 HTTP 500。
真实调用遵循 API 积分规则。转换失败会返还积分;若转换已完成,随后下载连接中断不会撤销该次成功转换。
查看 API 定价与积分参考资料与格式规范
格式参考资料用于说明底层语法;上方转换规则与样例描述 TableConvert 的实际实现。