Things to check before integrating
Before you integrate
Remove terminal prompts, row counts and wrapped lines; keep the printed column header.
Before you integrate
Duplicate keys and per-cell type parsing can change values or discard columns in object layouts.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
MySQL query result to JSON records API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/mysql-to-json' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=+-----+-------+--------+
| id | name | active |
+-----+-------+--------+
| 101 | Alice | true |
| 102 | Bob | false |
+-----+-------+--------+
' \
--form-string 'output[parsingJSON]=false' \
--form-string 'output[minify]=false' \
--form-string 'output[format]=object' \
--form-string 'output[indentSize]=2' \
--form-string 'output[rootName]=' \
--output 'mysql-to-json.json'Requires cURL. Download the sample input first when this example uploads a file.
MySQL query result to JSON records API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/mysql-to-json"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "+-----+-------+--------+\n| id | name | active |\n+-----+-------+--------+\n| 101 | Alice | true |\n| 102 | Bob | false |\n+-----+-------+--------+\n"),
"output[parsingJSON]": (None, "false"),
"output[minify]": (None, "false"),
"output[format]": (None, "object"),
"output[indentSize]": (None, "2"),
"output[rootName]": (None, ""),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("mysql-to-json.json").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
MySQL query result to JSON records API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "+-----+-------+--------+\n| id | name | active |\n+-----+-------+--------+\n| 101 | Alice | true |\n| 102 | Bob | false |\n+-----+-------+--------+\n");
form.set("output[parsingJSON]", "false");
form.set("output[minify]", "false");
form.set("output[format]", "object");
form.set("output[indentSize]", "2");
form.set("output[rootName]", "");
const response = await fetch("https://api.tableconvert.com/v2/convert/mysql-to-json", {
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("mysql-to-json.json", 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
This source means copied MySQL terminal table output, not a live database connection. Border lines are removed and visible cell text is parsed.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline MySQL table content. Choose one of data, file or url. |
file | binary | — | Upload a txt 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 JSON from the first-row header and data grid, or choose an alternate array layout. Optional cell parsing changes value representation and needs deliberate type review.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[parsingJSON] | boolean | false | Try JSON parsing for each cell; disable it to retain text such as identifiers with significant zeros. |
output[minify] | boolean | false | Reduce generated layout whitespace; inspect any format-specific effects on cell content. |
output[format] | string | object | Choose object, two-dimensional, column-oriented or keyed JSON layout; each uses the first row differently. |
output[indentSize] | number | 2 | Set generated text indentation; it controls formatting rather than data types. |
output[rootName] | string | Empty string | Wrap the JSON result in an object under this property name. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | The MySQL CLI border is stripped and its printed header and rows become plain cells. |
| Mapping rule 2 | The default layout maps header names to row values; alternate layouts change that mapping. |
| Mapping rule 3 | The printed header supplies record keys, while NULL remains display text unless deliberately remapped; no database connection occurs. |
How the input is read
- Paste the bordered text table returned by the MySQL command-line client.
- No database host, password, query execution or connection is required or performed.
- Remove row-count messages, prompts and wrapped terminal output before conversion.
- Printed NULL values and numeric-looking cells are text; database column types are not available from the terminal rendering.
How the output is written
- The default object layout uses header values as property names and excludes the header from data records.
- Duplicate header names can overwrite properties in object layouts; choose unique names.
- parsingJSON attempts JSON parsing per cell; keep it off to preserve textual identifiers.
When to use this API
This conversion in practice
Use a copied MySQL CLI query result as the starting dataset for an application JSON payload or fixture. Remove terminal prompts, row counts and wrapped lines; keep the printed column header.
JSON records
Expose a flat dataset as API-ready records or a deterministic integration fixture.
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.