Schema Reference

The three ClickHouse tables powering this site. All join on doc_path.

docs_pages

One row per documentation page. The primary key is doc_path.

ColumnTypeDescription
doc_pathStringPath portion of the page URL with /docs prefix stripped, e.g. /migrations/postgresql/dataset. Prepend https://clickhouse.com/docs to get the full URL.
page_titleStringHTML <title> of the page
h1StringText of the first <h1> heading
breadcrumbStringSlash-joined navigation path, e.g. SQL Reference / Functions
breadcrumb_arrayArray(String)breadcrumb split into an array — useful for arrayElement and ARRAY JOIN
breadcrumb_depthUInt8 MATERIALIZEDLength of breadcrumb_array
nav_titleString MATERIALIZEDLast element of breadcrumb_array — the short label used in sidebar navigation
sidebarStringTop-level sidebar section, e.g. Use Cases or SQL Reference
positionUInt16Position of the page within its sidebar section
word_countUInt32Approximate word count of the full page
h2_headingsArray(String)All H2 heading texts on the page
badgesArray(String)Badge labels present on the page, e.g. experimental, beta, enterprise
internal_linksArray(String)Internal links (relative paths to other docs pages)
external_linksArray(String)External links (full URLs) found on the page
scraped_atDateTimeTimestamp when this page was scraped

docs_sections

One row per H2 section within a page. Join to docs_pages on doc_path.

ColumnTypeDescription
doc_pathStringPage path — foreign key to docs_pages.doc_path
section_headingStringText of the H2 heading for this section
section_anchorStringURL anchor ID for this section, e.g. my-section
section_pathString MATERIALIZEDPath + anchor fragment: doc_path || '#' || section_anchor. Prepend https://clickhouse.com/docs to link directly to the section.
section_orderUInt16Position of this section within the page (0-indexed)
section_contentStringMarkdown content of the section — indexed with ngrambf_v1 for fast LIKE search
code_blocksArray(String)Contents of each fenced code block in the section
code_languagesArray(String)Language tags for each code block (parallel array to code_blocks)
word_countUInt32 MATERIALIZEDWord count of section_content

docs_badges

One row per badge occurrence. A single page may contribute multiple rows if the badge appears at different heading levels. Join to docs_pages on doc_path.

ColumnTypeDescription
doc_pathStringPage path — foreign key to docs_pages.doc_path
badgeLowCardinality(String)Badge label, e.g. experimental, beta, enterprise
levelLowCardinality(String)Where on the page the badge appears: page (after H1), h2, h3, or h4
h2_textStringText of the H2 heading in scope when the badge was found (empty for page-level badges)
h2_anchorStringURL anchor of that H2 heading — append as #anchor to doc_path to link directly to the section
sub_textStringText of the H3 or H4 heading the badge directly follows (empty for page- and H2-level badges)