Skip to content

Formatting API

Utilities for converting complex outputs to clean Markdown.

SQL Result

maticlib.core.formatting.sql_result.format_as_markdown_table 

format_as_markdown_table(columns, rows)

Converts database columns and rows into a beautifully formatted Markdown table.

Parameters:

Name Type Description Default
columns List[str]

A list of column names.

 required
rows List[Tuple]

A list of tuple rows returned by the database.

 required

Returns:

Type Description
str

A valid Markdown table string.
Source code in maticlib/core/formatting/sql_result.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def format_as_markdown_table(columns: List[str], rows: List[Tuple]) -> str:
    """
    Converts database columns and rows into a beautifully formatted Markdown table.

    Args:
        columns: A list of column names.
        rows: A list of tuple rows returned by the database.

    Returns:
        A valid Markdown table string.
    """
    if not columns:
        return ""

    # Header row
    header = "| " + " | ".join(str(c) for c in columns) + " |"
    # Separator row
    separator = "| " + " | ".join(["---"] * len(columns)) + " |"

    # Data rows
    data_lines = []
    for r in rows:
        row_str = (
            "| " + " | ".join(str(v) if v is not None else "NULL" for v in r) + " |"
        )
        data_lines.append(row_str)

    return "\n".join([header, separator] + data_lines)