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.
| Column | Type | Description |
|---|---|---|
doc_path | String | Path 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_title | String | HTML <title> of the page |
h1 | String | Text of the first <h1> heading |
breadcrumb | String | Slash-joined navigation path, e.g. SQL Reference / Functions |
breadcrumb_array | Array(String) | breadcrumb split into an array — useful for arrayElement and ARRAY JOIN |
breadcrumb_depth | UInt8 MATERIALIZED | Length of breadcrumb_array |
nav_title | String MATERIALIZED | Last element of breadcrumb_array — the short label used in sidebar navigation |
sidebar | String | Top-level sidebar section, e.g. Use Cases or SQL Reference |
position | UInt16 | Position of the page within its sidebar section |
word_count | UInt32 | Approximate word count of the full page |
h2_headings | Array(String) | All H2 heading texts on the page |
badges | Array(String) | Badge labels present on the page, e.g. experimental, beta, enterprise |
internal_links | Array(String) | Internal links (relative paths to other docs pages) |
external_links | Array(String) | External links (full URLs) found on the page |
scraped_at | DateTime | Timestamp when this page was scraped |
docs_sections
One row per H2 section within a page. Join to docs_pages on doc_path.
| Column | Type | Description |
|---|---|---|
doc_path | String | Page path — foreign key to docs_pages.doc_path |
section_heading | String | Text of the H2 heading for this section |
section_anchor | String | URL anchor ID for this section, e.g. my-section |
section_path | String MATERIALIZED | Path + anchor fragment: doc_path || '#' || section_anchor. Prepend https://clickhouse.com/docs to link directly to the section. |
section_order | UInt16 | Position of this section within the page (0-indexed) |
section_content | String | Markdown content of the section — indexed with ngrambf_v1 for fast LIKE search |
code_blocks | Array(String) | Contents of each fenced code block in the section |
code_languages | Array(String) | Language tags for each code block (parallel array to code_blocks) |
word_count | UInt32 MATERIALIZED | Word 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.
| Column | Type | Description |
|---|---|---|
doc_path | String | Page path — foreign key to docs_pages.doc_path |
badge | LowCardinality(String) | Badge label, e.g. experimental, beta, enterprise |
level | LowCardinality(String) | Where on the page the badge appears: page (after H1), h2, h3, or h4 |
h2_text | String | Text of the H2 heading in scope when the badge was found (empty for page-level badges) |
h2_anchor | String | URL anchor of that H2 heading — append as #anchor to doc_path to link directly to the section |
sub_text | String | Text of the H3 or H4 heading the badge directly follows (empty for page- and H2-level badges) |