Skip to main content
La page de recherche dans la documentation est une petite interface web autonome qui permet d’effectuer une recherche instantanée dans la documentation de référence intégrée. Elle est accessible sur n’importe quel port HTTP de ClickHouse, au path /docs. Accédez à /docs sur n’importe quel port HTTP de ClickHouse (par exemple, http://localhost:8123/docs) pour l’ouvrir.

​
Ce que fait cette page

La page interroge la table system.documentation via HTTP à mesure que vous tapez, et affiche le Markdown de l’entité sélectionnée. Comme elle lit system.documentation, elle couvre toutes les entités exposées par cette table — fonctions, fonctions d’agrégation, fonctions de table, moteurs de table, moteurs de base de données, types de données, paramètres, formats, codecs de compression, événements de profil, métriques, les tables système elles-mêmes, etc. — et correspond toujours à la documentation intégrée au serveur en cours d’exécution. Saisissez du texte dans la zone de recherche et les résultats apparaissent dans une liste à code couleur selon le type ; la sélection d’un résultat affiche sa documentation. Le rendu comprend :
  • un lien en forme de crayon à côté du titre de l’entité, qui ouvre son fichier source sur GitHub, d’après la colonne source de system.documentation ;
  • la coloration syntaxique ClickHouse SQL des blocs de code, à l’aide du même lexer intégré (Lexer.wasm) que l’interface /play ;
  • les formules TeX via KaTeX (par exemple, la formule de la page corr) ;
  • les encadrés :::note/:::tip/…, des ancres de titre avec liens partageables, et un bouton « Copy » au survol des blocs de code ;
  • les liens relatifs, résolus dans l’application vers une autre entité documentée lorsqu’elle existe, sinon vers https://clickhouse.com/docs ; les références « Related » et « Alias of » deviennent des liens internes à l’application.
Le terme de recherche actuel, l’entité ouverte et la section sont répercutés dans le fragment de l’URL, de sorte qu’il est possible de créer un lien direct vers une page ou une section précise, qui sera également restaurée via la navigation précédent/suivant du navigateur. Un sélecteur de thème clair/sombre (avec détection automatique) s’aligne sur /play.

​
Connexion

L’en-tête comporte des champs URL, user et password, exactement comme /play. Lorsque la page est servie par ClickHouse, l’URL correspond par défaut à l’origine actuelle ; lorsque la page est ouverte en tant que fichier local, elle correspond par défaut à http://localhost:8123/, ce qui permet aussi d’ouvrir la page localement tout en se connectant à un serveur distant. Le cache des noms de liens croisés est automatiquement reconstruit lorsque la connexion change.

​
Ressources

Toutes les ressources — y compris le moteur de rendu Markdown (Marked), le moteur de rendu mathématique (KaTeX, avec ses polices) et l’analyseur lexical SQL — sont servies directement par le binaire ClickHouse lui-même lorsque la page est servie en HTTP. Aucun CDN tiers n’est chargé depuis l’origine HTTP de ClickHouse ; la page est donc autonome, fonctionne hors ligne et n’exécute pas de code réseau tiers en même temps que les identifiants qu’elle traite.

​
Considérations de sécurité

La page envoie des requêtes à l’endpoint HTTP de ClickHouse avec les identifiants saisis dans l’en-tête ; les mêmes précautions que pour le protocole HTTP s’appliquent donc ici :
  • Servez toujours /docs via HTTPS dans les environnements non fiables afin de protéger les identifiants.
  • Restreignez l’accès au niveau du réseau (pare-feu, proxy inverse ou configuration listen_host) de la même manière que vous restreignez l’accès au protocole HTTP.
system.documentation contient uniquement la documentation de référence statique intégrée au serveur ; la page n’expose donc aucune donnée de vos tables.
Dernière modification le 23 juillet 2026