{
"message": "Unauthorized access. API key is missing or invalid."
}
{
"message": "NOT_FOUND: Alert not found"
}
{
"message": "Source not found"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"ClickHouse Documentation","colors":{"primary":"#1c1c1c","light":"#333431","dark":"#fdff75"},"logo":{"light":"https://mintcdn.com/private-7c7dfe99/h2VHbIjccjT9ClSc/_site/logo/light.svg?fit=max\u0026auto=format\u0026n=h2VHbIjccjT9ClSc\u0026q=85\u0026s=b8a838f982def2b530a95016300bc7ec","dark":"https://mintcdn.com/private-7c7dfe99/h2VHbIjccjT9ClSc/_site/logo/dark.svg?fit=max\u0026auto=format\u0026n=h2VHbIjccjT9ClSc\u0026q=85\u0026s=563dcf3fc5bb3694597dec207c9b4ecf"},"favicon":"https://mintcdn.com/private-7c7dfe99/h2VHbIjccjT9ClSc/_site/favicon.svg?fit=max\u0026auto=format\u0026n=h2VHbIjccjT9ClSc\u0026q=85\u0026s=9a2d9de19e9259c4b5260fa5bfa26851","appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#151515"}},"navbar":{},"fonts":{"family":"Inter"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"clarity":{"projectId":"xgummrwgj9"},"gtm":{"tagId":"GTM-WTNTDT7W"}},"contextual":{"options":["copy","view","download-pdf",{"title":"Set up the ClickHouse documentation MCP server","description":"Setup instructions for the ClickHouse documentation MCP server","icon":"/images/icons/icon-mcp.svg","href":"https://clickhouse.com/docs/resources/support-center/knowledge-base/setup-installation/set-up-clickhouse-documentation-mcp-server"}],"display":"toc"},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"variables":{"airgap_server_tag":"26.4.1.2739","airgap_keeper_tag":"26.2.1.258","airgap_operator_tag":"1.22992.1","airgap_cr_helm_tag":"1.11.11","airgap_api_tag":"1.175.4","airgap_api_helm_tag":"1.175.4","airgap_preflight_chart_tag":"1.38.7","airgap_support_bundle_tag":"1.12.0"},"navigation":{"languages":[{"language":"en","href":""},{"language":"ar","href":"ar"},{"language":"es","href":"es"},{"language":"fr","href":"fr"},{"language":"ja","href":"ja"},{"language":"ko","href":"ko"},{"language":"pt-BR","href":"pt-BR"},{"language":"ru","href":"ru"},{"language":"zh","href":"zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"private-7c7dfe99","hasAudioNarration":false,"actualSubdomain":"private-7c7dfe99","customDomains":["clickhouse.com"],"gitSource":{"_id":"6ad7fa91692c7c940ff17a19","type":"github","owner":"clickhouse","repo":"clickhouse","deployBranch":"master","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea828e4e4a728172b3e938","collectionId":"604e7981-8a8f-46f3-8d90-4c5ef818c8fa","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea828e4e4a728172b3e938"},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":false},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED","enabled":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea828e4e4a728172b3e938","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"Database","count":1753},{"language":"ja","tag":"データベース","count":1737},{"language":"pt-BR","tag":"Banco de dados","count":1737},{"language":"zh","tag":"数据库","count":1737},{"language":"ar","tag":"قاعدة البيانات","count":1736},{"language":"es","tag":"Base de datos","count":1736},{"language":"fr","tag":"Base de données","count":1736},{"language":"ko","tag":"데이터베이스","count":1736},{"language":"ru","tag":"База данных","count":1736},{"language":"en","tag":"Reference","count":1577},{"language":"ar","tag":"المرجع","count":1565},{"language":"es","tag":"Referencia","count":1565},{"language":"fr","tag":"Référence","count":1565},{"language":"ja","tag":"リファレンス","count":1565},{"language":"ko","tag":"참고","count":1565},{"language":"pt-BR","tag":"Referência","count":1565},{"language":"ru","tag":"Справочник","count":1565},{"language":"zh","tag":"参考文档","count":1565},{"language":"en","tag":"Solutions","count":560},{"language":"ar","tag":"الحلول","count":554},{"language":"es","tag":"Soluciones","count":554},{"language":"fr","tag":"Solutions","count":554},{"language":"ja","tag":"ソリューション","count":554},{"language":"ko","tag":"솔루션","count":554},{"language":"pt-BR","tag":"Soluções","count":554},{"language":"ru","tag":"Решения","count":554},{"language":"zh","tag":"解决方案","count":554},{"language":"es","tag":"Configuración","count":531},{"language":"ja","tag":"設定","count":531},{"language":"en","tag":"Settings","count":510},{"language":"ar","tag":"الإعدادات","count":505},{"language":"fr","tag":"Paramètres","count":505},{"language":"ko","tag":"설정","count":505},{"language":"pt-BR","tag":"Configurações","count":505},{"language":"ru","tag":"Настройки","count":505},{"language":"zh","tag":"设置","count":505},{"language":"en","tag":"Functions","count":330},{"language":"ar","tag":"الدوال","count":328},{"language":"es","tag":"Funciones","count":328},{"language":"fr","tag":"Fonctions","count":328},{"language":"ja","tag":"関数","count":328},{"language":"ko","tag":"함수","count":328},{"language":"pt-BR","tag":"Funções","count":328},{"language":"ru","tag":"Функции","count":328},{"language":"zh","tag":"函数","count":328},{"language":"en","tag":"Integrations","count":300},{"language":"ko","tag":"통합","count":296},{"language":"zh","tag":"集成","count":296},{"language":"ar","tag":"التكاملات","count":293},{"language":"es","tag":"Integraciones","count":293},{"language":"fr","tag":"Intégrations","count":293},{"language":"pt-BR","tag":"Integrações","count":293},{"language":"ru","tag":"Интеграции","count":293},{"language":"pt-BR","tag":"Recursos","count":291},{"language":"ja","tag":"インテグレーション","count":268},{"language":"en","tag":"Session Settings","count":261},{"language":"ar","tag":"إعدادات session","count":260},{"language":"es","tag":"Configuración de sesión","count":260},{"language":"fr","tag":"Paramètres de session","count":260},{"language":"ja","tag":"session 設定","count":260},{"language":"ko","tag":"세션 설정","count":260},{"language":"pt-BR","tag":"Configurações de sessão","count":260},{"language":"ru","tag":"Настройки сеанса","count":260},{"language":"zh","tag":"会话设置","count":260},{"language":"en","tag":"ClickHouse Cloud","count":256},{"language":"ar","tag":"ClickHouse Cloud","count":255},{"language":"es","tag":"ClickHouse Cloud","count":255},{"language":"fr","tag":"ClickHouse Cloud","count":255},{"language":"ja","tag":"ClickHouse Cloud","count":255},{"language":"ko","tag":"ClickHouse Cloud","count":255},{"language":"pt-BR","tag":"ClickHouse Cloud","count":255},{"language":"ru","tag":"ClickHouse Cloud","count":255},{"language":"zh","tag":"ClickHouse Cloud","count":255},{"language":"ar","tag":"أدلة إرشادية","count":219},{"language":"en","tag":"Guides","count":219},{"language":"es","tag":"Guías","count":219},{"language":"fr","tag":"Guides","count":219},{"language":"ja","tag":"ガイド","count":219},{"language":"ko","tag":"가이드","count":219},{"language":"pt-BR","tag":"Guias","count":219},{"language":"ru","tag":"Руководства","count":219},{"language":"zh","tag":"指南","count":219},{"language":"ar","tag":"الموارد","count":213},{"language":"en","tag":"Resources","count":213},{"language":"es","tag":"Recursos","count":213},{"language":"fr","tag":"Ressources","count":213},{"language":"ja","tag":"リソース","count":213},{"language":"ko","tag":"자료","count":213},{"language":"ru","tag":"Ресурсы","count":213},{"language":"zh","tag":"资源","count":213},{"language":"default","tag":"Solutions","count":125},{"language":"default","tag":"ClickHouse Cloud","count":125},{"language":"default","tag":"Cloud API","count":83},{"language":"default","tag":"API reference","count":83},{"language":"default","tag":"ClickHouse Private","count":42},{"language":"default","tag":"ClickStack","count":31},{"language":"default","tag":"Service","count":24},{"language":"default","tag":"Organization","count":21},{"language":"default","tag":"Postgres","count":18},{"language":"default","tag":"How-To Guides","count":17}],"searchSettings":{"maxResults":1}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"github-push-net-diff","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"_site/styles.css","href":"/docs/_mintlify/custom/private-7c7dfe99/2a1d0d506d6c7ad1/_site/styles.css"},{"filePath":"snippets/components/Badges/badges_styles.css","content":".ClickHouseSupportedBadge,.betaBadge{background-color:#dbeafe;border-radius:16px;display:flex;align-items:center;padding:5px 12px;color:#1d4ed8;display:inline-flex;margin-right:5px;font-size:.875rem}.betaBadge::before{content:\"β\";flex:0 0 auto;margin-right:8px;font-size:1rem;font-weight:600;line-height:1}.dark a.betaBadge,a.betaBadge{color:#1d4ed8!important;text-decoration:none!important}.dark .betaBadge{background-color:#1e3a6b;color:#93c5fd}.dark a.betaBadge{color:#93c5fd!important}.ClickHouseSupportedBadge{background-color:#faff69;color:#161517}.ClickHouseSupportedIcon{margin-right:8px}.ClickHouseSupportedIcon svg path{fill:#282828}.ClickHouseSupportedBadge a{color:#000}.dark .ClickHouseSupportedBadge{background-color:#faff69;color:#161517}.dark .ClickHouseSupportedBadge a{color:#161517}.dark .ClickHouseSupportedIcon svg path{fill:#161517}.cloudNotSupportedBadge{background-color:#f6e5ff;color:#609;border-radius:16px;display:flex;align-items:center;padding:5px 12px;display:inline-flex;margin-right:5px;font-size:.875rem}.cloudNotSupportedIcon{margin-right:8px}a.cloudNotSupportedBadge{color:#609!important;text-decoration:none!important}.cloudNotSupportedIcon svg path{stroke:#609}.dark .cloudNotSupportedBadge{background-color:#33004d;color:#ecf}.dark a.cloudNotSupportedBadge{color:#ecf!important;text-decoration:none!important}.dark .cloudNotSupportedIcon svg path{stroke:#ecf}.cloudBadge{background-color:#dae6fc;color:#061d48;border-radius:16px;display:flex;align-items:center;padding:5px 12px;display:inline-flex;margin-right:5px;font-size:.875rem}.dark .cloudBadge{background-color:#061d48;color:#dae6fc}.cloudIcon{margin-right:8px}.cloudIcon svg path{stroke:#061d48}.dark .cloudIcon svg path{stroke:#dae6fc}.CommunityMaintainedBadge{background-color:#69afff;border-radius:16px;display:flex;align-items:center;padding:5px 12px;color:#fff;display:inline-flex;margin-right:5px;font-size:.875rem}.CommunityMaintainedIcon{margin-right:8px}.CommunityMaintainedIcon svg path,.dark .CommunityMaintainedIcon svg path{fill:#fff;stroke:none}.CommunityMaintainedBadge a,.CommunityMaintainedBadge svg path{color:#69afff}.dark .CommunityMaintainedBadge{background-color:#69afff;color:#fff}.dark .CommunityMaintainedBadge a{color:#fff}.deprecatedBadge{background-color:#dfdfdf;color:#53575f;border-radius:16px;display:flex;align-items:center;padding:5px 12px;display:inline-flex;margin-right:5px;font-size:.875rem}.deprecatedIcon{margin-right:8px}.dark .deprecatedBadge a,.deprecatedBadge a{color:inherit}.dark .deprecatedBadge{background-color:#414141;color:#e6e7e9}.deprecatedIcon svg path{stroke:#53575f}.dark .deprecatedIcon svg path{stroke:#e6e7e9}.enterprisePlanFeatureContainer{background-color:#f6f7fa;border-radius:4px;border:1px solid #e6e7e9;padding:12px 16px;margin-bottom:8px;font-size:.875rem}.enterprisePlanFeatureContainer p,.scalePlanFeatureContainer p{margin:0;padding:0}.enterprisePlanFeatureBadge,.experimentalBadge{border-radius:16px;display:flex;align-items:center;display:inline-flex;font-size:.875rem}.enterprisePlanFeatureBadge{background-color:#008a0b;border:1px;border-color:#437eef;color:#fff;padding:2px 12px;margin-bottom:8px}.dark .enterprisePlanFeatureContainer{background-color:#1f1f1c;border:1px solid #414141}.dark .enterprisePlanFeatureBadge{background-color:#99ffa1;color:#1f1f1c}.experimentalBadge{background-color:#f3e8ff;color:#6d28d9;padding:5px 12px;margin-right:5px}.experimentalIcon{margin-right:8px}.dark a.experimentalBadge,a.experimentalBadge{color:#6d28d9!important;text-decoration:none!important}.dark .experimentalBadge{background-color:#3b1d6b;color:#d8b4fe}.dark a.experimentalBadge{color:#d8b4fe!important}.experimentalIcon svg path{stroke:#6d28d9}.dark .experimentalIcon svg path{stroke:#d8b4fe}.PartnerBadge{background-color:#990073;border-radius:16px;display:flex;align-items:center;padding:5px 12px;color:#fff;display:inline-flex;margin-right:5px;font-size:.875rem}.PartnerBadgeIcon{margin-right:8px}.PartnerBadgeIcon svg path{fill:#fbc9ef;stroke:#990073}.PartnerBadge a,.PartnerBadge svg path{color:#990073}.dark .PartnerBadge{background-color:#990073;color:#fbeff8}.dark .PartnerBadge a{color:#fbeff8}.dark .PartnerBadgeIcon svg path{fill:#990073;stroke:#fbeff8}.privatePreviewBadge{background-color:#fef3c7;color:#b45309;border-radius:16px;display:flex;align-items:center;padding:5px 12px;display:inline-flex;margin-right:5px;font-size:.875rem}.dark .privatePreviewBadge{background-color:#4b3410;color:#fcd34d}.privatePreviewIcon{margin-right:8px}.privatePreviewIcon svg path{stroke:#b45309}.dark .privatePreviewIcon svg path{stroke:#fcd34d}.publicPreviewBadge{background-color:#dbeafe;border-radius:16px;display:flex;align-items:center;padding:5px 12px;color:#1d4ed8;display:inline-flex;margin-right:5px;font-size:.875rem}.dark .publicPreviewBadge{background-color:#1e3a6b;color:#93c5fd}.scalePlanFeatureContainer{background-color:#f6f7fa;border-radius:4px;border:1px solid #e6e7e9;padding:12px 16px;margin-bottom:8px;font-size:.875rem}.scalePlanFeatureBadge{border-radius:16px;display:flex;align-items:center;display:inline-flex;padding:2px 12px;margin-bottom:8px;font-size:.875rem}.dark .scalePlanFeatureContainer{background-color:#1f1f1c;border:1px solid #414141}.dark .scalePlanFeatureBadge,.scalePlanFeatureBadge{background-color:#1d64ec;color:#fff}"},{"filePath":"snippets/components/ClickStackAnimation/ClickStackAnimation.css","content":"@keyframes fadeInOut{0%,to{opacity:.3}50%{opacity:.8}}.clickstack-animation-wrapper{width:100%;max-width:max-content;transition:opacity .3s ease}.clickstack-animation-inner{transform-origin:top left}.clickstack-grid{display:grid;width:537px;height:537px;grid-template-columns:repeat(3,1fr);grid-template-rows:repeat(3,1fr)}.clickstack-grid-item{position:relative;display:flex;align-items:center;justify-content:center}.clickstack-grid-column{display:flex;flex-direction:column;align-items:center}.clickstack-icon-box{display:flex;width:4rem;height:4rem;align-items:center;justify-content:center;border-radius:.375rem;padding:1rem;flex-shrink:0;border:1px solid rgba(113,113,122,.8);background-color:#171717}.clickstack-svg-absolute{position:absolute}.clickstack-svg-left-center{left:50%;top:50%;transform:translateY(2rem)}.clickstack-svg-right-center{right:50%;top:50%;transform:translateY(2rem)}.clickstack-svg-bottom-left{bottom:50%;left:50%;transform:translateY(-2rem)}.clickstack-svg-bottom-right{bottom:50%;right:50%;transform:translateY(-2rem)}.clickstack-logo-container{position:relative}.clickstack-logo-glow{position:absolute;inset:0;z-index:0;animation:fadeInOut 3s ease-in-out infinite;background-color:rgba(250,255,105,.6);filter:blur(40px)}.clickstack-logo-box{position:absolute;inset:0;z-index:10;display:flex;border-radius:.5rem;border:2px solid #faff69;background-color:#262626;background-image:linear-gradient(to bottom right,rgba(250,255,105,.2),rgba(250,255,105,.4))}.clickstack-logo-svg{margin:auto}:is(.light) .clickstack-logo-glow{display:none}:is(.light) .clickstack-logo-box{border-color:#faff69;background-color:#000;background-image:none}.clickstack-line-bg{stroke:#414141}.clickstack-line-animated{stroke:#faff69}:is(.light) .clickstack-line-bg{stroke:#d4d4d8}:is(.light) .clickstack-line-animated{stroke:#a1a1aa}@media (max-width:767px){.clickstack-animation-wrapper{max-width:400px}.clickstack-grid{width:400px;height:400px}}"}],"page":{"pagePath":"clickstack/api-reference/sources/get-source","slug":"/clickstack/api-reference/sources/get-source","pageMetadata":{"title":"Get Source","description":"Retrieves a specific source by ID","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/sources/{id}","href":"/clickstack/api-reference/sources/get-source","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves a specific source by ID\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Source","description":"Retrieves a specific source by ID","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/sources/{id}","href":"/clickstack/api-reference/sources/get-source","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/private-7c7dfe99/a0ab956a7a3c7ff5/_site/customizations/ask-ai-button.js","/docs/_mintlify/custom/private-7c7dfe99/39eb0ad87fa3adc8/_site/customizations/clickhouse-sql-highlight.js","/docs/_mintlify/custom/private-7c7dfe99/f2f887f569696d41/_site/customizations/clickhouse-sql-lexer-wasm.js","/docs/_mintlify/custom/private-7c7dfe99/564839e4bb02c38e/_site/customizations/custom-footer.js","/docs/_mintlify/custom/private-7c7dfe99/240e3ba1823c3bae/_site/customizations/galaxy.js","/docs/_mintlify/custom/private-7c7dfe99/38fd3c627bad5620/_site/customizations/inkeep-init.js","/docs/_mintlify/custom/private-7c7dfe99/ad7415752a665282/_site/customizations/kapa-init.js","/docs/_mintlify/custom/private-7c7dfe99/c54d4536629b44db/_site/customizations/nav-icon-preload.js","/docs/_mintlify/custom/private-7c7dfe99/10c01e58e00a0bb5/_site/customizations/navbar-cta.js","/docs/_mintlify/custom/private-7c7dfe99/f75dab9369f45602/_site/customizations/raise-issue-link.js","/docs/_mintlify/custom/private-7c7dfe99/a97e716bfafb62fd/_site/customizations/scroll-reset.js","/docs/_mintlify/custom/private-7c7dfe99/bb66ab6ab59dfc53/_site/customizations/settings-legacy-redirect.js","/docs/_mintlify/custom/private-7c7dfe99/0bfa7a5d239909b5/_site/customizations/settings-legacy-routes/format-settings.js","/docs/_mintlify/custom/private-7c7dfe99/e07c37962b288c7e/_site/customizations/settings-legacy-routes/mergetree-settings.js","/docs/_mintlify/custom/private-7c7dfe99/e8b3e9f392506be8/_site/customizations/settings-legacy-routes/server-settings.js","/docs/_mintlify/custom/private-7c7dfe99/7642655cfe306d70/_site/customizations/settings-legacy-routes/session-settings.js","/docs/_mintlify/custom/private-7c7dfe99/3bd87f000900d6e2/_site/customizations/tab-nav.js","/docs/_mintlify/custom/private-7c7dfe99/5c7ce50607c95a70/_site/customizations/webterminal.js","/docs/_mintlify/custom/private-7c7dfe99/7b903fec76456ee0/_site/customizations/cloud-sidebar-ad.js","/docs/_mintlify/custom/private-7c7dfe99/346eac2572f9fb1d/_site/customizations/section-ticker.js"],"openApiReferenceData":{"operation":{"summary":"Get Source","description":"Retrieves a specific source by ID","operationId":"getSource","tags":["Sources"],"parameters":["08b5951c-1e5b-4180-80eb-65d18e31b23a"],"responses":{"200":"50444113-ac7a-4891-86e9-8edce25ce7c8","401":"a8cd43a2-54fd-4849-bab3-114c9346c2bc","403":"cd22a999-a70b-4e91-ab7c-58c55e225ffc","404":"01b68cae-7f70-4065-968a-f2c7000be6b8"},"method":"get","type":"path","servers":["3d05231e-9556-4d83-8a93-081109e93a0a"],"security":["710c4f63-75c7-40a8-8397-187e7617a476"],"path":"/api/v2/sources/{id}","baseUrlOptions":["/"],"title":"Get Source","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"08b5951c-1e5b-4180-80eb-65d18e31b23a":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Source ID","uniqueKey":"","typeLabel":"string"},"description":"Source ID","example":"507f1f77bcf86cd799439011"}},"responses":{"50444113-ac7a-4891-86e9-8edce25ce7c8":{"description":"Successfully retrieved source","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"The source object.","required":["name","kind","connection","from","defaultTableSelectExpression","timestampValueExpression"],"properties":{"name":{"type":"string","description":"Display name for the source.","example":"Logs","isRequired":true,"uniqueKey":"data.oneOf.0.name","typeLabel":"string"},"kind":{"type":"string","enum":["log"],"description":"Source kind discriminator. Must be \"log\" for log sources.","example":"log","isRequired":true,"uniqueKey":"data.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"connection":{"type":"string","description":"ID of the ClickHouse connection used by this source.","example":"507f1f77bcf86cd799439012","isRequired":true,"uniqueKey":"data.oneOf.0.connection","typeLabel":"string"},"from":{"type":"object","required":["databaseName","tableName"],"properties":{"databaseName":{"type":"string","description":"ClickHouse database name","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.0.from.databaseName","typeLabel":"string"},"tableName":{"type":"string","description":"ClickHouse table name","example":"otel_logs","isRequired":true,"uniqueKey":"data.oneOf.0.from.tableName","typeLabel":"string"}},"description":"Database and table location of the source data.","isRequired":true,"uniqueKey":"data.oneOf.0.from","typeLabel":"object"},"defaultTableSelectExpression":{"type":"string","description":"Default columns selected in search results (this can be customized per search later)","example":"Timestamp, ServiceName, SeverityText, Body","isRequired":true,"uniqueKey":"data.oneOf.0.defaultTableSelectExpression","typeLabel":"string"},"timestampValueExpression":{"type":"string","description":"DateTime column or expression that is part of your table's primary key.","example":"Timestamp","isRequired":true,"uniqueKey":"data.oneOf.0.timestampValueExpression","typeLabel":"string"},"id":{"type":"string","readOnly":true,"description":"Unique source ID. Server-generated; ignored if sent in create/update requests.","example":"507f1f77bcf86cd799439011","uniqueKey":"data.oneOf.0.id","typeLabel":"string"},"section":{"type":"string","maxLength":256,"description":"Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.","example":"Billing","uniqueKey":"data.oneOf.0.section","typeLabel":"string"},"disabled":{"oneOf":[{"type":"boolean","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.0.disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.0.disabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.disabled","typeLabel":"boolean | null"},"querySettings":{"oneOf":[{"type":"array","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads","isRequired":true,"uniqueKey":"data.oneOf.0.querySettings.oneOf.0.items.[INDEX].setting","typeLabel":"string"},"value":{"type":"string","description":"Setting value","example":"4","isRequired":true,"uniqueKey":"data.oneOf.0.querySettings.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.querySettings.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.querySettings.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads"},"value":{"type":"string","description":"Setting value","example":"4"}}},"uniqueKey":"data.oneOf.0.querySettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.querySettings","typeLabel":"object[] | null"},"serviceNameExpression":{"oneOf":[{"type":"string","description":"Expression to extract the service name from log rows.","example":"ServiceName","uniqueKey":"data.oneOf.0.serviceNameExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the service name from log rows.","example":"ServiceName","uniqueKey":"data.oneOf.0.serviceNameExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.serviceNameExpression","typeLabel":"string | null"},"serviceVersionExpression":{"oneOf":[{"type":"string","description":"Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')).","example":"ResourceAttributes['service.version']","uniqueKey":"data.oneOf.0.serviceVersionExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')).","example":"ResourceAttributes['service.version']","uniqueKey":"data.oneOf.0.serviceVersionExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.serviceVersionExpression","typeLabel":"string | null"},"severityTextExpression":{"oneOf":[{"type":"string","description":"Expression to extract the severity/log level text.","example":"SeverityText","uniqueKey":"data.oneOf.0.severityTextExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the severity/log level text.","example":"SeverityText","uniqueKey":"data.oneOf.0.severityTextExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.severityTextExpression","typeLabel":"string | null"},"severityNumberExpression":{"oneOf":[{"type":"string","description":"Expression for the numeric OpenTelemetry SeverityNumber (1-24).","example":"SeverityNumber","uniqueKey":"data.oneOf.0.severityNumberExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression for the numeric OpenTelemetry SeverityNumber (1-24).","example":"SeverityNumber","uniqueKey":"data.oneOf.0.severityNumberExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.severityNumberExpression","typeLabel":"string | null"},"bodyExpression":{"oneOf":[{"type":"string","description":"Expression to extract the log message body.","example":"Body","uniqueKey":"data.oneOf.0.bodyExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the log message body.","example":"Body","uniqueKey":"data.oneOf.0.bodyExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.bodyExpression","typeLabel":"string | null"},"eventNameExpression":{"oneOf":[{"type":"string","description":"Expression for the OpenTelemetry log EventName.","example":"EventName","uniqueKey":"data.oneOf.0.eventNameExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression for the OpenTelemetry log EventName.","example":"EventName","uniqueKey":"data.oneOf.0.eventNameExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.eventNameExpression","typeLabel":"string | null"},"eventAttributesExpression":{"oneOf":[{"type":"string","description":"Expression to extract event-level attributes.","example":"LogAttributes","uniqueKey":"data.oneOf.0.eventAttributesExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract event-level attributes.","example":"LogAttributes","uniqueKey":"data.oneOf.0.eventAttributesExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.eventAttributesExpression","typeLabel":"string | null"},"resourceAttributesExpression":{"oneOf":[{"type":"string","description":"Expression to extract resource-level attributes.","example":"ResourceAttributes","uniqueKey":"data.oneOf.0.resourceAttributesExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract resource-level attributes.","example":"ResourceAttributes","uniqueKey":"data.oneOf.0.resourceAttributesExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.resourceAttributesExpression","typeLabel":"string | null"},"displayedTimestampValueExpression":{"oneOf":[{"type":"string","description":"This DateTime column is used to display and order search results.","example":"TimestampTime","uniqueKey":"data.oneOf.0.displayedTimestampValueExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"This DateTime column is used to display and order search results.","example":"TimestampTime","uniqueKey":"data.oneOf.0.displayedTimestampValueExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.displayedTimestampValueExpression","typeLabel":"string | null"},"orderByExpression":{"type":"string","description":"Custom ORDER BY expression that overrides the default ordering. Leave empty to use the auto-detected default.","example":"Timestamp DESC","uniqueKey":"data.oneOf.0.orderByExpression","typeLabel":"string"},"metricSourceId":{"oneOf":[{"type":"string","description":"HyperDX Source for metrics associated with logs. Optional","example":"507f1f77bcf86cd799439013","uniqueKey":"data.oneOf.0.metricSourceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HyperDX Source for metrics associated with logs. Optional","example":"507f1f77bcf86cd799439013","uniqueKey":"data.oneOf.0.metricSourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.metricSourceId","typeLabel":"string | null"},"traceSourceId":{"oneOf":[{"type":"string","description":"HyperDX Source for traces associated with logs. Optional","example":"507f1f77bcf86cd799439014","uniqueKey":"data.oneOf.0.traceSourceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HyperDX Source for traces associated with logs. Optional","example":"507f1f77bcf86cd799439014","uniqueKey":"data.oneOf.0.traceSourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.traceSourceId","typeLabel":"string | null"},"traceIdExpression":{"oneOf":[{"type":"string","description":"Expression to extract the trace ID for correlating logs with traces.","example":"TraceId","uniqueKey":"data.oneOf.0.traceIdExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the trace ID for correlating logs with traces.","example":"TraceId","uniqueKey":"data.oneOf.0.traceIdExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.traceIdExpression","typeLabel":"string | null"},"spanIdExpression":{"oneOf":[{"type":"string","description":"Expression to extract the span ID for correlating logs with traces.","example":"SpanId","uniqueKey":"data.oneOf.0.spanIdExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the span ID for correlating logs with traces.","example":"SpanId","uniqueKey":"data.oneOf.0.spanIdExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.spanIdExpression","typeLabel":"string | null"},"implicitColumnExpression":{"oneOf":[{"type":"string","description":"Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log.","example":"Body","uniqueKey":"data.oneOf.0.implicitColumnExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log.","example":"Body","uniqueKey":"data.oneOf.0.implicitColumnExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.implicitColumnExpression","typeLabel":"string | null"},"knownColumnsListExpression":{"oneOf":[{"type":"string","description":"For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns.","example":"Timestamp, Body, ServiceName","uniqueKey":"data.oneOf.0.knownColumnsListExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns.","example":"Timestamp, Body, ServiceName","uniqueKey":"data.oneOf.0.knownColumnsListExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.knownColumnsListExpression","typeLabel":"string | null"},"useTextIndexForImplicitColumn":{"oneOf":[{"type":"string","enum":["auto","enabled","disabled"],"description":"Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. \"auto\" detects a covering index at query time, \"enabled\" forces text index usage, \"disabled\" forces a LIKE/hasToken fallback.","example":"auto","uniqueKey":"data.oneOf.0.useTextIndexForImplicitColumn.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["auto","enabled","disabled"],"description":"Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. \"auto\" detects a covering index at query time, \"enabled\" forces text index usage, \"disabled\" forces a LIKE/hasToken fallback.","example":"auto","uniqueKey":"data.oneOf.0.useTextIndexForImplicitColumn.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.useTextIndexForImplicitColumn","typeLabel":"enum\u003cstring> | null"},"highlightedTraceAttributeExpressions":{"oneOf":[{"type":"array","description":"Expressions defining trace-level attributes which are displayed in the trace view for the selected trace.","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']","isRequired":true,"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].sqlExpression","typeLabel":"string"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression","typeLabel":"string | null"},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].alias","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Expressions defining trace-level attributes which are displayed in the trace view for the selected trace.","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"}]},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code"}]}}},"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.highlightedTraceAttributeExpressions","typeLabel":"object[] | null"},"highlightedRowAttributeExpressions":{"oneOf":[{"type":"array","description":"Expressions defining row-level attributes which are displayed in the row side panel for the selected row.","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']","isRequired":true,"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].sqlExpression","typeLabel":"string"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression","typeLabel":"string | null"},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].alias","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Expressions defining row-level attributes which are displayed in the row side panel for the selected row.","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"}]},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code"}]}}},"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.highlightedRowAttributeExpressions","typeLabel":"object[] | null"},"materializedViews":{"oneOf":[{"type":"array","description":"Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries.","items":{"type":"object","required":["databaseName","tableName","dimensionColumns","minGranularity","timestampColumn","aggregatedColumns"],"properties":{"databaseName":{"type":"string","description":"Database name for the materialized view","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].databaseName","typeLabel":"string"},"tableName":{"type":"string","description":"Table name for the materialized view","example":"otel_logs_mv_5m","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].tableName","typeLabel":"string"},"dimensionColumns":{"type":"string","description":"Columns which are not pre-aggregated in the materialized view and can be used for filtering and grouping.","example":"ServiceName, SeverityText","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].dimensionColumns","typeLabel":"string"},"minGranularity":{"type":"string","description":"The granularity of the timestamp column: a positive integer followed by a unit (s, m, h, d). Common values: 1s, 15s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 7d, 30d.","pattern":"^\\d+(s|m|h|d)$","example":"5m","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].minGranularity","typeLabel":"string"},"timestampColumn":{"type":"string","description":"Timestamp column name","example":"Timestamp","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].timestampColumn","typeLabel":"string"},"aggregatedColumns":{"type":"array","description":"Columns which are pre-aggregated by the materialized view","items":{"type":"object","required":["mvColumn","aggFn"],"properties":{"aggFn":{"type":"string","description":"Aggregation function (e.g., count, sum, avg)","example":"sum","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].aggFn","typeLabel":"string"},"mvColumn":{"type":"string","description":"Materialized view column name","example":"sum__Duration","isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].mvColumn","typeLabel":"string"},"sourceColumn":{"oneOf":[{"type":"string","description":"Source column name","example":"Duration","uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].sourceColumn.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source column name","example":"Duration","uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].sourceColumn.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].sourceColumn","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns","typeLabel":"object[]"},"minDate":{"oneOf":[{"type":"string","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z","uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].minDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z","uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].minDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX].minDate","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.materializedViews.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries.","items":{"type":"object","required":["databaseName","tableName","dimensionColumns","minGranularity","timestampColumn","aggregatedColumns"],"properties":{"databaseName":{"type":"string","description":"Database name for the materialized view","example":"otel"},"tableName":{"type":"string","description":"Table name for the materialized view","example":"otel_logs_mv_5m"},"dimensionColumns":{"type":"string","description":"Columns which are not pre-aggregated in the materialized view and can be used for filtering and grouping.","example":"ServiceName, SeverityText"},"minGranularity":{"type":"string","description":"The granularity of the timestamp column: a positive integer followed by a unit (s, m, h, d). Common values: 1s, 15s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 7d, 30d.","pattern":"^\\d+(s|m|h|d)$","example":"5m"},"minDate":{"oneOf":[{"type":"string","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z"},{"type":"null","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z"}]},"timestampColumn":{"type":"string","description":"Timestamp column name","example":"Timestamp"},"aggregatedColumns":{"type":"array","description":"Columns which are pre-aggregated by the materialized view","items":{"type":"object","required":["mvColumn","aggFn"],"properties":{"sourceColumn":{"oneOf":[{"type":"string","description":"Source column name","example":"Duration"},{"type":"null","description":"Source column name","example":"Duration"}]},"aggFn":{"type":"string","description":"Aggregation function (e.g., count, sum, avg)","example":"sum"},"mvColumn":{"type":"string","description":"Materialized view column name","example":"sum__Duration"}}}}}},"uniqueKey":"data.oneOf.0.materializedViews.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.materializedViews","typeLabel":"object[] | null"},"metadataMaterializedViews":{"oneOf":[{"type":"object","description":"Configure materialized views for fast field discovery and value autocomplete.","properties":{"keyRollupTable":{"type":"string","description":"ClickHouse table name for the key rollup (field discovery).","example":"otel_logs_key_rollup_15m","uniqueKey":"data.oneOf.0.metadataMaterializedViews.oneOf.0.keyRollupTable","typeLabel":"string"},"kvRollupTable":{"type":"string","description":"ClickHouse table name for the key-value rollup (value autocomplete).","example":"otel_logs_kv_rollup_15m","uniqueKey":"data.oneOf.0.metadataMaterializedViews.oneOf.0.kvRollupTable","typeLabel":"string"},"granularity":{"type":"string","description":"The time granularity of the rollup tables.","example":"15m","uniqueKey":"data.oneOf.0.metadataMaterializedViews.oneOf.0.granularity","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.metadataMaterializedViews.oneOf.0","typeLabel":"object"},{"type":"null","description":"Configure materialized views for fast field discovery and value autocomplete.","properties":{"keyRollupTable":{"type":"string","description":"ClickHouse table name for the key rollup (field discovery).","example":"otel_logs_key_rollup_15m"},"kvRollupTable":{"type":"string","description":"ClickHouse table name for the key-value rollup (value autocomplete).","example":"otel_logs_kv_rollup_15m"},"granularity":{"type":"string","description":"The time granularity of the rollup tables.","example":"15m"}},"uniqueKey":"data.oneOf.0.metadataMaterializedViews.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.metadataMaterializedViews","typeLabel":"object | null"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"object","description":"The source object.","required":["name","kind","connection","from","defaultTableSelectExpression","timestampValueExpression","durationExpression","durationPrecision","traceIdExpression","spanIdExpression","parentSpanIdExpression","spanNameExpression","spanKindExpression"],"properties":{"name":{"type":"string","description":"Display name for the source.","example":"Traces","isRequired":true,"uniqueKey":"data.oneOf.1.name","typeLabel":"string"},"kind":{"type":"string","enum":["trace"],"description":"Source kind discriminator. Must be \"trace\" for trace sources.","example":"trace","isRequired":true,"uniqueKey":"data.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"connection":{"type":"string","description":"ID of the ClickHouse connection used by this source.","example":"507f1f77bcf86cd799439012","isRequired":true,"uniqueKey":"data.oneOf.1.connection","typeLabel":"string"},"from":{"type":"object","required":["databaseName","tableName"],"properties":{"databaseName":{"type":"string","description":"ClickHouse database name","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.1.from.databaseName","typeLabel":"string"},"tableName":{"type":"string","description":"ClickHouse table name","example":"otel_logs","isRequired":true,"uniqueKey":"data.oneOf.1.from.tableName","typeLabel":"string"}},"description":"Database and table location of the source data.","isRequired":true,"uniqueKey":"data.oneOf.1.from","typeLabel":"object"},"defaultTableSelectExpression":{"type":"string","description":"Default columns selected in search results (this can be customized per search later)","example":"Timestamp, SpanName, ServiceName, Duration","isRequired":true,"uniqueKey":"data.oneOf.1.defaultTableSelectExpression","typeLabel":"string"},"timestampValueExpression":{"type":"string","description":"DateTime column or expression defines the start of the span","example":"Timestamp","isRequired":true,"uniqueKey":"data.oneOf.1.timestampValueExpression","typeLabel":"string"},"durationExpression":{"type":"string","description":"Expression to extract span duration.","example":"Duration","isRequired":true,"uniqueKey":"data.oneOf.1.durationExpression","typeLabel":"string"},"durationPrecision":{"type":"integer","minimum":0,"maximum":9,"default":3,"description":"Number of decimal digits in the duration value (e.g., 3 for milliseconds, 6 for microseconds, 9 for nanoseconds).","isRequired":true,"uniqueKey":"data.oneOf.1.durationPrecision","typeLabel":"integer"},"traceIdExpression":{"type":"string","description":"Expression to extract the trace ID.","example":"TraceId","isRequired":true,"uniqueKey":"data.oneOf.1.traceIdExpression","typeLabel":"string"},"spanIdExpression":{"type":"string","description":"Expression to extract the span ID.","example":"SpanId","isRequired":true,"uniqueKey":"data.oneOf.1.spanIdExpression","typeLabel":"string"},"parentSpanIdExpression":{"type":"string","description":"Expression to extract the parent span ID.","example":"ParentSpanId","isRequired":true,"uniqueKey":"data.oneOf.1.parentSpanIdExpression","typeLabel":"string"},"spanNameExpression":{"type":"string","description":"Expression to extract the span name.","example":"SpanName","isRequired":true,"uniqueKey":"data.oneOf.1.spanNameExpression","typeLabel":"string"},"spanKindExpression":{"type":"string","description":"Expression to extract the span kind (e.g., client, server, internal).","example":"SpanKind","isRequired":true,"uniqueKey":"data.oneOf.1.spanKindExpression","typeLabel":"string"},"id":{"type":"string","readOnly":true,"description":"Unique source ID. Server-generated; ignored if sent in create/update requests.","example":"507f1f77bcf86cd799439021","uniqueKey":"data.oneOf.1.id","typeLabel":"string"},"section":{"type":"string","maxLength":256,"description":"Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.","example":"Billing","uniqueKey":"data.oneOf.1.section","typeLabel":"string"},"disabled":{"oneOf":[{"type":"boolean","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.1.disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.1.disabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.disabled","typeLabel":"boolean | null"},"querySettings":{"oneOf":[{"type":"array","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads","isRequired":true,"uniqueKey":"data.oneOf.1.querySettings.oneOf.0.items.[INDEX].setting","typeLabel":"string"},"value":{"type":"string","description":"Setting value","example":"4","isRequired":true,"uniqueKey":"data.oneOf.1.querySettings.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.oneOf.1.querySettings.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.1.querySettings.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads"},"value":{"type":"string","description":"Setting value","example":"4"}}},"uniqueKey":"data.oneOf.1.querySettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.querySettings","typeLabel":"object[] | null"},"logSourceId":{"oneOf":[{"type":"string","description":"HyperDX Source for logs associated with traces. Optional","example":"507f1f77bcf86cd799439011","uniqueKey":"data.oneOf.1.logSourceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HyperDX Source for logs associated with traces. Optional","example":"507f1f77bcf86cd799439011","uniqueKey":"data.oneOf.1.logSourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.logSourceId","typeLabel":"string | null"},"sessionSourceId":{"oneOf":[{"type":"string","description":"HyperDX Source for sessions associated with traces. Optional","example":"507f1f77bcf86cd799439031","uniqueKey":"data.oneOf.1.sessionSourceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HyperDX Source for sessions associated with traces. Optional","example":"507f1f77bcf86cd799439031","uniqueKey":"data.oneOf.1.sessionSourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.sessionSourceId","typeLabel":"string | null"},"metricSourceId":{"oneOf":[{"type":"string","description":"HyperDX Source for metrics associated with traces. Optional","example":"507f1f77bcf86cd799439041","uniqueKey":"data.oneOf.1.metricSourceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HyperDX Source for metrics associated with traces. Optional","example":"507f1f77bcf86cd799439041","uniqueKey":"data.oneOf.1.metricSourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.metricSourceId","typeLabel":"string | null"},"statusCodeExpression":{"oneOf":[{"type":"string","description":"Expression to extract the span status code.","example":"StatusCode","uniqueKey":"data.oneOf.1.statusCodeExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the span status code.","example":"StatusCode","uniqueKey":"data.oneOf.1.statusCodeExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.statusCodeExpression","typeLabel":"string | null"},"statusMessageExpression":{"oneOf":[{"type":"string","description":"Expression to extract the span status message.","example":"StatusMessage","uniqueKey":"data.oneOf.1.statusMessageExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the span status message.","example":"StatusMessage","uniqueKey":"data.oneOf.1.statusMessageExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.statusMessageExpression","typeLabel":"string | null"},"serviceNameExpression":{"oneOf":[{"type":"string","description":"Expression to extract the service name from trace rows.","example":"ServiceName","uniqueKey":"data.oneOf.1.serviceNameExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract the service name from trace rows.","example":"ServiceName","uniqueKey":"data.oneOf.1.serviceNameExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.serviceNameExpression","typeLabel":"string | null"},"serviceVersionExpression":{"oneOf":[{"type":"string","description":"Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')).","example":"ResourceAttributes['service.version']","uniqueKey":"data.oneOf.1.serviceVersionExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')).","example":"ResourceAttributes['service.version']","uniqueKey":"data.oneOf.1.serviceVersionExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.serviceVersionExpression","typeLabel":"string | null"},"sampleRateExpression":{"type":"string","description":"Column or expression for upstream sampling weight (1/N). When set, aggregations (count, avg, sum, quantile) are corrected for sampling. Percentiles use quantileTDigestWeighted, which is an approximation. Leave empty if spans are not sampled.","example":"SampleRate","uniqueKey":"data.oneOf.1.sampleRateExpression","typeLabel":"string"},"resourceAttributesExpression":{"oneOf":[{"type":"string","description":"Expression to extract resource-level attributes.","example":"ResourceAttributes","uniqueKey":"data.oneOf.1.resourceAttributesExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract resource-level attributes.","example":"ResourceAttributes","uniqueKey":"data.oneOf.1.resourceAttributesExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.resourceAttributesExpression","typeLabel":"string | null"},"eventAttributesExpression":{"oneOf":[{"type":"string","description":"Expression to extract event-level attributes.","example":"SpanAttributes","uniqueKey":"data.oneOf.1.eventAttributesExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract event-level attributes.","example":"SpanAttributes","uniqueKey":"data.oneOf.1.eventAttributesExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.eventAttributesExpression","typeLabel":"string | null"},"spanEventsValueExpression":{"oneOf":[{"type":"string","description":"Expression to extract span events. Used to capture events associated with spans. Expected to be Nested ( Timestamp DateTime64(9), Name LowCardinality(String), Attributes Map(LowCardinality(String), String)","example":"Events","uniqueKey":"data.oneOf.1.spanEventsValueExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expression to extract span events. Used to capture events associated with spans. Expected to be Nested ( Timestamp DateTime64(9), Name LowCardinality(String), Attributes Map(LowCardinality(String), String)","example":"Events","uniqueKey":"data.oneOf.1.spanEventsValueExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.spanEventsValueExpression","typeLabel":"string | null"},"spanLinksValueExpression":{"type":"string","description":"Expression to extract span links. Used to capture links from a span to spans in other traces. Expected to be Nested ( TraceId String, SpanId String, TraceState String, Attributes Map(LowCardinality(String), String) )","example":"Links","uniqueKey":"data.oneOf.1.spanLinksValueExpression","typeLabel":"string"},"implicitColumnExpression":{"oneOf":[{"type":"string","description":"Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log.","example":"SpanName","uniqueKey":"data.oneOf.1.implicitColumnExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log.","example":"SpanName","uniqueKey":"data.oneOf.1.implicitColumnExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.implicitColumnExpression","typeLabel":"string | null"},"knownColumnsListExpression":{"oneOf":[{"type":"string","description":"For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns.","example":"Timestamp, Body, ServiceName","uniqueKey":"data.oneOf.1.knownColumnsListExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns.","example":"Timestamp, Body, ServiceName","uniqueKey":"data.oneOf.1.knownColumnsListExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.knownColumnsListExpression","typeLabel":"string | null"},"useTextIndexForImplicitColumn":{"oneOf":[{"type":"string","enum":["auto","enabled","disabled"],"description":"Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. \"auto\" detects a covering index at query time, \"enabled\" forces text index usage, \"disabled\" forces a LIKE/hasToken fallback.","example":"auto","uniqueKey":"data.oneOf.1.useTextIndexForImplicitColumn.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["auto","enabled","disabled"],"description":"Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. \"auto\" detects a covering index at query time, \"enabled\" forces text index usage, \"disabled\" forces a LIKE/hasToken fallback.","example":"auto","uniqueKey":"data.oneOf.1.useTextIndexForImplicitColumn.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.useTextIndexForImplicitColumn","typeLabel":"enum\u003cstring> | null"},"highlightedTraceAttributeExpressions":{"oneOf":[{"type":"array","description":"Expressions defining trace-level attributes which are displayed in the trace view for the selected trace.","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']","isRequired":true,"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].sqlExpression","typeLabel":"string"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression","typeLabel":"string | null"},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX].alias","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Expressions defining trace-level attributes which are displayed in the trace view for the selected trace.","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"}]},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code"}]}}},"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.highlightedTraceAttributeExpressions","typeLabel":"object[] | null"},"highlightedRowAttributeExpressions":{"oneOf":[{"type":"array","description":"Expressions defining row-level attributes which are displayed in the row side panel for the selected row","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']","isRequired":true,"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].sqlExpression","typeLabel":"string"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code","uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].luceneExpression","typeLabel":"string | null"},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code","uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX].alias","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Expressions defining row-level attributes which are displayed in the row side panel for the selected row","items":{"type":"object","required":["sqlExpression"],"properties":{"sqlExpression":{"type":"string","description":"SQL expression for the attribute","example":"SpanAttributes['http.status_code']"},"luceneExpression":{"oneOf":[{"type":"string","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"},{"type":"null","description":"An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value.","example":"http.status_code"}]},"alias":{"oneOf":[{"type":"string","description":"Optional alias for the attribute","example":"HTTP Status Code"},{"type":"null","description":"Optional alias for the attribute","example":"HTTP Status Code"}]}}},"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.highlightedRowAttributeExpressions","typeLabel":"object[] | null"},"displayedTimestampValueExpression":{"type":"string","description":"This DateTime column is used to display and order search results.","example":"Timestamp","uniqueKey":"data.oneOf.1.displayedTimestampValueExpression","typeLabel":"string"},"orderByExpression":{"type":"string","description":"Custom ORDER BY expression that overrides the default ordering. Leave empty to use the auto-detected default.","example":"Timestamp DESC","uniqueKey":"data.oneOf.1.orderByExpression","typeLabel":"string"},"materializedViews":{"oneOf":[{"type":"array","description":"Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries.","items":{"type":"object","required":["databaseName","tableName","dimensionColumns","minGranularity","timestampColumn","aggregatedColumns"],"properties":{"databaseName":{"type":"string","description":"Database name for the materialized view","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].databaseName","typeLabel":"string"},"tableName":{"type":"string","description":"Table name for the materialized view","example":"otel_logs_mv_5m","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].tableName","typeLabel":"string"},"dimensionColumns":{"type":"string","description":"Columns which are not pre-aggregated in the materialized view and can be used for filtering and grouping.","example":"ServiceName, SeverityText","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].dimensionColumns","typeLabel":"string"},"minGranularity":{"type":"string","description":"The granularity of the timestamp column: a positive integer followed by a unit (s, m, h, d). Common values: 1s, 15s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 7d, 30d.","pattern":"^\\d+(s|m|h|d)$","example":"5m","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].minGranularity","typeLabel":"string"},"timestampColumn":{"type":"string","description":"Timestamp column name","example":"Timestamp","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].timestampColumn","typeLabel":"string"},"aggregatedColumns":{"type":"array","description":"Columns which are pre-aggregated by the materialized view","items":{"type":"object","required":["mvColumn","aggFn"],"properties":{"aggFn":{"type":"string","description":"Aggregation function (e.g., count, sum, avg)","example":"sum","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].aggFn","typeLabel":"string"},"mvColumn":{"type":"string","description":"Materialized view column name","example":"sum__Duration","isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].mvColumn","typeLabel":"string"},"sourceColumn":{"oneOf":[{"type":"string","description":"Source column name","example":"Duration","uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].sourceColumn.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source column name","example":"Duration","uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].sourceColumn.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX].sourceColumn","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].aggregatedColumns","typeLabel":"object[]"},"minDate":{"oneOf":[{"type":"string","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z","uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].minDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z","uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].minDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX].minDate","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.1.materializedViews.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries.","items":{"type":"object","required":["databaseName","tableName","dimensionColumns","minGranularity","timestampColumn","aggregatedColumns"],"properties":{"databaseName":{"type":"string","description":"Database name for the materialized view","example":"otel"},"tableName":{"type":"string","description":"Table name for the materialized view","example":"otel_logs_mv_5m"},"dimensionColumns":{"type":"string","description":"Columns which are not pre-aggregated in the materialized view and can be used for filtering and grouping.","example":"ServiceName, SeverityText"},"minGranularity":{"type":"string","description":"The granularity of the timestamp column: a positive integer followed by a unit (s, m, h, d). Common values: 1s, 15s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 7d, 30d.","pattern":"^\\d+(s|m|h|d)$","example":"5m"},"minDate":{"oneOf":[{"type":"string","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z"},{"type":"null","format":"date-time","description":"(Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data.","example":"2025-01-01T00:00:00Z"}]},"timestampColumn":{"type":"string","description":"Timestamp column name","example":"Timestamp"},"aggregatedColumns":{"type":"array","description":"Columns which are pre-aggregated by the materialized view","items":{"type":"object","required":["mvColumn","aggFn"],"properties":{"sourceColumn":{"oneOf":[{"type":"string","description":"Source column name","example":"Duration"},{"type":"null","description":"Source column name","example":"Duration"}]},"aggFn":{"type":"string","description":"Aggregation function (e.g., count, sum, avg)","example":"sum"},"mvColumn":{"type":"string","description":"Materialized view column name","example":"sum__Duration"}}}}}},"uniqueKey":"data.oneOf.1.materializedViews.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.materializedViews","typeLabel":"object[] | null"},"metadataMaterializedViews":{"oneOf":[{"type":"object","description":"Configure materialized views for fast field discovery and value autocomplete.","properties":{"keyRollupTable":{"type":"string","description":"ClickHouse table name for the key rollup (field discovery).","example":"otel_traces_key_rollup_15m","uniqueKey":"data.oneOf.1.metadataMaterializedViews.oneOf.0.keyRollupTable","typeLabel":"string"},"kvRollupTable":{"type":"string","description":"ClickHouse table name for the key-value rollup (value autocomplete).","example":"otel_traces_kv_rollup_15m","uniqueKey":"data.oneOf.1.metadataMaterializedViews.oneOf.0.kvRollupTable","typeLabel":"string"},"granularity":{"type":"string","description":"The time granularity of the rollup tables.","example":"15m","uniqueKey":"data.oneOf.1.metadataMaterializedViews.oneOf.0.granularity","typeLabel":"string"}},"uniqueKey":"data.oneOf.1.metadataMaterializedViews.oneOf.0","typeLabel":"object"},{"type":"null","description":"Configure materialized views for fast field discovery and value autocomplete.","properties":{"keyRollupTable":{"type":"string","description":"ClickHouse table name for the key rollup (field discovery).","example":"otel_traces_key_rollup_15m"},"kvRollupTable":{"type":"string","description":"ClickHouse table name for the key-value rollup (value autocomplete).","example":"otel_traces_kv_rollup_15m"},"granularity":{"type":"string","description":"The time granularity of the rollup tables.","example":"15m"}},"uniqueKey":"data.oneOf.1.metadataMaterializedViews.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.metadataMaterializedViews","typeLabel":"object | null"}},"uniqueKey":"data.oneOf.1","typeLabel":"object"},{"type":"object","description":"The source object.","required":["name","kind","connection","from","metricTables","timestampValueExpression","resourceAttributesExpression"],"properties":{"name":{"type":"string","description":"Display name for the source.","example":"Metrics","isRequired":true,"uniqueKey":"data.oneOf.2.name","typeLabel":"string"},"kind":{"type":"string","enum":["metric"],"description":"Source kind discriminator. Must be \"metric\" for metric sources.","example":"metric","isRequired":true,"uniqueKey":"data.oneOf.2.kind","typeLabel":"enum\u003cstring>"},"connection":{"type":"string","description":"ID of the ClickHouse connection used by this source.","example":"507f1f77bcf86cd799439012","isRequired":true,"uniqueKey":"data.oneOf.2.connection","typeLabel":"string"},"from":{"type":"object","required":["databaseName"],"properties":{"databaseName":{"type":"string","description":"ClickHouse database name","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.2.from.databaseName","typeLabel":"string"},"tableName":{"oneOf":[{"type":"string","description":"ClickHouse table name","example":"otel_metrics_gauge","uniqueKey":"data.oneOf.2.from.tableName.oneOf.0","typeLabel":"string"},{"type":"null","description":"ClickHouse table name","example":"otel_metrics_gauge","uniqueKey":"data.oneOf.2.from.tableName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.from.tableName","typeLabel":"string | null"}},"description":"Database and optional table location of the metric source data.","isRequired":true,"uniqueKey":"data.oneOf.2.from","typeLabel":"object"},"metricTables":{"type":"object","description":"Mapping of metric data types to their respective table names.","properties":{"gauge":{"type":"string","description":"Table containing gauge metrics data","example":"otel_metrics_gauge","uniqueKey":"data.oneOf.2.metricTables.gauge","typeLabel":"string"},"histogram":{"type":"string","description":"Table containing histogram metrics data","example":"otel_metrics_histogram","uniqueKey":"data.oneOf.2.metricTables.histogram","typeLabel":"string"},"sum":{"type":"string","description":"Table containing sum metrics data","example":"otel_metrics_sum","uniqueKey":"data.oneOf.2.metricTables.sum","typeLabel":"string"},"summary":{"type":"string","description":"Table containing summary metrics data. Note - not yet fully supported by HyperDX","example":"otel_metrics_summary","uniqueKey":"data.oneOf.2.metricTables.summary","typeLabel":"string"},"exponential histogram":{"type":"string","description":"Table containing exponential histogram metrics data. Note - not yet fully supported by HyperDX","example":"otel_metrics_exponential_histogram","uniqueKey":"data.oneOf.2.metricTables.exponential histogram","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.2.metricTables","typeLabel":"object"},"timestampValueExpression":{"type":"string","description":"DateTime column or expression that is part of your table's primary key.","example":"TimeUnix","isRequired":true,"uniqueKey":"data.oneOf.2.timestampValueExpression","typeLabel":"string"},"resourceAttributesExpression":{"type":"string","description":"Column containing resource attributes for metrics","example":"ResourceAttributes","isRequired":true,"uniqueKey":"data.oneOf.2.resourceAttributesExpression","typeLabel":"string"},"id":{"type":"string","readOnly":true,"description":"Unique source ID. Server-generated; ignored if sent in create/update requests.","example":"507f1f77bcf86cd799439041","uniqueKey":"data.oneOf.2.id","typeLabel":"string"},"section":{"type":"string","maxLength":256,"description":"Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.","example":"Billing","uniqueKey":"data.oneOf.2.section","typeLabel":"string"},"disabled":{"oneOf":[{"type":"boolean","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.2.disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.2.disabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.disabled","typeLabel":"boolean | null"},"querySettings":{"oneOf":[{"type":"array","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads","isRequired":true,"uniqueKey":"data.oneOf.2.querySettings.oneOf.0.items.[INDEX].setting","typeLabel":"string"},"value":{"type":"string","description":"Setting value","example":"4","isRequired":true,"uniqueKey":"data.oneOf.2.querySettings.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.oneOf.2.querySettings.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.2.querySettings.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads"},"value":{"type":"string","description":"Setting value","example":"4"}}},"uniqueKey":"data.oneOf.2.querySettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.querySettings","typeLabel":"object[] | null"},"logSourceId":{"oneOf":[{"type":"string","description":"HyperDX Source for logs associated with metrics. Optional","example":"507f1f77bcf86cd799439011","uniqueKey":"data.oneOf.2.logSourceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HyperDX Source for logs associated with metrics. Optional","example":"507f1f77bcf86cd799439011","uniqueKey":"data.oneOf.2.logSourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.logSourceId","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.2","typeLabel":"object"},{"type":"object","description":"The source object.","required":["name","kind","connection","from","traceSourceId"],"properties":{"name":{"type":"string","description":"Display name for the source.","example":"Sessions","isRequired":true,"uniqueKey":"data.oneOf.3.name","typeLabel":"string"},"kind":{"type":"string","enum":["session"],"description":"Source kind discriminator. Must be \"session\" for session sources.","example":"session","isRequired":true,"uniqueKey":"data.oneOf.3.kind","typeLabel":"enum\u003cstring>"},"connection":{"type":"string","description":"ID of the ClickHouse connection used by this source.","example":"507f1f77bcf86cd799439012","isRequired":true,"uniqueKey":"data.oneOf.3.connection","typeLabel":"string"},"from":{"type":"object","required":["databaseName","tableName"],"properties":{"databaseName":{"type":"string","description":"ClickHouse database name","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.3.from.databaseName","typeLabel":"string"},"tableName":{"type":"string","description":"ClickHouse table name","example":"otel_logs","isRequired":true,"uniqueKey":"data.oneOf.3.from.tableName","typeLabel":"string"}},"description":"Database and table location of the source data.","isRequired":true,"uniqueKey":"data.oneOf.3.from","typeLabel":"object"},"traceSourceId":{"type":"string","description":"HyperDX Source for traces associated with sessions.","example":"507f1f77bcf86cd799439021","isRequired":true,"uniqueKey":"data.oneOf.3.traceSourceId","typeLabel":"string"},"id":{"type":"string","readOnly":true,"description":"Unique source ID. Server-generated; ignored if sent in create/update requests.","example":"507f1f77bcf86cd799439031","uniqueKey":"data.oneOf.3.id","typeLabel":"string"},"section":{"type":"string","maxLength":256,"description":"Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.","example":"Billing","uniqueKey":"data.oneOf.3.section","typeLabel":"string"},"disabled":{"oneOf":[{"type":"boolean","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.3.disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.3.disabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.disabled","typeLabel":"boolean | null"},"querySettings":{"oneOf":[{"type":"array","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads","isRequired":true,"uniqueKey":"data.oneOf.3.querySettings.oneOf.0.items.[INDEX].setting","typeLabel":"string"},"value":{"type":"string","description":"Setting value","example":"4","isRequired":true,"uniqueKey":"data.oneOf.3.querySettings.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.oneOf.3.querySettings.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.3.querySettings.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads"},"value":{"type":"string","description":"Setting value","example":"4"}}},"uniqueKey":"data.oneOf.3.querySettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.querySettings","typeLabel":"object[] | null"},"timestampValueExpression":{"oneOf":[{"type":"string","description":"DateTime column or expression that is part of your table's primary key.","example":"TimestampTime","uniqueKey":"data.oneOf.3.timestampValueExpression.oneOf.0","typeLabel":"string"},{"type":"null","description":"DateTime column or expression that is part of your table's primary key.","example":"TimestampTime","uniqueKey":"data.oneOf.3.timestampValueExpression.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.3.timestampValueExpression","typeLabel":"string | null"},"resourceAttributesExpression":{"type":"string","description":"Expression to extract resource-level attributes.","example":"ResourceAttributes","uniqueKey":"data.oneOf.3.resourceAttributesExpression","typeLabel":"string"}},"uniqueKey":"data.oneOf.3","typeLabel":"object"},{"type":"object","description":"The source object.","required":["name","kind","connection","from","timestampValueExpression"],"properties":{"name":{"type":"string","description":"Display name for the source.","example":"Prometheus Metrics","isRequired":true,"uniqueKey":"data.oneOf.4.name","typeLabel":"string"},"kind":{"type":"string","enum":["promql"],"description":"Source kind discriminator. Must be \"promql\" for PromQL sources.","example":"promql","isRequired":true,"uniqueKey":"data.oneOf.4.kind","typeLabel":"enum\u003cstring>"},"connection":{"type":"string","description":"ID of the connection used by this source. Either a ClickHouse connection holding the TimeSeries table, or a Prometheus-compatible connection.","example":"507f1f77bcf86cd799439012","isRequired":true,"uniqueKey":"data.oneOf.4.connection","typeLabel":"string"},"from":{"type":"object","required":["databaseName","tableName"],"properties":{"databaseName":{"type":"string","description":"ClickHouse database name","example":"otel","isRequired":true,"uniqueKey":"data.oneOf.4.from.databaseName","typeLabel":"string"},"tableName":{"type":"string","description":"ClickHouse table name","example":"otel_logs","isRequired":true,"uniqueKey":"data.oneOf.4.from.tableName","typeLabel":"string"}},"description":"The database and TimeSeries table to query on a ClickHouse connection. Not used for a Prometheus-compatible connection, but still required (empty strings are not accepted — use placeholder values such as \"default\").","isRequired":true,"uniqueKey":"data.oneOf.4.from","typeLabel":"object"},"timestampValueExpression":{"type":"string","description":"Required by the API for all source kinds; not used by PromQL queries.","example":"timestamp","isRequired":true,"uniqueKey":"data.oneOf.4.timestampValueExpression","typeLabel":"string"},"id":{"type":"string","readOnly":true,"description":"Unique source ID. Server-generated; ignored if sent in create/update requests.","example":"507f1f77bcf86cd799439051","uniqueKey":"data.oneOf.4.id","typeLabel":"string"},"section":{"type":"string","maxLength":256,"description":"Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together.","example":"Billing","uniqueKey":"data.oneOf.4.section","typeLabel":"string"},"disabled":{"oneOf":[{"type":"boolean","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.4.disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, the source is hidden from source selectors in the UI. Defaults to false.","example":false,"uniqueKey":"data.oneOf.4.disabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.4.disabled","typeLabel":"boolean | null"},"querySettings":{"oneOf":[{"type":"array","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads","isRequired":true,"uniqueKey":"data.oneOf.4.querySettings.oneOf.0.items.[INDEX].setting","typeLabel":"string"},"value":{"type":"string","description":"Setting value","example":"4","isRequired":true,"uniqueKey":"data.oneOf.4.querySettings.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.oneOf.4.querySettings.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.4.querySettings.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Optional ClickHouse query settings applied when querying this source.","items":{"type":"object","required":["setting","value"],"properties":{"setting":{"type":"string","description":"ClickHouse setting name","example":"max_threads"},"value":{"type":"string","description":"Setting value","example":"4"}}},"uniqueKey":"data.oneOf.4.querySettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.4.querySettings","typeLabel":"object[] | null"}},"uniqueKey":"data.oneOf.4","typeLabel":"object"}],"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"name":"Logs","kind":"log","connection":"507f1f77bcf86cd799439012","from":{"databaseName":"otel","tableName":"otel_logs"},"defaultTableSelectExpression":"Timestamp, ServiceName, SeverityText, Body","timestampValueExpression":"Timestamp","id":"507f1f77bcf86cd799439011","section":"Billing","disabled":false,"querySettings":[{"setting":"max_threads","value":"4"}],"serviceNameExpression":"ServiceName","serviceVersionExpression":"ResourceAttributes['service.version']","severityTextExpression":"SeverityText","severityNumberExpression":"SeverityNumber","bodyExpression":"Body","eventNameExpression":"EventName","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","displayedTimestampValueExpression":"TimestampTime","orderByExpression":"Timestamp DESC","metricSourceId":"507f1f77bcf86cd799439013","traceSourceId":"507f1f77bcf86cd799439014","traceIdExpression":"TraceId","spanIdExpression":"SpanId","implicitColumnExpression":"Body","knownColumnsListExpression":"Timestamp, Body, ServiceName","useTextIndexForImplicitColumn":"auto","highlightedTraceAttributeExpressions":[{"sqlExpression":"SpanAttributes['http.status_code']","luceneExpression":"http.status_code","alias":"HTTP Status Code"}],"highlightedRowAttributeExpressions":[{"sqlExpression":"SpanAttributes['http.status_code']","luceneExpression":"http.status_code","alias":"HTTP Status Code"}],"materializedViews":[{"databaseName":"otel","tableName":"otel_logs_mv_5m","dimensionColumns":"ServiceName, SeverityText","minGranularity":"5m","timestampColumn":"Timestamp","aggregatedColumns":[{"aggFn":"sum","mvColumn":"sum__Duration","sourceColumn":"Duration"}],"minDate":"2025-01-01T00:00:00Z"}],"metadataMaterializedViews":{"keyRollupTable":"otel_logs_key_rollup_15m","kvRollupTable":"otel_logs_kv_rollup_15m","granularity":"15m"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a8cd43a2-54fd-4849-bab3-114c9346c2bc":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message.","example":"NOT_FOUND: Alert not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthorized access. API key is missing or invalid."},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized access. API key is missing or invalid."}}},"exampleType":"examples"}},"exampleType":"examples"},"cd22a999-a70b-4e91-ab7c-58c55e225ffc":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message.","example":"NOT_FOUND: Alert not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"NOT_FOUND: Alert not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"01b68cae-7f70-4065-968a-f2c7000be6b8":{"description":"Source not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message.","example":"NOT_FOUND: Alert not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Source not found"},"examples":{"Example":{"title":"Example","value":{"message":"Source not found"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"710c4f63-75c7-40a8-8397-187e7617a476":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"3d05231e-9556-4d83-8a93-081109e93a0a":{"url":"/","description":"Your HyperDX instance (http://\u003chost>:\u003cport>)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json"},"subdomain":"private-7c7dfe99","siteName":"ClickHouse Documentation","title":"Get Source - ClickHouse Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/clickstack/api-reference/sources/get-source","matchLevel":0},"ar":{"href":"/ar/clickstack/api-reference/sources/get-source","matchLevel":1},"es":{"href":"/es/clickstack/api-reference/sources/get-source","matchLevel":1},"fr":{"href":"/fr/clickstack/api-reference/sources/get-source","matchLevel":1},"ja":{"href":"/ja/clickstack/api-reference/sources/get-source","matchLevel":1},"ko":{"href":"/ko/clickstack/api-reference/sources/get-source","matchLevel":1},"pt-BR":{"href":"/pt-br/clickstack/api-reference/sources/get-source","matchLevel":1},"ru":{"href":"/ru/clickstack/api-reference/sources/get-source","matchLevel":1},"zh":{"href":"/zh/clickstack/api-reference/sources/get-source","matchLevel":1}}},"originalFileLocation":"clickstack/api-reference/sources/get-source.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves a specific source by ID\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClickHouse Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Source - ClickHouse Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a specific source by ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClickHouse Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://private-7c7dfe99.mintlify.app/_mintlify/api/og/v2?division=Sources\u0026amp;title=Get+Source\u0026amp;description=Retrieves+a+specific+source+by+ID\u0026amp;theme=de5161c1b5df52f178b39943\u0026amp;signature=a2220aa8a690961b114e8546c8d36a7c281ba7905ec6e6e4cdf5dadd3286edfd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Source - ClickHouse Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a specific source by ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://private-7c7dfe99.mintlify.app/_mintlify/api/og/v2?division=Sources\u0026amp;title=Get+Source\u0026amp;description=Retrieves+a+specific+source+by+ID\u0026amp;theme=de5161c1b5df52f178b39943\u0026amp;signature=a2220aa8a690961b114e8546c8d36a7c281ba7905ec6e6e4cdf5dadd3286edfd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/private-7c7dfe99/4UShO1VxIGDRhyfj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClickHouse Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1c1c1c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/clickstack/api-reference/sources/get-source.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://clickhouse.com/docs/ar/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://clickhouse.com/docs/es/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://clickhouse.com/docs/fr/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://clickhouse.com/docs/ja/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://clickhouse.com/docs/ko/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://clickhouse.com/docs/pt-br/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://clickhouse.com/docs/ru/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://clickhouse.com/docs/zh/clickstack/api-reference/sources/get-source\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://clickhouse.com/#organization\",\"name\":\"ClickHouse Documentation\",\"url\":\"https://clickhouse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/private-7c7dfe99/h2VHbIjccjT9ClSc/_site/logo/light.svg?fit=max\u0026auto=format\u0026n=h2VHbIjccjT9ClSc\u0026q=85\u0026s=b8a838f982def2b530a95016300bc7ec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://clickhouse.com/docs#website\",\"name\":\"ClickHouse Documentation\",\"url\":\"https://clickhouse.com/docs\",\"publisher\":{\"@id\":\"https://clickhouse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source#webpage\",\"url\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\",\"name\":\"Get Source\",\"description\":\"Retrieves a specific source by ID\",\"isPartOf\":{\"@id\":\"https://clickhouse.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://clickhouse.com/docs/clickstack/api-reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sources\",\"item\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/list-sources\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Source\",\"item\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source#apireference\",\"headline\":\"Get Source\",\"name\":\"Get Source\",\"description\":\"Retrieves a specific source by ID\",\"url\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source\",\"mainEntityOfPage\":{\"@id\":\"https://clickhouse.com/docs/clickstack/api-reference/sources/get-source#webpage\"},\"publisher\":{\"@id\":\"https://clickhouse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://clickhouse.com/docs#website\"}}]}\u003c/script>","siteName":"ClickHouse Documentation","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Database","menu":[{"item":"Get started","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-get-started.svg","pages":[{"group":"Get started","icon":"/images/menu-icon-lightning.svg","pages":[{"title":"Get started with ClickHouse","sidebarTitle":"Overview","href":"/get-started"},{"group":"Quickstarts","expanded":false,"pages":[{"sidebarTitle":"Explore quickstarts","title":"Quickstarts explorer","mode":"custom","href":"/get-started/quickstarts/home"},{"group":"All use cases","expanded":false,"pages":[{"sidebarTitle":"Cloud quickstart","title":"ClickHouse Cloud quick start","href":"/get-started/setup/cloud"},{"sidebarTitle":"Obtain your Cloud connection details","title":"Obtain your Cloud connection details","href":"/get-started/quickstarts/obtain-your-cloud-connection-details"},{"sidebarTitle":"Insert data into ClickHouse Cloud using clickhouse-client","title":"Insert data into ClickHouse Cloud using clickhouse-client","href":"/get-started/quickstarts/insert-data-using-clickhouse-client"},{"sidebarTitle":"Creating tables in ClickHouse","title":"Creating tables in ClickHouse","href":"/get-started/quickstarts/creating-tables"},{"sidebarTitle":"Selecting ClickHouse Data","title":"Selecting ClickHouse Data","href":"/get-started/quickstarts/writing-queries"},{"sidebarTitle":"Create your first MergeTree table","title":"Create your first MergeTree table","href":"/get-started/quickstarts/create-your-first-mergetree-table"}]},{"group":"Real-time analytics","expanded":false,"pages":[{"sidebarTitle":"Create your first materialized view","title":"Create your first materialized view","href":"/get-started/quickstarts/create-your-first-materialized-view"},{"sidebarTitle":"Create your first projection","title":"Create your first projection","href":"/get-started/quickstarts/create-your-first-projection"}]},{"group":"Data warehousing","expanded":false,"pages":[{"sidebarTitle":"How to connect your Iceberg catalog in ClickHouse Cloud","title":"How to connect your Iceberg catalog in ClickHouse Cloud","href":"/get-started/quickstarts/connect-your-iceberg-catalog"},{"sidebarTitle":"Updating and deleting ClickHouse data","title":"Updating and deleting ClickHouse data","href":"/get-started/quickstarts/mutations"}]},{"group":"Observability","expanded":false,"pages":[{"sidebarTitle":"Working with the Map type in ClickHouse","title":"Working with the Map type in ClickHouse","href":"/get-started/quickstarts/working-with-the-map-type"}]}]},{"group":"Introduction","expanded":true,"pages":[{"sidebarTitle":"What is ClickHouse?","title":"What is ClickHouse?","href":"/get-started/about/intro"},{"sidebarTitle":"Why is ClickHouse so fast?","title":"Why is ClickHouse so fast?","href":"/get-started/about/why-clickhouse-is-so-fast"},{"sidebarTitle":"Why is ClickHouse unique?","title":"Distinctive Features of ClickHouse","href":"/get-started/about/distinctive-features"}]},{"group":"Use cases","expanded":true,"pages":[{"title":"Use cases","sidebarTitle":"Overview","href":"/get-started/use-cases/overview"},{"title":"Choose a service for your workload","sidebarTitle":"Choose a service","href":"/get-started/use-cases/choosing-a-service"},{"title":"Real-time analytics","sidebarTitle":"Real-time analytics","href":"/get-started/use-cases/real-time-analytics"},{"title":"Observability","sidebarTitle":"Observability","href":"/get-started/use-cases/observability"},{"title":"Data warehousing","sidebarTitle":"Data warehousing","href":"/get-started/use-cases/data-warehousing"},{"title":"Agentic analytics","sidebarTitle":"Agentic analytics","href":"/get-started/use-cases/agentic-analytics"}]},{"sidebarTitle":"Deployment modes","title":"Deployment modes","href":"/get-started/about/deployment-modes"}]},{"group":"Setup","icon":"/images/menu-icon-gear.svg","expanded":true,"pages":[{"sidebarTitle":"Install","title":"Installation instructions","href":"/get-started/setup/install"},{"sidebarTitle":"Cloud quickstart","title":"ClickHouse Cloud quick start","href":"/get-started/setup/cloud"},{"group":"Self-managed","expanded":true,"pages":[{"title":"Self-managed install","sidebarTitle":"Overview","href":"/get-started/setup/self-managed/overview"},{"group":"Local development","pages":[{"sidebarTitle":"Quick install","title":"Quick install","href":"/get-started/setup/self-managed/quick-install"},{"sidebarTitle":"clickhousectl (CLI)","title":"Install with the ClickHouse CLI","href":"/get-started/setup/self-managed/clickhousectl"},{"sidebarTitle":"Docker","title":"Install ClickHouse using Docker","href":"/get-started/setup/self-managed/docker"},{"sidebarTitle":"Source \u0026 CI builds","title":"Source \u0026 CI builds","href":"/get-started/setup/self-managed/advanced"}]},{"group":"Production server","pages":[{"sidebarTitle":"Debian/Ubuntu","title":"Install ClickHouse on Debian/Ubuntu","href":"/get-started/setup/self-managed/debian-ubuntu"},{"sidebarTitle":"Redhat/CentOS","title":"Install ClickHouse on rpm-based Linux distributions","href":"/get-started/setup/self-managed/redhat"},{"sidebarTitle":"NixOS","title":"Install ClickHouse on NixOS","href":"/get-started/setup/self-managed/nixos"},{"sidebarTitle":"Other Linux","title":"Install ClickHouse using tgz archives","href":"/get-started/setup/self-managed/other-linux"}]}]}]},{"group":"Sample datasets","icon":"/images/menu-icon-database.svg","expanded":true,"pages":[{"sidebarTitle":"Overview","title":"Tutorials and example datasets","href":"/get-started/sample-datasets/index"},{"sidebarTitle":"ClickHouse playground","title":"ClickHouse playground","href":"/get-started/sample-datasets/playground"},{"group":"Benchmarks","pages":[{"sidebarTitle":"AMPLab big data benchmark","title":"AMPLab Big Data Benchmark","href":"/get-started/sample-datasets/amplab-benchmark"},{"sidebarTitle":"Brown university benchmark","title":"Brown University Benchmark","href":"/get-started/sample-datasets/brown-benchmark"},{"sidebarTitle":"Criteo 1TB click logs","title":"Terabyte click logs from Criteo","href":"/get-started/sample-datasets/criteo"},{"title":"Join Order Benchmark (JOB)","sidebarTitle":"JOB","href":"/get-started/sample-datasets/job"},{"sidebarTitle":"Star Schema Benchmark","title":"Star Schema Benchmark (SSB, 2009)","href":"/get-started/sample-datasets/star-schema"},{"title":"TPC-DS (2012)","sidebarTitle":"TPC-DS","href":"/get-started/sample-datasets/tpcds"},{"title":"TPC-H (1999)","sidebarTitle":"TPC-H","href":"/get-started/sample-datasets/tpch"}]},{"group":"Vector search \u0026 embeddings","pages":[{"sidebarTitle":"dbpedia dataset","title":"dbpedia dataset","href":"/get-started/sample-datasets/dbpedia"},{"sidebarTitle":"Hacker News vector search dataset","title":"Hacker News vector search dataset","href":"/get-started/sample-datasets/hacker-news-vector-search"},{"sidebarTitle":"Laion-400M dataset","title":"Laion-400M dataset","href":"/get-started/sample-datasets/laion"},{"sidebarTitle":"LAION 5B dataset","title":"LAION 5B dataset","href":"/get-started/sample-datasets/laion5b"}]},{"group":"Web \u0026 social analytics","pages":[{"sidebarTitle":"Amazon customer reviews","title":"Amazon customer review","href":"/get-started/sample-datasets/amazon-reviews"},{"sidebarTitle":"Anonymized web analytics","title":"Anonymized web analytics","href":"/get-started/sample-datasets/anon-web-analytics-metrica"},{"sidebarTitle":"Github repo","title":"Writing queries in ClickHouse using GitHub data","href":"/get-started/sample-datasets/github"},{"sidebarTitle":"GitHub events","title":"GitHub events dataset","href":"/get-started/sample-datasets/github-events"},{"sidebarTitle":"Hacker news","title":"Hacker News dataset","href":"/get-started/sample-datasets/hacker-news"},{"sidebarTitle":"Stack Overflow","title":"Analyzing Stack Overflow data with ClickHouse","href":"/get-started/sample-datasets/stackoverflow"},{"sidebarTitle":"YouTube dislikes","title":"YouTube dataset of dislikes","href":"/get-started/sample-datasets/youtube-dislikes"}]},{"group":"Geo \u0026 location","pages":[{"sidebarTitle":"Cell towers","title":"Geospatial analysis with the cell tower dataset","href":"/get-started/sample-datasets/cell-towers"},{"sidebarTitle":"Foursquare OS Places","title":"Foursquare OS Places dataset","href":"/get-started/sample-datasets/foursquare-os-places"},{"sidebarTitle":"New York taxi data","title":"Geospatial analysis with the New York taxi dataset","href":"/get-started/sample-datasets/nyc-taxi"}]},{"group":"Time series \u0026 sensors","pages":[{"sidebarTitle":"Environmental sensors data","title":"Environmental sensors data","href":"/get-started/sample-datasets/environmental-sensors"},{"sidebarTitle":"NOAA Global Historical Climatology Network ","title":"NOAA Global Historical Climatology Network","href":"/get-started/sample-datasets/noaa"},{"sidebarTitle":"Taiwan historical weather datasets","title":"Taiwan historical weather datasets","href":"/get-started/sample-datasets/tw-weather"},{"sidebarTitle":"WikiStat","title":"WikiStat","href":"/get-started/sample-datasets/wikistat"}]},{"group":"Public records \u0026 open data","pages":[{"sidebarTitle":"COVID-19 open-data","title":"COVID-19 open data","href":"/get-started/sample-datasets/covid19"},{"sidebarTitle":"New York Public Library \"what's on the menu?\" dataset","title":"New York Public Library \"What's on the Menu?\" dataset","href":"/get-started/sample-datasets/menus"},{"sidebarTitle":"NYPD complaint data","title":"NYPD complaint data","href":"/get-started/sample-datasets/nypd-complaint-data"},{"sidebarTitle":"OnTime airline flight data","title":"OnTime","href":"/get-started/sample-datasets/ontime"},{"sidebarTitle":"UK property prices","title":"Analytical queries on UK property price data","href":"/get-started/sample-datasets/uk-price-paid"}]}]},{"group":"Migrate","icon":"/images/caret-double-right.svg","expanded":true,"pages":[{"sidebarTitle":"Overview","title":"Migrating Data into ClickHouse","href":"/get-started/migrate/overview"},{"group":"PostgreSQL","pages":[{"title":"Comparing PostgreSQL and ClickHouse","sidebarTitle":"Overview","href":"/get-started/migrate/postgres/overview"},{"group":"Migration guide","pages":[{"title":"Migrating data","sidebarTitle":"Part 1","href":"/get-started/migrate/postgres/migration-guide/migration-guide-part1"},{"title":"Rewriting PostgreSQL queries","sidebarTitle":"Part 2","href":"/get-started/migrate/postgres/migration-guide/migration-guide-part2"},{"title":"Data modeling techniques","sidebarTitle":"Part 3","href":"/get-started/migrate/postgres/migration-guide/migration-guide-part3"}]},{"title":"Appendix","href":"/get-started/migrate/postgres/appendix"}]},{"group":"BigQuery","pages":[{"title":"Comparing ClickHouse Cloud and BigQuery","sidebarTitle":"Overview","href":"/get-started/migrate/bigquery/overview"},{"title":"Migrating from BigQuery to ClickHouse Cloud","sidebarTitle":"Migration guide","href":"/get-started/migrate/bigquery/migrating-to-clickhouse-cloud"},{"sidebarTitle":"Loading data","title":"Loading data from BigQuery to ClickHouse","href":"/get-started/migrate/bigquery/loading-data"}]},{"group":"Snowflake","pages":[{"sidebarTitle":"Overview","title":"Snowflake to ClickHouse migration","href":"/get-started/migrate/snowflake/overview"},{"sidebarTitle":"Migration guide","title":"Migrate from Snowflake to ClickHouse","href":"/get-started/migrate/snowflake/migration-guide"},{"sidebarTitle":"SQL translation reference","title":"Migrating from Snowflake to ClickHouse","href":"/get-started/migrate/snowflake/sql-translation-reference"}]},{"group":"Elasticsearch","pages":[{"sidebarTitle":"Overview","title":"Migrate from Elasticsearch to ClickHouse","href":"/get-started/migrate/elastic/overview"}]},{"group":"Redshift","pages":[{"sidebarTitle":"Overview","title":"Comparing ClickHouse Cloud and Amazon Redshift","href":"/get-started/migrate/redshift/overview"},{"sidebarTitle":"Migration guide","title":"Amazon Redshift to ClickHouse migration guide","href":"/get-started/migrate/redshift/migration-guide"},{"sidebarTitle":"SQL translation reference","title":"Amazon Redshift SQL translation guide","href":"/get-started/migrate/redshift/sql-translation-reference"}]},{"group":"OSS to Cloud","pages":[{"sidebarTitle":"Using remoteSecure","title":"Migrating between self-managed ClickHouse and ClickHouse Cloud using remoteSecure","href":"/get-started/migrate/oss-to-cloud/clickhouse-to-cloud"},{"sidebarTitle":"Using BACKUP and RESTORE","title":"Migrating from self-managed ClickHouse to ClickHouse Cloud using backup commands","href":"/get-started/migrate/oss-to-cloud/oss-to-cloud-backup-restore"}]},{"group":"Other methods","pages":[{"sidebarTitle":"Using clickhouse-local","title":"Migrating to ClickHouse using clickhouse-local","href":"/get-started/migrate/other-methods/clickhouse-local-etl"},{"sidebarTitle":"Using a third-party ETL tool","title":"Using a third-party ETL tool","href":"/get-started/migrate/other-methods/etl-tool-to-clickhouse"},{"title":"Move data from cloud object storage to ClickHouse Cloud","href":"/get-started/migrate/other-methods/object-storage-to-clickhouse"}]}]}]},{"item":"Concepts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-concepts.svg","pages":[{"title":"Concepts","sidebarTitle":"Overview","mode":"wide","href":"/concepts"},{"group":"Fundamentals","expanded":true,"pages":[{"title":"Core concepts","mode":"wide","href":"/concepts/core-concepts/index"},{"sidebarTitle":"Glossary","title":"Glossary","mode":"wide","href":"/concepts/core-concepts/glossary"},{"title":"Table parts","href":"/concepts/core-concepts/parts"},{"title":"Table partitions","href":"/concepts/core-concepts/partitions"},{"title":"Part merges","href":"/concepts/core-concepts/merges"},{"title":"Primary indexes","href":"/concepts/core-concepts/primary-indexes"},{"sidebarTitle":"Query parallelism","title":"How ClickHouse executes a query in parallel","href":"/concepts/core-concepts/query-parallelism"},{"title":"Architecture overview","href":"/concepts/core-concepts/academic-overview"}]},{"group":"ClickHouse concepts","expanded":true,"pages":[{"title":"ClickHouse Concepts","sidebarTitle":"Overview","mode":"wide","href":"/concepts/features/index"},{"group":"Materialized views","pages":[{"title":"Materialized views","sidebarTitle":"Overview","href":"/concepts/features/materialized-views/index"},{"title":"Incremental materialized view","href":"/concepts/features/materialized-views/incremental-materialized-view"},{"title":"Refreshable materialized view","href":"/concepts/features/materialized-views/refreshable-materialized-view"},{"title":"Cascading materialized views","href":"/concepts/features/materialized-views/cascading-materialized-views"}]},{"group":"Dictionaries","pages":[{"title":"Dictionary","href":"/concepts/features/dictionaries/index"},{"title":"Dictionary best practices","sidebarTitle":"Best practices","href":"/concepts/features/dictionaries/best-practices"}]},{"group":"Projections","pages":[{"title":"Projections","href":"/concepts/features/projections/projections"},{"sidebarTitle":"Materialized views vs projections","title":"Materialized views versus projections","href":"/concepts/features/projections/materialized-views-versus-projections"}]},{"group":"Performance","pages":[{"sidebarTitle":"Performance and optimizations overview","title":"Performance and Optimizations","mode":"wide","href":"/concepts/features/performance/index"},{"sidebarTitle":"PREWHERE optimization","title":"How does the PREWHERE optimization work?","href":"/concepts/features/performance/prewhere"},{"sidebarTitle":"Allocation profiling","title":"Allocation profiling","href":"/concepts/features/performance/allocation-profiling"},{"sidebarTitle":"Allocation profiling for versions before 25.9","title":"Allocation profiling for versions before 25.9","href":"/concepts/features/performance/allocation-profiling-old"},{"group":"Caches","pages":[{"sidebarTitle":"Caches","title":"Cache types","href":"/concepts/features/performance/caches/caches"},{"sidebarTitle":"Query cache","title":"Query cache","href":"/concepts/features/performance/caches/query-cache"},{"sidebarTitle":"Query condition cache","title":"Query condition cache","href":"/concepts/features/performance/caches/query-condition-cache"},{"sidebarTitle":"Userspace page cache","title":"Userspace page cache","href":"/concepts/features/performance/caches/userspace-page-cache"}]},{"group":"Skipping-indexes","pages":[{"sidebarTitle":"Data skipping indexes","title":"Understanding ClickHouse data skipping indexes","href":"/concepts/features/performance/skip-indexes/skipping-indexes"},{"sidebarTitle":"Data skipping indexes - examples","title":"Data skipping index examples","href":"/concepts/features/performance/skip-indexes/skipping-indexes-examples"}]},{"sidebarTitle":"Lazy materialization","title":"Lazy materialization","href":"/concepts/features/performance/lazy-materialization"},{"group":"Troubleshooting","pages":[{"sidebarTitle":"Debugging memory issues","title":"Debugging memory issues","href":"/concepts/features/performance/troubleshoot/debugging-memory-issues"},{"title":"OOM canary","href":"/concepts/features/performance/troubleshoot/oom-canary"},{"sidebarTitle":"Testing Hardware","title":"How to Test Your Hardware with ClickHouse","href":"/concepts/features/performance/troubleshoot/performance-test"},{"sidebarTitle":"Query Profiling","title":"Sampling query profiler","href":"/concepts/features/performance/troubleshoot/sampling-query-profiler"}]}]},{"group":"Operations","pages":[{"sidebarTitle":"Background queries","title":"Background queries","href":"/concepts/features/operations/background-queries"},{"group":"Insert","pages":[{"title":"Inserting ClickHouse data","sidebarTitle":"Inserting ClickHouse data","href":"/concepts/features/operations/insert/inserting-data"},{"sidebarTitle":"Asynchronous inserts","title":"Asynchronous inserts (async_insert)","href":"/concepts/features/operations/insert/asyncinserts"},{"sidebarTitle":"Asynchronous INSERT ... SELECT","title":"Asynchronous INSERT ... SELECT","href":"/concepts/features/operations/insert/async-insert-select"},{"sidebarTitle":"Bulk inserts","title":"Bulk inserts","href":"/concepts/features/operations/insert/bulkinserts"},{"sidebarTitle":"Deduplication strategies","title":"Deduplication strategies","href":"/concepts/features/operations/insert/deduplication"},{"title":"Deduplicating inserts on retries","href":"/concepts/features/operations/insert/deduplicating-inserts-on-retries"},{"title":"Transactional (ACID) support","href":"/concepts/features/operations/insert/transactions"}]},{"group":"Select","pages":[{"group":"JOINs","pages":[{"title":"Using JOINs in ClickHouse","href":"/concepts/features/operations/select/joining-tables"},{"title":"How ClickHouse executes JOINs","href":"/concepts/features/operations/select/join-execution"},{"title":"JOIN algorithms","href":"/concepts/features/operations/select/join-algorithms"},{"title":"JOIN memory management and spilling","href":"/concepts/features/operations/select/join-memory-management"}]}]},{"group":"Update","pages":[{"title":"Updating Data","sidebarTitle":"Overview","href":"/concepts/features/operations/update/index"},{"title":"Updates in ClickHouse","sidebarTitle":"Working with updates","href":"/concepts/features/operations/update/overview"},{"title":"Working with the ReplacingMergeTree engine","sidebarTitle":"Working with the ReplacingMergeTree engine","href":"/concepts/features/operations/update/replacing-merge-tree"}]},{"group":"Delete","pages":[{"title":"Deleting Data","href":"/concepts/features/operations/delete/index"},{"title":"Delete overview","href":"/concepts/features/operations/delete/overview"},{"sidebarTitle":"Drop partition","title":"Dropping partitions","href":"/concepts/features/operations/delete/drop-partition"},{"title":"Lightweight delete","href":"/concepts/features/operations/delete/lightweight-delete"},{"sidebarTitle":"Truncate table","title":"Truncate Table","href":"/concepts/features/operations/delete/truncate"},{"sidebarTitle":"TTL (Time to Live)","title":"Manage data with TTL (time-to-live)","href":"/concepts/features/operations/delete/ttl"}]}]},{"group":"Configuration","pages":[{"group":"Settings","pages":[{"title":"Settings Overview","href":"/concepts/features/configuration/settings/overview"},{"sidebarTitle":"Query-level Session Settings","title":"Query-level Session Settings","href":"/concepts/features/configuration/settings/settings-query-level"},{"sidebarTitle":"User Settings","title":"Users and roles settings","href":"/concepts/features/configuration/settings/settings-users"},{"sidebarTitle":"Settings profiles","title":"Settings profiles","href":"/concepts/features/configuration/settings/settings-profiles"},{"sidebarTitle":"Constraints on settings","title":"Constraints on settings","href":"/concepts/features/configuration/settings/constraints-on-settings"},{"sidebarTitle":"Restrictions on query complexity","title":"Restrictions on query complexity","href":"/concepts/features/configuration/settings/query-complexity"},{"sidebarTitle":"Permissions for queries","title":"Permissions for queries","href":"/concepts/features/configuration/settings/permissions-for-queries"},{"title":"Memory overcommit","href":"/concepts/features/configuration/settings/memory-overcommit"},{"sidebarTitle":"Server overload","title":"Server overload","href":"/concepts/features/configuration/settings/server-overload"},{"sidebarTitle":"TCP connection limits","title":"TCP connection limits","href":"/concepts/features/configuration/settings/tcp-connection-limits"},{"sidebarTitle":"Alternative query languages","title":"Alternative query languages","href":"/concepts/features/configuration/settings/alternative-query-languages"}]},{"group":"Server config","pages":[{"sidebarTitle":"Configuration Files","title":"Configuration Files","href":"/concepts/features/configuration/server-config/configuration-files"},{"sidebarTitle":"External disks for storing data","title":"External disks for storing data","href":"/concepts/features/configuration/server-config/storing-data"},{"sidebarTitle":"Named collections","title":"Named collections","href":"/concepts/features/configuration/server-config/named-collections"},{"sidebarTitle":"Workload scheduling","title":"Workload scheduling","href":"/concepts/features/configuration/server-config/workload-scheduling"},{"sidebarTitle":"Quotas","title":"Quotas","href":"/concepts/features/configuration/server-config/quotas"},{"sidebarTitle":"Composable protocols","title":"Composable protocols","href":"/concepts/features/configuration/server-config/composable-protocols"},{"sidebarTitle":"Startup scripts","title":"Startup scripts","href":"/concepts/features/configuration/server-config/startup-scripts"},{"sidebarTitle":"Introspection port","title":"Introspection port","href":"/concepts/features/configuration/server-config/introspection-port"}]}]},{"group":"Security and auth","pages":[{"title":"Security and authentication","mode":"wide","href":"/concepts/features/security/index"},{"sidebarTitle":"Users and roles","title":"Access control and account management","href":"/concepts/features/security/access-rights"},{"sidebarTitle":"Network ports","title":"Network ports","href":"/concepts/features/security/network-ports"},{"group":"TLS","pages":[{"title":"TLS configuration","href":"/concepts/features/security/tls/index"},{"sidebarTitle":"Configuring TLS","title":"Configuring TLS","href":"/concepts/features/security/tls/configuring-tls"},{"sidebarTitle":"Configuring automatic TLS provisioning via ACME","title":"Configuring automatic TLS provisioning via ACME","href":"/concepts/features/security/tls/configuring-tls-acme-client"}]},{"group":"External authenticators","pages":[{"sidebarTitle":"External User Authenticators and Directories","title":"External User Authenticators and Directories","href":"/concepts/features/security/external-authenticators/index"},{"group":"SSL","pages":[{"title":"SSL X.509 certificate authentication","href":"/concepts/features/security/external-authenticators/ssl-x509"},{"sidebarTitle":"SSL user certificate authentication","title":"Configuring SSL user certificate for authentication","href":"/concepts/features/security/ssl-user-auth"}]},{"group":"LDAP","pages":[{"title":"LDAP","href":"/concepts/features/security/external-authenticators/ldap"},{"sidebarTitle":"Configuring LDAP","title":"Configuring ClickHouse to use LDAP for authentication and role mapping","href":"/concepts/features/security/configuring-ldap"}]},{"title":"HTTP","href":"/concepts/features/security/external-authenticators/http"},{"title":"Kerberos","href":"/concepts/features/security/external-authenticators/kerberos"},{"sidebarTitle":"JWT","title":"JWT Authentication","href":"/concepts/features/security/external-authenticators/jwt"}]}]},{"group":"Backup and restore","pages":[{"sidebarTitle":"Overview","title":"Backup and restore in ClickHouse","href":"/concepts/features/backup-restore/overview"},{"sidebarTitle":"Restore settings","title":"Restore settings","href":"/concepts/features/backup-restore/restore-settings"},{"sidebarTitle":"Named collections","title":"Backing up and restoring named collections","href":"/concepts/features/backup-restore/named-collections"},{"sidebarTitle":"Local disk / S3 disk","title":"BACKUP / RESTORE to disk","href":"/concepts/features/backup-restore/local-disk"},{"sidebarTitle":"S3 endpoint","title":"BACKUP / RESTORE to or from an S3 endpoint","href":"/concepts/features/backup-restore/s3-endpoint"},{"sidebarTitle":"AzureBlobStorage","title":"BACKUP/RESTORE to or from Azure Blob Storage","href":"/concepts/features/backup-restore/azure-blob-storage"},{"sidebarTitle":"Snapshot backup","title":"Snapshot backup and restore","href":"/concepts/features/backup-restore/snapshot"},{"sidebarTitle":"Alternative methods","title":"Alternative backup or restore methods","href":"/concepts/features/backup-restore/alternative-methods"}]},{"group":"Interfaces","pages":[{"title":"Native Clients and Interfaces","mode":"wide","href":"/concepts/features/interfaces/native-clients-interfaces-index"},{"sidebarTitle":"clickhousectl","title":"clickhousectl","href":"/concepts/features/interfaces/cli"},{"sidebarTitle":"ClickHouse Client","title":"ClickHouse Client","href":"/concepts/features/interfaces/client"},{"sidebarTitle":"Model Context Protocol (MCP)","title":"Model Context Protocol (MCP)","href":"/concepts/features/interfaces/mcp"},{"group":"Drivers and interfaces","pages":[{"sidebarTitle":"Overview","title":"Drivers and interfaces","href":"/concepts/features/interfaces/overview"},{"sidebarTitle":"HTTP interface","title":"HTTP interface","href":"/concepts/features/interfaces/http"},{"sidebarTitle":"Framing formats","title":"Framing formats","href":"/concepts/features/interfaces/framing-formats"},{"sidebarTitle":"Native interface (TCP)","title":"Native interface (TCP)","href":"/concepts/features/interfaces/tcp"},{"sidebarTitle":"ADBC driver","title":"ADBC driver","href":"/concepts/features/interfaces/adbc"},{"sidebarTitle":"MySQL interface","title":"MySQL interface","href":"/concepts/features/interfaces/mysql"},{"group":"ODBC driver","pages":[{"sidebarTitle":"Overview","title":"ODBC driver","href":"/concepts/features/interfaces/odbc/index"}]},{"sidebarTitle":"PostgreSQL interface","title":"PostgreSQL interface","href":"/concepts/features/interfaces/postgresql"},{"sidebarTitle":"Prometheus API and PromQL","title":"Prometheus HTTP API and PromQL","href":"/concepts/features/interfaces/prometheus"},{"sidebarTitle":"Prometheus metrics endpoint","title":"Prometheus metrics endpoint","href":"/concepts/features/interfaces/prometheus-metrics"},{"sidebarTitle":"SSH interface","title":"SSH interface with PTY","href":"/concepts/features/interfaces/ssh"},{"sidebarTitle":"gRPC interface","title":"gRPC interface","href":"/concepts/features/interfaces/grpc"},{"sidebarTitle":"Arrow Flight interface","title":"Arrow Flight interface","href":"/concepts/features/interfaces/arrowflight"}]},{"sidebarTitle":"Schema inference","title":"Automatic schema inference from input data","href":"/concepts/features/interfaces/schema-inference"},{"sidebarTitle":"Documentation Search","title":"Documentation Search","href":"/concepts/features/interfaces/documentation-search"},{"sidebarTitle":"Web SQL UI","title":"Web SQL UI (Play)","href":"/concepts/features/interfaces/web-sql"},{"sidebarTitle":"SQL Console","title":"SQL Console","href":"/concepts/features/interfaces/sql-console"},{"sidebarTitle":"Web UI Color Coding","title":"Web UI Color Coding","href":"/concepts/features/interfaces/web-ui-color-coding"},{"sidebarTitle":"Web UI Pinned Columns","title":"Web UI Pinned Columns","href":"/concepts/features/interfaces/web-ui-pinned-columns"},{"sidebarTitle":"Web UI Notebook Mode","title":"Web UI Notebook Mode","href":"/concepts/features/interfaces/web-ui-notebook"},{"sidebarTitle":"Web UI Result Shaping","title":"Web UI Sorting, Filtering and Pagination","href":"/concepts/features/interfaces/web-ui-result-shaping"},{"sidebarTitle":"Web Terminal","title":"Web Terminal","href":"/concepts/features/interfaces/web-terminal"},{"group":"Third-party clients","pages":[{"title":"Third-Party Interfaces","href":"/concepts/features/interfaces/third-party/index"}]}]},{"group":"Tools and utilities","pages":[{"sidebarTitle":"List of tools and utilities","title":"List of tools and utilities","mode":"wide","href":"/concepts/features/tools-and-utilities/index"},{"title":"clickhouse_backupview","href":"/concepts/features/tools-and-utilities/backupview"},{"sidebarTitle":"clickhouse-benchmark","title":"clickhouse-benchmark","href":"/concepts/features/tools-and-utilities/clickhouse-benchmark"},{"title":"clickhouse-compressor","href":"/concepts/features/tools-and-utilities/clickhouse-compressor"},{"sidebarTitle":"clickhouse-disks","title":"clickhouse-disks","href":"/concepts/features/tools-and-utilities/clickhouse-disks"},{"title":"clickhouse-format","href":"/concepts/features/tools-and-utilities/clickhouse-format"},{"sidebarTitle":"clickhouse-keeper-client","title":"clickhouse-keeper-client utility","href":"/concepts/features/tools-and-utilities/clickhouse-keeper-client"},{"sidebarTitle":"Keeper HTTP API","title":"Keeper HTTP API and Dashboard","href":"/concepts/features/tools-and-utilities/clickhouse-keeper-http-api"},{"sidebarTitle":"clickhouse-local","title":"clickhouse-local","href":"/concepts/features/tools-and-utilities/clickhouse-local"},{"title":"clickhouse-obfuscator","href":"/concepts/features/tools-and-utilities/clickhouse-obfuscator"},{"title":"clickhouse-odbc-bridge","href":"/concepts/features/tools-and-utilities/odbc-bridge"},{"title":"clickhouse-static-files-disk-uploader","href":"/concepts/features/tools-and-utilities/static-files-disk-uploader"}]}]},{"group":"Best practices","expanded":true,"pages":[{"title":"Best practices in ClickHouse","mode":"wide","href":"/concepts/best-practices/index"},{"sidebarTitle":"Choosing a primary key","title":"Choosing a primary key","href":"/concepts/best-practices/choosing-a-primary-key"},{"sidebarTitle":"Selecting data types","title":"Selecting data types","href":"/concepts/best-practices/select-data-type"},{"sidebarTitle":"Use materialized views","title":"Use materialized views","href":"/concepts/best-practices/use-materialized-views"},{"sidebarTitle":"Minimize and optimize JOINs","title":"Minimize and optimize JOINs","href":"/concepts/best-practices/minimize-optimize-joins"},{"sidebarTitle":"Choosing a partitioning key","title":"Choosing a partitioning key","href":"/concepts/best-practices/partitioning-keys"},{"sidebarTitle":"Selecting an insert strategy","title":"Selecting an insert strategy","href":"/concepts/best-practices/selecting-an-insert-strategy"},{"sidebarTitle":"Data skipping indices","title":"Use data skipping indices where appropriate","href":"/concepts/best-practices/using-data-skipping-indices"},{"sidebarTitle":"Avoid mutations","title":"Avoid mutations","href":"/concepts/best-practices/avoid-mutations"},{"sidebarTitle":"Avoid optimize final","title":"Avoid `OPTIMIZE FINAL`","href":"/concepts/best-practices/avoid-optimize-final"},{"sidebarTitle":"Avoid nullable columns","title":"Avoid nullable columns","href":"/concepts/best-practices/avoidnullablecolumns"},{"sidebarTitle":"Using JSON","title":"Use JSON where appropriate","href":"/concepts/best-practices/json-type"}]}]},{"item":"Guides","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-guides.svg","groups":[{"group":"ClickHouse guides","pages":[{"sidebarTitle":"Overview","title":"ClickHouse guides","mode":"wide","href":"/guides/clickhouse"},{"title":"Kusto Query Language (KQL) in ClickHouse","sidebarTitle":"Kusto Query Language (KQL)","href":"/guides/clickhouse/kusto-query-language"},{"title":"LogsQL dialect in ClickHouse","sidebarTitle":"LogsQL","href":"/guides/clickhouse/logsql"},{"group":"Data formats","pages":[{"sidebarTitle":"Overview","title":"Importing from various data formats to ClickHouse","href":"/guides/clickhouse/data-formats/intro"},{"sidebarTitle":"CSV and TSV","title":"Working with CSV and TSV data in ClickHouse","href":"/guides/clickhouse/data-formats/csv-tsv"},{"sidebarTitle":"Parquet","title":"Working with Parquet in ClickHouse","href":"/guides/clickhouse/data-formats/parquet"},{"sidebarTitle":"Avro, Arrow and ORC","title":"Working with Avro, Arrow, and ORC data in ClickHouse","href":"/guides/clickhouse/data-formats/arrow-avro-orc"},{"sidebarTitle":"Binary and native","title":"Using native and binary formats in ClickHouse","href":"/guides/clickhouse/data-formats/binary"},{"sidebarTitle":"SQL dumps","title":"Inserting and dumping SQL data in ClickHouse","href":"/guides/clickhouse/data-formats/sql"},{"sidebarTitle":"Regexp and templates","title":"Importing and exporting custom text data using templates and regex in ClickHouse","href":"/guides/clickhouse/data-formats/templates-regex"},{"group":"JSON","pages":[{"sidebarTitle":"Overview","title":"Working with JSON","href":"/guides/clickhouse/data-formats/json/intro"},{"sidebarTitle":"Loading JSON","title":"Working with JSON","href":"/guides/clickhouse/data-formats/json/loading"},{"title":"JSON schema inference","href":"/guides/clickhouse/data-formats/json/inference"},{"title":"Designing your schema","href":"/guides/clickhouse/data-formats/json/schema"},{"title":"Handling other JSON formats","sidebarTitle":"Handling other formats","href":"/guides/clickhouse/data-formats/json/formats"},{"title":"Exporting JSON","href":"/guides/clickhouse/data-formats/json/exporting"},{"title":"Other JSON approaches","href":"/guides/clickhouse/data-formats/json/other"}]}]},{"group":"Data modelling","pages":[{"title":"Data modelling overview","mode":"wide","href":"/guides/clickhouse/data-modelling/index"},{"title":"Schema design","href":"/guides/clickhouse/data-modelling/schema-design"},{"sidebarTitle":"Primary indexes","title":"A practical introduction to primary indexes in ClickHouse","href":"/guides/clickhouse/data-modelling/sparse-primary-indexes"},{"title":"Denormalizing Data","href":"/guides/clickhouse/data-modelling/denormalization"},{"title":"Backfilling Data","href":"/guides/clickhouse/data-modelling/backfilling"},{"sidebarTitle":"Merge table function","title":"Merge table function","href":"/guides/clickhouse/data-modelling/merge-table-function"},{"sidebarTitle":"Stored procedures \u0026 query parameters","title":"Stored procedures and query parameters in ClickHouse","href":"/guides/clickhouse/data-modelling/stored-procedures-and-prepared-statements"},{"sidebarTitle":"Generating random test data","title":"Generating random test data in ClickHouse","href":"/guides/clickhouse/data-modelling/generating-test-data"},{"group":"Compression","expanded":false,"pages":[{"title":"Compression in ClickHouse","href":"/guides/clickhouse/data-modelling/compression/compression-in-clickhouse"},{"title":"Compression modes","href":"/guides/clickhouse/data-modelling/compression/compression-modes"}]},{"title":"Working with arrays in ClickHouse","sidebarTitle":"Working with arrays in ClickHouse","href":"/guides/clickhouse/working-with-arrays"},{"title":"Working with JOINs in ClickHouse","sidebarTitle":"Working with JOINs in ClickHouse","href":"/guides/clickhouse/working-with-joins"}]},{"group":"Performance \u0026 monitoring","pages":[{"group":"Query optimization","pages":[{"sidebarTitle":"Overview","title":"Query optimization","href":"/guides/clickhouse/performance-and-monitoring/query-optimization"},{"sidebarTitle":"Diagnose slow queries","title":"Diagnose slow queries","href":"/guides/clickhouse/performance-and-monitoring/diagnose-slow-queries"},{"sidebarTitle":"Isolate query bottlenecks","title":"Isolate query bottlenecks","href":"/guides/clickhouse/performance-and-monitoring/isolate-query-bottlenecks"},{"sidebarTitle":"Choose an optimization approach","title":"Choose an optimization approach","href":"/guides/clickhouse/performance-and-monitoring/optimization-approaches"},{"sidebarTitle":"Worked optimization example","title":"Worked query optimization example","href":"/guides/clickhouse/performance-and-monitoring/query-optimization-example"}]},{"sidebarTitle":"Analyzer","title":"Analyzer","href":"/guides/clickhouse/performance-and-monitoring/analyzer"},{"sidebarTitle":"Understanding query execution with the analyzer","title":"Understanding query execution with the analyzer","href":"/guides/clickhouse/performance-and-monitoring/understanding-query-execution-with-the-analyzer"},{"sidebarTitle":"Dynamic column selection","title":"Dynamic column selection","href":"/guides/clickhouse/performance-and-monitoring/dynamic-column-selection"}]},{"group":"Aggregate combinator examples","expanded":false,"pages":[{"title":"anyIf","sidebarTitle":"anyIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/anyIf"},{"title":"argMaxIf","sidebarTitle":"argMaxIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/argMaxIf"},{"title":"argMinIf","sidebarTitle":"argMinIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/argMinIf"},{"title":"avgIf","sidebarTitle":"avgIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/avgIf"},{"title":"avgMap","sidebarTitle":"avgMap","href":"/guides/clickhouse/examples/aggregate-function-combinators/avgMap"},{"title":"avgMerge","sidebarTitle":"avgMerge","href":"/guides/clickhouse/examples/aggregate-function-combinators/avgMerge"},{"title":"avgMergeState","sidebarTitle":"avgMergeState","href":"/guides/clickhouse/examples/aggregate-function-combinators/avgMergeState"},{"title":"avgResample","sidebarTitle":"avgResample","href":"/guides/clickhouse/examples/aggregate-function-combinators/avgResample"},{"title":"avgState","sidebarTitle":"avgState","href":"/guides/clickhouse/examples/aggregate-function-combinators/avgState"},{"title":"countIf","sidebarTitle":"countIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/countIf"},{"title":"countResample","sidebarTitle":"countResample","href":"/guides/clickhouse/examples/aggregate-function-combinators/countResample"},{"title":"groupArrayDistinct","sidebarTitle":"groupArrayDistinct","href":"/guides/clickhouse/examples/aggregate-function-combinators/groupArrayDistinct"},{"title":"groupArrayResample","sidebarTitle":"groupArrayResample","href":"/guides/clickhouse/examples/aggregate-function-combinators/groupArrayResample"},{"title":"maxMap","sidebarTitle":"maxMap","href":"/guides/clickhouse/examples/aggregate-function-combinators/maxMap"},{"title":"maxSimpleState","sidebarTitle":"maxSimpleState","href":"/guides/clickhouse/examples/aggregate-function-combinators/maxSimpleState"},{"title":"minMap","sidebarTitle":"minMap","href":"/guides/clickhouse/examples/aggregate-function-combinators/minMap"},{"title":"minSimpleState","sidebarTitle":"minSimpleState","href":"/guides/clickhouse/examples/aggregate-function-combinators/minSimpleState"},{"title":"quantilesTimingArrayIf","sidebarTitle":"quantilesTimingArrayIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/quantilesTimingArrayIf"},{"title":"quantilesTimingIf","sidebarTitle":"quantilesTimingIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/quantilesTimingIf"},{"title":"sumArray","sidebarTitle":"sumArray","href":"/guides/clickhouse/examples/aggregate-function-combinators/sumArray"},{"title":"sumForEach","sidebarTitle":"sumForEach","href":"/guides/clickhouse/examples/aggregate-function-combinators/sumForEach"},{"title":"sumIf","sidebarTitle":"sumIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/sumIf"},{"title":"sumMap","sidebarTitle":"sumMap","href":"/guides/clickhouse/examples/aggregate-function-combinators/sumMap"},{"title":"sumSimpleState","sidebarTitle":"sumSimpleState","href":"/guides/clickhouse/examples/aggregate-function-combinators/sumSimpleState"},{"title":"uniqArray","sidebarTitle":"uniqArray","href":"/guides/clickhouse/examples/aggregate-function-combinators/uniqArray"},{"title":"uniqArrayIf","sidebarTitle":"uniqArrayIf","href":"/guides/clickhouse/examples/aggregate-function-combinators/uniqArrayIf"}]},{"title":"Self-managed Upgrade","href":"/guides/oss/update"},{"group":"OSS best practices","pages":[{"sidebarTitle":"Sizing and hardware recommendations","title":"Sizing and hardware recommendations","href":"/guides/oss/best-practices/sizing-and-hardware-recommendations"},{"sidebarTitle":"OSS usage recommendations","title":"OSS usage recommendations","href":"/guides/oss/best-practices/tips"}]},{"group":"Deployment and scaling","expanded":false,"pages":[{"sidebarTitle":"Introduction","title":"Introduction","href":"/guides/oss/deployment-and-scaling/terminology"},{"title":"Table shards and replicas","href":"/guides/oss/deployment-and-scaling/shards"},{"sidebarTitle":"Rebalancing shards","title":"Rebalancing Data","href":"/guides/oss/deployment-and-scaling/scaling-clusters"},{"sidebarTitle":"Separation of storage and compute","title":"Separation of storage and compute","href":"/guides/oss/deployment-and-scaling/separation-storage-compute"},{"sidebarTitle":"Cluster discovery","title":"Cluster discovery","href":"/guides/oss/deployment-and-scaling/cluster-discovery"},{"group":"Keeper","expanded":false,"pages":[{"sidebarTitle":"Configuring ClickHouse Keeper","title":"ClickHouse Keeper","href":"/guides/oss/deployment-and-scaling/keeper/index"},{"sidebarTitle":"Secured Communication with Zookeeper","title":"Optional secured communication between ClickHouse and Zookeeper","href":"/guides/oss/deployment-and-scaling/keeper/ssl-zookeeper"}]},{"group":"Monitoring","expanded":false,"pages":[{"sidebarTitle":"Monitoring","title":"Monitoring","href":"/guides/oss/deployment-and-scaling/monitoring/monitoring"},{"sidebarTitle":"Tracing ClickHouse with OpenTelemetry","title":"Tracing ClickHouse with OpenTelemetry","href":"/guides/oss/deployment-and-scaling/monitoring/opentelemetry"}]},{"group":"Examples","expanded":false,"pages":[{"sidebarTitle":"Replication","title":"Replicating data","href":"/guides/oss/deployment-and-scaling/examples/1-shard-2-replicas"},{"sidebarTitle":"Scaling","title":"Scaling","href":"/guides/oss/deployment-and-scaling/examples/2-shards-1-replica"},{"sidebarTitle":"Replication + scaling","title":"Replication + scaling","href":"/guides/oss/deployment-and-scaling/examples/2-shards-2-replicas"}]}]}]},{"group":"Use case guides","expanded":true,"pages":[{"title":"Use case guides","sidebarTitle":"Overview","mode":"wide","href":"/guides/use-cases/index"},{"group":"Real-time analytics","pages":[{"group":"Time series","expanded":false,"pages":[{"title":"Time-Series","href":"/guides/use-cases/real-time-analytics/time-series/index"},{"title":"Date and time data types - time-series","sidebarTitle":"Date and time data types","href":"/guides/use-cases/real-time-analytics/time-series/date-time-data-types"},{"title":"Basic operations - time-series","sidebarTitle":"Basic operations","href":"/guides/use-cases/real-time-analytics/time-series/basic-operations"},{"title":"Analysis functions - time-series","sidebarTitle":"Analysis functions","href":"/guides/use-cases/real-time-analytics/time-series/analysis-functions"},{"title":"Storage efficiency - time-series","sidebarTitle":"Storage efficiency","href":"/guides/use-cases/real-time-analytics/time-series/storage-efficiency"},{"title":"Query performance - time-series","sidebarTitle":"Query performance","href":"/guides/use-cases/real-time-analytics/time-series/query-performance"},{"title":"Build a rollup with materialized views for fast time-series analytics","href":"/guides/use-cases/real-time-analytics/time-series/materialized-view-rollup"},{"sidebarTitle":"Time series - gap fill","title":"Filling gaps in time-series data","href":"/guides/use-cases/real-time-analytics/time-series/time-series-filling-gaps"}]}]},{"group":"Observability","pages":[{"title":"Observability","sidebarTitle":"Overview","href":"/guides/use-cases/observability/index"},{"title":"ClickHouse Cloud monitoring","sidebarTitle":"ClickHouse Cloud monitoring","href":"/guides/use-cases/observability/cloud-monitoring"},{"title":"Self-managed monitoring","sidebarTitle":"Self-managed monitoring","href":"/guides/use-cases/observability/self-managed-monitoring"},{"group":"Build your own","pages":[{"title":"Build your own observability stack","sidebarTitle":"Overview","href":"/guides/use-cases/observability/build-your-own/index"},{"title":"Using ClickHouse for observability","href":"/guides/use-cases/observability/build-your-own/introduction"},{"title":"Designing a schema for observability","href":"/guides/use-cases/observability/build-your-own/schema-design"},{"title":"Integrating OpenTelemetry for data collection","href":"/guides/use-cases/observability/build-your-own/integrating-opentelemetry"},{"title":"Managing data","href":"/guides/use-cases/observability/build-your-own/managing-data"},{"title":"Using Grafana and ClickHouse for observability","href":"/guides/use-cases/observability/build-your-own/grafana"},{"title":"Demo application","href":"/guides/use-cases/observability/build-your-own/demo-application"}]}]},{"group":"Data warehousing","pages":[{"title":"Data Lake","href":"/guides/use-cases/data-warehousing/index"},{"group":"Getting started","pages":[{"title":"Getting started with data lakes","sidebarTitle":"Overview","href":"/guides/use-cases/data-warehousing/getting-started/overview"},{"title":"Querying open table formats directly","sidebarTitle":"Direct querying","href":"/guides/use-cases/data-warehousing/getting-started/querying-directly"},{"title":"Connecting to a data catalog","sidebarTitle":"Connecting to catalogs","href":"/guides/use-cases/data-warehousing/getting-started/connecting-catalogs"},{"title":"Accelerating analytics with MergeTree","sidebarTitle":"Accelerating queries","href":"/guides/use-cases/data-warehousing/getting-started/accelerating-analytics"},{"title":"Writing data to open table formats","sidebarTitle":"Writing to data lakes","href":"/guides/use-cases/data-warehousing/getting-started/writing-data"},{"title":"Data lakes best practices","sidebarTitle":"Best practices","href":"/guides/use-cases/data-warehousing/getting-started/best-practices"}]},{"group":"Catalogs","pages":[{"title":"Catalog guides","href":"/guides/use-cases/data-warehousing/reference/index"},{"sidebarTitle":"AWS Glue catalog","title":"AWS Glue catalog","href":"/guides/use-cases/data-warehousing/glue-catalog"},{"sidebarTitle":"Lakekeeper catalog","title":"Lakekeeper catalog","href":"/guides/use-cases/data-warehousing/lakekeeper-catalog"},{"sidebarTitle":"Nessie catalog","title":"Nessie catalog","href":"/guides/use-cases/data-warehousing/nessie-catalog"},{"sidebarTitle":"Fabric OneLake","title":"Fabric OneLake","href":"/guides/use-cases/data-warehousing/onelake-catalog"},{"sidebarTitle":"Polaris catalog","title":"Polaris catalog","href":"/guides/use-cases/data-warehousing/polaris-catalog"},{"sidebarTitle":"Horizon catalog","title":"Snowflake Horizon catalog","href":"/guides/use-cases/data-warehousing/horizon-catalog"},{"sidebarTitle":"REST catalog","title":"REST catalog","href":"/guides/use-cases/data-warehousing/rest-catalog"},{"sidebarTitle":"SeaweedFS catalog","title":"SeaweedFS catalog","href":"/guides/use-cases/data-warehousing/seaweedfs-catalog"},{"sidebarTitle":"Unity Catalog","title":"Unity Catalog","href":"/guides/use-cases/data-warehousing/unity-catalog"},{"sidebarTitle":"BigLake Metastore","title":"Lakehouse runtime catalog (BigLake Metastore)","href":"/guides/use-cases/data-warehousing/biglake-catalog"}]},{"title":"Support matrix","sidebarTitle":"Support matrix","href":"/guides/use-cases/data-warehousing/support-matrix"}]},{"group":"AI/ML","pages":[{"title":"Machine learning and GenAI","href":"/guides/use-cases/ai-ml/index"},{"sidebarTitle":"Vector search with QBit","title":"An introduction to vector search and QBit","href":"/guides/use-cases/ai-ml/vector-search"},{"sidebarTitle":"AI-powered SQL generation","title":"AI-powered SQL generation","href":"/guides/use-cases/ai-ml/ai-powered-sql-generation"},{"sidebarTitle":"Import Langfuse Cloud trace data","title":"Import Langfuse Cloud trace data","href":"/guides/use-cases/ai-ml/import-langfuse-trace-data"},{"group":"Data exploration","pages":[{"sidebarTitle":"Exploring data with Jupyter notebooks and chDB","title":"Exploring data with Jupyter notebooks and chDB","href":"/guides/use-cases/ai-ml/data-exploration/jupyter-notebook"},{"sidebarTitle":"Exploring data with Marimo notebooks and chDB","title":"Exploring data with Marimo notebooks and chDB","href":"/guides/use-cases/ai-ml/data-exploration/marimo-notebook"}]},{"group":"MCP","pages":[{"sidebarTitle":"Overview","title":"ClickHouse MCP integrations","mode":"wide","href":"/guides/use-cases/ai-ml/MCP/index"},{"sidebarTitle":"Set up ClickHouse MCP server","title":"Set up the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/claude-desktop"},{"sidebarTitle":"Integrate LibreChat","title":"Using ClickHouse MCP server with LibreChat","href":"/guides/use-cases/ai-ml/MCP/librechat"},{"sidebarTitle":"Integrate AnythingLLM","title":"Using ClickHouse MCP server with AnythingLLM","href":"/guides/use-cases/ai-ml/MCP/anythingllm"},{"sidebarTitle":"Integrate Open WebUI","title":"Using ClickHouse MCP server with Open WebUI","href":"/guides/use-cases/ai-ml/MCP/open-webui"},{"sidebarTitle":"Integrate Ollama","title":"Set up ClickHouse MCP server with Ollama","href":"/guides/use-cases/ai-ml/MCP/ollama"},{"sidebarTitle":"Integrate Jan.ai","title":"Using ClickHouse MCP server with Jan.ai","href":"/guides/use-cases/ai-ml/MCP/janai"},{"group":"AI agent libraries","pages":[{"title":"Integrate AI agent libraries with ClickHouse MCP server","sidebarTitle":"Overview","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/index"},{"sidebarTitle":"Agno","title":"How to build an AI Agent with Agno and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/agno"},{"sidebarTitle":"Chainlit","title":"How to build an AI Agent with Chainlit and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/chainlit"},{"sidebarTitle":"Claude Agent SDK","title":"How to build an AI Agent with Claude Agent SDK and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/claude-agent-sdk"},{"sidebarTitle":"CopilotKit","title":"How to build an AI Agent with CopilotKit and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/copilotkit"},{"sidebarTitle":"CrewAI","title":"How to build an AI Agent with CrewAI and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/crewai"},{"sidebarTitle":"DSPy","title":"How to build an AI Agent with DSPy and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/dspy"},{"sidebarTitle":"LangChain and LangGraph","title":"How to build a LangChain/LangGraph AI agent using ClickHouse MCP server.","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/langchain"},{"sidebarTitle":"LlamaIndex","title":"How to build a LlamaIndex AI agent using ClickHouse MCP server.","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/llamaindex"},{"sidebarTitle":"mcp-agent","title":"How to build an AI Agent with mcp-agent and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/mcp-agent"},{"sidebarTitle":"Microsoft Agent Framework","title":"How to build an AI Agent with Microsoft Agent framework and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/microsoft-agent-framework"},{"sidebarTitle":"OpenAI Agents SDK","title":"How to build an OpenAI agent using ClickHouse MCP server.","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/openai-agents"},{"sidebarTitle":"PydanticAI","title":"How to build a PydanticAI agent using ClickHouse MCP server.","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/pydantic-ai"},{"sidebarTitle":"SlackBot","title":"How to build a SlackBot agent using ClickHouse MCP server.","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/slackbot"},{"sidebarTitle":"Streamlit","title":"How to build a ClickHouse-backed AI Agent with Streamlit","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/streamlit"},{"sidebarTitle":"Upsonic","title":"How to build an AI Agent with Upsonic and the ClickHouse MCP server","href":"/guides/use-cases/ai-ml/MCP/ai-agent-libraries/upsonic"}]}]}]}]}]},{"item":"Reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-reference.svg","pages":[{"title":"Reference","sidebarTitle":"Home","mode":"wide","href":"/reference/home"},{"group":"SQL Reference","expanded":true,"pages":[{"sidebarTitle":"Syntax","title":"Syntax","href":"/reference/syntax"},{"group":"Statements","expanded":false,"pages":[{"sidebarTitle":"List of statements","title":"ClickHouse SQL Statements","href":"/reference/statements/index"},{"group":"ALTER","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"ALTER","href":"/reference/statements/alter/index"},{"sidebarTitle":"APPLY DELETED MASK","title":"ALTER TABLE ... APPLY DELETED MASK","href":"/reference/statements/alter/apply-deleted-mask"},{"sidebarTitle":"APPLY PATCHES","title":"ALTER TABLE ... APPLY PATCHES","href":"/reference/statements/alter/apply-patches"},{"sidebarTitle":"COLUMN","title":"ALTER TABLE ... COLUMN","href":"/reference/statements/alter/column"},{"sidebarTitle":"ALTER TABLE ... MODIFY COMMENT","title":"ALTER TABLE ... MODIFY COMMENT","href":"/reference/statements/alter/comment"},{"sidebarTitle":"CONSTRAINT","title":"ALTER TABLE ... CONSTRAINT","href":"/reference/statements/alter/constraint"},{"sidebarTitle":"ALTER DATABASE ... MODIFY COMMENT","title":"ALTER DATABASE ... MODIFY COMMENT","href":"/reference/statements/alter/database-comment"},{"sidebarTitle":"DELETE","title":"ALTER TABLE ... DELETE","href":"/reference/statements/alter/delete"},{"sidebarTitle":"NAMED COLLECTION","title":"ALTER NAMED COLLECTION","href":"/reference/statements/alter/named-collection"},{"sidebarTitle":"ORDER BY","title":"ALTER TABLE ... MODIFY ORDER BY","href":"/reference/statements/alter/order-by"},{"sidebarTitle":"PARTITION","title":"ALTER TABLE ... PARTITION","href":"/reference/statements/alter/partition"},{"sidebarTitle":"PROJECTION","title":"ALTER TABLE ... PROJECTION","href":"/reference/statements/alter/projection"},{"sidebarTitle":"QUOTA","title":"ALTER QUOTA","href":"/reference/statements/alter/quota"},{"sidebarTitle":"ROLE","title":"ALTER ROLE","href":"/reference/statements/alter/role"},{"sidebarTitle":"ROW POLICY","title":"ALTER ROW POLICY","href":"/reference/statements/alter/row-policy"},{"sidebarTitle":"SAMPLE BY","title":"ALTER TABLE ... MODIFY SAMPLE BY","href":"/reference/statements/alter/sample-by"},{"sidebarTitle":"SETTING","title":"ALTER TABLE ... MODIFY SETTING","href":"/reference/statements/alter/setting"},{"sidebarTitle":"SETTINGS PROFILE","title":"ALTER SETTINGS PROFILE","href":"/reference/statements/alter/settings-profile"},{"sidebarTitle":"INDEX","title":"ALTER TABLE ... INDEX","href":"/reference/statements/alter/skipping-index"},{"sidebarTitle":"STATISTICS","title":"ALTER TABLE ... STATISTICS","href":"/reference/statements/alter/statistics"},{"sidebarTitle":"TTL","title":"ALTER TABLE ... MODIFY TTL","href":"/reference/statements/alter/ttl"},{"sidebarTitle":"UPDATE","title":"ALTER TABLE ... UPDATE","href":"/reference/statements/alter/update"},{"sidebarTitle":"USER","title":"ALTER USER","href":"/reference/statements/alter/user"},{"sidebarTitle":"MASKING POLICY","title":"ALTER MASKING POLICY","href":"/reference/statements/alter/masking-policy"},{"sidebarTitle":"VIEW","title":"ALTER TABLE ... MODIFY QUERY","href":"/reference/statements/alter/view"}]},{"sidebarTitle":"ATTACH","title":"ATTACH","href":"/reference/statements/attach"},{"sidebarTitle":"CHECK GRANT","title":"CHECK GRANT","href":"/reference/statements/check-grant"},{"sidebarTitle":"CHECK DATABASE","title":"CHECK DATABASE","href":"/reference/statements/check-database"},{"sidebarTitle":"CHECK TABLE","title":"CHECK TABLE","href":"/reference/statements/check-table"},{"group":"CREATE","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"CREATE","href":"/reference/statements/create/index"},{"sidebarTitle":"DATABASE","title":"CREATE DATABASE","href":"/reference/statements/create/database"},{"group":"DICTIONARY","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"CREATE DICTIONARY","href":"/reference/statements/create/dictionary"},{"sidebarTitle":"Attributes","title":"Dictionary attributes","href":"/reference/statements/create/dictionary/attributes"},{"sidebarTitle":"Embedded dictionaries","title":"Embedded (geobase) dictionaries","href":"/reference/statements/create/dictionary/embedded"},{"sidebarTitle":"LIFETIME","title":"Refreshing dictionary data using LIFETIME","href":"/reference/statements/create/dictionary/lifetime"},{"group":"Layouts","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Dictionary layouts","href":"/reference/statements/create/dictionary/layouts/overview"},{"title":"flat dictionary layout","sidebarTitle":"flat","href":"/reference/statements/create/dictionary/layouts/flat"},{"title":"hashed dictionary layout types","sidebarTitle":"hashed","href":"/reference/statements/create/dictionary/layouts/hashed"},{"title":"hashed_array dictionary layout types","sidebarTitle":"hashed_array","href":"/reference/statements/create/dictionary/layouts/hashed-array"},{"title":"cache dictionary layout","sidebarTitle":"cache","href":"/reference/statements/create/dictionary/layouts/cache"},{"title":"ssd_cache dictionary layout types","sidebarTitle":"ssd_cache","href":"/reference/statements/create/dictionary/layouts/ssd-cache"},{"title":"direct dictionary layout","sidebarTitle":"direct","href":"/reference/statements/create/dictionary/layouts/direct"},{"title":"range_hashed dictionary layout types","sidebarTitle":"range_hashed","href":"/reference/statements/create/dictionary/layouts/range-hashed"},{"title":"Hierarchical dictionaries","sidebarTitle":"Hierarchical","href":"/reference/statements/create/dictionary/layouts/hierarchical"},{"title":"Naive Bayes dictionaries","sidebarTitle":"Naive Bayes","href":"/reference/statements/create/dictionary/layouts/naive-bayes"},{"title":"XGBoost dictionaries","sidebarTitle":"XGBoost","href":"/reference/statements/create/dictionary/layouts/xgboost"},{"title":"Polygon dictionaries","sidebarTitle":"Polygon","href":"/reference/statements/create/dictionary/layouts/polygon"},{"title":"ip_trie dictionary layout","sidebarTitle":"ip_trie","href":"/reference/statements/create/dictionary/layouts/ip-trie"},{"title":"Regular expression tree dictionary layout","sidebarTitle":"Regexp Tree","href":"/reference/statements/create/dictionary/layouts/regexp-tree"}]},{"group":"Sources","expanded":false,"pages":[{"title":"Dictionary Sources","sidebarTitle":"Overview","href":"/reference/statements/create/dictionary/sources/overview"},{"title":"Local File dictionary source","sidebarTitle":"Local File","href":"/reference/statements/create/dictionary/sources/local-file"},{"title":"Executable File dictionary source","sidebarTitle":"Executable File","href":"/reference/statements/create/dictionary/sources/executable-file"},{"title":"Executable Pool dictionary source","sidebarTitle":"Executable Pool","href":"/reference/statements/create/dictionary/sources/executable-pool"},{"title":"HTTP(S) dictionary source","sidebarTitle":"HTTP(S)","href":"/reference/statements/create/dictionary/sources/http"},{"title":"ClickHouse dictionary source","sidebarTitle":"ClickHouse","href":"/reference/statements/create/dictionary/sources/clickhouse"},{"title":"MySQL dictionary source","sidebarTitle":"MySQL","href":"/reference/statements/create/dictionary/sources/mysql"},{"title":"PostgreSQL dictionary source","sidebarTitle":"PostgreSQL","href":"/reference/statements/create/dictionary/sources/postgresql"},{"title":"MongoDB dictionary source","sidebarTitle":"MongoDB","href":"/reference/statements/create/dictionary/sources/mongodb"},{"title":"Redis dictionary source","sidebarTitle":"Redis","href":"/reference/statements/create/dictionary/sources/redis"},{"title":"Cassandra dictionary source","sidebarTitle":"Cassandra","href":"/reference/statements/create/dictionary/sources/cassandra"},{"title":"ODBC dictionary source","sidebarTitle":"ODBC","href":"/reference/statements/create/dictionary/sources/odbc"},{"title":"Null dictionary source","sidebarTitle":"Null","href":"/reference/statements/create/dictionary/sources/null"},{"title":"YAMLRegExpTree dictionary source","sidebarTitle":"YAMLRegExpTree","href":"/reference/statements/create/dictionary/sources/yamlregexptree"},{"title":"YTsaurus dictionary source","sidebarTitle":"YTsaurus","href":"/reference/statements/create/dictionary/sources/ytsaurus"}]}]},{"sidebarTitle":"MASKING POLICY","title":"CREATE MASKING POLICY","href":"/reference/statements/create/masking-policy"},{"sidebarTitle":"FUNCTION","title":"CREATE FUNCTION","href":"/reference/statements/create/function"},{"sidebarTitle":"HANDLER","title":"CREATE HANDLER","href":"/reference/statements/create/handler"},{"sidebarTitle":"NAMED COLLECTION","title":"CREATE NAMED COLLECTION","href":"/reference/statements/create/named-collection"},{"sidebarTitle":"QUOTA","title":"CREATE QUOTA","href":"/reference/statements/create/quota"},{"sidebarTitle":"ROLE","title":"CREATE ROLE","href":"/reference/statements/create/role"},{"sidebarTitle":"ROW POLICY","title":"CREATE ROW POLICY","href":"/reference/statements/create/row-policy"},{"sidebarTitle":"SETTINGS PROFILE","title":"CREATE SETTINGS PROFILE","href":"/reference/statements/create/settings-profile"},{"group":"TABLE","expanded":false,"pages":[{"sidebarTitle":"CREATE TABLE","title":"CREATE TABLE","href":"/reference/statements/create/table"},{"sidebarTitle":"CODEC","title":"CODEC","href":"/reference/statements/create/table/codec"},{"sidebarTitle":"TEMPORARY TABLE","title":"CREATE TEMPORARY TABLE","href":"/reference/statements/create/table/temporary-table"},{"sidebarTitle":"REPLACE TABLE","title":"REPLACE TABLE","href":"/reference/statements/create/table/replace-table"}]},{"sidebarTitle":"TOKEN","title":"CREATE TOKEN","href":"/reference/statements/create/token"},{"sidebarTitle":"USER","title":"CREATE USER","href":"/reference/statements/create/user"},{"sidebarTitle":"VIEW","title":"CREATE VIEW","href":"/reference/statements/create/view"}]},{"sidebarTitle":"DELETE","title":"DELETE","href":"/reference/statements/delete"},{"sidebarTitle":"DESCRIBE TABLE","title":"DESCRIBE TABLE","href":"/reference/statements/describe-table"},{"sidebarTitle":"DETACH","title":"DETACH","href":"/reference/statements/detach"},{"sidebarTitle":"Distributed DDL","title":"ON CLUSTER","href":"/reference/statements/distributed-ddl"},{"sidebarTitle":"DROP","title":"DROP","href":"/reference/statements/drop"},{"sidebarTitle":"EXCHANGE","title":"EXCHANGE","href":"/reference/statements/exchange"},{"sidebarTitle":"EXECUTE AS","title":"EXECUTE AS","href":"/reference/statements/execute_as"},{"sidebarTitle":"EXISTS","title":"EXISTS","href":"/reference/statements/exists"},{"sidebarTitle":"EXPLAIN","title":"EXPLAIN","href":"/reference/statements/explain"},{"sidebarTitle":"GRANT","title":"GRANT","href":"/reference/statements/grant"},{"sidebarTitle":"HYPOTHETICAL INDEX","title":"HYPOTHETICAL INDEX","href":"/reference/statements/hypothetical-index"},{"sidebarTitle":"HYPOTHETICAL PROJECTION","title":"HYPOTHETICAL PROJECTION","href":"/reference/statements/hypothetical-projection"},{"title":"IN","href":"/reference/statements/in"},{"sidebarTitle":"INSERT INTO","title":"INSERT INTO","href":"/reference/statements/insert-into"},{"sidebarTitle":"KILL","title":"KILL","href":"/reference/statements/kill"},{"sidebarTitle":"MOVE","title":"MOVE","href":"/reference/statements/move"},{"sidebarTitle":"OPTIMIZE","title":"OPTIMIZE","href":"/reference/statements/optimize"},{"sidebarTitle":"PARALLEL WITH","title":"PARALLEL WITH","href":"/reference/statements/parallel_with"},{"sidebarTitle":"RENAME","title":"RENAME","href":"/reference/statements/rename"},{"sidebarTitle":"REVOKE","title":"REVOKE","href":"/reference/statements/revoke"},{"group":"SELECT","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"SELECT","href":"/reference/statements/select/index"},{"sidebarTitle":"ALL","title":"ALL","href":"/reference/statements/select/all"},{"sidebarTitle":"APPLY","title":"APPLY modifier","href":"/reference/statements/select/apply_modifier"},{"sidebarTitle":"ARRAY JOIN","title":"ARRAY JOIN","href":"/reference/statements/select/array-join"},{"sidebarTitle":"DISTINCT","title":"DISTINCT","href":"/reference/statements/select/distinct"},{"sidebarTitle":"EXCEPT","title":"EXCEPT","href":"/reference/statements/select/except"},{"sidebarTitle":"EXCEPT","title":"EXCEPT modifier","href":"/reference/statements/select/except_modifier"},{"sidebarTitle":"FORMAT","title":"FORMAT","href":"/reference/statements/select/format"},{"sidebarTitle":"FROM","title":"FROM","href":"/reference/statements/select/from"},{"sidebarTitle":"GROUP BY","title":"GROUP BY","href":"/reference/statements/select/group-by"},{"sidebarTitle":"HAVING","title":"HAVING","href":"/reference/statements/select/having"},{"sidebarTitle":"INTERSECT","title":"INTERSECT","href":"/reference/statements/select/intersect"},{"sidebarTitle":"INTO OUTFILE","title":"INTO OUTFILE","href":"/reference/statements/select/into-outfile"},{"sidebarTitle":"JOIN","title":"JOIN","href":"/reference/statements/select/join"},{"sidebarTitle":"LIMIT BY","title":"LIMIT BY","href":"/reference/statements/select/limit-by"},{"sidebarTitle":"LIMIT","title":"LIMIT","href":"/reference/statements/select/limit"},{"sidebarTitle":"OFFSET","title":"OFFSET FETCH","href":"/reference/statements/select/offset"},{"sidebarTitle":"ORDER BY","title":"ORDER BY","href":"/reference/statements/select/order-by"},{"sidebarTitle":"Pipe operators","title":"PIPE OPERATORS","href":"/reference/statements/select/pipe-operators"},{"sidebarTitle":"PREWHERE","title":"PREWHERE","href":"/reference/statements/select/prewhere"},{"sidebarTitle":"QUALIFY","title":"QUALIFY","href":"/reference/statements/select/qualify"},{"sidebarTitle":"REPLACE","title":"REPLACE modifier","href":"/reference/statements/select/replace_modifier"},{"sidebarTitle":"SAMPLE","title":"SAMPLE","href":"/reference/statements/select/sample"},{"sidebarTitle":"UNION","title":"UNION","href":"/reference/statements/select/union"},{"sidebarTitle":"WHERE","title":"WHERE","href":"/reference/statements/select/where"},{"sidebarTitle":"WITH","title":"WITH","href":"/reference/statements/select/with"}]},{"sidebarTitle":"SET ROLE","title":"SET ROLE","href":"/reference/statements/set-role"},{"sidebarTitle":"SET","title":"SET","href":"/reference/statements/set"},{"sidebarTitle":"SHOW","title":"SHOW","href":"/reference/statements/show"},{"sidebarTitle":"SYSTEM","title":"SYSTEM","href":"/reference/statements/system"},{"sidebarTitle":"TRUNCATE","title":"TRUNCATE","href":"/reference/statements/truncate"},{"sidebarTitle":"UNDROP","title":"UNDROP","href":"/reference/statements/undrop"},{"sidebarTitle":"UPDATE","title":"UPDATE","href":"/reference/statements/update"},{"sidebarTitle":"USE","title":"USE","href":"/reference/statements/use"}]},{"group":"Operators","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Operators","href":"/reference/operators/index"}]}]},{"group":"Data Types","expanded":false,"pages":[{"sidebarTitle":"List of data types","title":"Data Types in ClickHouse","mode":"wide","href":"/reference/data-types/index"},{"group":"Numeric types","expanded":false,"pages":[{"sidebarTitle":"Int | UInt","title":"Int | UInt Types","href":"/reference/data-types/int-uint"},{"sidebarTitle":"Float32 | Float64 | BFloat16","title":"Float32 | Float64 | BFloat16 Types","href":"/reference/data-types/float"},{"sidebarTitle":"Decimal","title":"Decimal, Decimal(P), Decimal(P, S), Decimal32(S), Decimal64(S), Decimal128(S), Decimal256(S)","href":"/reference/data-types/decimal"},{"sidebarTitle":"Boolean","title":"Bool","href":"/reference/data-types/boolean"}]},{"group":"String types","expanded":false,"pages":[{"sidebarTitle":"String","title":"String","href":"/reference/data-types/string"},{"sidebarTitle":"FixedString(N)","title":"FixedString(N)","href":"/reference/data-types/fixedstring"}]},{"group":"Date and time types","expanded":false,"pages":[{"sidebarTitle":"Date","title":"Date","href":"/reference/data-types/date"},{"sidebarTitle":"Date32","title":"Date32","href":"/reference/data-types/date32"},{"sidebarTitle":"DateTime","title":"DateTime","href":"/reference/data-types/datetime"},{"sidebarTitle":"DateTime64","title":"DateTime64","href":"/reference/data-types/datetime64"},{"sidebarTitle":"Time","title":"Time","href":"/reference/data-types/time"},{"sidebarTitle":"Time64","title":"Time64","href":"/reference/data-types/time64"}]},{"group":"Network types","expanded":false,"pages":[{"sidebarTitle":"IPv4","title":"IPv4","href":"/reference/data-types/ipv4"},{"sidebarTitle":"IPv6","title":"IPv6","href":"/reference/data-types/ipv6"}]},{"group":"Composite types","expanded":false,"pages":[{"sidebarTitle":"Array(T)","title":"Array(T)","href":"/reference/data-types/array"},{"sidebarTitle":"Tuple(T1, T2, ...)","title":"Tuple(T1, T2, ...)","href":"/reference/data-types/tuple"},{"sidebarTitle":"Map(K, V)","title":"Map(K, V)","href":"/reference/data-types/map"},{"sidebarTitle":"Nested(Name1 Type1, Name2 Type2, ...)","title":"Nested(name1 Type1, Name2 Type2, ...)","href":"/reference/data-types/nested-data-structures/index"}]},{"group":"Semi-structured types","expanded":false,"pages":[{"sidebarTitle":"JSON","title":"JSON Data Type","href":"/reference/data-types/newjson"},{"sidebarTitle":"Dynamic","title":"Dynamic","href":"/reference/data-types/dynamic"},{"sidebarTitle":"Variant(T1, T2, ...)","title":"Variant(T1, T2, ...)","href":"/reference/data-types/variant"}]},{"group":"Nullable and optional types","expanded":false,"pages":[{"sidebarTitle":"Nullable(T)","title":"Nullable(T)","href":"/reference/data-types/nullable"},{"sidebarTitle":"LowCardinality(T)","title":"LowCardinality(T)","href":"/reference/data-types/lowcardinality"}]},{"group":"Specialized types","expanded":false,"pages":[{"sidebarTitle":"UUID","title":"UUID","href":"/reference/data-types/uuid"},{"sidebarTitle":"Enum","title":"Enum","href":"/reference/data-types/enum"},{"sidebarTitle":"Geo","title":"Geometric","href":"/reference/data-types/geo"},{"sidebarTitle":"QBit","title":"QBit Data Type","href":"/reference/data-types/qbit"},{"sidebarTitle":"Domains","title":"Domains","href":"/reference/data-types/domains/index"}]},{"group":"Aggregate function types","expanded":false,"pages":[{"sidebarTitle":"AggregateFunction","title":"AggregateFunction Type","href":"/reference/data-types/aggregatefunction"},{"sidebarTitle":"SimpleAggregateFunction","title":"SimpleAggregateFunction Type","href":"/reference/data-types/simpleaggregatefunction"}]},{"group":"Special Data Types","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Special Data Types","href":"/reference/data-types/special-data-types/index"},{"sidebarTitle":"Expression","title":"Expression","href":"/reference/data-types/special-data-types/expression"},{"sidebarTitle":"Interval","title":"Interval","href":"/reference/data-types/special-data-types/interval"},{"sidebarTitle":"Nothing","title":"Nothing","href":"/reference/data-types/special-data-types/nothing"},{"sidebarTitle":"Set","title":"Set","href":"/reference/data-types/special-data-types/set"}]},{"group":"Binary encoding","pages":[{"sidebarTitle":"Data types binary encoding specification.","title":"Data types binary encoding specification","href":"/reference/data-types/data-types-binary-encoding"}]}]},{"group":"Engines","expanded":false,"pages":[{"title":"Engines","sidebarTitle":"Overview","mode":"wide","href":"/reference/engines/engines"},{"group":"Table Engines","expanded":false,"pages":[{"title":"Table Engines","sidebarTitle":"Overview","href":"/reference/engines/table-engines/index"},{"group":"Integrations","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Table Engines for Integrations","href":"/reference/engines/table-engines/integrations/index"},{"sidebarTitle":"ArrowFlight","title":"ArrowFlight table engine","href":"/reference/engines/table-engines/integrations/arrowflight"},{"sidebarTitle":"AzureQueue","title":"AzureQueue table engine","href":"/reference/engines/table-engines/integrations/azure-queue"},{"sidebarTitle":"Azure Blob Storage","title":"AzureBlobStorage table engine","href":"/reference/engines/table-engines/integrations/azureBlobStorage"},{"sidebarTitle":"BigQuery","title":"BigQuery table engine","href":"/reference/engines/table-engines/integrations/bigquery"},{"sidebarTitle":"DeltaLake","title":"DeltaLake table engine","href":"/reference/engines/table-engines/integrations/deltalake"},{"sidebarTitle":"Elasticsearch","title":"Elasticsearch table engine","href":"/reference/engines/table-engines/integrations/elasticsearch"},{"sidebarTitle":"EmbeddedRocksDB","title":"EmbeddedRocksDB table engine","href":"/reference/engines/table-engines/integrations/embedded-rocksdb"},{"sidebarTitle":"ExternalDistributed","title":"ExternalDistributed table engine","href":"/reference/engines/table-engines/integrations/ExternalDistributed"},{"sidebarTitle":"HDFS","title":"HDFS table engine","href":"/reference/engines/table-engines/integrations/hdfs"},{"sidebarTitle":"Hive","title":"Hive table engine","href":"/reference/engines/table-engines/integrations/hive"},{"sidebarTitle":"Hudi","title":"Hudi table engine","href":"/reference/engines/table-engines/integrations/hudi"},{"sidebarTitle":"Iceberg","title":"Iceberg table engine","href":"/reference/engines/table-engines/integrations/iceberg"},{"sidebarTitle":"JDBC","title":"JDBC table engine","href":"/reference/engines/table-engines/integrations/jdbc"},{"sidebarTitle":"Kafka","title":"Kafka table engine","href":"/reference/engines/table-engines/integrations/kafka"},{"sidebarTitle":"MaterializedPostgreSQL","title":"MaterializedPostgreSQL table engine","href":"/reference/engines/table-engines/integrations/materialized-postgresql"},{"sidebarTitle":"MongoDB","title":"MongoDB table engine","href":"/reference/engines/table-engines/integrations/mongodb"},{"sidebarTitle":"MySQL","title":"MySQL table engine","href":"/reference/engines/table-engines/integrations/mysql"},{"sidebarTitle":"NATS","title":"NATS table engine","href":"/reference/engines/table-engines/integrations/nats"},{"sidebarTitle":"ODBC","title":"ODBC table engine","href":"/reference/engines/table-engines/integrations/odbc"},{"sidebarTitle":"Paimon","title":"Paimon table engine","href":"/reference/engines/table-engines/integrations/paimon"},{"sidebarTitle":"PostgreSQL","title":"PostgreSQL table Engine","href":"/reference/engines/table-engines/integrations/postgresql"},{"sidebarTitle":"RabbitMQ","title":"RabbitMQ table engine","href":"/reference/engines/table-engines/integrations/rabbitmq"},{"sidebarTitle":"Redis","title":"Redis table engine","href":"/reference/engines/table-engines/integrations/redis"},{"sidebarTitle":"S3","title":"S3 table engine","href":"/reference/engines/table-engines/integrations/s3"},{"sidebarTitle":"S3Queue","title":"S3Queue table engine","href":"/reference/engines/table-engines/integrations/s3queue"},{"sidebarTitle":"SQLite","title":"SQLite table engine","href":"/reference/engines/table-engines/integrations/sqlite"},{"sidebarTitle":"TimeSeries","title":"TimeSeries table engine","href":"/reference/engines/table-engines/integrations/time-series"},{"sidebarTitle":"YTsaurus","title":"YTsaurus table engine","href":"/reference/engines/table-engines/integrations/ytsaurus"}]},{"group":"Log Family","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Log engine family","href":"/reference/engines/table-engines/log-family/index"},{"title":"Log table engine","href":"/reference/engines/table-engines/log-family/log"},{"title":"StripeLog table engine","href":"/reference/engines/table-engines/log-family/stripelog"},{"title":"TinyLog table engine","href":"/reference/engines/table-engines/log-family/tinylog"}]},{"group":"MergeTree Family","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"MergeTree Engine Family","href":"/reference/engines/table-engines/mergetree-family/index"},{"sidebarTitle":"MergeTree","title":"MergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/mergetree"},{"sidebarTitle":"AggregatingMergeTree","title":"AggregatingMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/aggregatingmergetree"},{"sidebarTitle":"Exact and Approximate Vector Search","title":"Exact and Approximate Vector Search","href":"/reference/engines/table-engines/mergetree-family/annindexes"},{"sidebarTitle":"CoalescingMergeTree","title":"CoalescingMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/coalescingmergetree"},{"sidebarTitle":"CollapsingMergeTree","title":"CollapsingMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/collapsingmergetree"},{"sidebarTitle":"Custom Partitioning Key","title":"Custom Partitioning Key","href":"/reference/engines/table-engines/mergetree-family/custom-partitioning-key"},{"sidebarTitle":"GraphiteMergeTree","title":"GraphiteMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/graphitemergetree"},{"sidebarTitle":"ReplacingMergeTree","title":"ReplacingMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/replacingmergetree"},{"sidebarTitle":"Replicated*","title":"Replicated* table engines","href":"/reference/engines/table-engines/mergetree-family/replication"},{"sidebarTitle":"SummingMergeTree","title":"SummingMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/summingmergetree"},{"sidebarTitle":"Full-text Search with Text Indexes","title":"Full-text Search with Text Indexes","href":"/reference/engines/table-engines/mergetree-family/textindexes"},{"sidebarTitle":"VersionedCollapsingMergeTree","title":"VersionedCollapsingMergeTree table engine","href":"/reference/engines/table-engines/mergetree-family/versionedcollapsingmergetree"}]},{"group":"Special","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Special table engines","href":"/reference/engines/table-engines/special/index"},{"sidebarTitle":"Alias","title":"Alias table engine","href":"/reference/engines/table-engines/special/alias"},{"sidebarTitle":"Buffer","title":"Buffer table engine","href":"/reference/engines/table-engines/special/buffer"},{"sidebarTitle":"Dictionary","title":"Dictionary table engine","href":"/reference/engines/table-engines/special/dictionary"},{"sidebarTitle":"Distributed","title":"Distributed table engine","href":"/reference/engines/table-engines/special/distributed"},{"sidebarTitle":"Executable/ExecutablePool","title":"Executable and ExecutablePool table engines","href":"/reference/engines/table-engines/special/executable"},{"sidebarTitle":"External data for query processing","title":"External data for query processing","href":"/reference/engines/table-engines/special/external-data"},{"sidebarTitle":"File","title":"File table engine","href":"/reference/engines/table-engines/special/file"},{"sidebarTitle":"FileLog","title":"FileLog table engine","href":"/reference/engines/table-engines/special/filelog"},{"sidebarTitle":"GenerateRandom","title":"GenerateRandom table engine","href":"/reference/engines/table-engines/special/generate"},{"sidebarTitle":"Join","title":"Join table engine","href":"/reference/engines/table-engines/special/join"},{"sidebarTitle":"KeeperMap","title":"KeeperMap table engine","href":"/reference/engines/table-engines/special/keepermap"},{"sidebarTitle":"Memory","title":"Memory table engine","href":"/reference/engines/table-engines/special/memory"},{"sidebarTitle":"Merge","title":"Merge table engine","href":"/reference/engines/table-engines/special/merge"},{"sidebarTitle":"Null","title":"Null table engine","href":"/reference/engines/table-engines/special/null"},{"sidebarTitle":"QueryRunner","title":"QueryRunner table engine","href":"/reference/engines/table-engines/special/query-runner"},{"sidebarTitle":"Set","title":"Set table engine","href":"/reference/engines/table-engines/special/set"},{"sidebarTitle":"URL","title":"URL table engine","href":"/reference/engines/table-engines/special/url"},{"sidebarTitle":"View","title":"View table engine","href":"/reference/engines/table-engines/special/view"}]}]},{"group":"Database Engines","expanded":false,"pages":[{"title":"Database Engines","sidebarTitle":"Overview","href":"/reference/engines/database-engines/index"},{"sidebarTitle":"Atomic","title":"Atomic","href":"/reference/engines/database-engines/atomic"},{"sidebarTitle":"Backup","title":"Backup","href":"/reference/engines/database-engines/backup"},{"sidebarTitle":"Cluster","title":"Cluster","href":"/reference/engines/database-engines/cluster"},{"sidebarTitle":"DataLakeCatalog","title":"DataLakeCatalog","href":"/reference/engines/database-engines/datalake"},{"sidebarTitle":"Dictionary","title":"Dictionary","href":"/reference/engines/database-engines/dictionary"},{"sidebarTitle":"Filesystem","title":"Filesystem","href":"/reference/engines/database-engines/filesystem"},{"sidebarTitle":"HDFS","title":"HDFS","href":"/reference/engines/database-engines/hdfs"},{"sidebarTitle":"MaterializedPostgreSQL","title":"MaterializedPostgreSQL","href":"/reference/engines/database-engines/materialized-postgresql"},{"sidebarTitle":"Memory","title":"Memory","href":"/reference/engines/database-engines/memory"},{"sidebarTitle":"MySQL","title":"MySQL","href":"/reference/engines/database-engines/mysql"},{"sidebarTitle":"Ordinary","title":"Ordinary","href":"/reference/engines/database-engines/ordinary"},{"sidebarTitle":"Overlay","title":"Overlay","href":"/reference/engines/database-engines/overlay"},{"sidebarTitle":"PostgreSQL","title":"PostgreSQL","href":"/reference/engines/database-engines/postgresql"},{"sidebarTitle":"Remote","title":"Remote","href":"/reference/engines/database-engines/remote"},{"sidebarTitle":"Replicated","title":"Replicated","href":"/reference/engines/database-engines/replicated"},{"sidebarTitle":"S3","title":"S3","href":"/reference/engines/database-engines/s3"},{"sidebarTitle":"Shared","title":"Shared","href":"/reference/engines/database-engines/shared"},{"sidebarTitle":"SQLite","title":"SQLite","href":"/reference/engines/database-engines/sqlite"},{"sidebarTitle":"URL","title":"URL","href":"/reference/engines/database-engines/url"}]}]},{"group":"Functions","expanded":false,"pages":[{"title":"Functions Overview","mode":"wide","href":"/reference/functions/index"},{"group":"Regular functions","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Regular Functions","href":"/reference/functions/regular-functions/overview"},{"sidebarTitle":"AI","title":"AI Functions","href":"/reference/functions/regular-functions/ai-functions"},{"sidebarTitle":"Arithmetic","title":"Arithmetic Functions","href":"/reference/functions/regular-functions/arithmetic-functions"},{"sidebarTitle":"Arrays","title":"Array Functions","href":"/reference/functions/regular-functions/array-functions"},{"sidebarTitle":"arrayJoin","title":"arrayJoin function","href":"/reference/functions/regular-functions/array-join"},{"sidebarTitle":"Bit","title":"Bit Functions","href":"/reference/functions/regular-functions/bit-functions"},{"sidebarTitle":"Bitmap","title":"Bitmap Functions","href":"/reference/functions/regular-functions/bitmap-functions"},{"sidebarTitle":"Comparison","title":"Comparison Functions","href":"/reference/functions/regular-functions/comparison-functions"},{"sidebarTitle":"Conditional","title":"Conditional Functions","href":"/reference/functions/regular-functions/conditional-functions"},{"sidebarTitle":"Dates and time","title":"Functions for Working with Dates and Times","href":"/reference/functions/regular-functions/date-time-functions"},{"sidebarTitle":"Distance","title":"Distance functions","href":"/reference/functions/regular-functions/distance-functions"},{"sidebarTitle":"Embedded dictionary","title":"Functions for Working with Embedded Dictionaries","href":"/reference/functions/regular-functions/embedded-dict-functions"},{"sidebarTitle":"Encoding","title":"Encoding functions","href":"/reference/functions/regular-functions/encoding-functions"},{"sidebarTitle":"Encryption","title":"Encryption functions","href":"/reference/functions/regular-functions/encryption-functions"},{"sidebarTitle":"Dictionaries","title":"Functions for Working with Dictionaries","href":"/reference/functions/regular-functions/ext-dict-functions"},{"sidebarTitle":"Files","title":"Files","href":"/reference/functions/regular-functions/files"},{"sidebarTitle":"Financial","title":"Financial functions","href":"/reference/functions/regular-functions/financial-functions"},{"sidebarTitle":"Nullable","title":"Functions for working with nullable values","href":"/reference/functions/regular-functions/functions-for-nulls"},{"group":"Geo","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Geo Functions","href":"/reference/functions/regular-functions/geo/index"},{"sidebarTitle":"Geographical Coordinates","title":"Functions for Working with Geographical Coordinates","href":"/reference/functions/regular-functions/geo/coordinates"},{"sidebarTitle":"Flip Coordinates","title":"Flipping Coordinates","href":"/reference/functions/regular-functions/geo/flipCoordinates"},{"sidebarTitle":"Geometry","title":"Functions for Working with Geometry","href":"/reference/functions/regular-functions/geo/geometry"},{"sidebarTitle":"Geohash","title":"Functions for Working with Geohash","href":"/reference/functions/regular-functions/geo/geohash"},{"sidebarTitle":"H3 Indexes","title":"Functions for Working with H3 Indexes","href":"/reference/functions/regular-functions/geo/h3"},{"sidebarTitle":"Mapbox Vector Tiles","title":"Functions for Encoding Mapbox Vector Tiles","href":"/reference/functions/regular-functions/geo/mvt"},{"sidebarTitle":"Polygons","title":"Functions for Working with Polygons","href":"/reference/functions/regular-functions/geo/polygon"},{"sidebarTitle":"S2 Geometry","title":"Functions for Working with S2 Index","href":"/reference/functions/regular-functions/geo/s2"},{"sidebarTitle":"SVG","title":"Functions for Generating SVG images from Geo data","href":"/reference/functions/regular-functions/geo/svg"}]},{"sidebarTitle":"Hash","title":"Hash Functions","href":"/reference/functions/regular-functions/hash-functions"},{"sidebarTitle":"IN Operator","title":"Functions for Implementing the IN Operator","href":"/reference/functions/regular-functions/in-functions"},{"sidebarTitle":"Introspection","title":"Introspection Functions","href":"/reference/functions/regular-functions/introspection"},{"sidebarTitle":"IP Addresses","title":"Functions for working with IPv4 and IPv6 addresses","href":"/reference/functions/regular-functions/ip-address-functions"},{"sidebarTitle":"JSON","title":"JSON Functions","href":"/reference/functions/regular-functions/json-functions"},{"sidebarTitle":"Logical","title":"Logical functions","href":"/reference/functions/regular-functions/logical-functions"},{"sidebarTitle":"Machine Learning","title":"Machine Learning Functions","href":"/reference/functions/regular-functions/machine-learning-functions"},{"sidebarTitle":"Mathematical","title":"Mathematical functions","href":"/reference/functions/regular-functions/math-functions"},{"sidebarTitle":"NLP","title":"Natural Language Processing (NLP) Functions","href":"/reference/functions/regular-functions/nlp-functions"},{"sidebarTitle":"NumericIndexedVector","title":"NumericIndexedVector Functions","href":"/reference/functions/regular-functions/numeric-indexed-vector-functions"},{"sidebarTitle":"Other","title":"Other functions","href":"/reference/functions/regular-functions/other-functions"},{"sidebarTitle":"Random number","title":"Functions for generating random numbers","href":"/reference/functions/regular-functions/random-functions"},{"sidebarTitle":"Rounding","title":"Rounding functions","href":"/reference/functions/regular-functions/rounding-functions"},{"sidebarTitle":"String splitting","title":"Functions for splitting strings","href":"/reference/functions/regular-functions/splitting-merging-functions"},{"sidebarTitle":"String","title":"Functions for working with strings","href":"/reference/functions/regular-functions/string-functions"},{"sidebarTitle":"String replacement","title":"Functions for string replacement","href":"/reference/functions/regular-functions/string-replace-functions"},{"sidebarTitle":"String search","title":"Functions for Searching in Strings","href":"/reference/functions/regular-functions/string-search-functions"},{"sidebarTitle":"TimeSeries","title":"Functions for working with time series","href":"/reference/functions/regular-functions/time-series-functions"},{"sidebarTitle":"Time window","title":"Time window functions","href":"/reference/functions/regular-functions/time-window-functions"},{"sidebarTitle":"Tuples","title":"Tuple functions","href":"/reference/functions/regular-functions/tuple-functions"},{"sidebarTitle":"Maps","title":"Map functions","href":"/reference/functions/regular-functions/tuple-map-functions"},{"sidebarTitle":"Type conversion","title":"Type conversion functions","href":"/reference/functions/regular-functions/type-conversion-functions"},{"sidebarTitle":"ULIDs","title":"Functions for working with ULIDs","href":"/reference/functions/regular-functions/ulid-functions"},{"sidebarTitle":"uniqTheta","title":"uniqTheta Functions","href":"/reference/functions/regular-functions/uniqtheta-functions"},{"sidebarTitle":"URLs","title":"Functions for working with URLs","href":"/reference/functions/regular-functions/url-functions"},{"sidebarTitle":"UUIDs","title":"Functions for Working with UUIDs","href":"/reference/functions/regular-functions/uuid-functions"}]},{"group":"Aggregate Functions","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Aggregate Functions","href":"/reference/functions/aggregate-functions/index"},{"sidebarTitle":"Combinators","title":"Aggregate Function Combinators","href":"/reference/functions/aggregate-functions/combinators"},{"title":"GROUPING","href":"/reference/functions/aggregate-functions/grouping_function"},{"sidebarTitle":"Parametric","title":"Parametric Aggregate Functions","href":"/reference/functions/aggregate-functions/parametric-functions"},{"group":"Reference","expanded":false,"pages":[{"title":"Aggregate Functions","href":"/reference/functions/aggregate-functions/reference-index"},{"title":"aggThrow","href":"/reference/functions/aggregate-functions/aggThrow"},{"title":"analysisOfVariance","href":"/reference/functions/aggregate-functions/analysis_of_variance"},{"title":"any","href":"/reference/functions/aggregate-functions/any"},{"title":"anyHeavy","href":"/reference/functions/aggregate-functions/anyHeavy"},{"title":"anyLast","href":"/reference/functions/aggregate-functions/anyLast"},{"title":"approx_top_k","href":"/reference/functions/aggregate-functions/approxtopk"},{"title":"approx_top_sum","href":"/reference/functions/aggregate-functions/approxtopsum"},{"title":"argMax","href":"/reference/functions/aggregate-functions/argMax"},{"title":"argAndMax","href":"/reference/functions/aggregate-functions/argAndMax"},{"title":"argMin","href":"/reference/functions/aggregate-functions/argMin"},{"title":"argAndMin","href":"/reference/functions/aggregate-functions/argAndMin"},{"title":"avg","href":"/reference/functions/aggregate-functions/avg"},{"title":"avgWeighted","href":"/reference/functions/aggregate-functions/avgWeighted"},{"title":"boundingRatio","href":"/reference/functions/aggregate-functions/boundrat"},{"title":"categoricalInformationValue","href":"/reference/functions/aggregate-functions/categoricalInformationValue"},{"title":"contingency","href":"/reference/functions/aggregate-functions/contingency"},{"title":"corr","href":"/reference/functions/aggregate-functions/corr"},{"title":"corrMatrix","href":"/reference/functions/aggregate-functions/corrMatrix"},{"title":"corrStable","href":"/reference/functions/aggregate-functions/corrStable"},{"title":"count","href":"/reference/functions/aggregate-functions/count"},{"title":"covarPop","href":"/reference/functions/aggregate-functions/covarPop"},{"title":"covarPopMatrix","href":"/reference/functions/aggregate-functions/covarPopMatrix"},{"title":"covarPopStable","href":"/reference/functions/aggregate-functions/covarPopStable"},{"title":"covarSamp","href":"/reference/functions/aggregate-functions/covarSamp"},{"title":"covarSampMatrix","href":"/reference/functions/aggregate-functions/covarSampMatrix"},{"title":"covarSampStable","href":"/reference/functions/aggregate-functions/covarSampStable"},{"title":"cramersV","href":"/reference/functions/aggregate-functions/cramersV"},{"title":"cramersVBiasCorrected","href":"/reference/functions/aggregate-functions/cramersVBiasCorrected"},{"title":"deltaSum","href":"/reference/functions/aggregate-functions/deltaSum"},{"title":"deltaSumTimestamp","href":"/reference/functions/aggregate-functions/deltaSumTimestamp"},{"title":"distinctDynamicTypes","href":"/reference/functions/aggregate-functions/distinctDynamicTypes"},{"title":"distinctJSONPaths","href":"/reference/functions/aggregate-functions/distinctJSONPaths"},{"title":"distinctJSONPathsAndTypes","href":"/reference/functions/aggregate-functions/distinctJSONPathsAndTypes"},{"title":"entropy","href":"/reference/functions/aggregate-functions/entropy"},{"title":"estimateCompressionRatio","href":"/reference/functions/aggregate-functions/estimateCompressionRatio"},{"title":"exponentialMovingAverage","href":"/reference/functions/aggregate-functions/exponentialMovingAverage"},{"title":"exponentialTimeDecayedAvg","href":"/reference/functions/aggregate-functions/exponentialTimeDecayedAvg"},{"title":"exponentialTimeDecayedCount","href":"/reference/functions/aggregate-functions/exponentialTimeDecayedCount"},{"title":"exponentialTimeDecayedMax","href":"/reference/functions/aggregate-functions/exponentialTimeDecayedMax"},{"title":"exponentialTimeDecayedSum","href":"/reference/functions/aggregate-functions/exponentialTimeDecayedSum"},{"title":"first_value","href":"/reference/functions/aggregate-functions/first_value"},{"title":"flameGraph","href":"/reference/functions/aggregate-functions/flame_graph"},{"sidebarTitle":"gini","title":"gini","href":"/reference/functions/aggregate-functions/gini"},{"title":"groupArray","href":"/reference/functions/aggregate-functions/groupArray"},{"title":"groupArrayArray","href":"/reference/functions/aggregate-functions/groupArrayArray"},{"title":"groupArrayInsertAt","href":"/reference/functions/aggregate-functions/groupArrayInsertAt"},{"title":"groupArrayIntersect","href":"/reference/functions/aggregate-functions/groupArrayIntersect"},{"title":"groupArrayLast","href":"/reference/functions/aggregate-functions/groupArrayLast"},{"title":"groupArrayMovingAvg","href":"/reference/functions/aggregate-functions/groupArrayMovingAvg"},{"title":"groupArrayMovingSum","href":"/reference/functions/aggregate-functions/groupArrayMovingSum"},{"title":"groupArraySample","href":"/reference/functions/aggregate-functions/groupArraySample"},{"title":"groupArraySorted","href":"/reference/functions/aggregate-functions/groupArraySorted"},{"title":"groupBitAnd","href":"/reference/functions/aggregate-functions/groupBitAnd"},{"title":"groupBitmap","href":"/reference/functions/aggregate-functions/groupBitmap"},{"title":"groupBitmapAnd","href":"/reference/functions/aggregate-functions/groupBitmapAnd"},{"title":"groupBitmapOr","href":"/reference/functions/aggregate-functions/groupBitmapOr"},{"title":"groupBitmapXor","href":"/reference/functions/aggregate-functions/groupBitmapXor"},{"title":"groupBitOr","href":"/reference/functions/aggregate-functions/groupBitOr"},{"title":"groupBitXor","href":"/reference/functions/aggregate-functions/groupBitXor"},{"sidebarTitle":"groupConcat","title":"groupConcat","href":"/reference/functions/aggregate-functions/groupConcat"},{"sidebarTitle":"groupFormat","title":"groupFormat","href":"/reference/functions/aggregate-functions/groupFormat"},{"title":"groupUniqArray","href":"/reference/functions/aggregate-functions/groupUniqArray"},{"sidebarTitle":"intervalLengthSum","title":"intervalLengthSum","href":"/reference/functions/aggregate-functions/intervalLengthSum"},{"sidebarTitle":"kolmogorovSmirnovTest","title":"kolmogorovSmirnovTest","href":"/reference/functions/aggregate-functions/kolmogorovSmirnovTest"},{"title":"kurtPop","href":"/reference/functions/aggregate-functions/kurtPop"},{"title":"kurtSamp","href":"/reference/functions/aggregate-functions/kurtSamp"},{"sidebarTitle":"largestTriangleThreeBuckets","title":"largestTriangleThreeBuckets","href":"/reference/functions/aggregate-functions/largestTriangleThreeBuckets"},{"title":"last_value","href":"/reference/functions/aggregate-functions/last_value"},{"sidebarTitle":"mannWhitneyUTest","title":"mannWhitneyUTest","href":"/reference/functions/aggregate-functions/mannWhitneyUTest"},{"title":"max","href":"/reference/functions/aggregate-functions/max"},{"title":"maxIntersections","href":"/reference/functions/aggregate-functions/maxIntersections"},{"title":"maxIntersectionsPosition","href":"/reference/functions/aggregate-functions/maxIntersectionsPosition"},{"title":"maxMap","href":"/reference/functions/aggregate-functions/maxMap"},{"sidebarTitle":"meanZTest","title":"meanZTest","href":"/reference/functions/aggregate-functions/meanZTest"},{"title":"mergedJSONPatch","href":"/reference/functions/aggregate-functions/mergedJSONPatch"},{"title":"median","href":"/reference/functions/aggregate-functions/median"},{"title":"min","href":"/reference/functions/aggregate-functions/min"},{"title":"minMap","href":"/reference/functions/aggregate-functions/minMap"},{"title":"quantile","href":"/reference/functions/aggregate-functions/quantile"},{"title":"quantileGK","href":"/reference/functions/aggregate-functions/quantileGK"},{"title":"quantileBFloat16","href":"/reference/functions/aggregate-functions/quantileBFloat16"},{"title":"quantileDD","href":"/reference/functions/aggregate-functions/quantileddsketch"},{"title":"quantileDeterministic","href":"/reference/functions/aggregate-functions/quantileDeterministic"},{"title":"quantileExact Functions","href":"/reference/functions/aggregate-functions/quantileExact"},{"title":"quantileExactExclusive","href":"/reference/functions/aggregate-functions/quantileExactExclusive"},{"title":"quantileExactHigh","href":"/reference/functions/aggregate-functions/quantileExactHigh"},{"title":"quantileExactInclusive","href":"/reference/functions/aggregate-functions/quantileExactInclusive"},{"title":"quantileExactLow","href":"/reference/functions/aggregate-functions/quantileExactLow"},{"title":"quantileExactWeighted","href":"/reference/functions/aggregate-functions/quantileExactWeighted"},{"title":"quantileExactWeightedInterpolated","href":"/reference/functions/aggregate-functions/quantileExactWeightedInterpolated"},{"title":"quantileInterpolatedWeighted","href":"/reference/functions/aggregate-functions/quantileInterpolatedWeighted"},{"title":"quantilePrometheusHistogram","href":"/reference/functions/aggregate-functions/quantilePrometheusHistogram"},{"title":"quantiles Functions","href":"/reference/functions/aggregate-functions/quantiles"},{"title":"quantilesBFloat16","href":"/reference/functions/aggregate-functions/quantilesBFloat16"},{"title":"quantilesBFloat16Weighted","href":"/reference/functions/aggregate-functions/quantilesBFloat16Weighted"},{"title":"quantilesDD","href":"/reference/functions/aggregate-functions/quantilesDD"},{"title":"quantilesDeterministic","href":"/reference/functions/aggregate-functions/quantilesDeterministic"},{"title":"quantilesExact","href":"/reference/functions/aggregate-functions/quantilesExact"},{"title":"quantilesExactExclusive","href":"/reference/functions/aggregate-functions/quantilesExactExclusive"},{"title":"quantilesExactHigh","href":"/reference/functions/aggregate-functions/quantilesExactHigh"},{"title":"quantilesExactInclusive","href":"/reference/functions/aggregate-functions/quantilesExactInclusive"},{"title":"quantilesExactLow","href":"/reference/functions/aggregate-functions/quantilesExactLow"},{"title":"quantilesExactWeighted","href":"/reference/functions/aggregate-functions/quantilesExactWeighted"},{"title":"quantilesExactWeightedInterpolated","href":"/reference/functions/aggregate-functions/quantilesExactWeightedInterpolated"},{"title":"quantilesGK","href":"/reference/functions/aggregate-functions/quantilesGK"},{"title":"quantilesInterpolatedWeighted","href":"/reference/functions/aggregate-functions/quantilesInterpolatedWeighted"},{"title":"quantilesPrometheusHistogram","href":"/reference/functions/aggregate-functions/quantilesPrometheusHistogram"},{"title":"quantilesTDigest","href":"/reference/functions/aggregate-functions/quantilesTDigest"},{"title":"quantilesTDigestWeighted","href":"/reference/functions/aggregate-functions/quantilesTDigestWeighted"},{"title":"quantilesTiming","href":"/reference/functions/aggregate-functions/quantilesTiming"},{"title":"quantileTDigest","href":"/reference/functions/aggregate-functions/quantileTDigest"},{"title":"quantileTDigestWeighted","href":"/reference/functions/aggregate-functions/quantileTDigestWeighted"},{"title":"quantileTiming","href":"/reference/functions/aggregate-functions/quantileTiming"},{"title":"quantileTimingWeighted","href":"/reference/functions/aggregate-functions/quantileTimingWeighted"},{"title":"quantilesTimingWeighted","href":"/reference/functions/aggregate-functions/quantilesTimingWeighted"},{"title":"rankCorr","href":"/reference/functions/aggregate-functions/rankCorr"},{"title":"regr_avgx","href":"/reference/functions/aggregate-functions/regr_avgx"},{"title":"regr_avgy","href":"/reference/functions/aggregate-functions/regr_avgy"},{"title":"regr_count","href":"/reference/functions/aggregate-functions/regr_count"},{"title":"regr_intercept","href":"/reference/functions/aggregate-functions/regr_intercept"},{"title":"regr_r2","href":"/reference/functions/aggregate-functions/regr_r2"},{"title":"regr_slope","href":"/reference/functions/aggregate-functions/regr_slope"},{"title":"regr_sxx","href":"/reference/functions/aggregate-functions/regr_sxx"},{"title":"regr_sxy","href":"/reference/functions/aggregate-functions/regr_sxy"},{"title":"regr_syy","href":"/reference/functions/aggregate-functions/regr_syy"},{"title":"simpleLinearRegression","href":"/reference/functions/aggregate-functions/simpleLinearRegression"},{"title":"singleValueOrNull","href":"/reference/functions/aggregate-functions/singleValueOrNull"},{"title":"skewPop","href":"/reference/functions/aggregate-functions/skewPop"},{"title":"skewSamp","href":"/reference/functions/aggregate-functions/skewSamp"},{"sidebarTitle":"sparkbar","title":"sparkbar","href":"/reference/functions/aggregate-functions/sparkbar"},{"title":"stddevPop","href":"/reference/functions/aggregate-functions/stddevPop"},{"title":"stddevPopStable","href":"/reference/functions/aggregate-functions/stddevPopStable"},{"title":"stddevSamp","href":"/reference/functions/aggregate-functions/stddevSamp"},{"title":"stddevSampStable","href":"/reference/functions/aggregate-functions/stddevSampStable"},{"title":"stochasticLinearRegression","href":"/reference/functions/aggregate-functions/stochasticLinearRegression"},{"title":"stochasticLogisticRegression","href":"/reference/functions/aggregate-functions/stochasticLogisticRegression"},{"sidebarTitle":"studentTTest","title":"studentTTest","href":"/reference/functions/aggregate-functions/studentTTest"},{"sidebarTitle":"studentTTestOneSample","title":"studentTTestOneSample","href":"/reference/functions/aggregate-functions/studentTTestOneSample"},{"title":"sum","href":"/reference/functions/aggregate-functions/sum"},{"title":"sumCount","href":"/reference/functions/aggregate-functions/sumCount"},{"title":"sumKahan","href":"/reference/functions/aggregate-functions/sumKahan"},{"title":"sumMap","href":"/reference/functions/aggregate-functions/sumMap"},{"title":"sumMapWithOverflow","href":"/reference/functions/aggregate-functions/sumMapWithOverflow"},{"title":"sumWithOverflow","href":"/reference/functions/aggregate-functions/sumWithOverflow"},{"title":"theilsU","href":"/reference/functions/aggregate-functions/theilsU"},{"title":"timeSeriesAvgToGrid","href":"/reference/functions/aggregate-functions/timeSeriesAvgToGrid"},{"title":"timeSeriesBottomKMasks","href":"/reference/functions/aggregate-functions/timeSeriesBottomKMasks"},{"title":"timeSeriesChangesToGrid","href":"/reference/functions/aggregate-functions/timeSeriesChangesToGrid"},{"title":"timeSeriesCountToGrid","href":"/reference/functions/aggregate-functions/timeSeriesCountToGrid"},{"title":"timeSeriesDeltaToGrid","href":"/reference/functions/aggregate-functions/timeSeriesDeltaToGrid"},{"title":"timeSeriesDerivToGrid","href":"/reference/functions/aggregate-functions/timeSeriesDerivToGrid"},{"title":"timeSeriesFirstToGrid","href":"/reference/functions/aggregate-functions/timeSeriesFirstToGrid"},{"title":"timeSeriesGroupArray","href":"/reference/functions/aggregate-functions/timeSeriesGroupArray"},{"title":"timeSeriesIncreaseToGrid","href":"/reference/functions/aggregate-functions/timeSeriesIncreaseToGrid"},{"title":"timeSeriesInstantDeltaToGrid","href":"/reference/functions/aggregate-functions/timeSeriesInstantDeltaToGrid"},{"title":"timeSeriesInstantRateToGrid","href":"/reference/functions/aggregate-functions/timeSeriesInstantRateToGrid"},{"title":"timeSeriesLastToGrid","href":"/reference/functions/aggregate-functions/timeSeriesLastToGrid"},{"title":"timeSeriesLastTwoSamples","href":"/reference/functions/aggregate-functions/timeSeriesLastTwoSamples"},{"title":"timeSeriesLimitKMasks","href":"/reference/functions/aggregate-functions/timeSeriesLimitKMasks"},{"title":"timeSeriesLinearRegressionToGrid","href":"/reference/functions/aggregate-functions/timeSeriesLinearRegressionToGrid"},{"title":"timeSeriesMadToGrid","href":"/reference/functions/aggregate-functions/timeSeriesMadToGrid"},{"title":"timeSeriesMaxToGrid","href":"/reference/functions/aggregate-functions/timeSeriesMaxToGrid"},{"title":"timeSeriesMinToGrid","href":"/reference/functions/aggregate-functions/timeSeriesMinToGrid"},{"title":"timeSeriesPredictLinearToGrid","href":"/reference/functions/aggregate-functions/timeSeriesPredictLinearToGrid"},{"title":"timeSeriesPresentToGrid","href":"/reference/functions/aggregate-functions/timeSeriesPresentToGrid"},{"title":"timeSeriesQuantileToGrid","href":"/reference/functions/aggregate-functions/timeSeriesQuantileToGrid"},{"title":"timeSeriesRateToGrid","href":"/reference/functions/aggregate-functions/timeSeriesRateToGrid"},{"title":"timeSeriesResampleToGridWithStaleness","href":"/reference/functions/aggregate-functions/timeSeriesResampleToGridWithStaleness"},{"title":"timeSeriesResetsToGrid","href":"/reference/functions/aggregate-functions/timeSeriesResetsToGrid"},{"title":"timeSeriesStddevToGrid","href":"/reference/functions/aggregate-functions/timeSeriesStddevToGrid"},{"title":"timeSeriesStdvarToGrid","href":"/reference/functions/aggregate-functions/timeSeriesStdvarToGrid"},{"title":"timeSeriesSumToGrid","href":"/reference/functions/aggregate-functions/timeSeriesSumToGrid"},{"title":"timeSeriesTimestampOfFirstToGrid","href":"/reference/functions/aggregate-functions/timeSeriesTimestampOfFirstToGrid"},{"title":"timeSeriesTimestampOfLastToGrid","href":"/reference/functions/aggregate-functions/timeSeriesTimestampOfLastToGrid"},{"title":"timeSeriesTimestampOfMaxToGrid","href":"/reference/functions/aggregate-functions/timeSeriesTimestampOfMaxToGrid"},{"title":"timeSeriesTimestampOfMinToGrid","href":"/reference/functions/aggregate-functions/timeSeriesTimestampOfMinToGrid"},{"title":"timeSeriesTopKMasks","href":"/reference/functions/aggregate-functions/timeSeriesTopKMasks"},{"title":"topK","href":"/reference/functions/aggregate-functions/topK"},{"title":"topKWeighted","href":"/reference/functions/aggregate-functions/topKWeighted"},{"title":"uniq","href":"/reference/functions/aggregate-functions/uniq"},{"title":"uniqCombined","href":"/reference/functions/aggregate-functions/uniqCombined"},{"title":"uniqCombined64","href":"/reference/functions/aggregate-functions/uniqCombined64"},{"title":"uniqExact","href":"/reference/functions/aggregate-functions/uniqExact"},{"title":"uniqHLL12","href":"/reference/functions/aggregate-functions/uniqHLL12"},{"title":"uniqTheta","href":"/reference/functions/aggregate-functions/uniqthetasketch"},{"title":"varPop","href":"/reference/functions/aggregate-functions/varPop"},{"title":"varPopStable","href":"/reference/functions/aggregate-functions/varPopStable"},{"title":"varSamp","href":"/reference/functions/aggregate-functions/varSamp"},{"title":"varSampStable","href":"/reference/functions/aggregate-functions/varSampStable"},{"sidebarTitle":"welchTTest","title":"welchTTest","href":"/reference/functions/aggregate-functions/welchTTest"}]}]},{"group":"Table functions","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Table Functions","href":"/reference/functions/table-functions/index"},{"sidebarTitle":"arrowFlight","title":"arrowFlight","href":"/reference/functions/table-functions/arrowflight"},{"sidebarTitle":"azureBlobStorage","title":"azureBlobStorage","href":"/reference/functions/table-functions/azureBlobStorage"},{"sidebarTitle":"azureBlobStorageCluster","title":"azureBlobStorageCluster","href":"/reference/functions/table-functions/azureBlobStorageCluster"},{"sidebarTitle":"bigquery","title":"bigquery","href":"/reference/functions/table-functions/bigquery"},{"sidebarTitle":"cluster","title":"clusterAllReplicas","href":"/reference/functions/table-functions/cluster"},{"sidebarTitle":"deltaLake","title":"deltaLake","href":"/reference/functions/table-functions/deltalake"},{"sidebarTitle":"deltaLakeCluster","title":"deltaLakeCluster","href":"/reference/functions/table-functions/deltalakeCluster"},{"sidebarTitle":"dictionary","title":"dictionary","href":"/reference/functions/table-functions/dictionary"},{"sidebarTitle":"elasticsearch","title":"elasticsearch","href":"/reference/functions/table-functions/elasticsearch"},{"sidebarTitle":"executable","title":"executable","href":"/reference/functions/table-functions/executable"},{"sidebarTitle":"eval","title":"eval","href":"/reference/functions/table-functions/eval"},{"sidebarTitle":"file","title":"file","href":"/reference/functions/table-functions/file"},{"sidebarTitle":"fileCluster","title":"fileCluster","href":"/reference/functions/table-functions/fileCluster"},{"sidebarTitle":"filesystem","title":"filesystem","href":"/reference/functions/table-functions/filesystem"},{"sidebarTitle":"format","title":"format","href":"/reference/functions/table-functions/format"},{"sidebarTitle":"fuzzJSON","title":"fuzzJSON","href":"/reference/functions/table-functions/fuzzJSON"},{"sidebarTitle":"fuzzQuery","title":"fuzzQuery","href":"/reference/functions/table-functions/fuzzQuery"},{"sidebarTitle":"gcs","title":"gcs","href":"/reference/functions/table-functions/gcs"},{"sidebarTitle":"generateRandom","title":"generateRandom","href":"/reference/functions/table-functions/generate"},{"sidebarTitle":"generate_series","title":"generate_series (generateSeries)","href":"/reference/functions/table-functions/generate_series"},{"sidebarTitle":"hdfs","title":"hdfs","href":"/reference/functions/table-functions/hdfs"},{"sidebarTitle":"hdfsCluster","title":"hdfsCluster","href":"/reference/functions/table-functions/hdfsCluster"},{"sidebarTitle":"hudi","title":"hudi","href":"/reference/functions/table-functions/hudi"},{"sidebarTitle":"hudiCluster","title":"hudiCluster Table Function","href":"/reference/functions/table-functions/hudiCluster"},{"sidebarTitle":"iceberg","title":"iceberg","href":"/reference/functions/table-functions/iceberg"},{"sidebarTitle":"icebergCluster","title":"icebergCluster","href":"/reference/functions/table-functions/icebergCluster"},{"sidebarTitle":"input","title":"input","href":"/reference/functions/table-functions/input"},{"sidebarTitle":"jdbc","title":"jdbc","href":"/reference/functions/table-functions/jdbc"},{"title":"loop","href":"/reference/functions/table-functions/loop"},{"sidebarTitle":"merge","title":"merge","href":"/reference/functions/table-functions/merge"},{"sidebarTitle":"mergeTreeCodecBlockCounts","title":"mergeTreeCodecBlockCounts","href":"/reference/functions/table-functions/mergeTreeCodecBlockCounts"},{"sidebarTitle":"mergeTreeIndex","title":"mergeTreeIndex","href":"/reference/functions/table-functions/mergeTreeIndex"},{"sidebarTitle":"mergeTreeProjection","title":"mergeTreeProjection","href":"/reference/functions/table-functions/mergeTreeProjection"},{"sidebarTitle":"mergeTreeTextIndex","title":"mergeTreeTextIndex","href":"/reference/functions/table-functions/mergeTreeTextIndex"},{"sidebarTitle":"mongodb","title":"mongodb","href":"/reference/functions/table-functions/mongodb"},{"sidebarTitle":"mysql","title":"mysql","href":"/reference/functions/table-functions/mysql"},{"sidebarTitle":"null function","title":"null","href":"/reference/functions/table-functions/null"},{"sidebarTitle":"numbers","title":"numbers","href":"/reference/functions/table-functions/numbers"},{"sidebarTitle":"odbc","title":"odbc table function","href":"/reference/functions/table-functions/odbc"},{"sidebarTitle":"paimon","title":"paimon","href":"/reference/functions/table-functions/paimon"},{"sidebarTitle":"paimonCluster","title":"paimonCluster","href":"/reference/functions/table-functions/paimonCluster"},{"sidebarTitle":"postgresql","title":"postgresql","href":"/reference/functions/table-functions/postgresql"},{"sidebarTitle":"primes","title":"primes","href":"/reference/functions/table-functions/primes"},{"sidebarTitle":"prometheusQuery","title":"prometheusQuery","href":"/reference/functions/table-functions/prometheusQuery"},{"sidebarTitle":"prometheusQueryRange","title":"prometheusQueryRange","href":"/reference/functions/table-functions/prometheusQueryRange"},{"sidebarTitle":"redis","title":"redis","href":"/reference/functions/table-functions/redis"},{"sidebarTitle":"remote","title":"remote, remoteSecure","href":"/reference/functions/table-functions/remote"},{"sidebarTitle":"s3","title":"s3 Table Function","href":"/reference/functions/table-functions/s3"},{"sidebarTitle":"s3Cluster","title":"s3Cluster","href":"/reference/functions/table-functions/s3Cluster"},{"sidebarTitle":"sqlite","title":"sqlite","href":"/reference/functions/table-functions/sqlite"},{"sidebarTitle":"timeSeriesData","title":"timeSeriesData","href":"/reference/functions/table-functions/timeSeriesData"},{"sidebarTitle":"timeSeriesMetricFamilies","title":"timeSeriesMetricFamilies","href":"/reference/functions/table-functions/timeSeriesMetricFamilies"},{"sidebarTitle":"timeSeriesSamples","title":"timeSeriesSamples","href":"/reference/functions/table-functions/timeSeriesSamples"},{"sidebarTitle":"timeSeriesSelector","title":"timeSeriesSelector","href":"/reference/functions/table-functions/timeSeriesSelector"},{"sidebarTitle":"timeSeriesTags","title":"timeSeriesTags","href":"/reference/functions/table-functions/timeSeriesTags"},{"sidebarTitle":"timeSeriesTimeRanges","title":"timeSeriesTimeRanges","href":"/reference/functions/table-functions/timeSeriesTimeRanges"},{"sidebarTitle":"url","title":"url","href":"/reference/functions/table-functions/url"},{"sidebarTitle":"urlCluster","title":"urlCluster","href":"/reference/functions/table-functions/urlCluster"},{"sidebarTitle":"values","title":"values","href":"/reference/functions/table-functions/values"},{"sidebarTitle":"view","title":"view","href":"/reference/functions/table-functions/view"},{"sidebarTitle":"ytsaurus","title":"ytsaurus","href":"/reference/functions/table-functions/ytsaurus"},{"sidebarTitle":"zeros","title":"zeros","href":"/reference/functions/table-functions/zeros"}]},{"group":"Window functions","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"Window Functions","href":"/reference/functions/window-functions/index"},{"sidebarTitle":"cume_dist","title":"cume_dist","href":"/reference/functions/window-functions/cume_dist"},{"sidebarTitle":"dense_rank","title":"dense_rank","href":"/reference/functions/window-functions/dense_rank"},{"sidebarTitle":"first_value","title":"first_value","href":"/reference/functions/window-functions/first_value"},{"sidebarTitle":"lag","title":"lag","href":"/reference/functions/window-functions/lag"},{"sidebarTitle":"lagInFrame","title":"lagInFrame","href":"/reference/functions/window-functions/lagInFrame"},{"sidebarTitle":"last_value","title":"last_value","href":"/reference/functions/window-functions/last_value"},{"sidebarTitle":"lead","title":"lead","href":"/reference/functions/window-functions/lead"},{"sidebarTitle":"leadInFrame","title":"leadInFrame","href":"/reference/functions/window-functions/leadInFrame"},{"sidebarTitle":"nonNegativeDerivative","title":"nonNegativeDerivative","href":"/reference/functions/window-functions/nonNegativeDerivative"},{"sidebarTitle":"nth_value","title":"nth_value","href":"/reference/functions/window-functions/nth_value"},{"sidebarTitle":"ntile","title":"ntile","href":"/reference/functions/window-functions/ntile"},{"sidebarTitle":"percent_rank","title":"percent_rank","href":"/reference/functions/window-functions/percent_rank"},{"sidebarTitle":"rank","title":"rank","href":"/reference/functions/window-functions/rank"},{"sidebarTitle":"row_number","title":"row_number","href":"/reference/functions/window-functions/row_number"}]},{"group":"User Defined Functions","pages":[{"sidebarTitle":"UDF","title":"User Defined Functions (UDFs)","href":"/reference/functions/regular-functions/udf"},{"sidebarTitle":"WebAssembly UDFs","title":"WebAssembly User Defined Functions","href":"/reference/functions/regular-functions/wasm_udf"}]}]},{"group":"Formats","expanded":false,"pages":[{"sidebarTitle":"View all formats...","title":"Formats for input and output data","href":"/reference/formats/index"},{"group":"Arrow","expanded":false,"pages":[{"title":"Arrow","href":"/reference/formats/Arrow/Arrow"},{"title":"ArrowStream","href":"/reference/formats/Arrow/ArrowStream"}]},{"group":"Avro","expanded":false,"pages":[{"title":"Avro","href":"/reference/formats/Avro/Avro"},{"title":"AvroConfluent","href":"/reference/formats/Avro/AvroConfluent"}]},{"title":"BSONEachRow","href":"/reference/formats/BSONEachRow"},{"title":"Buffers","href":"/reference/formats/Buffers"},{"group":"CSV","expanded":false,"pages":[{"title":"CSV","href":"/reference/formats/CSV/CSV"},{"title":"CSVWithNames","href":"/reference/formats/CSV/CSVWithNames"},{"title":"CSVWithNamesAndTypes","href":"/reference/formats/CSV/CSVWithNamesAndTypes"}]},{"title":"CapnProto","href":"/reference/formats/CapnProto"},{"group":"CustomSeparated","expanded":false,"pages":[{"title":"CustomSeparated","href":"/reference/formats/CustomSeparated/CustomSeparated"},{"title":"CustomSeparatedIgnoreSpaces","href":"/reference/formats/CustomSeparated/CustomSeparatedIgnoreSpaces"},{"title":"CustomSeparatedIgnoreSpacesWithNames","href":"/reference/formats/CustomSeparated/CustomSeparatedIgnoreSpacesWithNames"},{"title":"CustomSeparatedIgnoreSpacesWithNamesAndTypes","href":"/reference/formats/CustomSeparated/CustomSeparatedIgnoreSpacesWithNamesAndTypes"},{"title":"CustomSeparatedWithNames","href":"/reference/formats/CustomSeparated/CustomSeparatedWithNames"},{"title":"CustomSeparatedWithNamesAndTypes","href":"/reference/formats/CustomSeparated/CustomSeparatedWithNamesAndTypes"}]},{"title":"DWARF","href":"/reference/formats/DWARF"},{"title":"Form","href":"/reference/formats/Form"},{"sidebarTitle":"GeoJSON","title":"GeoJSON","href":"/reference/formats/GeoJSON"},{"title":"Hash","href":"/reference/formats/Hash"},{"title":"HiveText","href":"/reference/formats/HiveText"},{"group":"JSON","expanded":false,"pages":[{"title":"JSON","href":"/reference/formats/JSON/JSON"},{"title":"JSONAsObject","href":"/reference/formats/JSON/JSONAsObject"},{"title":"JSONAsString","href":"/reference/formats/JSON/JSONAsString"},{"title":"JSONColumns","href":"/reference/formats/JSON/JSONColumns"},{"title":"JSONColumnsWithMetadata","href":"/reference/formats/JSON/JSONColumnsWithMetadata"},{"title":"JSONCompact","href":"/reference/formats/JSON/JSONCompact"},{"title":"JSONCompactColumns","href":"/reference/formats/JSON/JSONCompactColumns"},{"title":"JSONCompactEachRow","href":"/reference/formats/JSON/JSONCompactEachRow"},{"title":"JSONCompactEachRowWithNames","href":"/reference/formats/JSON/JSONCompactEachRowWithNames"},{"title":"JSONCompactEachRowWithNamesAndTypes","href":"/reference/formats/JSON/JSONCompactEachRowWithNamesAndTypes"},{"title":"JSONCompactEachRowWithProgress","href":"/reference/formats/JSON/JSONCompactEachRowWithProgress"},{"title":"JSONCompactStrings","href":"/reference/formats/JSON/JSONCompactStrings"},{"title":"JSONCompactStringsEachRow","href":"/reference/formats/JSON/JSONCompactStringsEachRow"},{"title":"JSONCompactStringsEachRowWithNames","href":"/reference/formats/JSON/JSONCompactStringsEachRowWithNames"},{"title":"JSONCompactStringsEachRowWithNamesAndTypes","href":"/reference/formats/JSON/JSONCompactStringsEachRowWithNamesAndTypes"},{"title":"JSONCompactStringsEachRowWithProgress","href":"/reference/formats/JSON/JSONCompactStringsEachRowWithProgress"},{"title":"JSONEachRow","href":"/reference/formats/JSON/JSONEachRow"},{"title":"JSONEachRowWithProgress","href":"/reference/formats/JSON/JSONEachRowWithProgress"},{"title":"JSONLines","href":"/reference/formats/JSON/JSONLines"},{"title":"JSONObjectEachRow","href":"/reference/formats/JSON/JSONObjectEachRow"},{"title":"JSONStrings","href":"/reference/formats/JSON/JSONStrings"},{"title":"JSONStringsEachRow","href":"/reference/formats/JSON/JSONStringsEachRow"},{"title":"JSONStringsEachRowWithProgress","href":"/reference/formats/JSON/JSONStringsEachRowWithProgress"},{"title":"PrettyJSONEachRow","href":"/reference/formats/JSON/PrettyJSONEachRow"},{"title":"Format Settings For JSON","href":"/reference/formats/JSON/format-settings"}]},{"group":"LineAsString","expanded":false,"pages":[{"title":"LineAsString","href":"/reference/formats/LineAsString/LineAsString"},{"title":"LineAsStringWithNames","href":"/reference/formats/LineAsString/LineAsStringWithNames"},{"title":"LineAsStringWithNamesAndTypes","href":"/reference/formats/LineAsString/LineAsStringWithNamesAndTypes"}]},{"title":"Markdown","href":"/reference/formats/Markdown"},{"title":"MsgPack","href":"/reference/formats/MsgPack"},{"title":"MySQLDump","href":"/reference/formats/MySQLDump"},{"title":"MySQLWire","href":"/reference/formats/MySQLWire"},{"title":"Native","href":"/reference/formats/Native"},{"title":"Npy","href":"/reference/formats/Npy"},{"title":"Null","href":"/reference/formats/Null"},{"title":"ODBCDriver2","href":"/reference/formats/ODBCDriver2"},{"title":"ORC","href":"/reference/formats/ORC"},{"title":"One","href":"/reference/formats/One"},{"group":"Parquet","expanded":false,"pages":[{"title":"Parquet","href":"/reference/formats/Parquet/Parquet"},{"title":"ParquetMetadata","href":"/reference/formats/Parquet/ParquetMetadata"}]},{"title":"PNG","href":"/reference/formats/PNG"},{"title":"PostgreSQLWire","href":"/reference/formats/PostgreSQLWire"},{"group":"Pretty","expanded":false,"pages":[{"title":"Pretty","href":"/reference/formats/Pretty/Pretty"},{"title":"PrettyCompact","href":"/reference/formats/Pretty/PrettyCompact"},{"title":"PrettyCompactMonoBlock","href":"/reference/formats/Pretty/PrettyCompactMonoBlock"},{"title":"PrettyCompactNoEscapes","href":"/reference/formats/Pretty/PrettyCompactNoEscapes"},{"title":"PrettyCompactNoEscapesMonoBlock","href":"/reference/formats/Pretty/PrettyCompactNoEscapesMonoBlock"},{"title":"PrettyMonoBlock","href":"/reference/formats/Pretty/PrettyMonoBlock"},{"title":"PrettyNoEscapes","href":"/reference/formats/Pretty/PrettyNoEscapes"},{"title":"PrettyNoEscapesMonoBlock","href":"/reference/formats/Pretty/PrettyNoEscapesMonoBlock"},{"title":"PrettySpace","href":"/reference/formats/Pretty/PrettySpace"},{"title":"PrettySpaceMonoBlock","href":"/reference/formats/Pretty/PrettySpaceMonoBlock"},{"title":"PrettySpaceNoEscapes","href":"/reference/formats/Pretty/PrettySpaceNoEscapes"},{"title":"PrettySpaceNoEscapesMonoBlock","href":"/reference/formats/Pretty/PrettySpaceNoEscapesMonoBlock"}]},{"title":"Prometheus","href":"/reference/formats/Prometheus"},{"group":"Protobuf","expanded":false,"pages":[{"title":"Protobuf","href":"/reference/formats/Protobuf/Protobuf"},{"title":"ProtobufList","href":"/reference/formats/Protobuf/ProtobufList"},{"title":"ProtobufSingle","href":"/reference/formats/Protobuf/ProtobufSingle"}]},{"group":"Puffin","expanded":false,"pages":[{"title":"Puffin","href":"/reference/formats/Puffin/Puffin"},{"title":"PuffinMetadata","href":"/reference/formats/Puffin/PuffinMetadata"}]},{"title":"RawBLOB","href":"/reference/formats/RawBLOB"},{"title":"Regexp","href":"/reference/formats/Regexp"},{"group":"RowBinary","expanded":false,"pages":[{"title":"RowBinary","href":"/reference/formats/RowBinary/RowBinary"},{"title":"RowBinaryWithDefaults","href":"/reference/formats/RowBinary/RowBinaryWithDefaults"},{"title":"RowBinaryWithNames","href":"/reference/formats/RowBinary/RowBinaryWithNames"},{"title":"RowBinaryWithNamesAndTypes","href":"/reference/formats/RowBinary/RowBinaryWithNamesAndTypes"},{"title":"RowBinaryWithNamesAndTypesAndDefaults","href":"/reference/formats/RowBinary/RowBinaryWithNamesAndTypesAndDefaults"}]},{"title":"SQLInsert","href":"/reference/formats/SQLInsert"},{"title":"SQLite","href":"/reference/formats/SQLite"},{"group":"TabSeparated","expanded":false,"pages":[{"title":"TSKV","href":"/reference/formats/TabSeparated/TSKV"},{"title":"TabSeparated","href":"/reference/formats/TabSeparated/TabSeparated"},{"title":"TabSeparatedRaw","href":"/reference/formats/TabSeparated/TabSeparatedRaw"},{"title":"TabSeparatedRawWithNames","href":"/reference/formats/TabSeparated/TabSeparatedRawWithNames"},{"title":"TabSeparatedRawWithNamesAndTypes","href":"/reference/formats/TabSeparated/TabSeparatedRawWithNamesAndTypes"},{"title":"TabSeparatedWithNames","href":"/reference/formats/TabSeparated/TabSeparatedWithNames"},{"title":"TabSeparatedWithNamesAndTypes","href":"/reference/formats/TabSeparated/TabSeparatedWithNamesAndTypes"}]},{"group":"Template","expanded":false,"pages":[{"title":"Template","href":"/reference/formats/Template/Template"},{"title":"TemplateIgnoreSpaces","href":"/reference/formats/Template/TemplateIgnoreSpaces"}]},{"title":"Values","href":"/reference/formats/Values"},{"title":"Vertical","href":"/reference/formats/Vertical"},{"sidebarTitle":"Vortex","title":"Vortex","href":"/reference/formats/Vortex"},{"title":"XML","href":"/reference/formats/XML"}]},{"group":"Settings","expanded":false,"pages":[{"title":"Settings","sidebarTitle":"Overview","mode":"wide","href":"/reference/settings/index"},{"group":"Server Settings","directory":"none","pages":[{"sidebarTitle":"Overview","title":"Server Settings","href":"/reference/settings/server-settings/settings"},{"title":"access_control_* server settings","sidebarTitle":"access_control_*","href":"/reference/settings/server-settings/settings/access-control"},{"title":"aggregate_function_* server settings","sidebarTitle":"aggregate_function_*","href":"/reference/settings/server-settings/settings/aggregate-function"},{"title":"ai_function_* server settings","sidebarTitle":"ai_function_*","href":"/reference/settings/server-settings/settings/ai-function"},{"title":"allow_* server settings","sidebarTitle":"allow_*","href":"/reference/settings/server-settings/settings/allow"},{"title":"allow_experimental_* server settings","sidebarTitle":"allow_experimental_*","href":"/reference/settings/server-settings/settings/allow-experimental"},{"title":"async_insert_* server settings","sidebarTitle":"async_insert_*","href":"/reference/settings/server-settings/settings/async-insert"},{"title":"async_load_* server settings","sidebarTitle":"async_load_*","href":"/reference/settings/server-settings/settings/async-load"},{"title":"asynchronous_* server settings","sidebarTitle":"asynchronous_*","href":"/reference/settings/server-settings/settings/asynchronous"},{"title":"asynchronous_metrics_* server settings","sidebarTitle":"asynchronous_metrics_*","href":"/reference/settings/server-settings/settings/asynchronous-metrics"},{"title":"background_* server settings","sidebarTitle":"background_*","href":"/reference/settings/server-settings/settings/background"},{"title":"background_merges_* server settings","sidebarTitle":"background_merges_*","href":"/reference/settings/server-settings/settings/background-merges"},{"title":"background_schedule_* server settings","sidebarTitle":"background_schedule_*","href":"/reference/settings/server-settings/settings/background-schedule"},{"title":"backup_* server settings","sidebarTitle":"backup_*","href":"/reference/settings/server-settings/settings/backup"},{"title":"backups_* server settings","sidebarTitle":"backups_*","href":"/reference/settings/server-settings/settings/backups"},{"title":"columns_cache_* server settings","sidebarTitle":"columns_cache_*","href":"/reference/settings/server-settings/settings/columns-cache"},{"title":"compiled_expression_* server settings","sidebarTitle":"compiled_expression_*","href":"/reference/settings/server-settings/settings/compiled-expression"},{"title":"concurrent_threads_* server settings","sidebarTitle":"concurrent_threads_*","href":"/reference/settings/server-settings/settings/concurrent-threads"},{"title":"cpu_slot_* server settings","sidebarTitle":"cpu_slot_*","href":"/reference/settings/server-settings/settings/cpu-slot"},{"title":"custom_* server settings","sidebarTitle":"custom_*","href":"/reference/settings/server-settings/settings/custom"},{"title":"database_catalog_* server settings","sidebarTitle":"database_catalog_*","href":"/reference/settings/server-settings/settings/database-catalog"},{"title":"database_replicated_* server settings","sidebarTitle":"database_replicated_*","href":"/reference/settings/server-settings/settings/database-replicated"},{"title":"default_* server settings","sidebarTitle":"default_*","href":"/reference/settings/server-settings/settings/default"},{"title":"default_replica_* server settings","sidebarTitle":"default_replica_*","href":"/reference/settings/server-settings/settings/default-replica"},{"title":"dictionaries_* server settings","sidebarTitle":"dictionaries_*","href":"/reference/settings/server-settings/settings/dictionaries"},{"title":"disable_* server settings","sidebarTitle":"disable_*","href":"/reference/settings/server-settings/settings/disable"},{"title":"disk_connections_* server settings","sidebarTitle":"disk_connections_*","href":"/reference/settings/server-settings/settings/disk-connections"},{"title":"distributed_* server settings","sidebarTitle":"distributed_*","href":"/reference/settings/server-settings/settings/distributed"},{"title":"distributed_cache_* server settings","sidebarTitle":"distributed_cache_*","href":"/reference/settings/server-settings/settings/distributed-cache"},{"title":"distributed_ddl_* server settings","sidebarTitle":"distributed_ddl_*","href":"/reference/settings/server-settings/settings/distributed-ddl"},{"title":"dns_allow_* server settings","sidebarTitle":"dns_allow_*","href":"/reference/settings/server-settings/settings/dns-allow"},{"title":"dns_cache_* server settings","sidebarTitle":"dns_cache_*","href":"/reference/settings/server-settings/settings/dns-cache"},{"title":"drop_distributed_* server settings","sidebarTitle":"drop_distributed_*","href":"/reference/settings/server-settings/settings/drop-distributed"},{"title":"enable_* server settings","sidebarTitle":"enable_*","href":"/reference/settings/server-settings/settings/enable"},{"title":"encryption_header_* server settings","sidebarTitle":"encryption_header_*","href":"/reference/settings/server-settings/settings/encryption-header"},{"title":"format_* server settings","sidebarTitle":"format_*","href":"/reference/settings/server-settings/settings/format"},{"title":"global_profiler_* server settings","sidebarTitle":"global_profiler_*","href":"/reference/settings/server-settings/settings/global-profiler"},{"title":"gpu_* server settings","sidebarTitle":"gpu_*","href":"/reference/settings/server-settings/settings/gpu"},{"title":"graphite_* server settings","sidebarTitle":"graphite_*","href":"/reference/settings/server-settings/settings/graphite"},{"title":"http_* server settings","sidebarTitle":"http_*","href":"/reference/settings/server-settings/settings/http"},{"title":"http_connections_* server settings","sidebarTitle":"http_connections_*","href":"/reference/settings/server-settings/settings/http-connections"},{"title":"iceberg_catalog_* server settings","sidebarTitle":"iceberg_catalog_*","href":"/reference/settings/server-settings/settings/iceberg-catalog"},{"title":"iceberg_compaction_* server settings","sidebarTitle":"iceberg_compaction_*","href":"/reference/settings/server-settings/settings/iceberg-compaction"},{"title":"iceberg_metadata_* server settings","sidebarTitle":"iceberg_metadata_*","href":"/reference/settings/server-settings/settings/iceberg-metadata"},{"title":"iceberg_scheduler_* server settings","sidebarTitle":"iceberg_scheduler_*","href":"/reference/settings/server-settings/settings/iceberg-scheduler"},{"title":"index_mark_* server settings","sidebarTitle":"index_mark_*","href":"/reference/settings/server-settings/settings/index-mark"},{"title":"index_uncompressed_* server settings","sidebarTitle":"index_uncompressed_*","href":"/reference/settings/server-settings/settings/index-uncompressed"},{"title":"interserver_* server settings","sidebarTitle":"interserver_*","href":"/reference/settings/server-settings/settings/interserver"},{"title":"interserver_http_* server settings","sidebarTitle":"interserver_http_*","href":"/reference/settings/server-settings/settings/interserver-http"},{"title":"interserver_https_* server settings","sidebarTitle":"interserver_https_*","href":"/reference/settings/server-settings/settings/interserver-https"},{"title":"jemalloc_* server settings","sidebarTitle":"jemalloc_*","href":"/reference/settings/server-settings/settings/jemalloc"},{"title":"jemalloc_enable_* server settings","sidebarTitle":"jemalloc_enable_*","href":"/reference/settings/server-settings/settings/jemalloc-enable"},{"title":"jemalloc_flush_* server settings","sidebarTitle":"jemalloc_flush_*","href":"/reference/settings/server-settings/settings/jemalloc-flush"},{"title":"keeper_* server settings","sidebarTitle":"keeper_*","href":"/reference/settings/server-settings/settings/keeper"},{"title":"keeper_server.socket_* server settings","sidebarTitle":"keeper_server.socket_*","href":"/reference/settings/server-settings/settings/keeper-server-socket"},{"title":"license_* server settings","sidebarTitle":"license_*","href":"/reference/settings/server-settings/settings/license"},{"title":"listen_* server settings","sidebarTitle":"listen_*","href":"/reference/settings/server-settings/settings/listen"},{"title":"load_marks_* server settings","sidebarTitle":"load_marks_*","href":"/reference/settings/server-settings/settings/load-marks"},{"title":"logger.async_* server settings","sidebarTitle":"logger.async_*","href":"/reference/settings/server-settings/settings/logger-async"},{"title":"logger.console_* server settings","sidebarTitle":"logger.console_*","href":"/reference/settings/server-settings/settings/logger-console"},{"title":"mark_cache_* server settings","sidebarTitle":"mark_cache_*","href":"/reference/settings/server-settings/settings/mark-cache"},{"title":"max_* server settings","sidebarTitle":"max_*","href":"/reference/settings/server-settings/settings/max"},{"title":"max_backups_* server settings","sidebarTitle":"max_backups_*","href":"/reference/settings/server-settings/settings/max-backups"},{"title":"max_concurrent_* server settings","sidebarTitle":"max_concurrent_*","href":"/reference/settings/server-settings/settings/max-concurrent"},{"title":"max_database_* server settings","sidebarTitle":"max_database_*","href":"/reference/settings/server-settings/settings/max-database"},{"title":"max_dictionary_* server settings","sidebarTitle":"max_dictionary_*","href":"/reference/settings/server-settings/settings/max-dictionary"},{"title":"max_distributed_* server settings","sidebarTitle":"max_distributed_*","href":"/reference/settings/server-settings/settings/max-distributed"},{"title":"max_format_* server settings","sidebarTitle":"max_format_*","href":"/reference/settings/server-settings/settings/max-format"},{"title":"max_io_* server settings","sidebarTitle":"max_io_*","href":"/reference/settings/server-settings/settings/max-io"},{"title":"max_local_* server settings","sidebarTitle":"max_local_*","href":"/reference/settings/server-settings/settings/max-local"},{"title":"max_named_* server settings","sidebarTitle":"max_named_*","href":"/reference/settings/server-settings/settings/max-named"},{"title":"max_pending_* server settings","sidebarTitle":"max_pending_*","href":"/reference/settings/server-settings/settings/max-pending"},{"title":"max_prefixes_* server settings","sidebarTitle":"max_prefixes_*","href":"/reference/settings/server-settings/settings/max-prefixes"},{"title":"max_remote_* server settings","sidebarTitle":"max_remote_*","href":"/reference/settings/server-settings/settings/max-remote"},{"title":"max_replicated_* server settings","sidebarTitle":"max_replicated_*","href":"/reference/settings/server-settings/settings/max-replicated"},{"title":"max_server_memory_usage_* server settings","sidebarTitle":"max_server_memory_usage_*","href":"/reference/settings/server-settings/settings/max-server-memory-usage"},{"title":"max_snapshot_* server settings","sidebarTitle":"max_snapshot_*","href":"/reference/settings/server-settings/settings/max-snapshot"},{"title":"max_table_* server settings","sidebarTitle":"max_table_*","href":"/reference/settings/server-settings/settings/max-table"},{"title":"max_thread_* server settings","sidebarTitle":"max_thread_*","href":"/reference/settings/server-settings/settings/max-thread"},{"title":"max_view_* server settings","sidebarTitle":"max_view_*","href":"/reference/settings/server-settings/settings/max-view"},{"title":"memory_worker_* server settings","sidebarTitle":"memory_worker_*","href":"/reference/settings/server-settings/settings/memory-worker"},{"title":"merge_* server settings","sidebarTitle":"merge_*","href":"/reference/settings/server-settings/settings/merge"},{"title":"merges_mutations_* server settings","sidebarTitle":"merges_mutations_*","href":"/reference/settings/server-settings/settings/merges-mutations"},{"title":"min_* server settings","sidebarTitle":"min_*","href":"/reference/settings/server-settings/settings/min"},{"title":"mlock_executable_* server settings","sidebarTitle":"mlock_executable_*","href":"/reference/settings/server-settings/settings/mlock-executable"},{"title":"mysql_* server settings","sidebarTitle":"mysql_*","href":"/reference/settings/server-settings/settings/mysql"},{"title":"oom_canary_* server settings","sidebarTitle":"oom_canary_*","href":"/reference/settings/server-settings/settings/oom-canary"},{"title":"openSSL.client.requireTLSv1_* server settings","sidebarTitle":"openSSL.client.requireTLSv1_*","href":"/reference/settings/server-settings/settings/openssl-client-requiretlsv1"},{"title":"openSSL.server.requireTLSv1_* server settings","sidebarTitle":"openSSL.server.requireTLSv1_*","href":"/reference/settings/server-settings/settings/openssl-server-requiretlsv1"},{"title":"os_* server settings","sidebarTitle":"os_*","href":"/reference/settings/server-settings/settings/os"},{"title":"os_threads_* server settings","sidebarTitle":"os_threads_*","href":"/reference/settings/server-settings/settings/os-threads"},{"title":"page_cache_* server settings","sidebarTitle":"page_cache_*","href":"/reference/settings/server-settings/settings/page-cache"},{"title":"paimon_metadata_* server settings","sidebarTitle":"paimon_metadata_*","href":"/reference/settings/server-settings/settings/paimon-metadata"},{"title":"parquet_metadata_* server settings","sidebarTitle":"parquet_metadata_*","href":"/reference/settings/server-settings/settings/parquet-metadata"},{"title":"parts_kill_delay_period_* server settings","sidebarTitle":"parts_kill_delay_period_*","href":"/reference/settings/server-settings/settings/parts-kill-delay-period"},{"title":"parts_killer_* server settings","sidebarTitle":"parts_killer_*","href":"/reference/settings/server-settings/settings/parts-killer"},{"title":"postgresql_* server settings","sidebarTitle":"postgresql_*","href":"/reference/settings/server-settings/settings/postgresql"},{"title":"prefetch_threadpool_* server settings","sidebarTitle":"prefetch_threadpool_*","href":"/reference/settings/server-settings/settings/prefetch-threadpool"},{"title":"primary_index_* server settings","sidebarTitle":"primary_index_*","href":"/reference/settings/server-settings/settings/primary-index"},{"title":"query_* server settings","sidebarTitle":"query_*","href":"/reference/settings/server-settings/settings/query"},{"title":"query_cache.max_* server settings","sidebarTitle":"query_cache.max_*","href":"/reference/settings/server-settings/settings/query-cache-max"},{"title":"query_condition_* server settings","sidebarTitle":"query_condition_*","href":"/reference/settings/server-settings/settings/query-condition"},{"title":"reader_executor_* server settings","sidebarTitle":"reader_executor_*","href":"/reference/settings/server-settings/settings/reader-executor"},{"title":"remote_* server settings","sidebarTitle":"remote_*","href":"/reference/settings/server-settings/settings/remote"},{"title":"replicated_fetches_* server settings","sidebarTitle":"replicated_fetches_*","href":"/reference/settings/server-settings/settings/replicated-fetches"},{"title":"s3_* server settings","sidebarTitle":"s3_*","href":"/reference/settings/server-settings/settings/s3"},{"title":"s3queue_* server settings","sidebarTitle":"s3queue_*","href":"/reference/settings/server-settings/settings/s3queue"},{"title":"show_* server settings","sidebarTitle":"show_*","href":"/reference/settings/server-settings/settings/show"},{"title":"shutdown_wait_* server settings","sidebarTitle":"shutdown_wait_*","href":"/reference/settings/server-settings/settings/shutdown-wait"},{"title":"skip_* server settings","sidebarTitle":"skip_*","href":"/reference/settings/server-settings/settings/skip"},{"title":"snapshot_cleaner_* server settings","sidebarTitle":"snapshot_cleaner_*","href":"/reference/settings/server-settings/settings/snapshot-cleaner"},{"title":"startup_* server settings","sidebarTitle":"startup_*","href":"/reference/settings/server-settings/settings/startup"},{"title":"statistics_cache_* server settings","sidebarTitle":"statistics_cache_*","href":"/reference/settings/server-settings/settings/statistics-cache"},{"title":"storage_* server settings","sidebarTitle":"storage_*","href":"/reference/settings/server-settings/settings/storage"},{"title":"storage_connections_* server settings","sidebarTitle":"storage_connections_*","href":"/reference/settings/server-settings/settings/storage-connections"},{"title":"streaming_exchange_* server settings","sidebarTitle":"streaming_exchange_*","href":"/reference/settings/server-settings/settings/streaming-exchange"},{"title":"tables_loader_* server settings","sidebarTitle":"tables_loader_*","href":"/reference/settings/server-settings/settings/tables-loader"},{"title":"tcp_close_* server settings","sidebarTitle":"tcp_close_*","href":"/reference/settings/server-settings/settings/tcp-close"},{"title":"tcp_port_* server settings","sidebarTitle":"tcp_port_*","href":"/reference/settings/server-settings/settings/tcp-port"},{"title":"temporary_data_* server settings","sidebarTitle":"temporary_data_*","href":"/reference/settings/server-settings/settings/temporary-data"},{"title":"text_index_* server settings","sidebarTitle":"text_index_*","href":"/reference/settings/server-settings/settings/text-index"},{"title":"threadpool_local_* server settings","sidebarTitle":"threadpool_local_*","href":"/reference/settings/server-settings/settings/threadpool-local"},{"title":"threadpool_remote_* server settings","sidebarTitle":"threadpool_remote_*","href":"/reference/settings/server-settings/settings/threadpool-remote"},{"title":"threadpool_writer_* server settings","sidebarTitle":"threadpool_writer_*","href":"/reference/settings/server-settings/settings/threadpool-writer"},{"title":"tmp_* server settings","sidebarTitle":"tmp_*","href":"/reference/settings/server-settings/settings/tmp"},{"title":"top_level_* server settings","sidebarTitle":"top_level_*","href":"/reference/settings/server-settings/settings/top-level"},{"title":"total_memory_* server settings","sidebarTitle":"total_memory_*","href":"/reference/settings/server-settings/settings/total-memory"},{"title":"uncompressed_cache_* server settings","sidebarTitle":"uncompressed_cache_*","href":"/reference/settings/server-settings/settings/uncompressed-cache"},{"title":"unique_key_* server settings","sidebarTitle":"unique_key_*","href":"/reference/settings/server-settings/settings/unique-key"},{"title":"use_* server settings","sidebarTitle":"use_*","href":"/reference/settings/server-settings/settings/use"},{"title":"user_* server settings","sidebarTitle":"user_*","href":"/reference/settings/server-settings/settings/user"},{"title":"user_defined_* server settings","sidebarTitle":"user_defined_*","href":"/reference/settings/server-settings/settings/user-defined"},{"title":"users_* server settings","sidebarTitle":"users_*","href":"/reference/settings/server-settings/settings/users"},{"title":"vector_similarity_* server settings","sidebarTitle":"vector_similarity_*","href":"/reference/settings/server-settings/settings/vector-similarity"},{"title":"workload_* server settings","sidebarTitle":"workload_*","href":"/reference/settings/server-settings/settings/workload"},{"title":"zookeeper_* server settings","sidebarTitle":"zookeeper_*","href":"/reference/settings/server-settings/settings/zookeeper"},{"title":"Other server settings","sidebarTitle":"Other","href":"/reference/settings/server-settings/settings/other"}]},{"group":"Session Settings","root":{"title":"Session Settings","sidebarTitle":"Overview","href":"/reference/settings/session-settings"},"directory":"none","pages":[{"title":"additional_* session settings","sidebarTitle":"additional_*","href":"/reference/settings/session-settings/additional"},{"title":"aggregate_* session settings","sidebarTitle":"aggregate_*","href":"/reference/settings/session-settings/aggregate"},{"title":"aggregation_* session settings","sidebarTitle":"aggregation_*","href":"/reference/settings/session-settings/aggregation"},{"title":"ai_function_* session settings","sidebarTitle":"ai_function_*","href":"/reference/settings/session-settings/ai-function"},{"title":"allow_* session settings","sidebarTitle":"allow_*","href":"/reference/settings/session-settings/allow"},{"title":"allow_deprecated_* session settings","sidebarTitle":"allow_deprecated_*","href":"/reference/settings/session-settings/allow-deprecated"},{"title":"allow_experimental_* session settings","sidebarTitle":"allow_experimental_*","href":"/reference/settings/session-settings/allow-experimental"},{"title":"allow_nondeterministic_* session settings","sidebarTitle":"allow_nondeterministic_*","href":"/reference/settings/session-settings/allow-nondeterministic"},{"title":"allow_prefetched_* session settings","sidebarTitle":"allow_prefetched_*","href":"/reference/settings/session-settings/allow-prefetched"},{"title":"allow_push_* session settings","sidebarTitle":"allow_push_*","href":"/reference/settings/session-settings/allow-push"},{"title":"allow_statistics_* session settings","sidebarTitle":"allow_statistics_*","href":"/reference/settings/session-settings/allow-statistics"},{"title":"allow_suspicious_* session settings","sidebarTitle":"allow_suspicious_*","href":"/reference/settings/session-settings/allow-suspicious"},{"title":"alter_* session settings","sidebarTitle":"alter_*","href":"/reference/settings/session-settings/alter"},{"title":"analyzer_compatibility_* session settings","sidebarTitle":"analyzer_compatibility_*","href":"/reference/settings/session-settings/analyzer-compatibility"},{"title":"apply_* session settings","sidebarTitle":"apply_*","href":"/reference/settings/session-settings/apply"},{"title":"apply_patch_parts_* session settings","sidebarTitle":"apply_patch_parts_*","href":"/reference/settings/session-settings/apply-patch-parts"},{"title":"ast_fuzzer_* session settings","sidebarTitle":"ast_fuzzer_*","href":"/reference/settings/session-settings/ast-fuzzer"},{"title":"asterisk_include_* session settings","sidebarTitle":"asterisk_include_*","href":"/reference/settings/session-settings/asterisk-include"},{"title":"async_* session settings","sidebarTitle":"async_*","href":"/reference/settings/session-settings/async"},{"title":"async_insert_* session settings","sidebarTitle":"async_insert_*","href":"/reference/settings/session-settings/async-insert"},{"title":"automatic_parallel_* session settings","sidebarTitle":"automatic_parallel_*","href":"/reference/settings/session-settings/automatic-parallel"},{"title":"azure_* session settings","sidebarTitle":"azure_*","href":"/reference/settings/session-settings/azure"},{"title":"azure_max_* session settings","sidebarTitle":"azure_max_*","href":"/reference/settings/session-settings/azure-max"},{"title":"azure_sdk_* session settings","sidebarTitle":"azure_sdk_*","href":"/reference/settings/session-settings/azure-sdk"},{"title":"azure_upload_* session settings","sidebarTitle":"azure_upload_*","href":"/reference/settings/session-settings/azure-upload"},{"title":"backup_restore_* session settings","sidebarTitle":"backup_restore_*","href":"/reference/settings/session-settings/backup-restore"},{"title":"cast_* session settings","sidebarTitle":"cast_*","href":"/reference/settings/session-settings/cast"},{"title":"cast_string_* session settings","sidebarTitle":"cast_string_*","href":"/reference/settings/session-settings/cast-string"},{"title":"check_* session settings","sidebarTitle":"check_*","href":"/reference/settings/session-settings/check"},{"title":"cloud_mode_* session settings","sidebarTitle":"cloud_mode_*","href":"/reference/settings/session-settings/cloud-mode"},{"title":"cluster_* session settings","sidebarTitle":"cluster_*","href":"/reference/settings/session-settings/cluster"},{"title":"cluster_table_* session settings","sidebarTitle":"cluster_table_*","href":"/reference/settings/session-settings/cluster-table"},{"title":"collect_hash_* session settings","sidebarTitle":"collect_hash_*","href":"/reference/settings/session-settings/collect-hash"},{"title":"columns_cache_* session settings","sidebarTitle":"columns_cache_*","href":"/reference/settings/session-settings/columns-cache"},{"title":"compatibility_* session settings","sidebarTitle":"compatibility_*","href":"/reference/settings/session-settings/compatibility"},{"title":"compatibility_ignore_* session settings","sidebarTitle":"compatibility_ignore_*","href":"/reference/settings/session-settings/compatibility-ignore"},{"title":"compile_* session settings","sidebarTitle":"compile_*","href":"/reference/settings/session-settings/compile"},{"title":"connect_timeout_* session settings","sidebarTitle":"connect_timeout_*","href":"/reference/settings/session-settings/connect-timeout"},{"title":"correlated_subqueries_* session settings","sidebarTitle":"correlated_subqueries_*","href":"/reference/settings/session-settings/correlated-subqueries"},{"title":"count_distinct_* session settings","sidebarTitle":"count_distinct_*","href":"/reference/settings/session-settings/count-distinct"},{"title":"create_* session settings","sidebarTitle":"create_*","href":"/reference/settings/session-settings/create"},{"title":"cross_join_* session settings","sidebarTitle":"cross_join_*","href":"/reference/settings/session-settings/cross-join"},{"title":"database_* session settings","sidebarTitle":"database_*","href":"/reference/settings/session-settings/database"},{"title":"database_replicated_* session settings","sidebarTitle":"database_replicated_*","href":"/reference/settings/session-settings/database-replicated"},{"title":"dead_blobs_* session settings","sidebarTitle":"dead_blobs_*","href":"/reference/settings/session-settings/dead-blobs"},{"title":"deduplicate_insert_* session settings","sidebarTitle":"deduplicate_insert_*","href":"/reference/settings/session-settings/deduplicate-insert"},{"title":"default_* session settings","sidebarTitle":"default_*","href":"/reference/settings/session-settings/default"},{"title":"delta_lake_* session settings","sidebarTitle":"delta_lake_*","href":"/reference/settings/session-settings/delta-lake"},{"title":"describe_include_* session settings","sidebarTitle":"describe_include_*","href":"/reference/settings/session-settings/describe-include"},{"title":"dictionary_* session settings","sidebarTitle":"dictionary_*","href":"/reference/settings/session-settings/dictionary"},{"title":"distributed_* session settings","sidebarTitle":"distributed_*","href":"/reference/settings/session-settings/distributed"},{"title":"distributed_background_* session settings","sidebarTitle":"distributed_background_*","href":"/reference/settings/session-settings/distributed-background"},{"title":"distributed_cache_* session settings","sidebarTitle":"distributed_cache_*","href":"/reference/settings/session-settings/distributed-cache"},{"title":"distributed_ddl_* session settings","sidebarTitle":"distributed_ddl_*","href":"/reference/settings/session-settings/distributed-ddl"},{"title":"distributed_index_analysis_* session settings","sidebarTitle":"distributed_index_analysis_*","href":"/reference/settings/session-settings/distributed-index-analysis"},{"title":"distributed_plan_* session settings","sidebarTitle":"distributed_plan_*","href":"/reference/settings/session-settings/distributed-plan"},{"title":"distributed_replica_* session settings","sidebarTitle":"distributed_replica_*","href":"/reference/settings/session-settings/distributed-replica"},{"title":"dynamic_disk_* session settings","sidebarTitle":"dynamic_disk_*","href":"/reference/settings/session-settings/dynamic-disk"},{"title":"empty_result_* session settings","sidebarTitle":"empty_result_*","href":"/reference/settings/session-settings/empty-result"},{"title":"enable_* session settings","sidebarTitle":"enable_*","href":"/reference/settings/session-settings/enable"},{"title":"enable_blob_storage_log_* session settings","sidebarTitle":"enable_blob_storage_log_*","href":"/reference/settings/session-settings/enable-blob-storage-log"},{"title":"enable_filesystem_* session settings","sidebarTitle":"enable_filesystem_*","href":"/reference/settings/session-settings/enable-filesystem"},{"title":"enable_join_* session settings","sidebarTitle":"enable_join_*","href":"/reference/settings/session-settings/enable-join"},{"title":"enable_lightweight_* session settings","sidebarTitle":"enable_lightweight_*","href":"/reference/settings/session-settings/enable-lightweight"},{"title":"enable_optimize_predicate_expression_* session settings","sidebarTitle":"enable_optimize_predicate_expression_*","href":"/reference/settings/session-settings/enable-optimize-predicate-expression"},{"title":"enable_parallel_* session settings","sidebarTitle":"enable_parallel_*","href":"/reference/settings/session-settings/enable-parallel"},{"title":"enable_positional_arguments_* session settings","sidebarTitle":"enable_positional_arguments_*","href":"/reference/settings/session-settings/enable-positional-arguments"},{"title":"enable_software_* session settings","sidebarTitle":"enable_software_*","href":"/reference/settings/session-settings/enable-software"},{"title":"engine_file_* session settings","sidebarTitle":"engine_file_*","href":"/reference/settings/session-settings/engine-file"},{"title":"external_storage_* session settings","sidebarTitle":"external_storage_*","href":"/reference/settings/session-settings/external-storage"},{"title":"external_table_* session settings","sidebarTitle":"external_table_*","href":"/reference/settings/session-settings/external-table"},{"title":"filesystem_cache_* session settings","sidebarTitle":"filesystem_cache_*","href":"/reference/settings/session-settings/filesystem-cache"},{"title":"filesystem_prefetch_* session settings","sidebarTitle":"filesystem_prefetch_*","href":"/reference/settings/session-settings/filesystem-prefetch"},{"title":"force_* session settings","sidebarTitle":"force_*","href":"/reference/settings/session-settings/force"},{"title":"force_optimize_* session settings","sidebarTitle":"force_optimize_*","href":"/reference/settings/session-settings/force-optimize"},{"title":"formatdatetime_* session settings","sidebarTitle":"formatdatetime_*","href":"/reference/settings/session-settings/formatdatetime"},{"title":"formatdatetime_f_* session settings","sidebarTitle":"formatdatetime_f_*","href":"/reference/settings/session-settings/formatdatetime-f"},{"title":"function_* session settings","sidebarTitle":"function_*","href":"/reference/settings/session-settings/function"},{"title":"function_json_* session settings","sidebarTitle":"function_json_*","href":"/reference/settings/session-settings/function-json"},{"title":"grace_hash_* session settings","sidebarTitle":"grace_hash_*","href":"/reference/settings/session-settings/grace-hash"},{"title":"group_by_* session settings","sidebarTitle":"group_by_*","href":"/reference/settings/session-settings/group-by"},{"title":"hdfs_* session settings","sidebarTitle":"hdfs_*","href":"/reference/settings/session-settings/hdfs"},{"title":"http_* session settings","sidebarTitle":"http_*","href":"/reference/settings/session-settings/http"},{"title":"http_headers_* session settings","sidebarTitle":"http_headers_*","href":"/reference/settings/session-settings/http-headers"},{"title":"http_max_* session settings","sidebarTitle":"http_max_*","href":"/reference/settings/session-settings/http-max"},{"title":"http_response_* session settings","sidebarTitle":"http_response_*","href":"/reference/settings/session-settings/http-response"},{"title":"http_retry_* session settings","sidebarTitle":"http_retry_*","href":"/reference/settings/session-settings/http-retry"},{"title":"iceberg_* session settings","sidebarTitle":"iceberg_*","href":"/reference/settings/session-settings/iceberg"},{"title":"iceberg_compaction_* session settings","sidebarTitle":"iceberg_compaction_*","href":"/reference/settings/session-settings/iceberg-compaction"},{"title":"iceberg_data_* session settings","sidebarTitle":"iceberg_data_*","href":"/reference/settings/session-settings/iceberg-data"},{"title":"iceberg_expire_* session settings","sidebarTitle":"iceberg_expire_*","href":"/reference/settings/session-settings/iceberg-expire"},{"title":"iceberg_insert_* session settings","sidebarTitle":"iceberg_insert_*","href":"/reference/settings/session-settings/iceberg-insert"},{"title":"iceberg_metadata_* session settings","sidebarTitle":"iceberg_metadata_*","href":"/reference/settings/session-settings/iceberg-metadata"},{"title":"ignore_* session settings","sidebarTitle":"ignore_*","href":"/reference/settings/session-settings/ignore"},{"title":"ignore_on_* session settings","sidebarTitle":"ignore_on_*","href":"/reference/settings/session-settings/ignore-on"},{"title":"implicit_* session settings","sidebarTitle":"implicit_*","href":"/reference/settings/session-settings/implicit"},{"title":"insert_* session settings","sidebarTitle":"insert_*","href":"/reference/settings/session-settings/insert"},{"title":"insert_keeper_* session settings","sidebarTitle":"insert_keeper_*","href":"/reference/settings/session-settings/insert-keeper"},{"title":"insert_quorum_* session settings","sidebarTitle":"insert_quorum_*","href":"/reference/settings/session-settings/insert-quorum"},{"title":"jemalloc_* session settings","sidebarTitle":"jemalloc_*","href":"/reference/settings/session-settings/jemalloc"},{"title":"jemalloc_profile_* session settings","sidebarTitle":"jemalloc_profile_*","href":"/reference/settings/session-settings/jemalloc-profile"},{"title":"join_* session settings","sidebarTitle":"join_*","href":"/reference/settings/session-settings/join"},{"title":"join_runtime_* session settings","sidebarTitle":"join_runtime_*","href":"/reference/settings/session-settings/join-runtime"},{"title":"join_to_* session settings","sidebarTitle":"join_to_*","href":"/reference/settings/session-settings/join-to"},{"title":"joined_* session settings","sidebarTitle":"joined_*","href":"/reference/settings/session-settings/joined"},{"title":"kafka_* session settings","sidebarTitle":"kafka_*","href":"/reference/settings/session-settings/kafka"},{"title":"keeper_* session settings","sidebarTitle":"keeper_*","href":"/reference/settings/session-settings/keeper"},{"title":"keeper_retry_* session settings","sidebarTitle":"keeper_retry_*","href":"/reference/settings/session-settings/keeper-retry"},{"title":"lightweight_* session settings","sidebarTitle":"lightweight_*","href":"/reference/settings/session-settings/lightweight"},{"title":"load_balancing_* session settings","sidebarTitle":"load_balancing_*","href":"/reference/settings/session-settings/load-balancing"},{"title":"local_filesystem_* session settings","sidebarTitle":"local_filesystem_*","href":"/reference/settings/session-settings/local-filesystem"},{"title":"log_* session settings","sidebarTitle":"log_*","href":"/reference/settings/session-settings/log"},{"title":"log_queries_* session settings","sidebarTitle":"log_queries_*","href":"/reference/settings/session-settings/log-queries"},{"title":"log_query_* session settings","sidebarTitle":"log_query_*","href":"/reference/settings/session-settings/log-query"},{"title":"logsql_* session settings","sidebarTitle":"logsql_*","href":"/reference/settings/session-settings/logsql"},{"title":"low_cardinality_* session settings","sidebarTitle":"low_cardinality_*","href":"/reference/settings/session-settings/low-cardinality"},{"title":"materialize_* session settings","sidebarTitle":"materialize_*","href":"/reference/settings/session-settings/materialize"},{"title":"materialize_statistics_on_insert_* session settings","sidebarTitle":"materialize_statistics_on_insert_*","href":"/reference/settings/session-settings/materialize-statistics-on-insert"},{"title":"materialized_views_* session settings","sidebarTitle":"materialized_views_*","href":"/reference/settings/session-settings/materialized-views"},{"title":"max_* session settings","sidebarTitle":"max_*","href":"/reference/settings/session-settings/max"},{"title":"max_ast_* session settings","sidebarTitle":"max_ast_*","href":"/reference/settings/session-settings/max-ast"},{"title":"max_bytes_* session settings","sidebarTitle":"max_bytes_*","href":"/reference/settings/session-settings/max-bytes"},{"title":"max_concurrent_* session settings","sidebarTitle":"max_concurrent_*","href":"/reference/settings/session-settings/max-concurrent"},{"title":"max_distributed_* session settings","sidebarTitle":"max_distributed_*","href":"/reference/settings/session-settings/max-distributed"},{"title":"max_download_* session settings","sidebarTitle":"max_download_*","href":"/reference/settings/session-settings/max-download"},{"title":"max_execution_* session settings","sidebarTitle":"max_execution_*","href":"/reference/settings/session-settings/max-execution"},{"title":"max_hyperscan_* session settings","sidebarTitle":"max_hyperscan_*","href":"/reference/settings/session-settings/max-hyperscan"},{"title":"max_insert_* session settings","sidebarTitle":"max_insert_*","href":"/reference/settings/session-settings/max-insert"},{"title":"max_joined_* session settings","sidebarTitle":"max_joined_*","href":"/reference/settings/session-settings/max-joined"},{"title":"max_local_* session settings","sidebarTitle":"max_local_*","href":"/reference/settings/session-settings/max-local"},{"title":"max_memory_usage_* session settings","sidebarTitle":"max_memory_usage_*","href":"/reference/settings/session-settings/max-memory-usage"},{"title":"max_network_* session settings","sidebarTitle":"max_network_*","href":"/reference/settings/session-settings/max-network"},{"title":"max_number_* session settings","sidebarTitle":"max_number_*","href":"/reference/settings/session-settings/max-number"},{"title":"max_parser_* session settings","sidebarTitle":"max_parser_*","href":"/reference/settings/session-settings/max-parser"},{"title":"max_partitions_* session settings","sidebarTitle":"max_partitions_*","href":"/reference/settings/session-settings/max-partitions"},{"title":"max_rand_* session settings","sidebarTitle":"max_rand_*","href":"/reference/settings/session-settings/max-rand"},{"title":"max_read_buffer_size_* session settings","sidebarTitle":"max_read_buffer_size_*","href":"/reference/settings/session-settings/max-read-buffer-size"},{"title":"max_remote_* session settings","sidebarTitle":"max_remote_*","href":"/reference/settings/session-settings/max-remote"},{"title":"max_result_* session settings","sidebarTitle":"max_result_*","href":"/reference/settings/session-settings/max-result"},{"title":"max_rows_* session settings","sidebarTitle":"max_rows_*","href":"/reference/settings/session-settings/max-rows"},{"title":"max_size_* session settings","sidebarTitle":"max_size_*","href":"/reference/settings/session-settings/max-size"},{"title":"max_skip_* session settings","sidebarTitle":"max_skip_*","href":"/reference/settings/session-settings/max-skip"},{"title":"max_streams_* session settings","sidebarTitle":"max_streams_*","href":"/reference/settings/session-settings/max-streams"},{"title":"max_temporary_* session settings","sidebarTitle":"max_temporary_*","href":"/reference/settings/session-settings/max-temporary"},{"title":"max_threads_* session settings","sidebarTitle":"max_threads_*","href":"/reference/settings/session-settings/max-threads"},{"title":"memory_* session settings","sidebarTitle":"memory_*","href":"/reference/settings/session-settings/memory"},{"title":"memory_overcommit_ratio_denominator_* session settings","sidebarTitle":"memory_overcommit_ratio_denominator_*","href":"/reference/settings/session-settings/memory-overcommit-ratio-denominator"},{"title":"memory_profiler_* session settings","sidebarTitle":"memory_profiler_*","href":"/reference/settings/session-settings/memory-profiler"},{"title":"merge_tree_* session settings","sidebarTitle":"merge_tree_*","href":"/reference/settings/session-settings/merge-tree"},{"title":"metrics_perf_* session settings","sidebarTitle":"metrics_perf_*","href":"/reference/settings/session-settings/metrics-perf"},{"title":"min_* session settings","sidebarTitle":"min_*","href":"/reference/settings/session-settings/min"},{"title":"min_bytes_* session settings","sidebarTitle":"min_bytes_*","href":"/reference/settings/session-settings/min-bytes"},{"title":"min_count_* session settings","sidebarTitle":"min_count_*","href":"/reference/settings/session-settings/min-count"},{"title":"min_execution_speed_* session settings","sidebarTitle":"min_execution_speed_*","href":"/reference/settings/session-settings/min-execution-speed"},{"title":"min_external_* session settings","sidebarTitle":"min_external_*","href":"/reference/settings/session-settings/min-external"},{"title":"min_free_* session settings","sidebarTitle":"min_free_*","href":"/reference/settings/session-settings/min-free"},{"title":"min_insert_* session settings","sidebarTitle":"min_insert_*","href":"/reference/settings/session-settings/min-insert"},{"title":"min_joined_* session settings","sidebarTitle":"min_joined_*","href":"/reference/settings/session-settings/min-joined"},{"title":"move_* session settings","sidebarTitle":"move_*","href":"/reference/settings/session-settings/move"},{"title":"mutations_* session settings","sidebarTitle":"mutations_*","href":"/reference/settings/session-settings/mutations"},{"title":"mutations_execute_* session settings","sidebarTitle":"mutations_execute_*","href":"/reference/settings/session-settings/mutations-execute"},{"title":"mysql_* session settings","sidebarTitle":"mysql_*","href":"/reference/settings/session-settings/mysql"},{"title":"mysql_map_* session settings","sidebarTitle":"mysql_map_*","href":"/reference/settings/session-settings/mysql-map"},{"title":"network_* session settings","sidebarTitle":"network_*","href":"/reference/settings/session-settings/network"},{"title":"number_of_* session settings","sidebarTitle":"number_of_*","href":"/reference/settings/session-settings/number-of"},{"title":"obfuscate_markov_* session settings","sidebarTitle":"obfuscate_markov_*","href":"/reference/settings/session-settings/obfuscate-markov"},{"title":"odbc_bridge_* session settings","sidebarTitle":"odbc_bridge_*","href":"/reference/settings/session-settings/odbc-bridge"},{"title":"opentelemetry_start_* session settings","sidebarTitle":"opentelemetry_start_*","href":"/reference/settings/session-settings/opentelemetry-start"},{"title":"opentelemetry_trace_* session settings","sidebarTitle":"opentelemetry_trace_*","href":"/reference/settings/session-settings/opentelemetry-trace"},{"title":"optimize_* session settings","sidebarTitle":"optimize_*","href":"/reference/settings/session-settings/optimize"},{"title":"optimize_aggregation_in_order_* session settings","sidebarTitle":"optimize_aggregation_in_order_*","href":"/reference/settings/session-settings/optimize-aggregation-in-order"},{"title":"optimize_and_compare_chain_* session settings","sidebarTitle":"optimize_and_compare_chain_*","href":"/reference/settings/session-settings/optimize-and-compare-chain"},{"title":"optimize_group_* session settings","sidebarTitle":"optimize_group_*","href":"/reference/settings/session-settings/optimize-group"},{"title":"optimize_if_* session settings","sidebarTitle":"optimize_if_*","href":"/reference/settings/session-settings/optimize-if"},{"title":"optimize_injective_* session settings","sidebarTitle":"optimize_injective_*","href":"/reference/settings/session-settings/optimize-injective"},{"title":"optimize_limit_* session settings","sidebarTitle":"optimize_limit_*","href":"/reference/settings/session-settings/optimize-limit"},{"title":"optimize_min_* session settings","sidebarTitle":"optimize_min_*","href":"/reference/settings/session-settings/optimize-min"},{"title":"optimize_move_to_prewhere_* session settings","sidebarTitle":"optimize_move_to_prewhere_*","href":"/reference/settings/session-settings/optimize-move-to-prewhere"},{"title":"optimize_or_like_chain_* session settings","sidebarTitle":"optimize_or_like_chain_*","href":"/reference/settings/session-settings/optimize-or-like-chain"},{"title":"optimize_redundant_* session settings","sidebarTitle":"optimize_redundant_*","href":"/reference/settings/session-settings/optimize-redundant"},{"title":"optimize_rewrite_* session settings","sidebarTitle":"optimize_rewrite_*","href":"/reference/settings/session-settings/optimize-rewrite"},{"title":"optimize_skip_* session settings","sidebarTitle":"optimize_skip_*","href":"/reference/settings/session-settings/optimize-skip"},{"title":"optimize_trivial_* session settings","sidebarTitle":"optimize_trivial_*","href":"/reference/settings/session-settings/optimize-trivial"},{"title":"optimize_use_* session settings","sidebarTitle":"optimize_use_*","href":"/reference/settings/session-settings/optimize-use"},{"title":"os_threads_* session settings","sidebarTitle":"os_threads_*","href":"/reference/settings/session-settings/os-threads"},{"title":"page_cache_* session settings","sidebarTitle":"page_cache_*","href":"/reference/settings/session-settings/page-cache"},{"title":"parallel_* session settings","sidebarTitle":"parallel_*","href":"/reference/settings/session-settings/parallel"},{"title":"parallel_replicas_* session settings","sidebarTitle":"parallel_replicas_*","href":"/reference/settings/session-settings/parallel-replicas"},{"title":"parsedatetime_* session settings","sidebarTitle":"parsedatetime_*","href":"/reference/settings/session-settings/parsedatetime"},{"title":"partial_merge_* session settings","sidebarTitle":"partial_merge_*","href":"/reference/settings/session-settings/partial-merge"},{"title":"parts_to_* session settings","sidebarTitle":"parts_to_*","href":"/reference/settings/session-settings/parts-to"},{"title":"postgresql_connection_* session settings","sidebarTitle":"postgresql_connection_*","href":"/reference/settings/session-settings/postgresql-connection"},{"title":"prefer_* session settings","sidebarTitle":"prefer_*","href":"/reference/settings/session-settings/prefer"},{"title":"preferred_* session settings","sidebarTitle":"preferred_*","href":"/reference/settings/session-settings/preferred"},{"title":"promql_* session settings","sidebarTitle":"promql_*","href":"/reference/settings/session-settings/promql"},{"title":"query_cache_* session settings","sidebarTitle":"query_cache_*","href":"/reference/settings/session-settings/query-cache"},{"title":"query_plan_* session settings","sidebarTitle":"query_plan_*","href":"/reference/settings/session-settings/query-plan"},{"title":"query_profiler_* session settings","sidebarTitle":"query_profiler_*","href":"/reference/settings/session-settings/query-profiler"},{"title":"read_* session settings","sidebarTitle":"read_*","href":"/reference/settings/session-settings/read"},{"title":"read_backoff_* session settings","sidebarTitle":"read_backoff_*","href":"/reference/settings/session-settings/read-backoff"},{"title":"read_from_* session settings","sidebarTitle":"read_from_*","href":"/reference/settings/session-settings/read-from"},{"title":"read_in_* session settings","sidebarTitle":"read_in_*","href":"/reference/settings/session-settings/read-in"},{"title":"read_overflow_mode_* session settings","sidebarTitle":"read_overflow_mode_*","href":"/reference/settings/session-settings/read-overflow-mode"},{"title":"reader_executor_* session settings","sidebarTitle":"reader_executor_*","href":"/reference/settings/session-settings/reader-executor"},{"title":"receive_* session settings","sidebarTitle":"receive_*","href":"/reference/settings/session-settings/receive"},{"title":"regexp_dict_* session settings","sidebarTitle":"regexp_dict_*","href":"/reference/settings/session-settings/regexp-dict"},{"title":"remote_filesystem_* session settings","sidebarTitle":"remote_filesystem_*","href":"/reference/settings/session-settings/remote-filesystem"},{"title":"remote_fs_* session settings","sidebarTitle":"remote_fs_*","href":"/reference/settings/session-settings/remote-fs"},{"title":"replace_running_query_* session settings","sidebarTitle":"replace_running_query_*","href":"/reference/settings/session-settings/replace-running-query"},{"title":"restore_replace_* session settings","sidebarTitle":"restore_replace_*","href":"/reference/settings/session-settings/restore-replace"},{"title":"rewrite_* session settings","sidebarTitle":"rewrite_*","href":"/reference/settings/session-settings/rewrite"},{"title":"s3_* session settings","sidebarTitle":"s3_*","href":"/reference/settings/session-settings/s3"},{"title":"s3_allow_* session settings","sidebarTitle":"s3_allow_*","href":"/reference/settings/session-settings/s3-allow"},{"title":"s3_max_* session settings","sidebarTitle":"s3_max_*","href":"/reference/settings/session-settings/s3-max"},{"title":"s3_upload_* session settings","sidebarTitle":"s3_upload_*","href":"/reference/settings/session-settings/s3-upload"},{"title":"s3_validate_* session settings","sidebarTitle":"s3_validate_*","href":"/reference/settings/session-settings/s3-validate"},{"title":"s3queue_* session settings","sidebarTitle":"s3queue_*","href":"/reference/settings/session-settings/s3queue"},{"title":"schema_inference_* session settings","sidebarTitle":"schema_inference_*","href":"/reference/settings/session-settings/schema-inference"},{"title":"send_* session settings","sidebarTitle":"send_*","href":"/reference/settings/session-settings/send"},{"title":"send_logs_* session settings","sidebarTitle":"send_logs_*","href":"/reference/settings/session-settings/send-logs"},{"title":"serialize_* session settings","sidebarTitle":"serialize_*","href":"/reference/settings/session-settings/serialize"},{"title":"shared_merge_* session settings","sidebarTitle":"shared_merge_*","href":"/reference/settings/session-settings/shared-merge"},{"title":"short_circuit_function_evaluation_* session settings","sidebarTitle":"short_circuit_function_evaluation_*","href":"/reference/settings/session-settings/short-circuit-function-evaluation"},{"title":"show_* session settings","sidebarTitle":"show_*","href":"/reference/settings/session-settings/show"},{"title":"shrink_over_* session settings","sidebarTitle":"shrink_over_*","href":"/reference/settings/session-settings/shrink-over"},{"title":"skip_unavailable_shards_* session settings","sidebarTitle":"skip_unavailable_shards_*","href":"/reference/settings/session-settings/skip-unavailable-shards"},{"title":"sleep_in_* session settings","sidebarTitle":"sleep_in_*","href":"/reference/settings/session-settings/sleep-in"},{"title":"split_* session settings","sidebarTitle":"split_*","href":"/reference/settings/session-settings/split"},{"title":"storage_* session settings","sidebarTitle":"storage_*","href":"/reference/settings/session-settings/storage"},{"title":"stream_* session settings","sidebarTitle":"stream_*","href":"/reference/settings/session-settings/stream"},{"title":"stream_like_* session settings","sidebarTitle":"stream_like_*","href":"/reference/settings/session-settings/stream-like"},{"title":"system_* session settings","sidebarTitle":"system_*","href":"/reference/settings/session-settings/system"},{"title":"table_* session settings","sidebarTitle":"table_*","href":"/reference/settings/session-settings/table"},{"title":"temporary_files_* session settings","sidebarTitle":"temporary_files_*","href":"/reference/settings/session-settings/temporary-files"},{"title":"text_index_* session settings","sidebarTitle":"text_index_*","href":"/reference/settings/session-settings/text-index"},{"title":"throw_on_* session settings","sidebarTitle":"throw_on_*","href":"/reference/settings/session-settings/throw-on"},{"title":"timeout_overflow_mode_* session settings","sidebarTitle":"timeout_overflow_mode_*","href":"/reference/settings/session-settings/timeout-overflow-mode"},{"title":"totals_* session settings","sidebarTitle":"totals_*","href":"/reference/settings/session-settings/totals"},{"title":"trace_profile_events_* session settings","sidebarTitle":"trace_profile_events_*","href":"/reference/settings/session-settings/trace-profile-events"},{"title":"unique_key_* session settings","sidebarTitle":"unique_key_*","href":"/reference/settings/session-settings/unique-key"},{"title":"update_* session settings","sidebarTitle":"update_*","href":"/reference/settings/session-settings/update"},{"title":"url_* session settings","sidebarTitle":"url_*","href":"/reference/settings/session-settings/url"},{"title":"use_* session settings","sidebarTitle":"use_*","href":"/reference/settings/session-settings/use"},{"title":"use_iceberg_* session settings","sidebarTitle":"use_iceberg_*","href":"/reference/settings/session-settings/use-iceberg"},{"title":"use_index_for_in_with_subqueries_* session settings","sidebarTitle":"use_index_for_in_with_subqueries_*","href":"/reference/settings/session-settings/use-index-for-in-with-subqueries"},{"title":"use_page_* session settings","sidebarTitle":"use_page_*","href":"/reference/settings/session-settings/use-page"},{"title":"use_paimon_* session settings","sidebarTitle":"use_paimon_*","href":"/reference/settings/session-settings/use-paimon"},{"title":"use_partition_* session settings","sidebarTitle":"use_partition_*","href":"/reference/settings/session-settings/use-partition"},{"title":"use_query_* session settings","sidebarTitle":"use_query_*","href":"/reference/settings/session-settings/use-query"},{"title":"use_skip_indexes_* session settings","sidebarTitle":"use_skip_indexes_*","href":"/reference/settings/session-settings/use-skip-indexes"},{"title":"use_statistics_* session settings","sidebarTitle":"use_statistics_*","href":"/reference/settings/session-settings/use-statistics"},{"title":"use_text_* session settings","sidebarTitle":"use_text_*","href":"/reference/settings/session-settings/use-text"},{"title":"use_top_k_dynamic_filtering_* session settings","sidebarTitle":"use_top_k_dynamic_filtering_*","href":"/reference/settings/session-settings/use-top-k-dynamic-filtering"},{"title":"use_variant_* session settings","sidebarTitle":"use_variant_*","href":"/reference/settings/session-settings/use-variant"},{"title":"validate_* session settings","sidebarTitle":"validate_*","href":"/reference/settings/session-settings/validate"},{"title":"vector_search_* session settings","sidebarTitle":"vector_search_*","href":"/reference/settings/session-settings/vector-search"},{"title":"wait_for_* session settings","sidebarTitle":"wait_for_*","href":"/reference/settings/session-settings/wait-for"},{"title":"webassembly_udf_* session settings","sidebarTitle":"webassembly_udf_*","href":"/reference/settings/session-settings/webassembly-udf"},{"title":"weight_lowering_* session settings","sidebarTitle":"weight_lowering_*","href":"/reference/settings/session-settings/weight-lowering"},{"title":"write_through_distributed_cache_* session settings","sidebarTitle":"write_through_distributed_cache_*","href":"/reference/settings/session-settings/write-through-distributed-cache"},{"title":"Other session settings","sidebarTitle":"Other","href":"/reference/settings/session-settings/other"}]},{"group":"MergeTree tables settings","root":{"title":"MergeTree tables settings","sidebarTitle":"Overview","href":"/reference/settings/merge-tree-settings"},"directory":"none","pages":[{"title":"add_minmax_* MergeTree table settings","sidebarTitle":"add_minmax_*","href":"/reference/settings/merge-tree-settings/add-minmax"},{"title":"allow_* MergeTree table settings","sidebarTitle":"allow_*","href":"/reference/settings/merge-tree-settings/allow"},{"title":"allow_experimental_* MergeTree table settings","sidebarTitle":"allow_experimental_*","href":"/reference/settings/merge-tree-settings/allow-experimental"},{"title":"always_fetch_* MergeTree table settings","sidebarTitle":"always_fetch_*","href":"/reference/settings/merge-tree-settings/always-fetch"},{"title":"async_* MergeTree table settings","sidebarTitle":"async_*","href":"/reference/settings/merge-tree-settings/async"},{"title":"cache_populated_by_fetch_* MergeTree table settings","sidebarTitle":"cache_populated_by_fetch_*","href":"/reference/settings/merge-tree-settings/cache-populated-by-fetch"},{"title":"check_* MergeTree table settings","sidebarTitle":"check_*","href":"/reference/settings/merge-tree-settings/check"},{"title":"cleanup_* MergeTree table settings","sidebarTitle":"cleanup_*","href":"/reference/settings/merge-tree-settings/cleanup"},{"title":"cleanup_delay_period_* MergeTree table settings","sidebarTitle":"cleanup_delay_period_*","href":"/reference/settings/merge-tree-settings/cleanup-delay-period"},{"title":"columns_* MergeTree table settings","sidebarTitle":"columns_*","href":"/reference/settings/merge-tree-settings/columns"},{"title":"compact_parts_* MergeTree table settings","sidebarTitle":"compact_parts_*","href":"/reference/settings/merge-tree-settings/compact-parts"},{"title":"compress_* MergeTree table settings","sidebarTitle":"compress_*","href":"/reference/settings/merge-tree-settings/compress"},{"title":"concurrent_part_removal_threshold_* MergeTree table settings","sidebarTitle":"concurrent_part_removal_threshold_*","href":"/reference/settings/merge-tree-settings/concurrent-part-removal-threshold"},{"title":"dead_blobs_* MergeTree table settings","sidebarTitle":"dead_blobs_*","href":"/reference/settings/merge-tree-settings/dead-blobs"},{"title":"detach_* MergeTree table settings","sidebarTitle":"detach_*","href":"/reference/settings/merge-tree-settings/detach"},{"title":"disable_* MergeTree table settings","sidebarTitle":"disable_*","href":"/reference/settings/merge-tree-settings/disable"},{"title":"distributed_index_* MergeTree table settings","sidebarTitle":"distributed_index_*","href":"/reference/settings/merge-tree-settings/distributed-index"},{"title":"enable_* MergeTree table settings","sidebarTitle":"enable_*","href":"/reference/settings/merge-tree-settings/enable"},{"title":"enable_block_* MergeTree table settings","sidebarTitle":"enable_block_*","href":"/reference/settings/merge-tree-settings/enable-block"},{"title":"escape_* MergeTree table settings","sidebarTitle":"escape_*","href":"/reference/settings/merge-tree-settings/escape"},{"title":"exclude_* MergeTree table settings","sidebarTitle":"exclude_*","href":"/reference/settings/merge-tree-settings/exclude"},{"title":"fault_probability_* MergeTree table settings","sidebarTitle":"fault_probability_*","href":"/reference/settings/merge-tree-settings/fault-probability"},{"title":"fsync_* MergeTree table settings","sidebarTitle":"fsync_*","href":"/reference/settings/merge-tree-settings/fsync"},{"title":"in_memory_* MergeTree table settings","sidebarTitle":"in_memory_*","href":"/reference/settings/merge-tree-settings/in-memory"},{"title":"inactive_parts_* MergeTree table settings","sidebarTitle":"inactive_parts_*","href":"/reference/settings/merge-tree-settings/inactive-parts"},{"title":"index_granularity_* MergeTree table settings","sidebarTitle":"index_granularity_*","href":"/reference/settings/merge-tree-settings/index-granularity"},{"title":"kill_delay_period_* MergeTree table settings","sidebarTitle":"kill_delay_period_*","href":"/reference/settings/merge-tree-settings/kill-delay-period"},{"title":"map_buckets_* MergeTree table settings","sidebarTitle":"map_buckets_*","href":"/reference/settings/merge-tree-settings/map-buckets"},{"title":"map_serialization_version_* MergeTree table settings","sidebarTitle":"map_serialization_version_*","href":"/reference/settings/merge-tree-settings/map-serialization-version"},{"title":"marks_* MergeTree table settings","sidebarTitle":"marks_*","href":"/reference/settings/merge-tree-settings/marks"},{"title":"materialize_* MergeTree table settings","sidebarTitle":"materialize_*","href":"/reference/settings/merge-tree-settings/materialize"},{"title":"materialize_projections_* MergeTree table settings","sidebarTitle":"materialize_projections_*","href":"/reference/settings/merge-tree-settings/materialize-projections"},{"title":"max_* MergeTree table settings","sidebarTitle":"max_*","href":"/reference/settings/merge-tree-settings/max"},{"title":"max_bytes_* MergeTree table settings","sidebarTitle":"max_bytes_*","href":"/reference/settings/merge-tree-settings/max-bytes"},{"title":"max_delay_* MergeTree table settings","sidebarTitle":"max_delay_*","href":"/reference/settings/merge-tree-settings/max-delay"},{"title":"max_files_* MergeTree table settings","sidebarTitle":"max_files_*","href":"/reference/settings/merge-tree-settings/max-files"},{"title":"max_merge_* MergeTree table settings","sidebarTitle":"max_merge_*","href":"/reference/settings/merge-tree-settings/max-merge"},{"title":"max_number_* MergeTree table settings","sidebarTitle":"max_number_*","href":"/reference/settings/merge-tree-settings/max-number"},{"title":"max_part_* MergeTree table settings","sidebarTitle":"max_part_*","href":"/reference/settings/merge-tree-settings/max-part"},{"title":"max_parts_* MergeTree table settings","sidebarTitle":"max_parts_*","href":"/reference/settings/merge-tree-settings/max-parts"},{"title":"max_postpone_* MergeTree table settings","sidebarTitle":"max_postpone_*","href":"/reference/settings/merge-tree-settings/max-postpone"},{"title":"max_replicated_* MergeTree table settings","sidebarTitle":"max_replicated_*","href":"/reference/settings/merge-tree-settings/max-replicated"},{"title":"max_suspicious_broken_parts_* MergeTree table settings","sidebarTitle":"max_suspicious_broken_parts_*","href":"/reference/settings/merge-tree-settings/max-suspicious-broken-parts"},{"title":"merge_* MergeTree table settings","sidebarTitle":"merge_*","href":"/reference/settings/merge-tree-settings/merge"},{"title":"merge_max_* MergeTree table settings","sidebarTitle":"merge_max_*","href":"/reference/settings/merge-tree-settings/merge-max"},{"title":"merge_selecting_* MergeTree table settings","sidebarTitle":"merge_selecting_*","href":"/reference/settings/merge-tree-settings/merge-selecting"},{"title":"merge_selector_* MergeTree table settings","sidebarTitle":"merge_selector_*","href":"/reference/settings/merge-tree-settings/merge-selector"},{"title":"merge_tree_* MergeTree table settings","sidebarTitle":"merge_tree_*","href":"/reference/settings/merge-tree-settings/merge-tree"},{"title":"merge_with_* MergeTree table settings","sidebarTitle":"merge_with_*","href":"/reference/settings/merge-tree-settings/merge-with"},{"title":"min_* MergeTree table settings","sidebarTitle":"min_*","href":"/reference/settings/merge-tree-settings/min"},{"title":"min_age_* MergeTree table settings","sidebarTitle":"min_age_*","href":"/reference/settings/merge-tree-settings/min-age"},{"title":"min_bytes_* MergeTree table settings","sidebarTitle":"min_bytes_*","href":"/reference/settings/merge-tree-settings/min-bytes"},{"title":"min_compressed_* MergeTree table settings","sidebarTitle":"min_compressed_*","href":"/reference/settings/merge-tree-settings/min-compressed"},{"title":"min_delay_* MergeTree table settings","sidebarTitle":"min_delay_*","href":"/reference/settings/merge-tree-settings/min-delay"},{"title":"min_free_* MergeTree table settings","sidebarTitle":"min_free_*","href":"/reference/settings/merge-tree-settings/min-free"},{"title":"min_level_* MergeTree table settings","sidebarTitle":"min_level_*","href":"/reference/settings/merge-tree-settings/min-level"},{"title":"min_relative_* MergeTree table settings","sidebarTitle":"min_relative_*","href":"/reference/settings/merge-tree-settings/min-relative"},{"title":"min_rows_* MergeTree table settings","sidebarTitle":"min_rows_*","href":"/reference/settings/merge-tree-settings/min-rows"},{"title":"number_of_* MergeTree table settings","sidebarTitle":"number_of_*","href":"/reference/settings/merge-tree-settings/number-of"},{"title":"object_shared_* MergeTree table settings","sidebarTitle":"object_shared_*","href":"/reference/settings/merge-tree-settings/object-shared"},{"title":"part_moves_* MergeTree table settings","sidebarTitle":"part_moves_*","href":"/reference/settings/merge-tree-settings/part-moves"},{"title":"parts_to_* MergeTree table settings","sidebarTitle":"parts_to_*","href":"/reference/settings/merge-tree-settings/parts-to"},{"title":"prefer_fetch_* MergeTree table settings","sidebarTitle":"prefer_fetch_*","href":"/reference/settings/merge-tree-settings/prefer-fetch"},{"title":"prewarm_* MergeTree table settings","sidebarTitle":"prewarm_*","href":"/reference/settings/merge-tree-settings/prewarm"},{"title":"primary_key_* MergeTree table settings","sidebarTitle":"primary_key_*","href":"/reference/settings/merge-tree-settings/primary-key"},{"title":"refresh_* MergeTree table settings","sidebarTitle":"refresh_*","href":"/reference/settings/merge-tree-settings/refresh"},{"title":"remote_fs_* MergeTree table settings","sidebarTitle":"remote_fs_*","href":"/reference/settings/merge-tree-settings/remote-fs"},{"title":"remove_* MergeTree table settings","sidebarTitle":"remove_*","href":"/reference/settings/merge-tree-settings/remove"},{"title":"replicated_deduplication_window_* MergeTree table settings","sidebarTitle":"replicated_deduplication_window_*","href":"/reference/settings/merge-tree-settings/replicated-deduplication-window"},{"title":"replicated_fetches_* MergeTree table settings","sidebarTitle":"replicated_fetches_*","href":"/reference/settings/merge-tree-settings/replicated-fetches"},{"title":"replicated_max_* MergeTree table settings","sidebarTitle":"replicated_max_*","href":"/reference/settings/merge-tree-settings/replicated-max"},{"title":"shared_merge_* MergeTree table settings","sidebarTitle":"shared_merge_*","href":"/reference/settings/merge-tree-settings/shared-merge"},{"title":"sleep_before_* MergeTree table settings","sidebarTitle":"sleep_before_*","href":"/reference/settings/merge-tree-settings/sleep-before"},{"title":"table_* MergeTree table settings","sidebarTitle":"table_*","href":"/reference/settings/merge-tree-settings/table"},{"title":"text_index_* MergeTree table settings","sidebarTitle":"text_index_*","href":"/reference/settings/merge-tree-settings/text-index"},{"title":"use_* MergeTree table settings","sidebarTitle":"use_*","href":"/reference/settings/merge-tree-settings/use"},{"title":"use_minimalistic_* MergeTree table settings","sidebarTitle":"use_minimalistic_*","href":"/reference/settings/merge-tree-settings/use-minimalistic"},{"title":"vertical_merge_* MergeTree table settings","sidebarTitle":"vertical_merge_*","href":"/reference/settings/merge-tree-settings/vertical-merge"},{"title":"write_* MergeTree table settings","sidebarTitle":"write_*","href":"/reference/settings/merge-tree-settings/write"},{"title":"write_ahead_* MergeTree table settings","sidebarTitle":"write_ahead_*","href":"/reference/settings/merge-tree-settings/write-ahead"},{"title":"zero_copy_* MergeTree table settings","sidebarTitle":"zero_copy_*","href":"/reference/settings/merge-tree-settings/zero-copy"},{"title":"Other MergeTree table settings","sidebarTitle":"Other","href":"/reference/settings/merge-tree-settings/other"}]},{"group":"Format Settings","root":{"title":"Format Settings","sidebarTitle":"Overview","href":"/reference/settings/formats"},"directory":"none","pages":[{"title":"bool_* format settings","sidebarTitle":"bool_*","href":"/reference/settings/formats/bool"},{"title":"date_time_* format settings","sidebarTitle":"date_time_*","href":"/reference/settings/formats/date-time"},{"title":"format_* format settings","sidebarTitle":"format_*","href":"/reference/settings/formats/format"},{"title":"format_avro_* format settings","sidebarTitle":"format_avro_*","href":"/reference/settings/formats/format-avro"},{"title":"format_binary_* format settings","sidebarTitle":"format_binary_*","href":"/reference/settings/formats/format-binary"},{"title":"format_capn_* format settings","sidebarTitle":"format_capn_*","href":"/reference/settings/formats/format-capn"},{"title":"format_csv_* format settings","sidebarTitle":"format_csv_*","href":"/reference/settings/formats/format-csv"},{"title":"format_custom_* format settings","sidebarTitle":"format_custom_*","href":"/reference/settings/formats/format-custom"},{"title":"format_regexp_* format settings","sidebarTitle":"format_regexp_*","href":"/reference/settings/formats/format-regexp"},{"title":"format_schema_* format settings","sidebarTitle":"format_schema_*","href":"/reference/settings/formats/format-schema"},{"title":"format_template_* format settings","sidebarTitle":"format_template_*","href":"/reference/settings/formats/format-template"},{"title":"input_format_* format settings","sidebarTitle":"input_format_*","href":"/reference/settings/formats/input-format"},{"title":"output_format_* format settings","sidebarTitle":"output_format_*","href":"/reference/settings/formats/output-format"},{"title":"schema_inference_* format settings","sidebarTitle":"schema_inference_*","href":"/reference/settings/formats/schema-inference"},{"title":"show_create_* format settings","sidebarTitle":"show_create_*","href":"/reference/settings/formats/show-create"},{"title":"type_json_* format settings","sidebarTitle":"type_json_*","href":"/reference/settings/formats/type-json"},{"title":"Other format settings","sidebarTitle":"Other","href":"/reference/settings/formats/other"}]},{"sidebarTitle":"Beta and experimental features","title":"Beta and experimental features","href":"/reference/settings/beta-and-experimental-features"}]},{"group":"System Tables","expanded":false,"pages":[{"sidebarTitle":"Overview","title":"System Tables Overview","href":"/reference/system-tables/overview"},{"title":"system.aggregate_function_combinators","href":"/reference/system-tables/aggregate_function_combinators"},{"title":"system.aggregated_zookeeper_log","href":"/reference/system-tables/aggregated_zookeeper_log"},{"title":"system.asynchronous_insert_log","href":"/reference/system-tables/asynchronous_insert_log"},{"title":"system.asynchronous_inserts","href":"/reference/system-tables/asynchronous_inserts"},{"title":"system.asynchronous_loader","href":"/reference/system-tables/asynchronous_loader"},{"title":"system.asynchronous_metric_log","href":"/reference/system-tables/asynchronous_metric_log"},{"title":"system.asynchronous_metrics","href":"/reference/system-tables/asynchronous_metrics"},{"title":"system.azure_queue_log","href":"/reference/system-tables/azure_queue_log"},{"sidebarTitle":"system.azure_queue_metadata","title":"system.azure_queue_metadata","href":"/reference/system-tables/azure_queue_metadata"},{"title":"system.azure_queue_metadata_cache","href":"/reference/system-tables/azure_queue_metadata_cache"},{"title":"system.azure_queue_settings","href":"/reference/system-tables/azure_queue_settings"},{"title":"system.backup_log","href":"/reference/system-tables/backup_log"},{"title":"system.backups","href":"/reference/system-tables/backups"},{"title":"system.background_schedule_pool","href":"/reference/system-tables/background_schedule_pool"},{"title":"system.background_schedule_pool_log","href":"/reference/system-tables/background_schedule_pool_log"},{"title":"system.blob_storage_log","href":"/reference/system-tables/blob_storage_log"},{"title":"system.build_options","href":"/reference/system-tables/build_options"},{"title":"system.certificates","href":"/reference/system-tables/certificates"},{"title":"system.clusters","href":"/reference/system-tables/clusters"},{"title":"system.codecs","href":"/reference/system-tables/codecs"},{"title":"system.collations","href":"/reference/system-tables/collations"},{"title":"system.columns","href":"/reference/system-tables/columns"},{"sidebarTitle":"system.columns_cache","title":"system.columns_cache","href":"/reference/system-tables/columns_cache"},{"title":"system.completions","href":"/reference/system-tables/completions"},{"sidebarTitle":"system.constraints","title":"system.constraints","href":"/reference/system-tables/constraints"},{"title":"system.contributors","href":"/reference/system-tables/contributors"},{"sidebarTitle":"system.connections","title":"system.connections","href":"/reference/system-tables/connections"},{"title":"system.crash_log","href":"/reference/system-tables/crash_log"},{"title":"system.current_roles","href":"/reference/system-tables/current_roles"},{"title":"system.dashboards","href":"/reference/system-tables/dashboards"},{"title":"system.data_skipping_index_types","href":"/reference/system-tables/data_skipping_index_types"},{"title":"system.data_skipping_indices","href":"/reference/system-tables/data_skipping_indices"},{"title":"system.data_type_families","href":"/reference/system-tables/data_type_families"},{"title":"system.database_engines","href":"/reference/system-tables/database_engines"},{"title":"system.database_replicas","href":"/reference/system-tables/database_replicas"},{"title":"system.databases","href":"/reference/system-tables/databases"},{"title":"system.dead_letter_queue","href":"/reference/system-tables/dead_letter_queue"},{"sidebarTitle":"system.delta_lake_metadata_log","title":"system.delta_lake_metadata_log","href":"/reference/system-tables/delta_lake_metadata_log"},{"title":"system.delta_lake_metadata_log","href":"/reference/system-tables/delta_metadata_log"},{"title":"system.detached_parts","href":"/reference/system-tables/detached_parts"},{"title":"system.detached_tables","href":"/reference/system-tables/detached_tables"},{"title":"system.dictionaries","href":"/reference/system-tables/dictionaries"},{"title":"system.dictionary_layouts","href":"/reference/system-tables/dictionary_layouts"},{"title":"system.dictionary_sources","href":"/reference/system-tables/dictionary_sources"},{"title":"system.dimensional_metrics","href":"/reference/system-tables/dimensional_metrics"},{"title":"system.disks","href":"/reference/system-tables/disks"},{"title":"system.disk_types","href":"/reference/system-tables/disk_types"},{"title":"system.distributed_ddl_queue","href":"/reference/system-tables/distributed_ddl_queue"},{"title":"system.distribution_queue","href":"/reference/system-tables/distribution_queue"},{"title":"system.dns_cache","href":"/reference/system-tables/dns_cache"},{"title":"system.documentation","href":"/reference/system-tables/documentation"},{"title":"system.dropped_tables","href":"/reference/system-tables/dropped_tables"},{"title":"system.dropped_tables_parts","href":"/reference/system-tables/dropped_tables_parts"},{"title":"system.enabled_roles","href":"/reference/system-tables/enabled_roles"},{"title":"system.error_log","href":"/reference/system-tables/error_log"},{"title":"system.errors","href":"/reference/system-tables/errors"},{"title":"system.events","href":"/reference/system-tables/events"},{"title":"system.fail_points","href":"/reference/system-tables/fail_points"},{"title":"system.formats","href":"/reference/system-tables/formats"},{"title":"system.filesystem_cache_log","href":"/reference/system-tables/filesystem_cache_log"},{"title":"system.filesystem_cache_settings","href":"/reference/system-tables/filesystem_cache_settings"},{"title":"system.filesystem_cache","href":"/reference/system-tables/filesystem_cache"},{"title":"system.filesystem_read_prefetches_log","href":"/reference/system-tables/filesystem_read_prefetches_log"},{"title":"system.functions","href":"/reference/system-tables/functions"},{"title":"system.grants","href":"/reference/system-tables/grants"},{"title":"system.graphite_retentions","href":"/reference/system-tables/graphite_retentions"},{"sidebarTitle":"system.handlers","title":"system.handlers","href":"/reference/system-tables/handlers"},{"sidebarTitle":"histogram_metric_log","title":"system.histogram_metric_log","href":"/reference/system-tables/histogram_metric_log"},{"title":"system.histogram_metrics","href":"/reference/system-tables/histogram_metrics"},{"sidebarTitle":"hypothetical_indexes","title":"system.hypothetical_indexes","href":"/reference/system-tables/hypothetical_indexes"},{"sidebarTitle":"hypothetical_projections","title":"system.hypothetical_projections","href":"/reference/system-tables/hypothetical_projections"},{"title":"system.iceberg_files","href":"/reference/system-tables/iceberg_files"},{"title":"system.iceberg_history","href":"/reference/system-tables/iceberg_history"},{"title":"system.iceberg_metadata_log","href":"/reference/system-tables/iceberg_metadata_log"},{"sidebarTitle":"system.iceberg_metadata_log_entries","title":"system.iceberg_metadata_log_entries","href":"/reference/system-tables/iceberg_metadata_log_entries"},{"title":"INFORMATION_SCHEMA","href":"/reference/system-tables/information_schema"},{"title":"system.instrumentation","href":"/reference/system-tables/instrumentation"},{"sidebarTitle":"system.jemalloc_arena_bins","title":"system.jemalloc_arena_bins","href":"/reference/system-tables/jemalloc_arena_bins"},{"title":"system.jemalloc_bins","href":"/reference/system-tables/jemalloc_bins"},{"title":"system.jemalloc_profile_text","href":"/reference/system-tables/jemalloc_profile_text"},{"sidebarTitle":"system.jemalloc_sampled_allocations","title":"system.jemalloc_sampled_allocations","href":"/reference/system-tables/jemalloc_sampled_allocations"},{"title":"system.jemalloc_stats","href":"/reference/system-tables/jemalloc_stats"},{"title":"system.kafka_consumers","href":"/reference/system-tables/kafka_consumers"},{"title":"system.keeper_changelogs","href":"/reference/system-tables/keeper_changelogs"},{"title":"system.keeper_cluster","href":"/reference/system-tables/keeper_cluster"},{"title":"system.keeper_snapshots","href":"/reference/system-tables/keeper_snapshots"},{"sidebarTitle":"keeper_storage","title":"system.keeper_storage","href":"/reference/system-tables/keeper_storage"},{"title":"system.keywords","href":"/reference/system-tables/keywords"},{"title":"system.licenses","href":"/reference/system-tables/licenses"},{"title":"system.macros","href":"/reference/system-tables/macros"},{"title":"system.masking_policies","href":"/reference/system-tables/masking_policies"},{"title":"system.merge_tree_settings","href":"/reference/system-tables/merge_tree_settings"},{"title":"system.merges","href":"/reference/system-tables/merges"},{"title":"system.metric_log","href":"/reference/system-tables/metric_log"},{"title":"system.metrics","href":"/reference/system-tables/metrics"},{"sidebarTitle":"models","title":"system.models","href":"/reference/system-tables/models"},{"title":"system.moves","href":"/reference/system-tables/moves"},{"title":"system.mutations","href":"/reference/system-tables/mutations"},{"title":"system.named_collections","href":"/reference/system-tables/named_collections"},{"title":"system.numbers","href":"/reference/system-tables/numbers"},{"title":"system.numbers_mt","href":"/reference/system-tables/numbers_mt"},{"title":"system.one","href":"/reference/system-tables/one"},{"title":"system.opentelemetry_span_log","href":"/reference/system-tables/opentelemetry_span_log"},{"title":"system.part_log","href":"/reference/system-tables/part_log"},{"title":"system.part_moves_between_shards","href":"/reference/system-tables/part_moves_between_shards"},{"title":"system.parts","href":"/reference/system-tables/parts"},{"title":"system.parts_columns","href":"/reference/system-tables/parts_columns"},{"title":"system.predicate_statistics_log","href":"/reference/system-tables/predicate_statistics_log"},{"title":"system.primes","href":"/reference/system-tables/primes"},{"title":"system.privileges","href":"/reference/system-tables/privileges"},{"title":"system.processes","href":"/reference/system-tables/processes"},{"title":"system.processors_profile_log","href":"/reference/system-tables/processors_profile_log"},{"title":"system.projection_parts","href":"/reference/system-tables/projection_parts"},{"title":"system.projection_parts_columns","href":"/reference/system-tables/projection_parts_columns"},{"title":"system.projections","href":"/reference/system-tables/projections"},{"title":"system.query_cache","href":"/reference/system-tables/query_cache"},{"title":"system.query_condition_cache","href":"/reference/system-tables/query_condition_cache"},{"title":"system.query_log","href":"/reference/system-tables/query_log"},{"title":"system.query_metric_log","href":"/reference/system-tables/query_metric_log"},{"title":"system.query_thread_log","href":"/reference/system-tables/query_thread_log"},{"title":"system.query_views_log","href":"/reference/system-tables/query_views_log"},{"title":"system.quota_limits","href":"/reference/system-tables/quota_limits"},{"title":"system.quota_usage","href":"/reference/system-tables/quota_usage"},{"title":"system.quotas","href":"/reference/system-tables/quotas"},{"title":"system.quotas_usage","href":"/reference/system-tables/quotas_usage"},{"title":"system.remote_data_paths","href":"/reference/system-tables/remote_data_paths"},{"title":"system.replicas","href":"/reference/system-tables/replicas"},{"title":"system.replicated_fetches","href":"/reference/system-tables/replicated_fetches"},{"title":"system.replicated_merge_tree_settings","href":"/reference/system-tables/replicated_merge_tree_settings"},{"title":"system.replication_queue","href":"/reference/system-tables/replication_queue"},{"title":"system.resources","href":"/reference/system-tables/resources"},{"title":"system.rocksdb","href":"/reference/system-tables/rocksdb"},{"title":"system.role_grants","href":"/reference/system-tables/role_grants"},{"title":"system.roles","href":"/reference/system-tables/roles"},{"title":"system.row_policies","href":"/reference/system-tables/row_policies"},{"sidebarTitle":"system.s3_queue_metadata","title":"system.s3_queue_metadata","href":"/reference/system-tables/s3_queue_metadata"},{"title":"system.s3_queue_settings","href":"/reference/system-tables/s3_queue_settings"},{"title":"system.s3queue_log","href":"/reference/system-tables/s3queue_log"},{"title":"system.s3queue_metadata_cache","href":"/reference/system-tables/s3queue_metadata_cache"},{"title":"system.scheduler","href":"/reference/system-tables/scheduler"},{"title":"system.schema_inference_cache","href":"/reference/system-tables/schema_inference_cache"},{"title":"system.server_settings","href":"/reference/system-tables/server_settings"},{"title":"system.session_log","href":"/reference/system-tables/session_log"},{"sidebarTitle":"system.session_query_ids","title":"system.session_query_ids","href":"/reference/system-tables/session_query_ids"},{"title":"system.settings","href":"/reference/system-tables/settings"},{"title":"system.settings_changes","href":"/reference/system-tables/settings_changes"},{"title":"system.settings_profile_elements","href":"/reference/system-tables/settings_profile_elements"},{"title":"system.settings_profiles","href":"/reference/system-tables/settings_profiles"},{"title":"system.stack_trace","href":"/reference/system-tables/stack_trace"},{"sidebarTitle":"system.statements","title":"system.statements","href":"/reference/system-tables/statements"},{"sidebarTitle":"system.stemmers","title":"system.stemmers","href":"/reference/system-tables/stemmers"},{"title":"system.storage_policies","href":"/reference/system-tables/storage_policies"},{"title":"system.symbols","href":"/reference/system-tables/symbols"},{"title":"system.warnings","href":"/reference/system-tables/system_warnings"},{"title":"system.table_engines","href":"/reference/system-tables/table_engines"},{"title":"system.table_functions","href":"/reference/system-tables/table_functions"},{"title":"system.tables","href":"/reference/system-tables/tables"},{"title":"system.text_log","href":"/reference/system-tables/text_log"},{"title":"system.time_zones","href":"/reference/system-tables/time_zones"},{"title":"system.tokenizers","href":"/reference/system-tables/tokenizers"},{"title":"system.trace_log","href":"/reference/system-tables/trace_log"},{"title":"system.transactions","href":"/reference/system-tables/transactions"},{"title":"system.transactions_info_log","href":"/reference/system-tables/transactions_info_log"},{"title":"system.unicode","href":"/reference/system-tables/unicode"},{"title":"system.user_defined_functions","href":"/reference/system-tables/user_defined_functions"},{"title":"system.user_directories","href":"/reference/system-tables/user_directories"},{"title":"system.user_processes","href":"/reference/system-tables/user_processes"},{"sidebarTitle":"user_query_log","title":"system.user_query_log","href":"/reference/system-tables/user_query_log"},{"title":"system.users","href":"/reference/system-tables/users"},{"title":"system.view_refreshes","href":"/reference/system-tables/view_refreshes"},{"title":"system.warnings","href":"/reference/system-tables/warnings"},{"title":"system.workloads","href":"/reference/system-tables/workloads"},{"title":"system.zeros","href":"/reference/system-tables/zeros"},{"title":"system.zeros_mt","href":"/reference/system-tables/zeros_mt"},{"title":"system.zookeeper","href":"/reference/system-tables/zookeeper"},{"title":"system.zookeeper_info","href":"/reference/system-tables/zookeeper_info"},{"title":"system.zookeeper_connection","href":"/reference/system-tables/zookeeper_connection"},{"title":"system.zookeeper_connection_log","href":"/reference/system-tables/zookeeper_connection_log"},{"title":"system.zookeeper_log","href":"/reference/system-tables/zookeeper_log"},{"title":"system.zookeeper_watches","href":"/reference/system-tables/zookeeper_watches"}]},{"group":"Data Lakes","pages":[{"sidebarTitle":"Overview","title":"Data Lakes","href":"/reference/datalakes"}]}]}]},{"tab":"Solutions","menu":[{"item":"ClickHouse Cloud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/section-header.svg","href":"#"},{"item":"ClickHouse Cloud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-clickhouse-cloud.svg","pages":[{"title":"ClickHouse Cloud","href":"/products/cloud/getting-started/cloud-get-started"}]},{"item":"ClickHouse Managed Postgres","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-postgres.svg","pages":[{"title":"ClickHouse Managed Postgres","href":"/products/managed-postgres/overview"}]},{"item":"Langfuse","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/logo-langfuse.svg","href":"https://langfuse.com/docs"},{"item":"Open source","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/section-header.svg","href":"#"},{"item":"ClickStack","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-clickstack.svg","pages":[{"title":"ClickStack","sidebarTitle":"Home","mode":"wide","href":"/clickstack"},{"group":"Get started","expanded":true,"pages":[{"title":"ClickStack - the ClickHouse observability stack","sidebarTitle":"Overview","href":"/clickstack/overview"},{"group":"Quickstarts","expanded":true,"pages":[{"title":"Getting started with ClickStack","sidebarTitle":"Getting started","href":"/clickstack/getting-started/index"},{"title":"Getting started with Managed ClickStack","sidebarTitle":"Managed","href":"/clickstack/getting-started/managed"},{"title":"Getting started with ClickStack Open Source","sidebarTitle":"Open source","href":"/clickstack/getting-started/oss"}]},{"group":"Sample datasets","pages":[{"title":"Sample data and demos","href":"/clickstack/example-datasets/index"},{"title":"Sample logs, traces and metrics","href":"/clickstack/example-datasets/sample-data"},{"title":"Monitoring Kubernetes","href":"/clickstack/example-datasets/kubernetes"},{"title":"Local logs \u0026 metrics","href":"/clickstack/example-datasets/local-data"},{"title":"Remote demo dataset","href":"/clickstack/example-datasets/remote-demo-data"},{"title":"Session replay demo","href":"/clickstack/example-datasets/session-replay"},{"title":"Chrome extension","href":"/clickstack/example-datasets/chrome-extension"},{"title":"Generate synthetic OpenTelemetry data with otelgen","sidebarTitle":"Synthetic data with otelgen","href":"/clickstack/example-datasets/otelgen"},{"title":"Generate synthetic OpenTelemetry data with telemetrygen","sidebarTitle":"Synthetic data with telemetrygen","href":"/clickstack/example-datasets/telemetrygen"},{"title":"HackerNews Analyzer demo","sidebarTitle":"HackerNews Analyzer demo","href":"/clickstack/example-datasets/instrument-application"}]},{"title":"Architecture","href":"/clickstack/architecture"},{"title":"ClickStack FAQ","sidebarTitle":"FAQ","href":"/clickstack/faq"}]},{"group":"Features","pages":[{"group":"Deployment","pages":[{"title":"Deployment options","href":"/clickstack/deployment/overview"},{"group":"Open Source","pages":[{"title":"Open source deployment options","href":"/clickstack/deployment/oss"},{"title":"All in one","href":"/clickstack/deployment/all-in-one"},{"group":"Helm","pages":[{"group":"v2.x","pages":[{"title":"Helm","href":"/clickstack/deployment/helm"},{"title":"Helm configuration","href":"/clickstack/deployment/helm-configuration"},{"title":"Helm deployment options","href":"/clickstack/deployment/helm-deployment-options"},{"title":"Helm cloud deployments","href":"/clickstack/deployment/helm-cloud"},{"title":"Helm additional manifests","href":"/clickstack/deployment/helm-additional-manifests"},{"title":"Helm upgrade guide","href":"/clickstack/deployment/helm-upgrade"}]},{"group":"v1.x (deprecated)","pages":[{"title":"Helm (v1.x)","href":"/clickstack/deployment/helm-v1"},{"title":"Helm configuration (v1.x)","href":"/clickstack/deployment/helm-configuration-v1"},{"title":"Helm deployment options (v1.x)","href":"/clickstack/deployment/helm-deployment-options-v1"},{"title":"Helm cloud deployments (v1.x)","href":"/clickstack/deployment/helm-cloud-v1"}]}]},{"title":"Docker Compose","href":"/clickstack/deployment/docker-compose"},{"title":"HyperDX only","href":"/clickstack/deployment/hyperdx-only"},{"title":"Local mode only","href":"/clickstack/deployment/local-mode-only"},{"title":"Embedded in ClickHouse","href":"/clickstack/deployment/clickhouse-embedded"}]},{"title":"Managed","href":"/clickstack/deployment/managed"}]},{"title":"Search with ClickStack","sidebarTitle":"Search","href":"/clickstack/features/search"},{"group":"Dashboards","pages":[{"title":"Visualizations and dashboards with ClickStack","sidebarTitle":"Overview","href":"/clickstack/features/dashboards/overview"},{"title":"Dashboard templates","sidebarTitle":"Dashboard templates","href":"/clickstack/features/dashboards/dashboard-templates"},{"title":"SQL-based visualizations","sidebarTitle":"SQL-based visualizations","href":"/clickstack/features/dashboards/sql-visualizations"},{"title":"Table row-click drilldowns","sidebarTitle":"Row-click drilldowns","href":"/clickstack/features/dashboards/row-click-drilldowns"},{"title":"Release markers on dashboard charts","sidebarTitle":"Release markers","href":"/clickstack/features/dashboards/release-markers"}]},{"title":"AI Notebooks with ClickStack","sidebarTitle":"AI Notebooks","href":"/clickstack/notebooks"},{"title":"Text-to-Chart","sidebarTitle":"Text-to-Chart","href":"/clickstack/text-to-chart"},{"title":"Event patterns with ClickStack","sidebarTitle":"Event patterns","href":"/clickstack/features/event-patterns"},{"title":"Event deltas with ClickStack","sidebarTitle":"Event deltas","href":"/clickstack/features/event-deltas"},{"title":"Alerts with ClickStack","sidebarTitle":"Alerts","href":"/clickstack/features/alerts"},{"title":"Anomaly detection alerts with ClickStack","sidebarTitle":"Anomaly detection","href":"/clickstack/features/anomaly-detection"},{"title":"Service maps","sidebarTitle":"Service maps","href":"/clickstack/service-maps"},{"title":"Session replay","sidebarTitle":"Session replay","href":"/clickstack/features/session-replay"},{"title":"ClickStack MCP server","sidebarTitle":"MCP Server","href":"/clickstack/mcp"},{"title":"Deep links","sidebarTitle":"Deep links","href":"/clickstack/url-parameters"},{"group":"Demo days","pages":[{"title":"ClickStack demo days","href":"/clickstack/demo-days/index"},{"group":"2026","pages":[{"group":"October","pages":[{"title":"Demo days - 2026-10-22","sidebarTitle":"2026-10-22","href":"/clickstack/demo-days/2026/2026-10-22"},{"title":"Demo days - 2026-10-15","sidebarTitle":"2026-10-15","href":"/clickstack/demo-days/2026/2026-10-15"},{"title":"Demo days - 2026-10-08","sidebarTitle":"2026-10-08","href":"/clickstack/demo-days/2026/2026-10-08"},{"title":"Demo days - 2026-10-01","sidebarTitle":"2026-10-01","href":"/clickstack/demo-days/2026/2026-10-01"}]},{"group":"September","pages":[{"title":"Demo days - 2026-09-24","sidebarTitle":"2026-09-24","href":"/clickstack/demo-days/2026/2026-09-24"},{"title":"Demo days - 2026-09-17","sidebarTitle":"2026-09-17","href":"/clickstack/demo-days/2026/2026-09-17"},{"title":"Demo days - 2026-09-10","sidebarTitle":"2026-09-10","href":"/clickstack/demo-days/2026/2026-09-10"},{"title":"Demo days - 2026-09-04","sidebarTitle":"2026-09-04","href":"/clickstack/demo-days/2026/2026-09-04"}]},{"group":"August","pages":[{"title":"Demo days - 2026-08-28","sidebarTitle":"2026-08-28","href":"/clickstack/demo-days/2026/2026-08-28"},{"title":"Demo days - 2026-08-21","sidebarTitle":"2026-08-21","href":"/clickstack/demo-days/2026/2026-08-21"},{"title":"Demo days - 2026-08-15","sidebarTitle":"2026-08-15","href":"/clickstack/demo-days/2026/2026-08-15"},{"title":"Demo days - 2026-08-07","sidebarTitle":"2026-08-07","href":"/clickstack/demo-days/2026/2026-08-07"}]},{"group":"July","pages":[{"title":"Demo days - 2026-07-31","sidebarTitle":"2026-07-31","href":"/clickstack/demo-days/2026/2026-07-31"},{"title":"Demo days - 2026-07-24","sidebarTitle":"2026-07-24","href":"/clickstack/demo-days/2026/2026-07-24"},{"title":"Demo days - 2026-07-17","sidebarTitle":"2026-07-17","href":"/clickstack/demo-days/2026/2026-07-17"},{"title":"Demo days - 2026-07-10","sidebarTitle":"2026-07-10","href":"/clickstack/demo-days/2026/2026-07-10"},{"title":"Demo days - 2026-07-02","sidebarTitle":"2026-07-02","href":"/clickstack/demo-days/2026/2026-07-02"}]},{"group":"June","pages":[{"title":"Demo days - 2026-06-26","sidebarTitle":"2026-06-26","href":"/clickstack/demo-days/2026/2026-06-26"},{"title":"Demo days - 2026-06-18","sidebarTitle":"2026-06-18","href":"/clickstack/demo-days/2026/2026-06-18"},{"title":"Demo days - 2026-06-12","sidebarTitle":"2026-06-12","href":"/clickstack/demo-days/2026/2026-06-12"},{"title":"Demo days - 2026-06-05","sidebarTitle":"2026-06-05","href":"/clickstack/demo-days/2026/2026-06-05"}]},{"group":"May","pages":[{"title":"Demo days - 2026-05-29","sidebarTitle":"2026-05-29","href":"/clickstack/demo-days/2026/2026-05-29"},{"title":"Demo days - 2026-05-22","sidebarTitle":"2026-05-22","href":"/clickstack/demo-days/2026/2026-05-22"},{"title":"Demo days - 2026-05-15","sidebarTitle":"2026-05-15","href":"/clickstack/demo-days/2026/2026-05-15"},{"title":"Demo days - 2026-05-08","sidebarTitle":"2026-05-08","href":"/clickstack/demo-days/2026/2026-05-08"}]},{"group":"April","pages":[{"title":"Demo days - 2026-04-17","sidebarTitle":"2026-04-17","href":"/clickstack/demo-days/2026/2026-04-17"},{"title":"Demo days - 2026-04-10","sidebarTitle":"2026-04-10","href":"/clickstack/demo-days/2026/2026-04-10"},{"title":"Demo days - 2026-04-03","sidebarTitle":"2026-04-03","href":"/clickstack/demo-days/2026/2026-04-03"}]}]}]}]},{"group":"Managing ClickStack","expanded":true,"pages":[{"title":"Managing ClickStack","sidebarTitle":"Overview","href":"/clickstack/managing/overview"},{"title":"ClickStack - administration","sidebarTitle":"Adminstration","href":"/clickstack/managing/admin"},{"title":"Configuration options","href":"/clickstack/managing/config"},{"title":"Estimating resources","sidebarTitle":"Estimating resources","href":"/clickstack/managing/estimating-resources"},{"title":"Isolating read and write workloads","sidebarTitle":"Isolating read and write","href":"/clickstack/managing/isolating-read-write"},{"title":"ClickStack - materialized views","sidebarTitle":"Materialized views","href":"/clickstack/managing/materialized-views"},{"title":"ClickStack - performance tuning","sidebarTitle":"Performance tuning","href":"/clickstack/managing/performance-tuning"},{"title":"Going to production","sidebarTitle":"Production","href":"/clickstack/managing/production"},{"title":"Role-based access control (RBAC)","sidebarTitle":"Role-based access control","href":"/clickstack/managing/rbac"},{"title":"Managing TTL","sidebarTitle":"Managing TTL","href":"/clickstack/managing/ttl"}]},{"group":"Guides","pages":[{"group":"Ingesting data","expanded":true,"pages":[{"title":"Ingesting data into ClickStack","sidebarTitle":"Overview","href":"/clickstack/ingesting-data/overview"},{"title":"Ingesting with OpenTelemetry","href":"/clickstack/ingesting-data/opentelemetry"},{"title":"Ingesting with Vector","href":"/clickstack/ingesting-data/vector"},{"sidebarTitle":"OpenTelemetry collector","title":"ClickStack OpenTelemetry collector","href":"/clickstack/ingesting-data/collector"},{"sidebarTitle":"Tables and schemas","title":"Tables and schemas used by ClickStack","href":"/clickstack/ingesting-data/schemas"},{"sidebarTitle":"Map vs JSON type","title":"Map vs JSON type for ClickStack","href":"/clickstack/ingesting-data/schema/map-vs-json"},{"title":"Trace sampling","sidebarTitle":"Trace sampling","href":"/clickstack/ingesting-data/trace-sampling"},{"group":"Integrations","pages":[{"title":"Integration guides","href":"/clickstack/integration-examples/index"},{"title":"Monitoring Nginx logs with ClickStack","sidebarTitle":"Nginx logs","href":"/clickstack/integration-examples/nginx-logs"},{"title":"Monitoring Nginx traces with ClickStack","sidebarTitle":"Nginx traces","href":"/clickstack/integration-examples/nginx-traces"},{"title":"Monitoring Redis logs with ClickStack","sidebarTitle":"Redis logs","href":"/clickstack/integration-examples/redis-logs"},{"title":"Monitoring Redis metrics with ClickStack","sidebarTitle":"Redis metrics","href":"/clickstack/integration-examples/redis-metrics"},{"title":"Monitoring AWS CloudWatch logs with ClickStack","sidebarTitle":"AWS CloudWatch logs","href":"/clickstack/integration-examples/cloudwatch"},{"title":"Monitoring AWS Lambda logs with ClickStack using Rotel","sidebarTitle":"AWS Lambda logs","href":"/clickstack/integration-examples/aws-lambda"},{"group":"Host logs","pages":[{"title":"Monitoring host logs with ClickStack","sidebarTitle":"Generic host logs","href":"/clickstack/integration-examples/host-logs"},{"title":"Monitoring EC2 host logs with ClickStack","sidebarTitle":"EC2 host logs","href":"/clickstack/integration-examples/host-logs/ec2"}]},{"title":"Monitoring JVM metrics with ClickStack","sidebarTitle":"JVM metrics","href":"/clickstack/integration-examples/jvm-metrics"},{"title":"Monitoring Kafka metrics with ClickStack","sidebarTitle":"Kafka metrics","href":"/clickstack/integration-examples/kafka-metrics"},{"title":"Kubernetes","href":"/clickstack/integration-examples/kubernetes"},{"title":"Monitoring MySQL logs with ClickStack","sidebarTitle":"MySQL logs","href":"/clickstack/integration-examples/mysql"},{"title":"Monitoring Node.js traces with ClickStack","sidebarTitle":"Node.js traces","href":"/clickstack/integration-examples/nodejs-traces"},{"title":"Monitoring PostgreSQL logs with ClickStack","sidebarTitle":"PostgreSQL logs","href":"/clickstack/integration-examples/postgres-logs"},{"title":"Monitoring PostgreSQL metrics with ClickStack","sidebarTitle":"PostgreSQL metrics","href":"/clickstack/integration-examples/postgres-metrics"},{"title":"Monitoring Systemd logs with ClickStack","sidebarTitle":"Systemd/Journald logs","href":"/clickstack/integration-examples/systemd"},{"title":"Monitoring Temporal Cloud metrics with ClickStack","sidebarTitle":"Temporal Cloud metrics","href":"/clickstack/integration-examples/temporal"},{"title":"Monitoring Cloudflare logs with ClickStack","sidebarTitle":"Cloudflare logs","href":"/clickstack/integration-examples/cloudflare"},{"title":"Monitoring Kafka logs with ClickStack","sidebarTitle":"Kafka logs","href":"/clickstack/integration-examples/kafka-logs"},{"title":"Monitoring MongoDB logs with ClickStack","sidebarTitle":"MongoDB logs","href":"/clickstack/integration-examples/mongodb-logs"}]},{"group":"Language SDKs","pages":[{"title":"Language SDKs","sidebarTitle":"Overview","href":"/clickstack/ingesting-data/sdks/index"},{"title":"Browser JS","href":"/clickstack/ingesting-data/sdks/browser"},{"title":"Node.js","href":"/clickstack/ingesting-data/sdks/nodejs"},{"title":"Python","href":"/clickstack/ingesting-data/sdks/python"},{"title":"Golang","href":"/clickstack/ingesting-data/sdks/golang"},{"title":"Java","href":"/clickstack/ingesting-data/sdks/java"},{"title":"Ruby on Rails","href":"/clickstack/ingesting-data/sdks/ruby"},{"title":"Elixir","href":"/clickstack/ingesting-data/sdks/elixir"},{"title":"Deno","href":"/clickstack/ingesting-data/sdks/deno"},{"title":"NestJS","href":"/clickstack/ingesting-data/sdks/nestjs"},{"title":"Next.js","href":"/clickstack/ingesting-data/sdks/nextjs"},{"title":"React Native","href":"/clickstack/ingesting-data/sdks/react-native"},{"title":"AWS Lambda","href":"/clickstack/ingesting-data/sdks/aws-lambda"}]}]},{"group":"Migration guides","expanded":true,"pages":[{"title":"Migrating to ClickStack from other observability solutions","sidebarTitle":"Overview","href":"/clickstack/migration/index"},{"group":"Migrating from Elastic","pages":[{"title":"Migrating to ClickStack from Elastic","sidebarTitle":"Overview","href":"/clickstack/migration/elastic/index"},{"title":"Migrating to ClickStack from Elastic","sidebarTitle":"Introduction","href":"/clickstack/migration/elastic/intro"},{"title":"Equivalent concepts in ClickStack and Elastic","sidebarTitle":"Equivalent concepts","href":"/clickstack/migration/elastic/concepts"},{"title":"Mapping types","sidebarTitle":"Types","href":"/clickstack/migration/elastic/types"},{"title":"Searching in ClickStack and Elastic","sidebarTitle":"Search","href":"/clickstack/migration/elastic/search"},{"title":"Migrating data to ClickStack from Elastic","sidebarTitle":"Migrating data","href":"/clickstack/migration/elastic/migrating-data"},{"title":"Migrating agents from Elastic","sidebarTitle":"Migrating agents","href":"/clickstack/migration/elastic/migrating-agents"},{"title":"Migrating SDKs from Elastic","sidebarTitle":"Migrating SDKs","href":"/clickstack/migration/elastic/migrating-sdks"}]},{"title":"Migrating to ClickStack from Datadog","sidebarTitle":"Migrating from Datadog","href":"/clickstack/migration/datadog/index"}]}]},{"group":"Integration partners","expanded":true,"pages":[{"title":"Integration partners","sidebarTitle":"Overview","href":"/clickstack/integration-partners/index"},{"title":"Sending OpenTelemetry to ClickStack with Bindplane","sidebarTitle":"Bindplane","href":"/clickstack/integration-partners/bindplane"},{"title":"Correlating bitdrift mobile sessions with ClickStack traces","sidebarTitle":"bitdrift","href":"/clickstack/integration-partners/bitdrift"},{"title":"Sending OpenTelemetry to ClickStack with Odigos","sidebarTitle":"Odigos","href":"/clickstack/integration-partners/odigos"},{"title":"Sending OpenTelemetry to ClickStack with Telflo","sidebarTitle":"Telflo","href":"/clickstack/integration-partners/telflo"}]},{"group":"API reference","root":{"title":"API reference","href":"/clickstack/api-reference"},"expanded":true,"pages":[{"group":"Alerts","pages":[{"title":"Get Alert","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/alerts/{id}","href":"/clickstack/api-reference/alerts/get-alert"},{"title":"Update Alert","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json put /api/v2/alerts/{id}","href":"/clickstack/api-reference/alerts/update-alert"},{"title":"Delete Alert","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/alerts/{id}","href":"/clickstack/api-reference/alerts/delete-alert"},{"title":"List Alerts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/alerts","href":"/clickstack/api-reference/alerts/list-alerts"},{"title":"Create Alert","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/alerts","href":"/clickstack/api-reference/alerts/create-alert"}]},{"group":"Charts","pages":[{"title":"Query Chart Series Data","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/charts/series","href":"/clickstack/api-reference/charts/query-chart-series-data"}]},{"group":"Connections","pages":[{"title":"List Connections","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/connections","href":"/clickstack/api-reference/connections/list-connections"},{"title":"Create Connection","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/connections","href":"/clickstack/api-reference/connections/create-connection"},{"title":"Get Connection","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/connections/{id}","href":"/clickstack/api-reference/connections/get-connection"},{"title":"Update Connection","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json put /api/v2/connections/{id}","href":"/clickstack/api-reference/connections/update-connection"},{"title":"Delete Connection","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/connections/{id}","href":"/clickstack/api-reference/connections/delete-connection"}]},{"group":"Dashboards","pages":[{"title":"List Dashboards","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/dashboards","href":"/clickstack/api-reference/dashboards/list-dashboards"},{"title":"Create Dashboard","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/dashboards","href":"/clickstack/api-reference/dashboards/create-dashboard"},{"title":"Get Dashboard","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/dashboards/{id}","href":"/clickstack/api-reference/dashboards/get-dashboard"},{"title":"Update Dashboard","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json put /api/v2/dashboards/{id}","href":"/clickstack/api-reference/dashboards/update-dashboard"},{"title":"Delete Dashboard","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/dashboards/{id}","href":"/clickstack/api-reference/dashboards/delete-dashboard"},{"title":"Validate Dashboard","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/dashboards/validate","href":"/clickstack/api-reference/dashboards/validate-dashboard"}]},{"group":"Saved Searches","pages":[{"title":"List Saved Searches","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/saved-searches","href":"/clickstack/api-reference/saved-searches/list-saved-searches"},{"title":"Create Saved Search","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/saved-searches","href":"/clickstack/api-reference/saved-searches/create-saved-search"},{"title":"Get Saved Search","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/saved-searches/{id}","href":"/clickstack/api-reference/saved-searches/get-saved-search"},{"title":"Update Saved Search","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json put /api/v2/saved-searches/{id}","href":"/clickstack/api-reference/saved-searches/update-saved-search"},{"title":"Delete Saved Search","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/saved-searches/{id}","href":"/clickstack/api-reference/saved-searches/delete-saved-search"}]},{"group":"Search","pages":[{"title":"Search Raw Logs and Traces","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/search","href":"/clickstack/api-reference/search/search-raw-logs-and-traces"}]},{"group":"Sources","pages":[{"title":"List Sources","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/sources","href":"/clickstack/api-reference/sources/list-sources"},{"title":"Create Source","description":"Creates a new source.\n\nThe request body is a source object without the `id` field. If an\n`id` is sent anyway it is silently ignored (stripped before\nvalidation — the request is never rejected because of it).\nGranularity fields\n(`materializedViews[].minGranularity` and\n`metadataMaterializedViews.granularity`) accept the same short format\nthe API returns (e.g. `5m`, `15s`, `1h`, `1d`).\n","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/sources","href":"/clickstack/api-reference/sources/create-source"},{"title":"Get Source","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/sources/{id}","href":"/clickstack/api-reference/sources/get-source"},{"title":"Update Source","description":"Updates an existing source. The full source object must be provided;\nthis is a replace, not a patch.\n\nThe request body is a source object without the `id` field. If an\n`id` is sent anyway it is silently ignored (stripped before\nvalidation — never a 400); the path parameter alone identifies the\nsource. Granularity fields (`materializedViews[].minGranularity` and\n`metadataMaterializedViews.granularity`) accept the same short format\nthe API returns (e.g. `5m`, `15s`, `1h`, `1d`).\n","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json put /api/v2/sources/{id}","href":"/clickstack/api-reference/sources/update-source"},{"title":"Delete Source","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/sources/{id}","href":"/clickstack/api-reference/sources/delete-source"}]},{"group":"Team","pages":[{"title":"Get Team","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/team","href":"/clickstack/api-reference/team/get-team"},{"title":"List Team Members","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/team/members","href":"/clickstack/api-reference/team/list-team-members"},{"title":"Invite Team Member","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/team/invitation","href":"/clickstack/api-reference/team/invite-team-member"},{"title":"List Team Invitations","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/team/invitations","href":"/clickstack/api-reference/team/list-team-invitations"},{"title":"Delete Team Invitation","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/team/invitation/{id}","href":"/clickstack/api-reference/team/delete-team-invitation"},{"title":"Remove Team Member","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/team/member/{id}","href":"/clickstack/api-reference/team/remove-team-member"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/webhooks","href":"/clickstack/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/webhooks","href":"/clickstack/api-reference/webhooks/create-webhook"},{"title":"Validate Webhook","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json post /api/v2/webhooks/validate","href":"/clickstack/api-reference/webhooks/validate-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json put /api/v2/webhooks/{id}","href":"/clickstack/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json delete /api/v2/webhooks/{id}","href":"/clickstack/api-reference/webhooks/delete-webhook"}]}]}]},{"item":"Agentic Data Stack","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-agentic-data-stack.svg","pages":[{"title":"Agentic Data Stack","href":"/products/agentic-data-stack/overview"}]},{"item":"chDB","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-chdb.svg","pages":[{"title":"chDB","href":"/chdb"}]},{"item":"Kubernetes Operator","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-kubernetes-operator.svg","pages":[{"title":"Kubernetes Operator","href":"/products/kubernetes-operator/overview"}]}]},{"tab":"Integrations","menu":[{"item":"Ecosystem","pages":[{"title":"Ecosystem","href":"/integrations/home"}]},{"item":"ClickPipes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-clickpipes.svg","pages":[{"title":"ClickPipes","href":"/integrations/clickpipes/home"}]},{"item":"Language clients","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-language-clients.svg","pages":[{"title":"Language clients","href":"/integrations/language-clients"}]},{"item":"Connectors","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-connectors.svg","pages":[{"title":"Connectors","href":"/integrations/connectors/data-sources"}]}],"pages":[{"title":"Integrations","href":"/integrations/home"}]},{"tab":"Resources","menu":[{"item":"Support center","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-support-center.svg","pages":[{"title":"Support center","href":"/resources/support-center/home"}]},{"item":"Development \u0026 contributing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-contribute.svg","pages":[{"title":"Development \u0026 contributing","href":"/resources/develop-contribute/introduction/developer-instruction"}]},{"item":"Changelogs","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-changelogs.svg","dropdowns":[{"dropdown":"Cloud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-clickhouse-cloud.svg","pages":[{"title":"Cloud","href":"/resources/changelogs/cloud"}]},{"dropdown":"Open source","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-server.svg","pages":[{"title":"Open source","href":"/resources/changelogs/oss/2026"}]}]},{"item":"About","icon":"https://mintlify.s3.us-west-1.amazonaws.com/private-7c7dfe99/images/icons/icon-about.svg","pages":[{"title":"About","href":"/resources/about"}]}],"pages":[{"title":"Resources","href":"/resources/support-center/home"}]}]},{"language":"ar","pages":[{"title":"ar","href":"/ar/clickstack/api-reference/sources/get-source"}]},{"language":"es","pages":[{"title":"es","href":"/es/clickstack/api-reference/sources/get-source"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/clickstack/api-reference/sources/get-source"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/clickstack/api-reference/sources/get-source"}]},{"language":"ko","pages":[{"title":"ko","href":"/ko/clickstack/api-reference/sources/get-source"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-br/clickstack/api-reference/sources/get-source"}]},{"language":"ru","pages":[{"title":"ru","href":"/ru/clickstack/api-reference/sources/get-source"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/clickstack/api-reference/sources/get-source"}]}]},"basePath":"","title":"Get Source - ClickHouse Documentation","buildId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","deploymentId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-vlKR2tYY.js","utils-DBDPZSWe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CxHK4zz2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-27b98BOz.js","snippetPresets-DNnui32z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BOWGOUSK.js","ApiExamples-cDVS2zyo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BEE-OyDQ.js","shallow-fqEMZOYR.js","getApiPlaygroundDisplay-BPut1_OB.js","CodeSnippet-h9vp8UTG.js","CodeSnippets-DoMjCW5Q.js","getPastedJson-C4r-hmQ_.js","icon-CCDahfhO.js","MethodPill-Dpq0JSrS.js","DuplicateIcon-BGPwFt-j.js","createIcon-DBULrQp7.js","DynamicMarkdown-B74atANy.js","SectionHeading-DZCpbSmT.js","axios-vUo_bRtp.js","Markdown-BwkgxkAH.js","clsx-CEIlvfOI.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-f6OgbvLC.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DvlTOml0.js"]}