MySQL query result to AsciiDoc table API

Code examples

These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/mysql-to-asciidoc' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=+---------+--------------+-------+
| chapter | topic        | pages |
+---------+--------------+-------+
| 1       | Introduction | 8     |
| 2       | Installation | 12    |
+---------+--------------+-------+
' \
  --form-string 'output[minify]=false' \
  --form-string 'output[firstHeader]=true' \
  --form-string 'output[lastFooter]=false' \
  --form-string 'output[title]=' \
  --output 'mysql-to-asciidoc.adoc'

import os
from pathlib import Path
import requests

endpoint = "https://api.tableconvert.com/v2/convert/mysql-to-asciidoc"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
    "data": (None, "+---------+--------------+-------+\n| chapter | topic        | pages |\n+---------+--------------+-------+\n| 1       | Introduction | 8     |\n| 2       | Installation | 12    |\n+---------+--------------+-------+\n"),
    "output[minify]": (None, "false"),
    "output[firstHeader]": (None, "true"),
    "output[lastFooter]": (None, "false"),
    "output[title]": (None, ""),
}

response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("mysql-to-asciidoc.adoc").write_bytes(response.content)

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

const form = new FormData();
form.set("data", "+---------+--------------+-------+\n| chapter | topic        | pages |\n+---------+--------------+-------+\n| 1       | Introduction | 8     |\n| 2       | Installation | 12    |\n+---------+--------------+-------+\n");
form.set("output[minify]", "false");
form.set("output[firstHeader]", "true");
form.set("output[lastFooter]", "false");
form.set("output[title]", "");

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

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.

Send one source: data, file, or url. The examples below use the source mode appropriate for this format.

Output options

Generate an AsciiDoc table block for technical documentation. Header, footer and title settings control the table markup rather than rendering a document.

Conversion rules

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 output uses an AsciiDoc table boundary and cell separators.
• Choose firstHeader and lastFooter according to the meaning of the first and last rows.
• Check literal pipe characters and multiline text in the Asciidoctor renderer you use.

When to use this API

Responses and errors

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.

References and format specifications

Format references explain the underlying syntax. The conversion rules and samples above describe TableConvert’s implementation.

• dev.mysql.com
• docs.asciidoctor.org