Skip to content

markdown ​

Description ​

A pipe-delimited Markdown table with column names and an alignment row. This is output-only.

Output only. Select it with FORMAT markdown. Names ignore ASCII case; use the snake_case name shown here.

The first row contains column labels and the next row defines table alignment. Each subsequent row contains rendered values between pipes.

This output is intended for a Markdown reader. It carries display text rather than a lossless typed import representation, and has no input decoder.

text
SELECT expressions FORMAT markdown;

Example usage ​

sql
SELECT CAST(7 AS Int64) AS id, 'Ada' AS name FORMAT markdown;
text
| id | name |
|-:|:-|
| 7 | Ada |

Format settings ​

Use a statement SETTINGS clause; these options are not persisted by SET.

Setting Type Default Meaning
markdown_escape_special_characters Bool 0 Escape ASCII punctuation in text and byte-string values with a backslash; when off, escape controls, backslashes, and single quotes.