ClickHouse documents itself

ClickHouse
413 views •

ClickHouse's documentation doesn't just live on our website, it ships with the product too. You can look things up with the help command in the terminal, browse everything in a built-in docs UI, or query the system tables underneath it all. In this video, we try all three with clickhouse local, no server required. 🔸 help bar, help session_query_ids_history_size and other lookups right in the terminal 🔸 Typo suggestions when you get a name slightly wrong 🔸 Serving the docs UI from clickhouse local with SYSTEM START LISTEN HTTP 🔸 Searching, copying code and following links in the docs UI 🔸 Querying system.documentation, system.functions and system.settings directly ⏱️ Chapters 0:00 Intro 0:12 The help command in clickhouse local 1:04 Starting the HTTP server with SYSTEM START LISTEN HTTP 1:19 Searching the docs web UI 1:51 The system.documentation table 2:31 system.functions and system.settings 2:59 system.settings_changes and other system tables 3:15 Wrap up 🔗 Links system.documentation: https://clickhouse.com/docs/operations/system-tables/documentation system.functions: https://clickhouse.com/docs/operations/system-tables/functions system.settings: https://clickhouse.com/docs/operations/system-tables/settings system.settings_changes: https://clickhouse.com/docs/operations/system-tables/settings_changes clickhouse-local: https://clickhouse.com/docs/operations/utilities/clickhouse-local

Keyboard shortcuts

On. Switch them off if they collide with your assistive tools; ? still opens this sheet.

Go to

Press g then the letter.

  • gh Latest
  • gs Sources
  • gm Media
  • gv Videos
  • gp Podcasts
  • gc Calendar
  • gd Decoder
  • gz Dataviz
  • ga Datasets
  • gb Blog
  • gk Markets
  • gj Careers
  • gn Prompt Notebook

On this page

  • / Focus search, where there is one
  • t Back to top
  • ? This list
  • Esc Close