Things to check before integrating
Before you integrate
Reduce the input to supported INSERT rows and check quoted identifiers and literal values.
Before you integrate
Unquoted true-like strings, embedded quotes and multiline values can change parsing; validate with the intended YAML parser.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
SQL INSERT to YAML records API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/sql-to-yaml' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=CREATE TABLE records (name TEXT, region TEXT, enabled TEXT);
INSERT INTO records VALUES ('\''frontend'\'', '\''eu'\'', '\''true'\'');
INSERT INTO records VALUES ('\''worker'\'', '\''us'\'', '\''false'\'');' \
--form-string 'output[indentSize]=2' \
--form-string 'output[arrayStyle]=block' \
--form-string 'output[quotationStyle]=none' \
--output 'sql-to-yaml.yaml'Requires cURL. Download the sample input first when this example uploads a file.
SQL INSERT to YAML records API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/sql-to-yaml"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "CREATE TABLE records (name TEXT, region TEXT, enabled TEXT);\nINSERT INTO records VALUES ('frontend', 'eu', 'true');\nINSERT INTO records VALUES ('worker', 'us', 'false');"),
"output[indentSize]": (None, "2"),
"output[arrayStyle]": (None, "block"),
"output[quotationStyle]": (None, "none"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("sql-to-yaml.yaml").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
SQL INSERT to YAML records API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "CREATE TABLE records (name TEXT, region TEXT, enabled TEXT);\nINSERT INTO records VALUES ('frontend', 'eu', 'true');\nINSERT INTO records VALUES ('worker', 'us', 'false');");
form.set("output[indentSize]", "2");
form.set("output[arrayStyle]", "block");
form.set("output[quotationStyle]", "none");
const response = await fetch("https://api.tableconvert.com/v2/convert/sql-to-yaml", {
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-yaml.yaml", Buffer.from(await response.arrayBuffer()));Requires Node.js 20 or later with built-in fetch, FormData and Blob.
Authentication
Send Authorization: Bearer YOUR_API_KEY. Let the HTTP client set the multipart boundary; do not set Content-Type manually.
Keep production API keys in server-side environment variables.
Request parameters
Supported INSERT statements and their column lists are parsed as table text. The API does not execute SQL against a database.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline SQL table content. Choose one of data, file or url. |
file | binary | — | Upload a sql file using multipart/form-data. |
url | string | — | A supported publicly accessible HTTP or HTTPS file URL. |
Send one source: data, file, or url. The examples below use the source mode appropriate for this format.
Output options
Generate a YAML sequence of row mappings with block or flow layout. Quoting and scalar interpretation require review in the consuming parser.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[indentSize] | string | 2 | Set generated text indentation; it controls formatting rather than data types. |
output[arrayStyle] | string | block | Use block or flow style for the YAML sequence and mappings. |
output[quotationStyle] | string | none | Choose YAML scalar quotation style; validate embedded quotes and multiline values separately. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | Supported INSERT column names and value tuples become a header and data rows without SQL execution. |
| Mapping rule 2 | Header names become mapping keys and each data row becomes one sequence entry. |
| Mapping rule 3 | INSERT column lists become record keys and tuples become rows; the result represents parsed values, not a database query result or schema migration. |
How the input is read
- Use explicit INSERT column lists and supported value tuples for predictable column mapping.
- This is text parsing, not arbitrary SQL query evaluation, schema migration or database access.
- Prepare computed expressions, dialect-specific literals and complex dumps before importing.
- Quoted identifier text and source literal semantics may need cleanup after extraction; verify nulls and escaping.
How the output is written
- Header names become mapping keys and data rows become sequence entries.
- Choose indentation, arrayStyle and quotationStyle for your destination workflow.
- The generator is not a complete YAML quoting engine; validate colons, quotes, multiline values and boolean-like strings.
When to use this API
This conversion in practice
Use a supported SQL INSERT export as the starting dataset for a YAML configuration or data fixture. Reduce the input to supported INSERT rows and check quoted identifiers and literal values.
YAML records
Draft a small configuration or data fixture for a YAML-consuming tool.
Responses and errors
| HTTP status | Description |
|---|---|
200 | text/plain; charset=utf-8 |
400 | Invalid input or conversion parameters. |
402 | Insufficient credits for this request. |
403 | Missing or invalid API key. |
413 | The input exceeds the configured request limit. |
415 | Unsupported input media type. |
429 | Rate limit exceeded. |
500 | The conversion could not be completed. |
503 | The renderer is unavailable or the request timed out. |
Check the response before retrying. A new HTTP request is a new conversion and may use credits again.
Limits, billing and versions
Local previews accept up to 200 KB. The current API implementation allows one uploaded file up to 50 MiB, limits each multipart text field to 1 MiB, and gives v2 conversion tasks a 30-second deadline. Deployment limits may be stricter. Read the returned error before retrying; some parser or renderer failures return HTTP 500.
Live calls follow the API credit policy. Failed conversions are refunded; a completed conversion is not undone if the download connection later fails.
View API pricing and creditsUsing API v1?
This page documents v2, which returns the output directly. API v1 wraps the result in a JSON envelope. Check the overview before changing an existing integration.
API overviewReferences and format specifications
Format references explain the underlying syntax. The conversion rules and samples above describe TableConvert’s implementation.