SQL INSERT文本 转 Markdown表格 API

代码示例

这些示例以 multipart/form-data 发送样例，并原样保存响应字节。请先设置环境变量 TABLECONVERT_API_KEY。

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/sql-to-markdown' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=CREATE TABLE records (task TEXT, owner TEXT, status TEXT);
INSERT INTO records VALUES ('\''Write docs'\'', '\''Alice'\'', '\''Done'\'');
INSERT INTO records VALUES ('\''Review API'\'', '\''Bob'\'', '\''Pending'\'');' \
  --form-string 'output[escape]=false' \
  --form-string 'output[pretty]=true' \
  --form-string 'output[boldFirstRow]=false' \
  --form-string 'output[boldFirstColumn]=false' \
  --form-string 'output[firstHeader]=true' \
  --form-string 'output[align]=l' \
  --form-string 'output[simple]=false' \
  --form-string 'output[multilineHandling]=preserve' \
  --form-string 'output[includeLineNumbers]=false' \
  --output 'sql-to-markdown.md'

import os
from pathlib import Path
import requests

endpoint = "https://api.tableconvert.com/v2/convert/sql-to-markdown"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
    "data": (None, "CREATE TABLE records (task TEXT, owner TEXT, status TEXT);\nINSERT INTO records VALUES ('Write docs', 'Alice', 'Done');\nINSERT INTO records VALUES ('Review API', 'Bob', 'Pending');"),
    "output[escape]": (None, "false"),
    "output[pretty]": (None, "true"),
    "output[boldFirstRow]": (None, "false"),
    "output[boldFirstColumn]": (None, "false"),
    "output[firstHeader]": (None, "true"),
    "output[align]": (None, "l"),
    "output[simple]": (None, "false"),
    "output[multilineHandling]": (None, "preserve"),
    "output[includeLineNumbers]": (None, "false"),
}

response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("sql-to-markdown.md").write_bytes(response.content)

import { writeFile } from "node:fs/promises";

const form = new FormData();
form.set("data", "CREATE TABLE records (task TEXT, owner TEXT, status TEXT);\nINSERT INTO records VALUES ('Write docs', 'Alice', 'Done');\nINSERT INTO records VALUES ('Review API', 'Bob', 'Pending');");
form.set("output[escape]", "false");
form.set("output[pretty]", "true");
form.set("output[boldFirstRow]", "false");
form.set("output[boldFirstColumn]", "false");
form.set("output[firstHeader]", "true");
form.set("output[align]", "l");
form.set("output[simple]", "false");
form.set("output[multilineHandling]", "preserve");
form.set("output[includeLineNumbers]", "false");

const response = await fetch("https://api.tableconvert.com/v2/convert/sql-to-markdown", {
  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-markdown.md", Buffer.from(await response.arrayBuffer()));

请求参数

将受支持的INSERT语句及其列清单按表格文本解析；API不会在数据库中执行SQL。

使用 data、file 或 url 提供一种输入来源。页面示例使用适合该格式的来源模式。

输出选项

为文档生成竖线分隔的Markdown表格；对齐与格式选项作用于表格文本，不渲染完整文档。

转换规则

输入读取方式

• 为获得可预期的列映射，请使用明确的INSERT列清单与受支持的值元组。
• 这里进行文本解析，不求值任意SQL查询，也不迁移schema或访问数据库。
• 导入前请处理计算表达式、方言专用字面量与复杂转储。
• 提取后可能需要清理带引号的标识符文本与源字面量语义；请核对null和转义。

输出生成方式

• 通常首行用作表头，也可选择其他表头安排。
• 请转义字面竖线，并根据Markdown渲染器选择multilineHandling。
• GFM竖线表格属于扩展，并非所有Markdown实现都支持。

适用场景

响应与错误

重试前请先检查响应。新的 HTTP 请求属于新的转换，可能再次消耗积分。

限制、计费与版本

本地预览最多接受 200 KB。当前 API 实现允许上传一个不超过 50 MiB 的文件，multipart 中每个文本字段限制为 1 MiB，v2 转换任务的截止时间为 30 秒。部署环境可能设置更严格的限制。重试前请先检查错误内容；部分解析或渲染失败会返回 HTTP 500。

真实调用遵循 API 积分规则。转换失败会返还积分；若转换已完成，随后下载连接中断不会撤销该次成功转换。

参考资料与格式规范

格式参考资料用于说明底层语法；上方转换规则与样例描述 TableConvert 的实际实现。

• www.postgresql.org
• github.github.com