Files
datastore/docs/docs.json
T

3894 lines
216 KiB
JSON

{
"$schema": "https://mintlify.com/docs.json",
"appearance": {
"default": "dark"
},
"background": {
"color": {
"dark": "#151515",
"light": "#FFFFFF"
}
},
"banner": {
"content": "ClickHouse launches Claude-powered Agents and House Mates partner program at Open House 2026 [Read more →](https://clickhouse.com/blog/clickhouse-tops-250m-arr-and-4000-customers)",
"dismissible": true
},
"colors": {
"dark": "#fdff75",
"light": "#333431",
"primary": "#1c1c1c"
},
"contextual": {
"display": "toc",
"options": [
"copy",
"view",
{
"description": "Setup instructions for docs MCP server",
"href": "https://clickhouse.com/docs#claude-code",
"icon": "/images/icons/icon-mcp.svg",
"title": "Set up docs MCP server"
}
]
},
"favicon": "/_site/favicon.svg",
"fonts": {
"family": "Inter"
},
"interaction": {
"drilldown": false
},
"logo": {
"dark": "/_site/logo/dark.svg",
"light": "/_site/logo/light.svg"
},
"metadata": {
"timestamp": true
},
"name": "ClickHouse Documentation",
"navbar": {},
"navigation": {
"languages": [
{
"language": "en",
"tabs": [
{
"pages": [
"index"
],
"tab": "Home"
},
{
"menu": [
{
"icon": "/images/icons/icon-get-started.svg",
"item": "Get started",
"pages": [
{
"group": "Get started",
"icon": "/images/menu-icon-lightning.svg",
"pages": [
{
"expandable": true,
"expanded": true,
"group": "Introduction",
"pages": [
"get-started/about/intro",
"get-started/about/why-clickhouse-is-so-fast",
"get-started/about/distinctive-features"
]
},
{
"expanded": true,
"group": "Use cases",
"pages": [
"get-started/use-cases/real-time-analytics",
"get-started/use-cases/observability",
"get-started/use-cases/data-warehousing",
"get-started/use-cases/agentic-analytics"
],
"root": "get-started/use-cases/overview"
},
"get-started/about/deployment-modes",
"get-started/quickstarts/home"
],
"root": "get-started/index"
},
{
"expanded": true,
"group": "Setup",
"icon": "/images/menu-icon-gear.svg",
"pages": [
"get-started/setup/cloud",
{
"expanded": true,
"group": "Self-managed",
"pages": [
{
"group": "Local development",
"pages": [
"get-started/setup/self-managed/quick-install",
"get-started/setup/self-managed/clickhousectl",
"get-started/setup/self-managed/docker",
"get-started/setup/self-managed/advanced"
]
},
{
"group": "Production server",
"pages": [
"get-started/setup/self-managed/debian-ubuntu",
"get-started/setup/self-managed/redhat",
"get-started/setup/self-managed/nixos",
"get-started/setup/self-managed/other-linux"
]
}
],
"root": "get-started/setup/self-managed/overview"
}
],
"root": "get-started/setup/install"
},
{
"expanded": true,
"group": "Sample datasets",
"icon": "/images/menu-icon-database.svg",
"pages": [
"get-started/sample-datasets/playground",
{
"group": "Benchmarks",
"pages": [
"get-started/sample-datasets/amplab-benchmark",
"get-started/sample-datasets/brown-benchmark",
"get-started/sample-datasets/criteo",
"get-started/sample-datasets/job",
"get-started/sample-datasets/star-schema",
"get-started/sample-datasets/tpcds",
"get-started/sample-datasets/tpch"
]
},
{
"group": "Vector search & embeddings",
"pages": [
"get-started/sample-datasets/dbpedia",
"get-started/sample-datasets/hacker-news-vector-search",
"get-started/sample-datasets/laion",
"get-started/sample-datasets/laion5b"
]
},
{
"group": "Web & social analytics",
"pages": [
"get-started/sample-datasets/amazon-reviews",
"get-started/sample-datasets/anon-web-analytics-metrica",
"get-started/sample-datasets/github",
"get-started/sample-datasets/github-events",
"get-started/sample-datasets/hacker-news",
"get-started/sample-datasets/stackoverflow",
"get-started/sample-datasets/youtube-dislikes"
]
},
{
"group": "Geo & location",
"pages": [
"get-started/sample-datasets/cell-towers",
"get-started/sample-datasets/foursquare-os-places",
"get-started/sample-datasets/nyc-taxi"
]
},
{
"group": "Time series & sensors",
"pages": [
"get-started/sample-datasets/environmental-sensors",
"get-started/sample-datasets/noaa",
"get-started/sample-datasets/tw-weather",
"get-started/sample-datasets/wikistat"
]
},
{
"group": "Public records & open data",
"pages": [
"get-started/sample-datasets/covid19",
"get-started/sample-datasets/menus",
"get-started/sample-datasets/nypd-complaint-data",
"get-started/sample-datasets/ontime",
"get-started/sample-datasets/uk-price-paid"
]
}
],
"root": "get-started/sample-datasets/index"
},
{
"expanded": true,
"group": "Migrate",
"icon": "/images/caret-double-right.svg",
"pages": [
{
"group": "PostgreSQL",
"pages": [
"get-started/migrate/postgres/overview",
{
"group": "Migration guide",
"pages": [
"get-started/migrate/postgres/migration-guide/migration-guide-part1",
"get-started/migrate/postgres/migration-guide/migration-guide-part2",
"get-started/migrate/postgres/migration-guide/migration-guide-part3"
]
},
"get-started/migrate/postgres/appendix"
],
"root": "get-started/migrate/postgres/index"
},
{
"group": "BigQuery",
"pages": [
"get-started/migrate/bigquery/overview",
"get-started/migrate/bigquery/migrating-to-clickhouse-cloud",
"get-started/migrate/bigquery/loading-data"
],
"root": "get-started/migrate/bigquery/index"
},
{
"group": "Snowflake",
"pages": [
"get-started/migrate/snowflake/overview",
"get-started/migrate/snowflake/migration-guide",
"get-started/migrate/snowflake/sql-translation-reference"
]
},
{
"group": "Elasticsearch",
"pages": [
"get-started/migrate/elastic/overview"
]
},
{
"group": "Redshift",
"pages": [
"get-started/migrate/redshift/overview",
"get-started/migrate/redshift/migration-guide",
"get-started/migrate/redshift/sql-translation-reference"
]
},
{
"group": "OSS to Cloud",
"pages": [
"get-started/migrate/oss-to-cloud/clickhouse-to-cloud"
]
},
{
"group": "Other methods",
"pages": [
"get-started/migrate/other-methods/clickhouse-local-etl",
"get-started/migrate/other-methods/etl-tool-to-clickhouse",
"get-started/migrate/other-methods/object-storage-to-clickhouse"
]
}
],
"root": "get-started/migrate/overview"
}
]
},
{
"icon": "/images/icons/icon-concepts.svg",
"item": "Concepts",
"pages": [
"concepts/index",
{
"expanded": true,
"group": "Fundamentals",
"pages": [
"concepts/core-concepts/glossary",
"concepts/core-concepts/parts",
"concepts/core-concepts/partitions",
"concepts/core-concepts/merges",
"concepts/core-concepts/primary-indexes",
"concepts/core-concepts/query-parallelism",
"concepts/core-concepts/academic-overview"
],
"root": "concepts/core-concepts/index"
},
{
"expanded": true,
"group": "ClickHouse concepts",
"pages": [
{
"group": "Materialized views",
"pages": [
"concepts/features/materialized-views/incremental-materialized-view",
"concepts/features/materialized-views/refreshable-materialized-view",
"concepts/features/materialized-views/cascading-materialized-views"
],
"root": "concepts/features/materialized-views/index"
},
{
"group": "Dictionaries",
"pages": [
"concepts/features/dictionaries/best-practices"
],
"root": "concepts/features/dictionaries/index"
},
{
"group": "Projections",
"pages": [
"concepts/features/projections/projections",
"concepts/features/projections/materialized-views-versus-projections"
]
},
{
"group": "Performance",
"pages": [
"concepts/features/performance/prewhere",
"concepts/features/performance/allocation-profiling",
"concepts/features/performance/allocation-profiling-old",
{
"group": "Caches",
"pages": [
"concepts/features/performance/caches/caches",
"concepts/features/performance/caches/query-cache",
"concepts/features/performance/caches/query-condition-cache",
"concepts/features/performance/caches/userspace-page-cache"
]
},
{
"group": "Skipping-indexes",
"pages": [
"concepts/features/performance/skip-indexes/skipping-indexes",
"concepts/features/performance/skip-indexes/skipping-indexes-examples"
]
},
"concepts/features/performance/lazy-materialization",
{
"group": "Troubleshooting",
"pages": [
"concepts/features/performance/troubleshoot/debugging-memory-issues",
"concepts/features/performance/troubleshoot/performance-test",
"concepts/features/performance/troubleshoot/sampling-query-profiler"
]
}
],
"root": "concepts/features/performance/index"
},
{
"group": "Operations",
"pages": [
{
"group": "Insert",
"pages": [
"concepts/features/operations/insert/inserting-data",
"concepts/features/operations/insert/asyncinserts",
"concepts/features/operations/insert/bulkinserts",
"concepts/features/operations/insert/deduplication",
"concepts/features/operations/insert/deduplicating-inserts-on-retries",
"concepts/features/operations/insert/transactions"
]
},
{
"group": "Select",
"pages": [
"concepts/features/operations/select/joining-tables"
]
},
{
"group": "Update",
"pages": [
"concepts/features/operations/update/overview",
"concepts/features/operations/update/on-fly-mutations",
"concepts/features/operations/update/replacing-merge-tree"
],
"root": "concepts/features/operations/update/index"
},
{
"group": "Delete",
"pages": [
"concepts/features/operations/delete/overview",
"concepts/features/operations/delete/delete-mutations",
"concepts/features/operations/delete/drop-partition",
"concepts/features/operations/delete/lightweight-delete",
"concepts/features/operations/delete/truncate",
"concepts/features/operations/delete/ttl"
],
"root": "concepts/features/operations/delete/index"
}
]
},
{
"group": "Configuration",
"pages": [
{
"group": "Settings",
"pages": [
"concepts/features/configuration/settings/overview",
"concepts/features/configuration/settings/settings-query-level",
"concepts/features/configuration/settings/settings-users",
"concepts/features/configuration/settings/settings-profiles",
"concepts/features/configuration/settings/constraints-on-settings",
"concepts/features/configuration/settings/query-complexity",
"concepts/features/configuration/settings/permissions-for-queries",
"concepts/features/configuration/settings/memory-overcommit",
"concepts/features/configuration/settings/server-overload",
"concepts/features/configuration/settings/tcp-connection-limits",
"concepts/features/configuration/settings/alternative-query-languages"
]
},
{
"group": "Server config",
"pages": [
"concepts/features/configuration/server-config/configuration-files",
"concepts/features/configuration/server-config/storing-data",
"concepts/features/configuration/server-config/named-collections",
"concepts/features/configuration/server-config/workload-scheduling",
"concepts/features/configuration/server-config/quotas",
"concepts/features/configuration/server-config/composable-protocols",
"concepts/features/configuration/server-config/startup-scripts"
]
}
]
},
{
"group": "Security and auth",
"pages": [
"concepts/features/security/access-rights",
"concepts/features/security/network-ports",
{
"group": "TLS",
"pages": [
"concepts/features/security/tls/configuring-tls",
"concepts/features/security/tls/configuring-tls-acme-client"
],
"root": "concepts/features/security/tls/index"
},
{
"group": "External authenticators",
"pages": [
{
"group": "SSL",
"pages": [
"concepts/features/security/external-authenticators/ssl-x509",
"concepts/features/security/ssl-user-auth"
]
},
{
"group": "LDAP",
"pages": [
"concepts/features/security/external-authenticators/ldap",
"concepts/features/security/configuring-ldap"
]
},
"concepts/features/security/external-authenticators/http",
"concepts/features/security/external-authenticators/kerberos",
"concepts/features/security/external-authenticators/jwt"
],
"root": "concepts/features/security/external-authenticators/index"
}
],
"root": "concepts/features/security/index"
},
{
"group": "Backup and restore",
"pages": [
"concepts/features/backup-restore/overview",
"concepts/features/backup-restore/local-disk",
"concepts/features/backup-restore/s3-endpoint",
"concepts/features/backup-restore/azure-blob-storage",
"concepts/features/backup-restore/snapshot",
"concepts/features/backup-restore/alternative-methods"
]
},
{
"group": "Interfaces",
"pages": [
"concepts/features/interfaces/cli",
"concepts/features/interfaces/client",
{
"group": "Drivers and interfaces",
"pages": [
"concepts/features/interfaces/http",
"concepts/features/interfaces/tcp",
"concepts/features/interfaces/jdbc",
"concepts/features/interfaces/mysql",
"concepts/features/interfaces/odbc",
"concepts/features/interfaces/postgresql",
"concepts/features/interfaces/prometheus",
"concepts/features/interfaces/ssh",
"concepts/features/interfaces/grpc",
"concepts/features/interfaces/arrowflight"
],
"root": "concepts/features/interfaces/overview"
},
"concepts/features/interfaces/cpp",
"concepts/features/interfaces/schema-inference",
"concepts/features/interfaces/web-terminal",
{
"group": "Third-party clients",
"pages": [],
"root": "concepts/features/interfaces/third-party/index"
}
],
"root": "concepts/features/interfaces/native-clients-interfaces-index"
},
{
"group": "Tools and utilities",
"pages": [
"concepts/features/tools-and-utilities/backupview",
"concepts/features/tools-and-utilities/clickhouse-benchmark",
"concepts/features/tools-and-utilities/clickhouse-compressor",
"concepts/features/tools-and-utilities/clickhouse-disks",
"concepts/features/tools-and-utilities/clickhouse-format",
"concepts/features/tools-and-utilities/clickhouse-keeper-client",
"concepts/features/tools-and-utilities/clickhouse-keeper-http-api",
"concepts/features/tools-and-utilities/clickhouse-local",
"concepts/features/tools-and-utilities/clickhouse-obfuscator",
"concepts/features/tools-and-utilities/odbc-bridge",
"concepts/features/tools-and-utilities/static-files-disk-uploader"
],
"root": "concepts/features/tools-and-utilities/index"
}
],
"root": "concepts/features/index"
},
{
"expanded": true,
"group": "Best practices",
"pages": [
"concepts/best-practices/choosing-a-primary-key",
"concepts/best-practices/select-data-type",
"concepts/best-practices/use-materialized-views",
"concepts/best-practices/minimize-optimize-joins",
"concepts/best-practices/partitioning-keys",
"concepts/best-practices/selecting-an-insert-strategy",
"concepts/best-practices/using-data-skipping-indices",
"concepts/best-practices/avoid-mutations",
"concepts/best-practices/avoid-optimize-final",
"concepts/best-practices/avoidnullablecolumns",
"concepts/best-practices/json-type"
],
"root": "concepts/best-practices/index"
}
],
"root": "concepts/index"
},
{
"groups": [
{
"group": "ClickHouse guides",
"pages": [
{
"group": "Data formats",
"pages": [
"guides/clickhouse/data-formats/csv-tsv",
"guides/clickhouse/data-formats/parquet",
"guides/clickhouse/data-formats/arrow-avro-orc",
"guides/clickhouse/data-formats/binary",
"guides/clickhouse/data-formats/sql",
"guides/clickhouse/data-formats/templates-regex",
{
"group": "JSON",
"pages": [
"guides/clickhouse/data-formats/json/loading",
"guides/clickhouse/data-formats/json/inference",
"guides/clickhouse/data-formats/json/schema",
"guides/clickhouse/data-formats/json/formats",
"guides/clickhouse/data-formats/json/exporting",
"guides/clickhouse/data-formats/json/other"
],
"root": "guides/clickhouse/data-formats/json/intro"
}
],
"root": "guides/clickhouse/data-formats/intro"
},
{
"group": "Data modelling",
"pages": [
"guides/clickhouse/data-modelling/schema-design",
"guides/clickhouse/data-modelling/sparse-primary-indexes",
"guides/clickhouse/data-modelling/denormalization",
"guides/clickhouse/data-modelling/backfilling",
"guides/clickhouse/data-modelling/merge-table-function",
"guides/clickhouse/data-modelling/stored-procedures-and-prepared-statements",
"guides/clickhouse/data-modelling/generating-test-data",
{
"expanded": false,
"group": "Compression",
"pages": [
"guides/clickhouse/data-modelling/compression/compression-in-clickhouse",
"guides/clickhouse/data-modelling/compression/compression-modes"
]
},
"guides/clickhouse/working-with-arrays",
"guides/clickhouse/working-with-joins"
],
"root": "guides/clickhouse/data-modelling/index"
},
{
"group": "Performance & monitoring",
"pages": [
"guides/clickhouse/performance-and-monitoring/query-optimization",
"guides/clickhouse/performance-and-monitoring/analyzer",
"guides/clickhouse/performance-and-monitoring/understanding-query-execution-with-the-analyzer",
"guides/clickhouse/performance-and-monitoring/dynamic-column-selection"
]
},
{
"expanded": false,
"group": "Aggregate combinator examples",
"pages": [
"guides/clickhouse/examples/aggregate-function-combinators/anyIf",
"guides/clickhouse/examples/aggregate-function-combinators/argMaxIf",
"guides/clickhouse/examples/aggregate-function-combinators/argMinIf",
"guides/clickhouse/examples/aggregate-function-combinators/avgIf",
"guides/clickhouse/examples/aggregate-function-combinators/avgMap",
"guides/clickhouse/examples/aggregate-function-combinators/avgMerge",
"guides/clickhouse/examples/aggregate-function-combinators/avgMergeState",
"guides/clickhouse/examples/aggregate-function-combinators/avgResample",
"guides/clickhouse/examples/aggregate-function-combinators/avgState",
"guides/clickhouse/examples/aggregate-function-combinators/countIf",
"guides/clickhouse/examples/aggregate-function-combinators/countResample",
"guides/clickhouse/examples/aggregate-function-combinators/groupArrayDistinct",
"guides/clickhouse/examples/aggregate-function-combinators/groupArrayResample",
"guides/clickhouse/examples/aggregate-function-combinators/maxMap",
"guides/clickhouse/examples/aggregate-function-combinators/maxSimpleState",
"guides/clickhouse/examples/aggregate-function-combinators/minMap",
"guides/clickhouse/examples/aggregate-function-combinators/minSimpleState",
"guides/clickhouse/examples/aggregate-function-combinators/quantilesTimingArrayIf",
"guides/clickhouse/examples/aggregate-function-combinators/quantilesTimingIf",
"guides/clickhouse/examples/aggregate-function-combinators/sumArray",
"guides/clickhouse/examples/aggregate-function-combinators/sumForEach",
"guides/clickhouse/examples/aggregate-function-combinators/sumIf",
"guides/clickhouse/examples/aggregate-function-combinators/sumMap",
"guides/clickhouse/examples/aggregate-function-combinators/sumSimpleState",
"guides/clickhouse/examples/aggregate-function-combinators/uniqArray",
"guides/clickhouse/examples/aggregate-function-combinators/uniqArrayIf"
]
},
"guides/oss/update",
{
"group": "OSS best practices",
"pages": [
"guides/oss/best-practices/sizing-and-hardware-recommendations",
"guides/oss/best-practices/tips"
]
},
{
"expanded": false,
"group": "Deployment and scaling",
"pages": [
"guides/oss/deployment-and-scaling/terminology",
"guides/oss/deployment-and-scaling/shards",
"guides/oss/deployment-and-scaling/scaling-clusters",
"guides/oss/deployment-and-scaling/separation-storage-compute",
"guides/oss/deployment-and-scaling/cluster-discovery",
{
"expanded": false,
"group": "Keeper",
"pages": [
"guides/oss/deployment-and-scaling/keeper/ssl-zookeeper"
],
"root": "guides/oss/deployment-and-scaling/keeper/index"
},
{
"expanded": false,
"group": "Monitoring",
"pages": [
"guides/oss/deployment-and-scaling/monitoring/monitoring",
"guides/oss/deployment-and-scaling/monitoring/opentelemetry"
]
},
{
"expanded": false,
"group": "Examples",
"pages": [
"guides/oss/deployment-and-scaling/examples/1-shard-2-replicas",
"guides/oss/deployment-and-scaling/examples/2-shards-1-replica",
"guides/oss/deployment-and-scaling/examples/2-shards-2-replicas"
]
}
],
"root": "guides/oss/deployment-and-scaling/index"
}
],
"root": "guides/clickhouse/index"
},
{
"expanded": true,
"group": "Use case guides",
"pages": [
{
"group": "Real-time analytics",
"pages": [
{
"expanded": false,
"group": "Time series",
"pages": [
"guides/use-cases/real-time-analytics/time-series/date-time-data-types",
"guides/use-cases/real-time-analytics/time-series/basic-operations",
"guides/use-cases/real-time-analytics/time-series/analysis-functions",
"guides/use-cases/real-time-analytics/time-series/storage-efficiency",
"guides/use-cases/real-time-analytics/time-series/query-performance",
"guides/use-cases/real-time-analytics/time-series/materialized-view-rollup",
"guides/use-cases/real-time-analytics/time-series/time-series-filling-gaps"
],
"root": "guides/use-cases/real-time-analytics/time-series/index"
}
]
},
{
"group": "Observability",
"pages": [
"guides/use-cases/observability/cloud-monitoring",
"guides/use-cases/observability/self-managed-monitoring",
{
"group": "Build your own",
"pages": [
"guides/use-cases/observability/build-your-own/introduction",
"guides/use-cases/observability/build-your-own/schema-design",
"guides/use-cases/observability/build-your-own/integrating-opentelemetry",
"guides/use-cases/observability/build-your-own/managing-data",
"guides/use-cases/observability/build-your-own/grafana",
"guides/use-cases/observability/build-your-own/demo-application"
],
"root": "guides/use-cases/observability/build-your-own/index"
}
],
"root": "guides/use-cases/observability/index"
},
{
"group": "Data warehousing",
"pages": [
{
"group": "Getting started",
"pages": [
"guides/use-cases/data-warehousing/getting-started/querying-directly",
"guides/use-cases/data-warehousing/getting-started/connecting-catalogs",
"guides/use-cases/data-warehousing/getting-started/accelerating-analytics",
"guides/use-cases/data-warehousing/getting-started/writing-data"
],
"root": "guides/use-cases/data-warehousing/getting-started/overview"
},
{
"group": "Catalogs",
"pages": [
"guides/use-cases/data-warehousing/glue-catalog",
"guides/use-cases/data-warehousing/lakekeeper-catalog",
"guides/use-cases/data-warehousing/nessie-catalog",
"guides/use-cases/data-warehousing/onelake-catalog",
"guides/use-cases/data-warehousing/polaris-catalog",
"guides/use-cases/data-warehousing/rest-catalog",
"guides/use-cases/data-warehousing/unity-catalog",
"guides/use-cases/data-warehousing/biglake-catalog"
],
"root": "guides/use-cases/data-warehousing/reference/index"
},
"guides/use-cases/data-warehousing/support-matrix"
],
"root": "guides/use-cases/data-warehousing/index"
},
{
"group": "AI/ML",
"pages": [
"guides/use-cases/ai-ml/vector-search",
"guides/use-cases/ai-ml/ai-powered-sql-generation",
{
"group": "Data exploration",
"pages": [
"guides/use-cases/ai-ml/data-exploration/jupyter-notebook",
"guides/use-cases/ai-ml/data-exploration/marimo-notebook"
]
},
{
"group": "MCP",
"pages": [
"guides/use-cases/ai-ml/MCP/claude-desktop",
"guides/use-cases/ai-ml/MCP/librechat",
"guides/use-cases/ai-ml/MCP/anythingllm",
"guides/use-cases/ai-ml/MCP/open-webui",
"guides/use-cases/ai-ml/MCP/ollama",
"guides/use-cases/ai-ml/MCP/janai",
{
"group": "AI agent libraries",
"pages": [
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/streamlit",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/langchain",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/llamaindex",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/pydantic-ai",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/slackbot",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/agno",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/chainlit",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/claude-agent-sdk",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/copilotkit",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/crewai",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/dspy",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/mcp-agent",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/microsoft-agent-framework",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/upsonic",
"guides/use-cases/ai-ml/MCP/ai-agent-libraries/openai-agents"
],
"root": "guides/use-cases/ai-ml/MCP/ai-agent-libraries/index"
}
],
"root": "guides/use-cases/ai-ml/MCP/index"
}
],
"root": "guides/use-cases/ai-ml/index"
}
],
"root": "guides/use-cases/index"
}
],
"icon": "/images/icons/icon-guides.svg",
"item": "Guides"
},
{
"icon": "/images/icons/icon-reference.svg",
"item": "Reference",
"pages": [
"reference/home",
{
"expandable": true,
"expanded": true,
"group": "SQL Reference",
"pages": [
"reference/syntax",
{
"expandable": true,
"expanded": false,
"group": "Statements",
"pages": [
{
"expanded": false,
"group": "ALTER",
"pages": [
"reference/statements/alter/index",
"reference/statements/alter/apply-deleted-mask",
"reference/statements/alter/apply-patches",
"reference/statements/alter/column",
"reference/statements/alter/comment",
"reference/statements/alter/constraint",
"reference/statements/alter/database-comment",
"reference/statements/alter/delete",
"reference/statements/alter/named-collection",
"reference/statements/alter/order-by",
"reference/statements/alter/partition",
"reference/statements/alter/projection",
"reference/statements/alter/quota",
"reference/statements/alter/role",
"reference/statements/alter/row-policy",
"reference/statements/alter/sample-by",
"reference/statements/alter/setting",
"reference/statements/alter/settings-profile",
"reference/statements/alter/skipping-index",
"reference/statements/alter/statistics",
"reference/statements/alter/ttl",
"reference/statements/alter/update",
"reference/statements/alter/user",
"reference/statements/alter/masking-policy",
"reference/statements/alter/view"
],
"root": "reference/statements/alter/index"
},
"reference/statements/attach",
"reference/statements/check-grant",
"reference/statements/check-table",
{
"expanded": false,
"group": "CREATE",
"pages": [
"reference/statements/create/database",
{
"expanded": false,
"group": "DICTIONARY",
"pages": [
"reference/statements/create/dictionary/attributes",
"reference/statements/create/dictionary/embedded",
"reference/statements/create/dictionary/lifetime",
{
"expanded": false,
"group": "Layouts",
"pages": [
"reference/statements/create/dictionary/layouts/flat",
"reference/statements/create/dictionary/layouts/hashed",
"reference/statements/create/dictionary/layouts/hashed-array",
"reference/statements/create/dictionary/layouts/cache",
"reference/statements/create/dictionary/layouts/ssd-cache",
"reference/statements/create/dictionary/layouts/direct",
"reference/statements/create/dictionary/layouts/range-hashed",
"reference/statements/create/dictionary/layouts/hierarchical",
"reference/statements/create/dictionary/layouts/polygon",
"reference/statements/create/dictionary/layouts/ip-trie",
"reference/statements/create/dictionary/layouts/regexp-tree"
],
"root": "reference/statements/create/dictionary/layouts/overview"
},
{
"expanded": false,
"group": "Sources",
"pages": [
"reference/statements/create/dictionary/sources/local-file",
"reference/statements/create/dictionary/sources/executable-file",
"reference/statements/create/dictionary/sources/executable-pool",
"reference/statements/create/dictionary/sources/http",
"reference/statements/create/dictionary/sources/clickhouse",
"reference/statements/create/dictionary/sources/mysql",
"reference/statements/create/dictionary/sources/postgresql",
"reference/statements/create/dictionary/sources/mongodb",
"reference/statements/create/dictionary/sources/redis",
"reference/statements/create/dictionary/sources/cassandra",
"reference/statements/create/dictionary/sources/odbc",
"reference/statements/create/dictionary/sources/null",
"reference/statements/create/dictionary/sources/yamlregexptree",
"reference/statements/create/dictionary/sources/ytsaurus"
],
"root": "reference/statements/create/dictionary/sources/overview"
}
],
"root": "reference/statements/create/dictionary"
},
"reference/statements/create/masking-policy",
"reference/statements/create/function",
"reference/statements/create/named-collection",
"reference/statements/create/quota",
"reference/statements/create/role",
"reference/statements/create/row-policy",
"reference/statements/create/settings-profile",
"reference/statements/create/table",
"reference/statements/create/user",
"reference/statements/create/view"
],
"root": "reference/statements/create/index"
},
"reference/statements/delete",
"reference/statements/describe-table",
"reference/statements/detach",
"reference/statements/distributed-ddl",
"reference/statements/drop",
"reference/statements/exchange",
"reference/statements/execute_as",
"reference/statements/exists",
"reference/statements/explain",
"reference/statements/grant",
"reference/statements/in",
"reference/statements/insert-into",
"reference/statements/kill",
"reference/statements/move",
"reference/statements/optimize",
"reference/statements/parallel_with",
"reference/statements/rename",
"reference/statements/revoke",
{
"expanded": false,
"group": "SELECT",
"pages": [
"reference/statements/select/all",
"reference/statements/select/apply_modifier",
"reference/statements/select/array-join",
"reference/statements/select/distinct",
"reference/statements/select/except",
"reference/statements/select/except_modifier",
"reference/statements/select/format",
"reference/statements/select/from",
"reference/statements/select/group-by",
"reference/statements/select/having",
"reference/statements/select/intersect",
"reference/statements/select/into-outfile",
"reference/statements/select/join",
"reference/statements/select/limit-by",
"reference/statements/select/limit",
"reference/statements/select/offset",
"reference/statements/select/order-by",
"reference/statements/select/prewhere",
"reference/statements/select/qualify",
"reference/statements/select/replace_modifier",
"reference/statements/select/sample",
"reference/statements/select/union",
"reference/statements/select/where",
"reference/statements/select/with"
],
"root": "reference/statements/select/index"
},
"reference/statements/set-role",
"reference/statements/set",
"reference/statements/show",
"reference/statements/system",
"reference/statements/truncate",
"reference/statements/undrop",
"reference/statements/update",
"reference/statements/use",
"reference/statements/watch"
],
"root": "reference/statements/index"
},
{
"expandable": true,
"expanded": false,
"group": "Operators",
"pages": [
"reference/operators/exists",
"reference/operators/distributed-ddl"
],
"root": "reference/operators/index"
}
]
},
{
"expandable": true,
"expanded": false,
"group": "Data Types",
"pages": [
{
"expanded": false,
"group": "Numeric types",
"pages": [
"reference/data-types/int-uint",
"reference/data-types/float",
"reference/data-types/decimal",
"reference/data-types/boolean"
]
},
{
"expanded": false,
"group": "String types",
"pages": [
"reference/data-types/string",
"reference/data-types/fixedstring"
]
},
{
"expanded": false,
"group": "Date and time types",
"pages": [
"reference/data-types/date",
"reference/data-types/date32",
"reference/data-types/datetime",
"reference/data-types/datetime64",
"reference/data-types/time",
"reference/data-types/time64"
]
},
{
"expanded": false,
"group": "Network types",
"pages": [
"reference/data-types/ipv4",
"reference/data-types/ipv6"
]
},
{
"expanded": false,
"group": "Composite types",
"pages": [
"reference/data-types/array",
"reference/data-types/tuple",
"reference/data-types/map",
"reference/data-types/nested-data-structures/index"
]
},
{
"expanded": false,
"group": "Semi-structured types",
"pages": [
"reference/data-types/newjson",
"reference/data-types/dynamic",
"reference/data-types/variant"
]
},
{
"expanded": false,
"group": "Nullable and optional types",
"pages": [
"reference/data-types/nullable",
"reference/data-types/lowcardinality"
]
},
{
"expanded": false,
"group": "Specialized types",
"pages": [
"reference/data-types/uuid",
"reference/data-types/enum",
"reference/data-types/geo",
"reference/data-types/qbit",
"reference/data-types/domains/index"
]
},
{
"expanded": false,
"group": "Aggregate function types",
"pages": [
"reference/data-types/aggregatefunction",
"reference/data-types/simpleaggregatefunction"
]
},
{
"expanded": false,
"group": "Special Data Types",
"pages": [
"reference/data-types/special-data-types/expression",
"reference/data-types/special-data-types/interval",
"reference/data-types/special-data-types/nothing",
"reference/data-types/special-data-types/set"
],
"root": "reference/data-types/special-data-types/index"
},
{
"group": "Binary encoding",
"pages": [
"reference/data-types/data-types-binary-encoding"
]
}
],
"root": "reference/data-types/index"
},
{
"expandable": true,
"expanded": false,
"group": "Engines",
"pages": [
{
"expanded": false,
"group": "Table Engines",
"pages": [
{
"expanded": false,
"group": "Integrations",
"pages": [
"reference/engines/table-engines/integrations/arrowflight",
"reference/engines/table-engines/integrations/azure-queue",
"reference/engines/table-engines/integrations/azureBlobStorage",
"reference/engines/table-engines/integrations/deltalake",
"reference/engines/table-engines/integrations/embedded-rocksdb",
"reference/engines/table-engines/integrations/ExternalDistributed",
"reference/engines/table-engines/integrations/hdfs",
"reference/engines/table-engines/integrations/hive",
"reference/engines/table-engines/integrations/hudi",
"reference/engines/table-engines/integrations/iceberg",
"reference/engines/table-engines/integrations/jdbc",
"reference/engines/table-engines/integrations/kafka",
"reference/engines/table-engines/integrations/materialized-postgresql",
"reference/engines/table-engines/integrations/mongodb",
"reference/engines/table-engines/integrations/mysql",
"reference/engines/table-engines/integrations/nats",
"reference/engines/table-engines/integrations/odbc",
"reference/engines/table-engines/integrations/paimon",
"reference/engines/table-engines/integrations/postgresql",
"reference/engines/table-engines/integrations/rabbitmq",
"reference/engines/table-engines/integrations/redis",
"reference/engines/table-engines/integrations/s3",
"reference/engines/table-engines/integrations/s3queue",
"reference/engines/table-engines/integrations/sqlite",
"reference/engines/table-engines/integrations/time-series",
"reference/engines/table-engines/integrations/ytsaurus"
],
"root": "reference/engines/table-engines/integrations/index"
},
{
"expanded": false,
"group": "Log Family",
"pages": [
"reference/engines/table-engines/log-family/log",
"reference/engines/table-engines/log-family/stripelog",
"reference/engines/table-engines/log-family/tinylog"
],
"root": "reference/engines/table-engines/log-family/index"
},
{
"expanded": false,
"group": "MergeTree Family",
"pages": [
"reference/engines/table-engines/mergetree-family/mergetree",
"reference/engines/table-engines/mergetree-family/aggregatingmergetree",
"reference/engines/table-engines/mergetree-family/annindexes",
"reference/engines/table-engines/mergetree-family/coalescingmergetree",
"reference/engines/table-engines/mergetree-family/collapsingmergetree",
"reference/engines/table-engines/mergetree-family/custom-partitioning-key",
"reference/engines/table-engines/mergetree-family/graphitemergetree",
"reference/engines/table-engines/mergetree-family/replacingmergetree",
"reference/engines/table-engines/mergetree-family/replication",
"reference/engines/table-engines/mergetree-family/summingmergetree",
"reference/engines/table-engines/mergetree-family/textindexes",
"reference/engines/table-engines/mergetree-family/versionedcollapsingmergetree"
],
"root": "reference/engines/table-engines/mergetree-family/index"
},
{
"expanded": false,
"group": "Special",
"pages": [
"reference/engines/table-engines/special/alias",
"reference/engines/table-engines/special/buffer",
"reference/engines/table-engines/special/dictionary",
"reference/engines/table-engines/special/distributed",
"reference/engines/table-engines/special/executable",
"reference/engines/table-engines/special/external-data",
"reference/engines/table-engines/special/file",
"reference/engines/table-engines/special/filelog",
"reference/engines/table-engines/special/generate",
"reference/engines/table-engines/special/join",
"reference/engines/table-engines/special/keepermap",
"reference/engines/table-engines/special/memory",
"reference/engines/table-engines/special/merge",
"reference/engines/table-engines/special/null",
"reference/engines/table-engines/special/set",
"reference/engines/table-engines/special/url",
"reference/engines/table-engines/special/view"
],
"root": "reference/engines/table-engines/special/index"
}
],
"root": "reference/engines/table-engines/index"
},
{
"expanded": false,
"group": "Database Engines",
"pages": [
"reference/engines/database-engines/atomic",
"reference/engines/database-engines/backup",
"reference/engines/database-engines/datalake",
"reference/engines/database-engines/materialized-postgresql",
"reference/engines/database-engines/mysql",
"reference/engines/database-engines/postgresql",
"reference/engines/database-engines/replicated",
"reference/engines/database-engines/shared",
"reference/engines/database-engines/sqlite"
],
"root": "reference/engines/database-engines/index"
}
],
"root": "reference/engines/engines"
},
{
"expandable": true,
"expanded": false,
"group": "Functions",
"pages": [
{
"expanded": false,
"group": "Regular functions",
"pages": [
"reference/functions/regular-functions/ai-functions",
"reference/functions/regular-functions/arithmetic-functions",
"reference/functions/regular-functions/array-functions",
"reference/functions/regular-functions/array-join",
"reference/functions/regular-functions/bit-functions",
"reference/functions/regular-functions/bitmap-functions",
"reference/functions/regular-functions/comparison-functions",
"reference/functions/regular-functions/conditional-functions",
"reference/functions/regular-functions/date-time-functions",
"reference/functions/regular-functions/distance-functions",
"reference/functions/regular-functions/embedded-dict-functions",
"reference/functions/regular-functions/encoding-functions",
"reference/functions/regular-functions/encryption-functions",
"reference/functions/regular-functions/ext-dict-functions",
"reference/functions/regular-functions/files",
"reference/functions/regular-functions/financial-functions",
"reference/functions/regular-functions/functions-for-nulls",
{
"expanded": false,
"group": "Geo",
"pages": [
"reference/functions/regular-functions/geo/coordinates",
"reference/functions/regular-functions/geo/flipCoordinates",
"reference/functions/regular-functions/geo/geometry",
"reference/functions/regular-functions/geo/geohash",
"reference/functions/regular-functions/geo/h3",
"reference/functions/regular-functions/geo/polygon",
"reference/functions/regular-functions/geo/s2",
"reference/functions/regular-functions/geo/svg"
],
"root": "reference/functions/regular-functions/geo/index"
},
"reference/functions/regular-functions/hash-functions",
"reference/functions/regular-functions/in-functions",
"reference/functions/regular-functions/introspection",
"reference/functions/regular-functions/ip-address-functions",
"reference/functions/regular-functions/json-functions",
"reference/functions/regular-functions/logical-functions",
"reference/functions/regular-functions/machine-learning-functions",
"reference/functions/regular-functions/math-functions",
"reference/functions/regular-functions/nlp-functions",
"reference/functions/regular-functions/numeric-indexed-vector-functions",
"reference/functions/regular-functions/other-functions",
"reference/functions/regular-functions/random-functions",
"reference/functions/regular-functions/regular-functions-index",
"reference/functions/regular-functions/rounding-functions",
"reference/functions/regular-functions/splitting-merging-functions",
"reference/functions/regular-functions/string-functions",
"reference/functions/regular-functions/string-replace-functions",
"reference/functions/regular-functions/string-search-functions",
"reference/functions/regular-functions/time-series-functions",
"reference/functions/regular-functions/time-window-functions",
"reference/functions/regular-functions/tuple-functions",
"reference/functions/regular-functions/tuple-map-functions",
"reference/functions/regular-functions/type-conversion-functions",
"reference/functions/regular-functions/ulid-functions",
"reference/functions/regular-functions/uniqtheta-functions",
"reference/functions/regular-functions/url-functions",
"reference/functions/regular-functions/uuid-functions"
],
"root": "reference/functions/regular-functions/overview"
},
{
"expanded": false,
"group": "Aggregate Functions",
"pages": [
"reference/functions/aggregate-functions/combinators",
"reference/functions/aggregate-functions/grouping_function",
"reference/functions/aggregate-functions/parametric-functions",
{
"expanded": false,
"group": "Reference",
"pages": [
"reference/functions/aggregate-functions/reference-index",
"reference/functions/aggregate-functions/aggThrow",
"reference/functions/aggregate-functions/analysis_of_variance",
"reference/functions/aggregate-functions/any",
"reference/functions/aggregate-functions/anyHeavy",
"reference/functions/aggregate-functions/anyLast",
"reference/functions/aggregate-functions/approxtopk",
"reference/functions/aggregate-functions/approxtopsum",
"reference/functions/aggregate-functions/argMax",
"reference/functions/aggregate-functions/argAndMax",
"reference/functions/aggregate-functions/argMin",
"reference/functions/aggregate-functions/argAndMin",
"reference/functions/aggregate-functions/avg",
"reference/functions/aggregate-functions/avgWeighted",
"reference/functions/aggregate-functions/boundrat",
"reference/functions/aggregate-functions/categoricalInformationValue",
"reference/functions/aggregate-functions/contingency",
"reference/functions/aggregate-functions/corr",
"reference/functions/aggregate-functions/corrMatrix",
"reference/functions/aggregate-functions/corrStable",
"reference/functions/aggregate-functions/count",
"reference/functions/aggregate-functions/covarPop",
"reference/functions/aggregate-functions/covarPopMatrix",
"reference/functions/aggregate-functions/covarPopStable",
"reference/functions/aggregate-functions/covarSamp",
"reference/functions/aggregate-functions/covarSampMatrix",
"reference/functions/aggregate-functions/covarSampStable",
"reference/functions/aggregate-functions/cramersV",
"reference/functions/aggregate-functions/cramersVBiasCorrected",
"reference/functions/aggregate-functions/deltaSum",
"reference/functions/aggregate-functions/deltaSumTimestamp",
"reference/functions/aggregate-functions/distinctDynamicTypes",
"reference/functions/aggregate-functions/distinctJSONPaths",
"reference/functions/aggregate-functions/distinctJSONPathsAndTypes",
"reference/functions/aggregate-functions/entropy",
"reference/functions/aggregate-functions/estimateCompressionRatio",
"reference/functions/aggregate-functions/exponentialMovingAverage",
"reference/functions/aggregate-functions/exponentialTimeDecayedAvg",
"reference/functions/aggregate-functions/exponentialTimeDecayedCount",
"reference/functions/aggregate-functions/exponentialTimeDecayedMax",
"reference/functions/aggregate-functions/exponentialTimeDecayedSum",
"reference/functions/aggregate-functions/first_value",
"reference/functions/aggregate-functions/flame_graph",
"reference/functions/aggregate-functions/groupArray",
"reference/functions/aggregate-functions/groupArrayArray",
"reference/functions/aggregate-functions/groupArrayInsertAt",
"reference/functions/aggregate-functions/groupArrayIntersect",
"reference/functions/aggregate-functions/groupArrayLast",
"reference/functions/aggregate-functions/groupArrayMovingAvg",
"reference/functions/aggregate-functions/groupArrayMovingSum",
"reference/functions/aggregate-functions/groupArraySample",
"reference/functions/aggregate-functions/groupArraySorted",
"reference/functions/aggregate-functions/groupBitAnd",
"reference/functions/aggregate-functions/groupBitmap",
"reference/functions/aggregate-functions/groupBitmapAnd",
"reference/functions/aggregate-functions/groupBitmapOr",
"reference/functions/aggregate-functions/groupBitmapXor",
"reference/functions/aggregate-functions/groupBitOr",
"reference/functions/aggregate-functions/groupBitXor",
"reference/functions/aggregate-functions/groupConcat",
"reference/functions/aggregate-functions/groupUniqArray",
"reference/functions/aggregate-functions/intervalLengthSum",
"reference/functions/aggregate-functions/kolmogorovSmirnovTest",
"reference/functions/aggregate-functions/kurtPop",
"reference/functions/aggregate-functions/kurtSamp",
"reference/functions/aggregate-functions/largestTriangleThreeBuckets",
"reference/functions/aggregate-functions/last_value",
"reference/functions/aggregate-functions/mannWhitneyUTest",
"reference/functions/aggregate-functions/max",
"reference/functions/aggregate-functions/maxIntersections",
"reference/functions/aggregate-functions/maxIntersectionsPosition",
"reference/functions/aggregate-functions/maxMap",
"reference/functions/aggregate-functions/meanZTest",
"reference/functions/aggregate-functions/median",
"reference/functions/aggregate-functions/min",
"reference/functions/aggregate-functions/minMap",
"reference/functions/aggregate-functions/quantile",
"reference/functions/aggregate-functions/quantileGK",
"reference/functions/aggregate-functions/quantileBFloat16",
"reference/functions/aggregate-functions/quantileddsketch",
"reference/functions/aggregate-functions/quantileDeterministic",
"reference/functions/aggregate-functions/quantileExact",
"reference/functions/aggregate-functions/quantileExactExclusive",
"reference/functions/aggregate-functions/quantileExactHigh",
"reference/functions/aggregate-functions/quantileExactInclusive",
"reference/functions/aggregate-functions/quantileExactLow",
"reference/functions/aggregate-functions/quantileExactWeighted",
"reference/functions/aggregate-functions/quantileExactWeightedInterpolated",
"reference/functions/aggregate-functions/quantileInterpolatedWeighted",
"reference/functions/aggregate-functions/quantilePrometheusHistogram",
"reference/functions/aggregate-functions/quantiles",
"reference/functions/aggregate-functions/quantilesExactExclusive",
"reference/functions/aggregate-functions/quantilesExactInclusive",
"reference/functions/aggregate-functions/quantilesGK",
"reference/functions/aggregate-functions/quantileTDigest",
"reference/functions/aggregate-functions/quantileTDigestWeighted",
"reference/functions/aggregate-functions/quantileTiming",
"reference/functions/aggregate-functions/quantileTimingWeighted",
"reference/functions/aggregate-functions/quantilesTimingWeighted",
"reference/functions/aggregate-functions/rankCorr",
"reference/functions/aggregate-functions/simpleLinearRegression",
"reference/functions/aggregate-functions/singleValueOrNull",
"reference/functions/aggregate-functions/skewPop",
"reference/functions/aggregate-functions/skewSamp",
"reference/functions/aggregate-functions/sparkbar",
"reference/functions/aggregate-functions/stddevPop",
"reference/functions/aggregate-functions/stddevPopStable",
"reference/functions/aggregate-functions/stddevSamp",
"reference/functions/aggregate-functions/stddevSampStable",
"reference/functions/aggregate-functions/stochasticLinearRegression",
"reference/functions/aggregate-functions/stochasticLogisticRegression",
"reference/functions/aggregate-functions/studentTTest",
"reference/functions/aggregate-functions/studentTTestOneSample",
"reference/functions/aggregate-functions/sum",
"reference/functions/aggregate-functions/sumCount",
"reference/functions/aggregate-functions/sumKahan",
"reference/functions/aggregate-functions/sumMap",
"reference/functions/aggregate-functions/sumMapWithOverflow",
"reference/functions/aggregate-functions/sumWithOverflow",
"reference/functions/aggregate-functions/theilsU",
"reference/functions/aggregate-functions/timeSeriesChangesToGrid",
"reference/functions/aggregate-functions/timeSeriesDeltaToGrid",
"reference/functions/aggregate-functions/timeSeriesDerivToGrid",
"reference/functions/aggregate-functions/timeSeriesGroupArray",
"reference/functions/aggregate-functions/timeSeriesInstantDeltaToGrid",
"reference/functions/aggregate-functions/timeSeriesInstantRateToGrid",
"reference/functions/aggregate-functions/timeSeriesLastTwoSamples",
"reference/functions/aggregate-functions/timeSeriesPredictLinearToGrid",
"reference/functions/aggregate-functions/timeSeriesRateToGrid",
"reference/functions/aggregate-functions/timeSeriesResampleToGridWithStaleness",
"reference/functions/aggregate-functions/timeSeriesResetsToGrid",
"reference/functions/aggregate-functions/topK",
"reference/functions/aggregate-functions/topKWeighted",
"reference/functions/aggregate-functions/uniq",
"reference/functions/aggregate-functions/uniqCombined",
"reference/functions/aggregate-functions/uniqCombined64",
"reference/functions/aggregate-functions/uniqExact",
"reference/functions/aggregate-functions/uniqHLL12",
"reference/functions/aggregate-functions/uniqthetasketch",
"reference/functions/aggregate-functions/varPop",
"reference/functions/aggregate-functions/varPopStable",
"reference/functions/aggregate-functions/varSamp",
"reference/functions/aggregate-functions/varSampStable",
"reference/functions/aggregate-functions/welchTTest"
]
}
],
"root": "reference/functions/aggregate-functions/index"
},
{
"expanded": false,
"group": "Table functions",
"pages": [
"reference/functions/table-functions/arrowflight",
"reference/functions/table-functions/azureBlobStorage",
"reference/functions/table-functions/azureBlobStorageCluster",
"reference/functions/table-functions/cluster",
"reference/functions/table-functions/deltalake",
"reference/functions/table-functions/deltalakeCluster",
"reference/functions/table-functions/dictionary",
"reference/functions/table-functions/executable",
"reference/functions/table-functions/file",
"reference/functions/table-functions/fileCluster",
"reference/functions/table-functions/filesystem",
"reference/functions/table-functions/format",
"reference/functions/table-functions/fuzzJSON",
"reference/functions/table-functions/fuzzQuery",
"reference/functions/table-functions/gcs",
"reference/functions/table-functions/generate",
"reference/functions/table-functions/generate_series",
"reference/functions/table-functions/hdfs",
"reference/functions/table-functions/hdfsCluster",
"reference/functions/table-functions/hudi",
"reference/functions/table-functions/hudiCluster",
"reference/functions/table-functions/iceberg",
"reference/functions/table-functions/icebergCluster",
"reference/functions/table-functions/input",
"reference/functions/table-functions/jdbc",
"reference/functions/table-functions/loop",
"reference/functions/table-functions/merge",
"reference/functions/table-functions/mergeTreeIndex",
"reference/functions/table-functions/mergeTreeProjection",
"reference/functions/table-functions/mergeTreeTextIndex",
"reference/functions/table-functions/mongodb",
"reference/functions/table-functions/mysql",
"reference/functions/table-functions/null",
"reference/functions/table-functions/numbers",
"reference/functions/table-functions/odbc",
"reference/functions/table-functions/paimon",
"reference/functions/table-functions/paimonCluster",
"reference/functions/table-functions/postgresql",
"reference/functions/table-functions/primes",
"reference/functions/table-functions/prometheusQuery",
"reference/functions/table-functions/prometheusQueryRange",
"reference/functions/table-functions/redis",
"reference/functions/table-functions/remote",
"reference/functions/table-functions/s3",
"reference/functions/table-functions/s3Cluster",
"reference/functions/table-functions/sqlite",
"reference/functions/table-functions/timeSeriesData",
"reference/functions/table-functions/timeSeriesMetrics",
"reference/functions/table-functions/timeSeriesSamples",
"reference/functions/table-functions/timeSeriesSelector",
"reference/functions/table-functions/timeSeriesTags",
"reference/functions/table-functions/url",
"reference/functions/table-functions/urlCluster",
"reference/functions/table-functions/values",
"reference/functions/table-functions/view",
"reference/functions/table-functions/ytsaurus",
"reference/functions/table-functions/zeros"
],
"root": "reference/functions/table-functions/index"
},
{
"expanded": false,
"group": "Window functions",
"pages": [
"reference/functions/window-functions/cume_dist",
"reference/functions/window-functions/dense_rank",
"reference/functions/window-functions/first_value",
"reference/functions/window-functions/lag",
"reference/functions/window-functions/lagInFrame",
"reference/functions/window-functions/last_value",
"reference/functions/window-functions/lead",
"reference/functions/window-functions/leadInFrame",
"reference/functions/window-functions/nth_value",
"reference/functions/window-functions/percent_rank",
"reference/functions/window-functions/rank",
"reference/functions/window-functions/row_number"
],
"root": "reference/functions/window-functions/index"
},
{
"group": "User Defined Functions",
"pages": [
"reference/functions/regular-functions/udf",
"reference/functions/regular-functions/wasm_udf"
]
}
],
"root": "reference/functions/index"
},
{
"expandable": true,
"expanded": false,
"group": "Formats",
"pages": [
{
"expanded": false,
"group": "Arrow",
"pages": [
"reference/formats/Arrow/Arrow",
"reference/formats/Arrow/ArrowStream"
]
},
{
"expanded": false,
"group": "Avro",
"pages": [
"reference/formats/Avro/Avro",
"reference/formats/Avro/AvroConfluent"
]
},
"reference/formats/BSONEachRow",
"reference/formats/Buffers",
{
"expanded": false,
"group": "CSV",
"pages": [
"reference/formats/CSV/CSV",
"reference/formats/CSV/CSVWithNames",
"reference/formats/CSV/CSVWithNamesAndTypes"
]
},
"reference/formats/CapnProto",
{
"expanded": false,
"group": "CustomSeparated",
"pages": [
"reference/formats/CustomSeparated/CustomSeparated",
"reference/formats/CustomSeparated/CustomSeparatedIgnoreSpaces",
"reference/formats/CustomSeparated/CustomSeparatedIgnoreSpacesWithNames",
"reference/formats/CustomSeparated/CustomSeparatedIgnoreSpacesWithNamesAndTypes",
"reference/formats/CustomSeparated/CustomSeparatedWithNames",
"reference/formats/CustomSeparated/CustomSeparatedWithNamesAndTypes"
]
},
"reference/formats/DWARF",
"reference/formats/Form",
"reference/formats/Hash",
"reference/formats/HiveText",
{
"expanded": false,
"group": "JSON",
"pages": [
"reference/formats/JSON/JSON",
"reference/formats/JSON/JSONAsObject",
"reference/formats/JSON/JSONAsString",
"reference/formats/JSON/JSONColumns",
"reference/formats/JSON/JSONColumnsWithMetadata",
"reference/formats/JSON/JSONCompact",
"reference/formats/JSON/JSONCompactColumns",
"reference/formats/JSON/JSONCompactEachRow",
"reference/formats/JSON/JSONCompactEachRowWithNames",
"reference/formats/JSON/JSONCompactEachRowWithNamesAndTypes",
"reference/formats/JSON/JSONCompactEachRowWithProgress",
"reference/formats/JSON/JSONCompactStrings",
"reference/formats/JSON/JSONCompactStringsEachRow",
"reference/formats/JSON/JSONCompactStringsEachRowWithNames",
"reference/formats/JSON/JSONCompactStringsEachRowWithNamesAndTypes",
"reference/formats/JSON/JSONCompactStringsEachRowWithProgress",
"reference/formats/JSON/JSONEachRow",
"reference/formats/JSON/JSONEachRowWithProgress",
"reference/formats/JSON/JSONLines",
"reference/formats/JSON/JSONObjectEachRow",
"reference/formats/JSON/JSONStrings",
"reference/formats/JSON/JSONStringsEachRow",
"reference/formats/JSON/JSONStringsEachRowWithProgress",
"reference/formats/JSON/PrettyJSONEachRow",
"reference/formats/JSON/format-settings"
]
},
{
"expanded": false,
"group": "LineAsString",
"pages": [
"reference/formats/LineAsString/LineAsString",
"reference/formats/LineAsString/LineAsStringWithNames",
"reference/formats/LineAsString/LineAsStringWithNamesAndTypes"
]
},
"reference/formats/Markdown",
"reference/formats/MsgPack",
"reference/formats/MySQLDump",
"reference/formats/MySQLWire",
"reference/formats/Native",
"reference/formats/Npy",
"reference/formats/Null",
"reference/formats/ODBCDriver2",
"reference/formats/ORC",
"reference/formats/One",
{
"expanded": false,
"group": "Parquet",
"pages": [
"reference/formats/Parquet/Parquet",
"reference/formats/Parquet/ParquetMetadata"
]
},
"reference/formats/PostgreSQLWire",
{
"expanded": false,
"group": "Pretty",
"pages": [
"reference/formats/Pretty/Pretty",
"reference/formats/Pretty/PrettyCompact",
"reference/formats/Pretty/PrettyCompactMonoBlock",
"reference/formats/Pretty/PrettyCompactNoEscapes",
"reference/formats/Pretty/PrettyCompactNoEscapesMonoBlock",
"reference/formats/Pretty/PrettyMonoBlock",
"reference/formats/Pretty/PrettyNoEscapes",
"reference/formats/Pretty/PrettyNoEscapesMonoBlock",
"reference/formats/Pretty/PrettySpace",
"reference/formats/Pretty/PrettySpaceMonoBlock",
"reference/formats/Pretty/PrettySpaceNoEscapes",
"reference/formats/Pretty/PrettySpaceNoEscapesMonoBlock"
]
},
"reference/formats/Prometheus",
{
"expanded": false,
"group": "Protobuf",
"pages": [
"reference/formats/Protobuf/Protobuf",
"reference/formats/Protobuf/ProtobufList",
"reference/formats/Protobuf/ProtobufSingle"
]
},
"reference/formats/RawBLOB",
"reference/formats/Regexp",
{
"expanded": false,
"group": "RowBinary",
"pages": [
"reference/formats/RowBinary/RowBinary",
"reference/formats/RowBinary/RowBinaryWithDefaults",
"reference/formats/RowBinary/RowBinaryWithNames",
"reference/formats/RowBinary/RowBinaryWithNamesAndTypes",
"reference/formats/RowBinary/RowBinaryWithNamesAndTypesAndDefaults"
]
},
"reference/formats/SQLInsert",
{
"expanded": false,
"group": "TabSeparated",
"pages": [
"reference/formats/TabSeparated/TSKV",
"reference/formats/TabSeparated/TabSeparated",
"reference/formats/TabSeparated/TabSeparatedRaw",
"reference/formats/TabSeparated/TabSeparatedRawWithNames",
"reference/formats/TabSeparated/TabSeparatedRawWithNamesAndTypes",
"reference/formats/TabSeparated/TabSeparatedWithNames",
"reference/formats/TabSeparated/TabSeparatedWithNamesAndTypes"
]
},
{
"expanded": false,
"group": "Template",
"pages": [
"reference/formats/Template/Template",
"reference/formats/Template/TemplateIgnoreSpaces"
]
},
"reference/formats/Values",
"reference/formats/Vertical",
"reference/formats/XML"
],
"root": "reference/formats/index"
},
{
"expandable": true,
"expanded": false,
"group": "Settings",
"pages": [
"reference/settings/server-settings/settings",
"reference/settings/session-settings",
"reference/settings/merge-tree-settings",
"reference/settings/formats",
"reference/settings/beta-and-experimental-features"
],
"root": "reference/settings/index"
},
{
"expandable": true,
"expanded": false,
"group": "System Tables",
"pages": [
"reference/system-tables/index",
"reference/system-tables/aggregate_function_combinators",
"reference/system-tables/aggregated_zookeeper_log",
"reference/system-tables/asynchronous_insert_log",
"reference/system-tables/asynchronous_inserts",
"reference/system-tables/asynchronous_loader",
"reference/system-tables/asynchronous_metric_log",
"reference/system-tables/asynchronous_metrics",
"reference/system-tables/azure_queue_log",
"reference/system-tables/azure_queue_metadata_cache",
"reference/system-tables/azure_queue_settings",
"reference/system-tables/backup_log",
"reference/system-tables/backups",
"reference/system-tables/background_schedule_pool",
"reference/system-tables/background_schedule_pool_log",
"reference/system-tables/blob_storage_log",
"reference/system-tables/build_options",
"reference/system-tables/certificates",
"reference/system-tables/clusters",
"reference/system-tables/codecs",
"reference/system-tables/collations",
"reference/system-tables/columns",
"reference/system-tables/completions",
"reference/system-tables/constraints",
"reference/system-tables/contributors",
"reference/system-tables/crash_log",
"reference/system-tables/current_roles",
"reference/system-tables/dashboards",
"reference/system-tables/data_skipping_index_types",
"reference/system-tables/data_skipping_indices",
"reference/system-tables/data_type_families",
"reference/system-tables/database_engines",
"reference/system-tables/database_replicas",
"reference/system-tables/databases",
"reference/system-tables/dead_letter_queue",
"reference/system-tables/delta_metadata_log",
"reference/system-tables/detached_parts",
"reference/system-tables/detached_tables",
"reference/system-tables/dictionaries",
"reference/system-tables/dimensional_metrics",
"reference/system-tables/disks",
"reference/system-tables/distributed_ddl_queue",
"reference/system-tables/distribution_queue",
"reference/system-tables/dns_cache",
"reference/system-tables/dropped_tables",
"reference/system-tables/dropped_tables_parts",
"reference/system-tables/enabled_roles",
"reference/system-tables/error_log",
"reference/system-tables/errors",
"reference/system-tables/events",
"reference/system-tables/fail_points",
"reference/system-tables/formats",
"reference/system-tables/filesystem_cache_log",
"reference/system-tables/filesystem_cache_settings",
"reference/system-tables/filesystem_cache",
"reference/system-tables/filesystem_read_prefetches_log",
"reference/system-tables/functions",
"reference/system-tables/grants",
"reference/system-tables/graphite_retentions",
"reference/system-tables/histogram_metric_log",
"reference/system-tables/histogram_metrics",
"reference/system-tables/iceberg_history",
"reference/system-tables/iceberg_metadata_log",
"reference/system-tables/information_schema",
"reference/system-tables/instrumentation",
"reference/system-tables/jemalloc_bins",
"reference/system-tables/jemalloc_stats",
"reference/system-tables/jemalloc_profile_text",
"reference/system-tables/kafka_consumers",
"reference/system-tables/keywords",
"reference/system-tables/licenses",
"reference/system-tables/macros",
"reference/system-tables/masking_policies",
"reference/system-tables/merge_tree_settings",
"reference/system-tables/merges",
"reference/system-tables/metric_log",
"reference/system-tables/metrics",
"reference/system-tables/models",
"reference/system-tables/moves",
"reference/system-tables/mutations",
"reference/system-tables/named_collections",
"reference/system-tables/numbers",
"reference/system-tables/numbers_mt",
"reference/system-tables/one",
"reference/system-tables/opentelemetry_span_log",
"reference/system-tables/part_log",
"reference/system-tables/part_moves_between_shards",
"reference/system-tables/parts",
"reference/system-tables/parts_columns",
"reference/system-tables/predicate_statistics_log",
"reference/system-tables/primes",
"reference/system-tables/privileges",
"reference/system-tables/processes",
"reference/system-tables/processors_profile_log",
"reference/system-tables/projection_parts",
"reference/system-tables/projection_parts_columns",
"reference/system-tables/projections",
"reference/system-tables/query_cache",
"reference/system-tables/query_condition_cache",
"reference/system-tables/query_log",
"reference/system-tables/query_metric_log",
"reference/system-tables/query_thread_log",
"reference/system-tables/query_views_log",
"reference/system-tables/quota_limits",
"reference/system-tables/quota_usage",
"reference/system-tables/quotas",
"reference/system-tables/quotas_usage",
"reference/system-tables/remote_data_paths",
"reference/system-tables/replicas",
"reference/system-tables/replicated_fetches",
"reference/system-tables/replicated_merge_tree_settings",
"reference/system-tables/replication_queue",
"reference/system-tables/resources",
"reference/system-tables/rocksdb",
"reference/system-tables/role_grants",
"reference/system-tables/roles",
"reference/system-tables/row_policies",
"reference/system-tables/s3_queue_settings",
"reference/system-tables/s3queue_log",
"reference/system-tables/s3queue_metadata_cache",
"reference/system-tables/scheduler",
"reference/system-tables/schema_inference_cache",
"reference/system-tables/server_settings",
"reference/system-tables/session_log",
"reference/system-tables/settings",
"reference/system-tables/settings_changes",
"reference/system-tables/settings_profile_elements",
"reference/system-tables/settings_profiles",
"reference/system-tables/stack_trace",
"reference/system-tables/storage_policies",
"reference/system-tables/symbols",
"reference/system-tables/system_warnings",
"reference/system-tables/table_engines",
"reference/system-tables/table_functions",
"reference/system-tables/tables",
"reference/system-tables/text_log",
"reference/system-tables/time_zones",
"reference/system-tables/tokenizers",
"reference/system-tables/trace_log",
"reference/system-tables/transactions",
"reference/system-tables/transactions_info_log",
"reference/system-tables/unicode",
"reference/system-tables/user_defined_functions",
"reference/system-tables/user_directories",
"reference/system-tables/user_processes",
"reference/system-tables/users",
"reference/system-tables/view_refreshes",
"reference/system-tables/warnings",
"reference/system-tables/workloads",
"reference/system-tables/zeros",
"reference/system-tables/zeros_mt",
"reference/system-tables/zookeeper",
"reference/system-tables/zookeeper_info",
"reference/system-tables/zookeeper_connection",
"reference/system-tables/zookeeper_connection_log",
"reference/system-tables/zookeeper_log",
"reference/system-tables/zookeeper_watches"
],
"root": "reference/system-tables/overview"
},
{
"group": "Data Lakes",
"pages": [],
"root": "reference/datalakes"
}
]
}
],
"tab": "Database"
},
{
"menu": [
{
"href": "#",
"icon": "/images/icons/section-header.svg",
"item": "ClickHouse"
},
{
"groups": [
{
"group": "ClickHouse Cloud",
"pages": [
{
"group": "Get started",
"pages": [
"products/cloud/getting-started/intro",
"products/cloud/getting-started/resource-tour"
],
"root": "products/cloud/getting-started/cloud-get-started"
},
{
"group": "Features",
"pages": [
"products/cloud/features/cloud-tiers",
"products/cloud/features/cli",
"products/cloud/features/integrations",
"products/cloud/features/data-catalogs",
"products/cloud/reference/architecture",
"products/cloud/reference/supported-regions",
{
"expanded": false,
"group": "SQL console",
"pages": [
"products/cloud/features/sql-console-features/sql-console",
"products/cloud/features/sql-console-features/query-insights",
"products/cloud/features/sql-console-features/query-endpoints",
"products/cloud/features/sql-console-features/dashboards",
"products/cloud/features/sql-console-features/hyperdx",
"products/cloud/features/sql-console-features/user-defined-functions"
]
},
{
"expanded": false,
"group": "Infrastructure",
"pages": [
{
"group": "Automatic scaling",
"pages": [
"products/cloud/features/autoscaling/vertical",
"products/cloud/features/autoscaling/horizontal",
"products/cloud/features/autoscaling/make-before-break",
"products/cloud/features/autoscaling/idling",
"products/cloud/features/autoscaling/scaling-recommendations",
"products/cloud/features/autoscaling/scheduled-scaling"
],
"root": "products/cloud/features/autoscaling/overview"
},
"products/cloud/features/infrastructure/parallel-replicas",
"products/cloud/features/infrastructure/deployment-options",
"products/cloud/features/infrastructure/shared-catalog",
"products/cloud/features/infrastructure/shared-merge-tree",
"products/cloud/features/infrastructure/warehouses"
]
},
{
"expanded": false,
"group": "Admin",
"pages": [
{
"group": "Cloud API",
"pages": [
"products/cloud/features/admin-features/api/api-overview",
"products/cloud/features/admin-features/api/openapi",
"products/cloud/features/admin-features/api/postman"
],
"root": "products/cloud/features/admin-features/api/index"
},
"products/cloud/features/admin-features/upgrades"
]
},
"products/cloud/features/security",
{
"expanded": false,
"group": "Monitoring",
"pages": [
"products/cloud/features/monitoring/overview",
"products/cloud/features/monitoring/cloud-console",
"products/cloud/features/monitoring/advanced-dashboard",
"products/cloud/features/monitoring/notifications",
"products/cloud/features/monitoring/prometheus",
"products/cloud/features/monitoring/system-tables",
"products/cloud/features/monitoring/integrations"
]
},
{
"group": "Backups",
"pages": [
"products/cloud/features/backups/faq"
],
"root": "products/cloud/features/backups/overview"
},
"products/cloud/features/support",
{
"expanded": false,
"group": "AI/ML",
"pages": [
"products/cloud/features/ai-ml/ask-ai",
"products/cloud/features/ai-ml/aichat/using-ai-chat",
"products/cloud/features/ai-ml/aichat/customizing-semantic-layer",
"products/cloud/features/ai-ml/langfuse",
"products/cloud/features/ai-ml/remote-mcp",
"products/cloud/features/ai-ml/mcp/remote-mcp",
{
"group": "ClickHouse Agents",
"pages": [
"products/cloud/features/ai-ml/agents/quickstart",
"products/cloud/features/ai-ml/agents/chat",
{
"group": "Agent Builder",
"pages": [
"products/cloud/features/ai-ml/agents/builder/model-parameters",
"products/cloud/features/ai-ml/agents/builder/code-interpreter",
"products/cloud/features/ai-ml/agents/builder/web-search",
"products/cloud/features/ai-ml/agents/builder/image-generation",
"products/cloud/features/ai-ml/agents/builder/vision",
"products/cloud/features/ai-ml/agents/builder/mcp-servers",
"products/cloud/features/ai-ml/agents/builder/skills",
"products/cloud/features/ai-ml/agents/builder/subagents"
],
"root": "products/cloud/features/ai-ml/agents/builder/index"
},
"products/cloud/features/ai-ml/agents/prompts",
"products/cloud/features/ai-ml/agents/memory",
"products/cloud/features/ai-ml/agents/marketplace",
"products/cloud/features/ai-ml/agents/sharing-and-access"
],
"root": "products/cloud/features/ai-ml/agents/index"
},
"products/cloud/features/ai-ml/model-developer-terms"
],
"root": "products/cloud/features/ai-ml/index"
}
]
},
{
"group": "Cloud reference",
"pages": [
"products/cloud/reference/service-uptime",
"products/cloud/reference/account-close",
"products/cloud/reference/data-resiliency",
"products/cloud/reference/settings",
"products/cloud/reference/security/console-roles",
"products/cloud/reference/security/audit-logging",
"products/cloud/reference/security/compliance-overview",
"products/cloud/reference/security/ai-compliance",
"products/cloud/reference/personal-data-access"
],
"root": "products/cloud/reference/index"
},
{
"group": "Billing",
"pages": [
"products/cloud/reference/billing/billing-overview",
{
"expanded": false,
"group": "Marketplace",
"pages": [
"products/cloud/reference/billing/marketplace/overview",
"products/cloud/reference/billing/marketplace/aws-marketplace-committed",
"products/cloud/reference/billing/marketplace/aws-marketplace-payg",
"products/cloud/reference/billing/marketplace/azure-marketplace-committed",
"products/cloud/reference/billing/marketplace/azure-marketplace-payg",
"products/cloud/reference/billing/marketplace/gcp-marketplace-committed",
"products/cloud/reference/billing/marketplace/gcp-marketplace-payg",
"products/cloud/reference/billing/marketplace/migrate-marketplace-payg-committed"
],
"root": "products/cloud/reference/billing/marketplace/index"
},
{
"expanded": false,
"group": "ClickPipes",
"pages": [
"products/cloud/reference/billing/clickpipes/clickpipes-for-cdc",
"products/cloud/reference/billing/clickpipes/clickpipes-for-streaming-and-object-storage"
],
"root": "products/cloud/reference/billing/clickpipes/index"
},
"products/cloud/reference/billing/network-data-transfer",
"products/cloud/reference/billing/payment-thresholds",
"products/cloud/reference/billing/spend-alerts",
"products/cloud/reference/billing/managing-payment-methods",
"products/cloud/reference/billing/billing-compliance"
],
"root": "products/cloud/reference/billing/index"
},
{
"group": "Guides",
"pages": [
{
"group": "Best practices",
"pages": [
"products/cloud/guides/best-practices/multitenancy",
"products/cloud/guides/best-practices/usagelimits"
],
"root": "products/cloud/guides/best-practices/index"
},
{
"expanded": false,
"group": "General",
"pages": [
"products/cloud/guides/cloud-compatibility",
"products/cloud/guides/production-readiness"
]
},
{
"expanded": false,
"group": "Migration",
"pages": [
"products/cloud/guides/migration/upload-a-csv-file",
"products/cloud/guides/migration/oss-to-cloud-backup-restore"
]
},
{
"expanded": false,
"group": "SQL console",
"pages": [
"products/cloud/guides/sql-console/connection-details",
"products/cloud/guides/sql-console/query-endpoints"
]
},
{
"expanded": false,
"group": "Backups",
"pages": [
"products/cloud/guides/backups/review-and-restore-backups",
"products/cloud/guides/backups/configurable-backups",
{
"expanded": false,
"group": "Bring Your Own Backup",
"pages": [
"products/cloud/guides/backups/bring-your-own-backup/export-backups-to-own-cloud-account",
"products/cloud/guides/backups/bring-your-own-backup/backup-restore-from-ui",
"products/cloud/guides/backups/bring-your-own-backup/backup-restore-using-commands"
]
}
],
"root": "products/cloud/guides/backups/index"
},
{
"expanded": false,
"group": "Data sources",
"pages": [
"products/cloud/guides/data-sources/cloud-endpoints-api",
"products/cloud/guides/data-sources/accessing-s3-data-securely",
"products/cloud/guides/data-sources/secure-azure",
"products/cloud/guides/data-sources/secure-gcs",
"products/cloud/guides/data-sources/accessing-iceberg-data-securely"
],
"root": "products/cloud/guides/data-sources/index"
},
{
"expanded": false,
"group": "Infrastructure",
"pages": [
{
"expanded": false,
"group": "Deployment modes",
"pages": [
"products/cloud/guides/infrastructure/deployment-options/clickhouse-private",
"products/cloud/guides/infrastructure/deployment-options/clickhouse-government",
"products/cloud/guides/infrastructure/deployment-options/byoc/overview"
]
}
]
},
{
"expanded": false,
"group": "Security",
"pages": [
{
"expanded": false,
"group": "Cloud access management",
"pages": [
"products/cloud/guides/security/cloud-access-management/manage-my-account",
"products/cloud/guides/security/cloud-access-management/manage-cloud-users",
"products/cloud/guides/security/cloud-access-management/manage-custom-roles",
"products/cloud/guides/security/cloud-access-management/manage-sql-console-role-assignments",
"products/cloud/guides/security/cloud-access-management/manage-database-users",
"products/cloud/guides/security/cloud-access-management/saml-sso-setup",
"products/cloud/guides/security/cloud-access-management/scim-setup",
"products/cloud/guides/security/cloud-access-management/common-access-management-queries",
"products/cloud/guides/security/cloud-access-management/manage-database-service-accounts",
"products/cloud/guides/security/saml-sso-removal"
],
"root": "products/cloud/guides/security/cloud-access-management/index"
},
{
"expanded": false,
"group": "Connectivity",
"pages": [
"products/cloud/guides/security/connectivity/setting-ip-filters",
{
"expanded": false,
"group": "Private networking",
"pages": [
"products/cloud/guides/security/connectivity/private-networking/aws-privatelink",
"products/cloud/guides/security/connectivity/private-networking/gcp-private-service-connect",
"products/cloud/guides/security/connectivity/private-networking/azure-privatelink"
],
"root": "products/cloud/guides/security/connectivity/private-networking/index"
}
]
},
{
"expanded": false,
"group": "Audit logging",
"pages": [
"products/cloud/guides/security/audit-logging/console-audit-log",
"products/cloud/guides/security/audit-logging/database-audit-log",
"products/cloud/guides/security/audit-logging/byoc-security-playbook"
],
"root": "products/cloud/guides/security/audit-logging/index"
},
{
"expanded": false,
"group": "Data security",
"pages": [
"products/cloud/guides/security/data-masking",
"products/cloud/guides/security/cmek"
]
},
{
"expanded": false,
"group": "Compliance",
"pages": [
"products/cloud/guides/security/compliance/hipaa-onboarding",
"products/cloud/guides/security/compliance/pci-onboarding"
]
}
]
}
],
"root": "products/cloud/guides/index"
},
{
"group": "API reference",
"openapi": "https://api.clickhouse.cloud/v1"
}
]
},
{
"group": "Bring Your Own Cloud",
"pages": [
{
"group": "Overview",
"pages": [
"products/bring-your-own-cloud/overview/overview",
"products/bring-your-own-cloud/overview/architecture"
]
},
{
"group": "Configuration",
"pages": [
"products/bring-your-own-cloud/configuration/configurations",
"products/bring-your-own-cloud/configuration/connect",
"products/bring-your-own-cloud/configuration/operations"
]
},
{
"group": "Onboarding",
"pages": [
"products/bring-your-own-cloud/onboarding/aws",
"products/bring-your-own-cloud/onboarding/standard",
{
"group": "Customization",
"pages": [
"products/bring-your-own-cloud/onboarding/customization-aws",
"products/bring-your-own-cloud/onboarding/customization-gcp"
]
},
{
"group": "Network",
"pages": [
"products/bring-your-own-cloud/onboarding/network-aws",
"products/bring-your-own-cloud/onboarding/network-gcp"
],
"root": "products/bring-your-own-cloud/onboarding/network"
},
"products/bring-your-own-cloud/onboarding/new-region",
"products/bring-your-own-cloud/onboarding/azure-private-preview"
]
},
{
"group": "Reference",
"pages": [
"products/bring-your-own-cloud/reference/network-security",
"products/bring-your-own-cloud/reference/privilege",
"products/bring-your-own-cloud/reference/clickhouse-data-access",
"products/bring-your-own-cloud/reference/observability-aws",
"products/bring-your-own-cloud/reference/billable-aws-services",
"products/bring-your-own-cloud/reference/cost-model-aws",
"products/bring-your-own-cloud/reference/aws-service-limits",
"products/bring-your-own-cloud/reference/faq",
"products/bring-your-own-cloud/reference/faq-aws"
]
}
]
}
],
"icon": "/images/icons/icon-clickhouse-cloud.svg",
"item": "ClickHouse Cloud"
},
{
"groups": [
{
"group": "Get started",
"pages": [
"products/managed-postgres/overview",
"products/managed-postgres/quickstart"
]
},
{
"group": "Features",
"pages": [
"products/managed-postgres/connection",
"products/managed-postgres/settings",
"products/managed-postgres/scaling",
"products/managed-postgres/security",
"products/managed-postgres/rbac",
"products/managed-postgres/local-development",
"products/managed-postgres/high-availability",
"products/managed-postgres/read-replicas",
"products/managed-postgres/backup-and-restore",
"products/managed-postgres/extensions",
{
"group": "pg_clickhouse",
"pages": [
"products/managed-postgres/extensions/pg_clickhouse/reference",
"products/managed-postgres/extensions/pg_clickhouse/tutorial"
],
"root": "products/managed-postgres/extensions/pg_clickhouse/introduction"
},
"products/managed-postgres/upgrades",
"products/managed-postgres/openapi",
"products/managed-postgres/terraform"
]
},
{
"group": "Benchmarks",
"pages": [
"products/managed-postgres/benchmarks"
]
},
{
"group": "Pricing",
"pages": [
"products/managed-postgres/pricing"
]
},
{
"group": "ClickHouse Integration",
"pages": [
"products/managed-postgres/clickhouse-integration"
]
},
{
"group": "Migrations",
"pages": [
"products/managed-postgres/migrations/overview",
"products/managed-postgres/migrations/pg_dump-pg_restore",
"products/managed-postgres/migrations/logical-replication",
"products/managed-postgres/migrations/peerdb",
"products/managed-postgres/migrations/clickpipes",
"products/managed-postgres/migrations/data-validation",
"products/managed-postgres/migrations/clickhouse-cloud",
"products/managed-postgres/migrations/faq"
]
},
{
"group": "Monitoring",
"pages": [
"products/managed-postgres/monitoring/overview",
"products/managed-postgres/monitoring/dashboard",
"products/managed-postgres/monitoring/metrics",
"products/managed-postgres/monitoring/prometheus",
"products/managed-postgres/monitoring/query-insights"
]
},
{
"group": "FAQ",
"pages": [
"products/managed-postgres/faq"
]
}
],
"icon": "/images/icons/icon-postgres.svg",
"item": "Managed Postgres"
},
{
"icon": "/images/icons/icon-clickstack.svg",
"item": "ClickStack",
"pages": [
"clickstack/index",
{
"expanded": true,
"group": "Get started",
"pages": [
{
"expanded": true,
"group": "Getting started",
"pages": [
"clickstack/getting-started/managed",
"clickstack/getting-started/oss"
],
"root": "clickstack/getting-started/index"
},
{
"group": "Sample datasets",
"pages": [
"clickstack/example-datasets/sample-data",
"clickstack/example-datasets/kubernetes",
"clickstack/example-datasets/local-data",
"clickstack/example-datasets/remote-demo-data",
"clickstack/example-datasets/session-replay",
"clickstack/example-datasets/chrome-extension",
"clickstack/example-datasets/otelgen"
],
"root": "clickstack/example-datasets/index"
},
"clickstack/architecture",
"clickstack/faq"
],
"root": "clickstack/overview"
},
{
"group": "Features",
"pages": [
{
"group": "Deployment",
"pages": [
{
"group": "Open Source",
"pages": [
"clickstack/deployment/all-in-one",
{
"group": "Helm",
"pages": [
{
"group": "v2.x",
"pages": [
"clickstack/deployment/helm-configuration",
"clickstack/deployment/helm-deployment-options",
"clickstack/deployment/helm-cloud",
"clickstack/deployment/helm-additional-manifests",
"clickstack/deployment/helm-upgrade"
],
"root": "clickstack/deployment/helm"
},
{
"group": "v1.x (deprecated)",
"pages": [
"clickstack/deployment/helm-configuration-v1",
"clickstack/deployment/helm-deployment-options-v1",
"clickstack/deployment/helm-cloud-v1"
],
"root": "clickstack/deployment/helm-v1"
}
]
},
"clickstack/deployment/docker-compose",
"clickstack/deployment/hyperdx-only",
"clickstack/deployment/local-mode-only",
"clickstack/deployment/clickhouse-embedded"
],
"root": "clickstack/deployment/oss"
},
"clickstack/deployment/managed"
],
"root": "clickstack/deployment/overview"
},
"clickstack/features/search",
{
"group": "Dashboards",
"pages": [
"clickstack/features/dashboards/dashboard-templates",
"clickstack/features/dashboards/sql-visualizations",
"clickstack/features/dashboards/row-click-drilldowns"
],
"root": "clickstack/features/dashboards/overview"
},
"clickstack/notebooks",
"clickstack/text-to-chart",
"clickstack/features/event-patterns",
"clickstack/features/event-deltas",
"clickstack/features/alerts",
"clickstack/service-maps",
"clickstack/features/session-replay",
"clickstack/mcp",
{
"group": "Demo days",
"pages": [
{
"group": "2026",
"pages": [
"clickstack/demo-days/2026/2026-06-12",
"clickstack/demo-days/2026/2026-06-05",
"clickstack/demo-days/2026/2026-05-29",
"clickstack/demo-days/2026/2026-05-22",
"clickstack/demo-days/2026/2026-05-15",
"clickstack/demo-days/2026/2026-05-08",
"clickstack/demo-days/2026/2026-04-17",
"clickstack/demo-days/2026/2026-04-10",
"clickstack/demo-days/2026/2026-04-03"
]
}
],
"root": "clickstack/demo-days/index"
}
]
},
{
"expanded": true,
"group": "Managing ClickStack",
"pages": [
"clickstack/managing/admin",
"clickstack/managing/config",
"clickstack/managing/estimating-resources",
"clickstack/managing/materialized-views",
"clickstack/managing/performance-tuning",
"clickstack/managing/production",
"clickstack/managing/rbac",
"clickstack/managing/ttl"
],
"root": "clickstack/managing/overview"
},
{
"group": "Guides",
"pages": [
{
"group": "Ingesting data",
"pages": [
"clickstack/ingesting-data/overview",
"clickstack/ingesting-data/opentelemetry",
"clickstack/ingesting-data/vector",
"clickstack/ingesting-data/collector",
"clickstack/ingesting-data/schemas",
"clickstack/ingesting-data/schema/map-vs-json",
"clickstack/ingesting-data/trace-sampling",
{
"group": "Integrations",
"pages": [
"clickstack/integration-examples/nginx-logs",
"clickstack/integration-examples/nginx-traces",
"clickstack/integration-examples/redis-logs",
"clickstack/integration-examples/redis-metrics",
"clickstack/integration-examples/cloudwatch",
"clickstack/integration-examples/aws-lambda",
{
"group": "Host logs",
"pages": [
"clickstack/integration-examples/host-logs",
"clickstack/integration-examples/host-logs/ec2"
]
},
"clickstack/integration-examples/jvm-metrics",
"clickstack/integration-examples/kafka-metrics",
"clickstack/integration-examples/kubernetes",
"clickstack/integration-examples/mysql",
"clickstack/integration-examples/nodejs-traces",
"clickstack/integration-examples/postgres-logs",
"clickstack/integration-examples/postgres-metrics",
"clickstack/integration-examples/systemd",
"clickstack/integration-examples/temporal",
"clickstack/integration-examples/cloudflare",
"clickstack/integration-examples/kafka-logs",
"clickstack/integration-examples/mongodb-logs"
],
"root": "clickstack/integration-examples/index"
},
{
"group": "Language SDKs",
"pages": [
"clickstack/ingesting-data/sdks/browser",
"clickstack/ingesting-data/sdks/nodejs",
"clickstack/ingesting-data/sdks/python",
"clickstack/ingesting-data/sdks/golang",
"clickstack/ingesting-data/sdks/java",
"clickstack/ingesting-data/sdks/ruby",
"clickstack/ingesting-data/sdks/elixir",
"clickstack/ingesting-data/sdks/deno",
"clickstack/ingesting-data/sdks/nestjs",
"clickstack/ingesting-data/sdks/nextjs",
"clickstack/ingesting-data/sdks/react-native",
"clickstack/ingesting-data/sdks/aws-lambda"
],
"root": "clickstack/ingesting-data/sdks/index"
}
],
"root": "clickstack/ingesting-data/index"
},
{
"expanded": true,
"group": "Migration guides",
"pages": [
{
"group": "Migrating from Elastic",
"pages": [
"clickstack/migration/elastic/intro",
"clickstack/migration/elastic/concepts",
"clickstack/migration/elastic/types",
"clickstack/migration/elastic/search",
"clickstack/migration/elastic/migrating-data",
"clickstack/migration/elastic/migrating-agents",
"clickstack/migration/elastic/migrating-sdks"
],
"root": "clickstack/migration/elastic/index"
}
],
"root": "clickstack/migration/index"
}
]
},
{
"expanded": true,
"group": "Integration partners",
"pages": [
"clickstack/integration-partners/bindplane",
"clickstack/integration-partners/odigos"
],
"root": "clickstack/integration-partners/index"
},
{
"expanded": true,
"group": "API reference",
"openapi": "https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json",
"root": "clickstack/api-reference"
}
]
},
{
"href": "https://langfuse.com/docs",
"icon": "/images/icons/logo-langfuse.svg",
"item": "LangFuse"
},
{
"href": "#",
"icon": "/images/icons/section-header.svg",
"item": "Open source"
},
{
"groups": [
{
"group": "Get started",
"pages": [
"products/agentic-data-stack/overview",
"products/agentic-data-stack/docker-setup"
]
},
{
"group": "Components",
"pages": [
"products/agentic-data-stack/components/librechat",
"products/agentic-data-stack/components/mcp-server",
"products/agentic-data-stack/components/langfuse"
]
}
],
"icon": "/images/icons/icon-agentic-data-stack.svg",
"item": "Agentic Data Stack"
},
{
"groups": [
{
"group": "Get started",
"pages": [
"products/chdb/getting-started"
],
"root": "products/chdb/index"
},
{
"group": "Language integrations",
"pages": [
"products/chdb/install/python",
"products/chdb/install/nodejs",
"products/chdb/install/go",
"products/chdb/install/rust",
"products/chdb/install/bun",
"products/chdb/install/c"
],
"root": "products/chdb/install/index"
},
{
"group": "DataStore",
"pages": [
"products/chdb/datastore/quickstart",
"products/chdb/datastore/factory-methods",
"products/chdb/datastore/query-building",
"products/chdb/datastore/aggregation",
"products/chdb/datastore/accessors",
"products/chdb/datastore/io",
"products/chdb/datastore/execution-model",
"products/chdb/datastore/pandas-compat",
"products/chdb/datastore/class-reference"
],
"root": "products/chdb/datastore/index"
},
{
"group": "Configuration",
"pages": [
"products/chdb/configuration/execution-engine",
"products/chdb/configuration/function-config",
"products/chdb/configuration/performance-mode"
],
"root": "products/chdb/configuration/index"
},
{
"group": "Debugging",
"pages": [
"products/chdb/debugging/explain",
"products/chdb/debugging/logging",
"products/chdb/debugging/profiling"
],
"root": "products/chdb/debugging/index"
},
{
"group": "Developer guides",
"pages": [
"products/chdb/guides/jupysql",
"products/chdb/guides/querying-pandas",
"products/chdb/guides/querying-apache-arrow",
"products/chdb/guides/querying-s3-bucket",
"products/chdb/guides/querying-parquet",
"products/chdb/guides/query-remote-clickhouse",
"products/chdb/guides/clickhouse-local",
"products/chdb/guides/migration-from-pandas",
"products/chdb/guides/pandas-cookbook",
"products/chdb/guides/pandas-differences",
"products/chdb/guides/pandas-performance",
"products/chdb/guides/pandas-to-sql"
],
"root": "products/chdb/guides/index"
},
{
"group": "Technical reference",
"pages": [
"products/chdb/reference/data-formats",
"products/chdb/reference/sql-reference",
"products/chdb/api/python"
],
"root": "products/chdb/reference/index"
}
],
"icon": "/images/icons/icon-chdb.svg",
"item": "chDB"
},
{
"icon": "/images/icons/icon-kubernetes-operator.svg",
"item": "Kubernetes Operator",
"pages": [
"products/kubernetes-operator/overview",
{
"expanded": true,
"group": "Install",
"pages": [
"products/kubernetes-operator/install/kubectl",
"products/kubernetes-operator/install/helm",
"products/kubernetes-operator/install/olm"
]
},
{
"expanded": true,
"group": "Guides",
"pages": [
"products/kubernetes-operator/guides/introduction",
"products/kubernetes-operator/guides/configuration",
"products/kubernetes-operator/guides/storage",
"products/kubernetes-operator/guides/monitoring",
"products/kubernetes-operator/guides/scaling",
"products/kubernetes-operator/guides/tls"
]
},
{
"expanded": true,
"group": "Reference",
"pages": [
"products/kubernetes-operator/reference/api-reference"
]
}
]
},
{
"item": "ClickHouse Private",
"pages": [
"products/clickhouse-private/index",
{
"group": "Tutorials",
"icon": "graduation-cap",
"pages": [
"products/clickhouse-private/tutorials/deploy-clickhouse-on-aws-eks",
"products/clickhouse-private/tutorials/deploy-clickhouse-on-gcp-gke",
"products/clickhouse-private/tutorials/deploy-clickhouse-on-bare-metal",
"products/clickhouse-private/tutorials/deploy-clickhouse-with-fips-compliance-government",
"products/clickhouse-private/tutorials/install-the-clickhouse-private-api"
]
},
{
"group": "How-To Guides",
"icon": "wrench",
"pages": [
"products/clickhouse-private/guides/back-up-and-restore-clickhouse-manual",
"products/clickhouse-private/guides/manage-backups-via-the-private-api",
"products/clickhouse-private/guides/vertically-scale-a-clickhouse-cluster",
"products/clickhouse-private/guides/reset-user-passwords",
"products/clickhouse-private/guides/configure-cert-manager-for-clickhouse-certificates",
"products/clickhouse-private/guides/configure-remote_servers-for-distributed-queries",
"products/clickhouse-private/guides/generate-fips-compliant-certificates-for-clickhouse",
"products/clickhouse-private/guides/integrate-teleport-with-clickhouse-private",
"products/clickhouse-private/guides/configure-alerting-for-clickhouse",
"products/clickhouse-private/guides/set-up-prometheus-monitoring",
"products/clickhouse-private/guides/run-preflight-checks",
"products/clickhouse-private/guides/collect-a-support-bundle-for-troubleshooting",
"products/clickhouse-private/guides/migrate-to-shared-catalog",
"products/clickhouse-private/guides/set-up-hydra-compute-compute-separation",
"products/clickhouse-private/guides/upgrade-clickhouse-private"
]
},
{
"group": "Reference",
"icon": "book",
"pages": [
"products/clickhouse-private/reference/breaking-changes",
"products/clickhouse-private/reference/changelog",
"products/clickhouse-private/reference/component-versions",
"products/clickhouse-private/reference/clickhouse-private-api-reference",
"products/clickhouse-private/reference/infrastructure-requirements-reference",
"products/clickhouse-private/reference/metrics-and-alerts-reference",
"products/clickhouse-private/reference/glossary"
]
},
{
"group": "Explanation",
"icon": "lightbulb",
"pages": [
"products/clickhouse-private/explanation/clickhouse-operator-architecture",
"products/clickhouse-private/explanation/hydra-compute-separation",
"products/clickhouse-private/explanation/pki-and-mtls-in-clickhouse-private",
"products/clickhouse-private/explanation/fips-140-2-compliance-for-clickhouse-private",
"products/clickhouse-private/explanation/backup-strategy-for-clickhouse-private",
"products/clickhouse-private/explanation/faq-troubleshooting",
"products/clickhouse-private/explanation/troubleshooting-guide"
]
}
]
}
],
"tab": "Solutions"
},
{
"menu": [
{
"item": "Ecosystem",
"pages": [
"integrations/home"
]
},
{
"groups": [
{
"group": "ClickPipes for Object Storage",
"icon": "/images/integrations/logos/clickpipes_for_amazon_s3.svg",
"pages": [
{
"group": "Amazon S3",
"icon": "/images/integrations/logos/amazon_s3_logo.svg",
"pages": [
"integrations/clickpipes/object-storage/amazon-s3/overview",
"integrations/clickpipes/object-storage/amazon-s3/get-started",
"integrations/clickpipes/object-storage/amazon-s3/unordered-mode"
]
},
{
"group": "Google Cloud Storage",
"icon": "/images/integrations/logos/gcs.svg",
"pages": [
"integrations/clickpipes/object-storage/google-cloud-storage/overview",
"integrations/clickpipes/object-storage/google-cloud-storage/get-started",
"integrations/clickpipes/object-storage/google-cloud-storage/unordered-mode"
]
},
{
"group": "Azure Blob Storage",
"icon": "/images/integrations/logos/azureblobstorage.svg",
"pages": [
"integrations/clickpipes/object-storage/azure-blob-storage/overview",
"integrations/clickpipes/object-storage/azure-blob-storage/get-started"
]
}
],
"root": "integrations/clickpipes/home"
},
{
"group": "ClickPipes for Postgres",
"icon": "/images/integrations/logos/postgresql.svg",
"pages": [
"integrations/clickpipes/postgres/deduplication",
"integrations/clickpipes/postgres/ordering-keys",
"integrations/clickpipes/postgres/toast",
"integrations/clickpipes/postgres/connecting-to-postgresql",
"integrations/clickpipes/postgres/inserting-data",
"integrations/clickpipes/postgres/schema-changes",
"integrations/clickpipes/postgres/faq",
"integrations/clickpipes/postgres/postgres-generated-columns",
"integrations/clickpipes/postgres/parallel-initial-load",
"integrations/clickpipes/postgres/lifecycle",
"integrations/clickpipes/postgres/auth",
{
"group": "Operations",
"pages": [
"integrations/clickpipes/postgres/add-table",
"integrations/clickpipes/postgres/pause-and-resume",
"integrations/clickpipes/postgres/remove-table",
"integrations/clickpipes/postgres/table-resync",
"integrations/clickpipes/postgres/resync",
"integrations/clickpipes/postgres/controlling-sync",
"integrations/clickpipes/postgres/scaling"
]
},
{
"group": "Source",
"pages": [
"integrations/clickpipes/postgres/source/alloydb",
"integrations/clickpipes/postgres/source/rds",
"integrations/clickpipes/postgres/source/aurora",
"integrations/clickpipes/postgres/source/supabase",
"integrations/clickpipes/postgres/source/google-cloudsql",
"integrations/clickpipes/postgres/source/azure-flexible-server-postgres",
"integrations/clickpipes/postgres/source/neon-postgres",
"integrations/clickpipes/postgres/source/crunchy-postgres",
"integrations/clickpipes/postgres/source/generic",
"integrations/clickpipes/postgres/source/timescale",
"integrations/clickpipes/postgres/source/planetscale"
]
}
],
"root": "integrations/clickpipes/postgres/index"
},
{
"group": "ClickPipes for Kafka",
"icon": "/images/integrations/logos/kafka.svg",
"pages": [
"integrations/clickpipes/kafka/create-kafka-clickpipe",
"integrations/clickpipes/kafka/schema-registries",
"integrations/clickpipes/kafka/reference",
"integrations/clickpipes/kafka/best-practices",
"integrations/clickpipes/kafka/faq"
],
"root": "integrations/clickpipes/kafka/index"
},
{
"group": "ClickPipes for Kinesis",
"icon": "/images/integrations/logos/amazon_kinesis_logo.svg",
"pages": [
"integrations/clickpipes/kinesis/overview",
"integrations/clickpipes/kinesis/auth"
],
"root": "integrations/clickpipes/kinesis/index"
},
{
"group": "ClickPipes for GCP Pub/Sub",
"icon": "/images/integrations/logos/google_pubsub.svg",
"pages": [
"integrations/clickpipes/pubsub/overview",
"integrations/clickpipes/pubsub/auth"
],
"root": "integrations/clickpipes/pubsub/index"
},
{
"group": "ClickPipes for MySQL",
"icon": "/images/integrations/logos/mysql.svg",
"pages": [
"integrations/clickpipes/mysql/faq",
"integrations/clickpipes/mysql/datatypes",
"integrations/clickpipes/mysql/parallel-initial-load",
"integrations/clickpipes/mysql/schema-changes",
"integrations/clickpipes/mysql/lifecycle",
{
"group": "Operations",
"pages": [
"integrations/clickpipes/mysql/add-table",
"integrations/clickpipes/mysql/pause-and-resume",
"integrations/clickpipes/mysql/remove-table",
"integrations/clickpipes/mysql/table-resync",
"integrations/clickpipes/mysql/resync",
"integrations/clickpipes/mysql/controlling-sync",
"integrations/clickpipes/mysql/scaling"
]
},
{
"group": "Source",
"pages": [
"integrations/clickpipes/mysql/source/rds",
"integrations/clickpipes/mysql/source/aurora",
"integrations/clickpipes/mysql/source/gcp",
"integrations/clickpipes/mysql/source/azure-flexible-server-mysql",
"integrations/clickpipes/mysql/source/generic",
"integrations/clickpipes/mysql/source/rds-maria",
"integrations/clickpipes/mysql/source/generic-maria"
]
}
],
"root": "integrations/clickpipes/mysql/index"
},
{
"group": "ClickPipes for MongoDB",
"icon": "/images/integrations/logos/mongodb.svg",
"pages": [
"integrations/clickpipes/mongodb/datatypes",
"integrations/clickpipes/mongodb/quickstart",
"integrations/clickpipes/mongodb/lifecycle",
"integrations/clickpipes/mongodb/faq",
{
"group": "Operations",
"pages": [
"integrations/clickpipes/mongodb/add-table",
"integrations/clickpipes/mongodb/remove-table",
"integrations/clickpipes/mongodb/pause-and-resume",
"integrations/clickpipes/mongodb/table-resync",
"integrations/clickpipes/mongodb/resync",
"integrations/clickpipes/mongodb/controlling-sync",
"integrations/clickpipes/mongodb/scaling"
]
},
{
"group": "Source",
"pages": [
"integrations/clickpipes/mongodb/source/atlas",
"integrations/clickpipes/mongodb/source/generic",
"integrations/clickpipes/mongodb/source/documentdb"
]
}
],
"root": "integrations/clickpipes/mongodb/index"
},
{
"group": "ClickPipes for BigQuery",
"icon": "/images/logo-bigquery.svg",
"pages": [
"integrations/clickpipes/bigquery/overview",
"integrations/clickpipes/bigquery/get-started"
]
},
{
"group": "Programmatic access",
"icon": "code",
"pages": [
"integrations/clickpipes/programmatic-access/openapi",
"integrations/clickpipes/programmatic-access/terraform"
]
},
{
"group": "Other",
"icon": "ellipsis",
"pages": [
"integrations/clickpipes/aws-privatelink",
"integrations/clickpipes/dynamodb",
"integrations/clickpipes/monitoring"
]
}
],
"icon": "/images/icons/icon-clickpipes.svg",
"item": "ClickPipes",
"root": "integrations/clickpipes/home"
},
{
"groups": [
{
"group": "Home",
"icon": "house",
"pages": [],
"root": "integrations/language-clients/index"
},
{
"group": "JavaScript",
"icon": "/images/integrations/logos/node_js.svg",
"pages": [],
"root": "integrations/language-clients/js"
},
{
"expanded": true,
"group": "Python",
"icon": "/images/integrations/logos/notext-python.svg",
"pages": [
"integrations/language-clients/python/driver-api",
"integrations/language-clients/python/additional-options",
"integrations/language-clients/python/advanced-querying",
"integrations/language-clients/python/advanced-inserting",
"integrations/language-clients/python/advanced-usage",
"integrations/language-clients/python/sqlalchemy"
],
"root": "integrations/language-clients/python/index"
},
{
"expanded": true,
"group": "Go",
"icon": "/images/integrations/logos/golang.svg",
"pages": [
"integrations/language-clients/go/clickhouse-api",
"integrations/language-clients/go/configuration",
"integrations/language-clients/go/config-reference",
"integrations/language-clients/go/data-types",
"integrations/language-clients/go/database-sql-api"
],
"root": "integrations/language-clients/go/index"
},
{
"expanded": true,
"group": "Java",
"icon": "/images/integrations/logos/java.svg",
"pages": [
"integrations/language-clients/java/client",
"integrations/language-clients/java/jdbc",
"integrations/language-clients/java/r2dbc",
"integrations/language-clients/java/date-time-guide"
],
"root": "integrations/language-clients/java/index"
},
{
"group": "C#",
"icon": "/images/integrations/logos/csharp.svg",
"pages": [],
"root": "integrations/language-clients/csharp/overview"
},
{
"group": "Rust",
"icon": "/images/integrations/logos/rust.webp",
"pages": [],
"root": "integrations/language-clients/rust"
},
{
"group": "C++",
"icon": "/images/integrations/logos/logo_cpp.svg",
"pages": [],
"root": "integrations/language-clients/cpp"
},
{
"group": "C",
"icon": "/images/integrations/logos/logo_c.svg",
"pages": [],
"root": "integrations/language-clients/c"
},
{
"group": "Third-party clients",
"icon": "users",
"pages": [
"integrations/language-clients/third-party/moose-olap",
"integrations/language-clients/third-party/client-libraries"
]
}
],
"icon": "/images/icons/icon-language-clients.svg",
"item": "Language clients"
},
{
"groups": [
{
"group": "Data sources",
"pages": [
{
"expanded": false,
"group": "AWS S3",
"pages": [
"integrations/connectors/data-ingestion/AWS/integrating-s3-with-clickhouse",
"integrations/connectors/data-ingestion/AWS/performance",
"integrations/connectors/data-ingestion/AWS/creating-an-s3-iam-role-and-bucket"
]
},
"integrations/connectors/data-sources/postgres",
{
"expanded": false,
"group": "Kafka",
"pages": [
"integrations/connectors/data-ingestion/kafka/kafka-clickhouse-connect-sink",
"integrations/connectors/data-ingestion/kafka/confluent/confluent-cloud",
"integrations/connectors/data-ingestion/kafka/confluent/custom-connector",
"integrations/connectors/data-ingestion/kafka/msk/index",
"integrations/connectors/data-ingestion/kafka/kafka-vector",
"integrations/connectors/data-ingestion/kafka/kafka-table-engine",
"integrations/connectors/data-ingestion/kafka/confluent/index",
"integrations/connectors/data-ingestion/kafka/confluent/kafka-connect-http",
"integrations/connectors/data-ingestion/kafka/kafka-connect-jdbc",
"integrations/connectors/data-ingestion/kafka/kafka-table-engine-named-collections"
],
"root": "integrations/connectors/data-ingestion/kafka/index"
},
"integrations/connectors/data-sources/mysql",
"integrations/connectors/data-sources/cassandra",
"integrations/connectors/data-sources/gcs",
"integrations/connectors/data-ingestion/s3-minio",
"integrations/connectors/data-ingestion/emqx/index",
"integrations/connectors/data-ingestion/insert-local-files",
"integrations/connectors/data-ingestion/jdbc-with-clickhouse",
"integrations/connectors/data-ingestion/odbc-with-clickhouse"
],
"root": "integrations/connectors/data-sources/index"
},
{
"expanded": true,
"group": "Data visualization",
"pages": [
{
"expanded": false,
"group": "Grafana",
"pages": [
"integrations/connectors/data-visualization/grafana/query-builder",
"integrations/connectors/data-visualization/grafana/config"
],
"root": "integrations/connectors/data-visualization/grafana/index"
},
"integrations/connectors/data-visualization/lightdash-and-clickhouse",
"integrations/connectors/data-visualization/looker-and-clickhouse",
"integrations/connectors/data-visualization/looker-studio-and-clickhouse",
"integrations/connectors/data-visualization/metabase-and-clickhouse",
"integrations/connectors/data-visualization/omni-and-clickhouse",
"integrations/connectors/data-visualization/powerbi-and-clickhouse",
"integrations/connectors/data-visualization/quicksight-and-clickhouse",
"integrations/connectors/data-visualization/superset-and-clickhouse",
"integrations/connectors/data-visualization/splunk-and-clickhouse",
{
"expanded": false,
"group": "Tableau",
"pages": [
"integrations/connectors/data-visualization/tableau/tableau-and-clickhouse",
"integrations/connectors/data-visualization/tableau/tableau-online-and-clickhouse",
"integrations/connectors/data-visualization/tableau/tableau-connection-tips",
"integrations/connectors/data-visualization/tableau/tableau-analysis-tips"
]
},
{
"expanded": false,
"group": "Community integrations",
"pages": [
"integrations/connectors/data-visualization/community-integrations/astrato-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/chartbrew-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/databrain-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/deepnote",
"integrations/connectors/data-visualization/community-integrations/dot-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/draxlr-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/embeddable-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/explo-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/fabi-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/hashboard-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/luzmo-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/mitzu-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/rocketbi-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/zingdata-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/querio-and-clickhouse",
"integrations/connectors/data-visualization/community-integrations/holistics-and-clickhouse"
]
}
],
"root": "integrations/connectors/data-visualization/index"
},
{
"expanded": true,
"group": "Data ingestion",
"pages": [
"integrations/connectors/data-ingestion/etl-tools/airbyte-and-clickhouse",
"integrations/connectors/data-ingestion/etl-tools/airflow-and-clickhouse",
"integrations/connectors/data-ingestion/etl-tools/apify-and-clickhouse",
{
"expanded": false,
"group": "Apache Spark",
"pages": [
"integrations/connectors/data-ingestion/apache-spark/spark-native-connector",
"integrations/connectors/data-ingestion/apache-spark/databricks",
"integrations/connectors/data-ingestion/apache-spark/spark-jdbc"
],
"root": "integrations/connectors/data-ingestion/apache-spark/index"
},
"integrations/connectors/data-ingestion/apache-flink",
"integrations/connectors/data-ingestion/AWS/glue",
{
"expanded": false,
"group": "Azure Data Factory",
"pages": [
"integrations/connectors/data-ingestion/azure/azure-data-factory/overview",
"integrations/connectors/data-ingestion/azure/azure-data-factory/using-azureblobstorage",
"integrations/connectors/data-ingestion/azure/azure-data-factory/using-http-interface"
],
"root": "integrations/connectors/data-ingestion/azure/azure-data-factory/index"
},
"integrations/connectors/data-ingestion/azure/azure-synapse",
"integrations/connectors/data-ingestion/etl-tools/apache-beam",
{
"expanded": false,
"group": "Google Dataflow",
"pages": [
"integrations/connectors/data-ingestion/GCP/google-dataflow/dataflow",
"integrations/connectors/data-ingestion/GCP/google-dataflow/java-runner",
"integrations/connectors/data-ingestion/GCP/google-dataflow/templates",
{
"expanded": false,
"group": "Dataflow templates",
"pages": [
"integrations/connectors/data-ingestion/GCP/google-dataflow/templates/bigquery-to-clickhouse",
"integrations/connectors/data-ingestion/GCP/google-dataflow/templates/pubsub-to-clickhouse"
]
}
]
},
"integrations/connectors/data-ingestion/etl-tools/bladepipe-and-clickhouse",
{
"expanded": false,
"group": "dbt",
"pages": [
"integrations/connectors/data-ingestion/etl-tools/dbt/features-and-configurations",
"integrations/connectors/data-ingestion/etl-tools/dbt/materializations",
"integrations/connectors/data-ingestion/etl-tools/dbt/materialization-materialized-view",
"integrations/connectors/data-ingestion/etl-tools/dbt/guides"
],
"root": "integrations/connectors/data-ingestion/etl-tools/dbt/index"
},
"integrations/connectors/data-ingestion/etl-tools/dlt-and-clickhouse",
{
"group": "Fivetran",
"pages": [
"integrations/connectors/data-ingestion/etl-tools/fivetran/reference",
"integrations/connectors/data-ingestion/etl-tools/fivetran/troubleshooting"
],
"root": "integrations/connectors/data-ingestion/etl-tools/fivetran/index"
},
"integrations/connectors/data-ingestion/etl-tools/nifi-and-clickhouse",
"integrations/connectors/data-ingestion/etl-tools/vector-to-clickhouse",
{
"expanded": false,
"group": "Streamkap",
"pages": [
"integrations/connectors/data-ingestion/streamkap/streamkap-and-clickhouse",
"integrations/connectors/data-ingestion/streamkap/sql-server-clickhouse"
]
},
{
"expanded": false,
"group": "Community integrations",
"pages": [
"integrations/connectors/data-ingestion/community-integrations/artie-and-clickhouse",
"integrations/connectors/data-ingestion/community-integrations/estuary"
]
}
],
"root": "integrations/connectors/data-ingestion/index"
},
{
"expanded": true,
"group": "Data integrations",
"pages": [
"integrations/connectors/data-integrations/integrations/retool",
"integrations/connectors/data-integrations/integrations/easypanel",
"integrations/connectors/data-integrations/integrations/middleware",
"integrations/connectors/data-integrations/integrations/notion",
"integrations/connectors/data-integrations/integrations/splunk"
],
"root": "integrations/connectors/tools/data-integration-index"
},
{
"expanded": true,
"group": "SQL-clients",
"pages": [
"integrations/connectors/sql-clients/sql-console",
"integrations/connectors/sql-clients/datagrip",
"integrations/connectors/sql-clients/dbeaver",
"integrations/connectors/sql-clients/dbvisualizer",
"integrations/connectors/sql-clients/jupysql",
"integrations/connectors/sql-clients/qstudio",
"integrations/connectors/sql-clients/tablum",
"integrations/connectors/sql-clients/marimo",
"integrations/connectors/sql-clients/cli"
],
"root": "integrations/connectors/sql-clients/index"
},
{
"expanded": true,
"group": "Tools",
"pages": [
"integrations/connectors/tools/gui",
"integrations/connectors/tools/proxy",
"integrations/connectors/tools/third-party-libraries"
],
"root": "integrations/connectors/tools/index"
}
],
"icon": "/images/icons/icon-connectors.svg",
"item": "Connectors"
}
],
"tab": "Integrations"
},
{
"menu": [
{
"groups": [
{
"group": "Knowledgebase",
"pages": [
{
"group": "Performance & optimization",
"pages": [
"resources/support-center/knowledge-base/performance-optimization/insert-select-settings-tuning",
"resources/support-center/knowledge-base/performance-optimization/async-vs-optimize-read-in-order",
"resources/support-center/knowledge-base/performance-optimization/check-query-processing-time-only",
"resources/support-center/knowledge-base/performance-optimization/find-expensive-queries",
"resources/support-center/knowledge-base/performance-optimization/finding-expensive-queries-by-memory-usage",
"resources/support-center/knowledge-base/performance-optimization/improve-map-performance",
"resources/support-center/knowledge-base/performance-optimization/memory-limit-exceeded-for-query",
"resources/support-center/knowledge-base/performance-optimization/optimize-final-vs-final",
"resources/support-center/knowledge-base/performance-optimization/query-max-execution-time",
"resources/support-center/knowledge-base/performance-optimization/tips-tricks-optimizing-basic-data-types-in-clickhouse",
"resources/support-center/knowledge-base/performance-optimization/why-is-my-primary-key-not-used"
]
},
{
"group": "Cloud",
"pages": [
"resources/support-center/knowledge-base/cloud-services/aws-privatelink-setup-for-clickpipes",
"resources/support-center/knowledge-base/cloud-services/aws-privatelink-setup-for-msk-clickpipes",
"resources/support-center/knowledge-base/cloud-services/change-billing-email",
"resources/support-center/knowledge-base/cloud-services/clickhouse-cloud-api-usage",
"resources/support-center/knowledge-base/cloud-services/custom-dns-alias-for-instance",
"resources/support-center/knowledge-base/cloud-services/execute-system-queries-in-cloud",
"resources/support-center/knowledge-base/cloud-services/how-to-check-my-clickhouse-cloud-sevice-state",
"resources/support-center/knowledge-base/cloud-services/how-to-connect-to-ch-cloud-using-ssh-keys",
"resources/support-center/knowledge-base/cloud-services/ingest-failures-23-9-release",
"resources/support-center/knowledge-base/cloud-services/multi-region-replication",
"resources/support-center/knowledge-base/cloud-services/unable-to-access-cloud-service"
]
},
{
"group": "Data import & export",
"pages": [
"resources/support-center/knowledge-base/data-import-export/achieving-atomic-inserts",
"resources/support-center/knowledge-base/data-import-export/cannot-append-data-to-parquet-format",
"resources/support-center/knowledge-base/data-import-export/file-export",
"resources/support-center/knowledge-base/data-import-export/importing-geojason-with-nested-object-array",
"resources/support-center/knowledge-base/data-import-export/importing-and-working-with-json-array-objects",
"resources/support-center/knowledge-base/data-import-export/ingest-parquet-files-in-s3",
"resources/support-center/knowledge-base/data-import-export/json-import",
"resources/support-center/knowledge-base/data-import-export/json-extract-example",
"resources/support-center/knowledge-base/data-import-export/json-simple-example",
"resources/support-center/knowledge-base/data-import-export/kafka-clickhouse-json",
"resources/support-center/knowledge-base/data-import-export/kafka-to-clickhouse-setup",
"resources/support-center/knowledge-base/data-import-export/mysql-to-parquet-csv-json",
"resources/support-center/knowledge-base/data-import-export/parquet-to-csv-json",
"resources/support-center/knowledge-base/data-import-export/postgresql-to-parquet-csv-json",
"resources/support-center/knowledge-base/data-import-export/s3-export-data-year-month-folders"
]
},
{
"group": "Configuration & settings",
"pages": [
"resources/support-center/knowledge-base/configuration-settings/about-quotas-and-query-complexity",
"resources/support-center/knowledge-base/configuration-settings/alter-user-settings-exception",
"resources/support-center/knowledge-base/configuration-settings/change-the-prompt-in-clickhouse-client",
"resources/support-center/knowledge-base/configuration-settings/configure-a-user-setting",
"resources/support-center/knowledge-base/configuration-settings/configure-cap-ipc-lock-and-cap-sys-nice-in-docker",
"resources/support-center/knowledge-base/configuration-settings/ignoring-incorrect-settings",
"resources/support-center/knowledge-base/configuration-settings/maximum-number-of-tables-and-databases"
]
},
{
"group": "Integrations & client libraries",
"pages": [
"resources/support-center/knowledge-base/integrations/node-js-example",
"resources/support-center/knowledge-base/integrations/ODBC-authentication-failed-error-using-PowerBI-CH-connector",
"resources/support-center/knowledge-base/integrations/oracle-odbc",
"resources/support-center/knowledge-base/integrations/how-to-set-up-ch-on-docker-odbc-connect-mssql",
"resources/support-center/knowledge-base/integrations/python-clickhouse-connect-example",
"resources/support-center/knowledge-base/integrations/python-http-requests",
"resources/support-center/knowledge-base/integrations/terraform-example"
]
},
{
"group": "Troubleshooting & errors",
"pages": [
"resources/support-center/troubleshooting/troubleshooting",
"resources/support-center/knowledge-base/troubleshooting/certificate-verify-failed-error",
"resources/support-center/knowledge-base/troubleshooting/configure-cap-ipc-lock-and-cap-sys-nice-in-docker",
"resources/support-center/knowledge-base/troubleshooting/connection-timeout-remote-remoteSecure",
"resources/support-center/knowledge-base/troubleshooting/count-parts-by-type",
"resources/support-center/knowledge-base/troubleshooting/exception-too-many-parts",
"resources/support-center/knowledge-base/troubleshooting/fix-developer-verification-error-in-macos",
"resources/support-center/knowledge-base/troubleshooting/part-intersects-previous-part"
],
"root": "resources/support-center/troubleshooting/index"
},
{
"group": "Tables & schema",
"pages": [
"resources/support-center/knowledge-base/tables-schema/add-column",
"resources/support-center/knowledge-base/tables-schema/delete-old-data",
"resources/support-center/knowledge-base/tables-schema/exchangeStatementToSwitchTables",
"resources/support-center/knowledge-base/tables-schema/how-to-create-table-to-query-multiple-remote-clusters",
"resources/support-center/knowledge-base/tables-schema/recreate-table-across-terminals",
"resources/support-center/knowledge-base/tables-schema/schema-migration-tools",
"resources/support-center/knowledge-base/tables-schema/search-across-node-for-tables-with-a-wildcard"
]
},
{
"group": "Queries & SQL",
"pages": [
"resources/support-center/knowledge-base/queries-sql/calculate-pi-using-sql",
"resources/support-center/knowledge-base/queries-sql/compare-resultsets",
"resources/support-center/knowledge-base/queries-sql/comparing-metrics-between-queries",
"resources/support-center/knowledge-base/queries-sql/filtered-aggregates",
"resources/support-center/knowledge-base/queries-sql/how-to-filter-a-clickhouse-table-by-an-array-column",
"resources/support-center/knowledge-base/queries-sql/how-to-insert-all-rows-from-another-table",
"resources/support-center/knowledge-base/queries-sql/pivot",
"resources/support-center/knowledge-base/queries-sql/useful-queries-for-troubleshooting",
"resources/support-center/knowledge-base/queries-sql/using-array-join-to-extract-and-query-attributes"
]
},
{
"group": "Materialized views & projections",
"pages": [
"resources/support-center/knowledge-base/materialized-views/are-materialized-views-inserted-asynchronously",
"resources/support-center/knowledge-base/materialized-views/how-to-display-queries-using-mv",
"resources/support-center/knowledge-base/materialized-views/how-to-use-parametrised-views",
"resources/support-center/knowledge-base/materialized-views/projection-example"
]
},
{
"group": "Monitoring & debugging",
"pages": [
"resources/support-center/knowledge-base/monitoring-debugging/check-query-cache-in-use",
"resources/support-center/knowledge-base/monitoring-debugging/generate-har-file",
"resources/support-center/knowledge-base/monitoring-debugging/mapping-of-system-metrics-to-prometheus-metrics",
"resources/support-center/knowledge-base/monitoring-debugging/outputSendLogsLevelTracesToFile",
"resources/support-center/knowledge-base/monitoring-debugging/profiling-clickhouse-with-llvm-xray",
"resources/support-center/knowledge-base/monitoring-debugging/send-logs-level",
"resources/support-center/knowledge-base/monitoring-debugging/which-processes-are-currently-running",
"resources/support-center/knowledge-base/monitoring-debugging/view-number-of-active-mutations",
"resources/support-center/knowledge-base/monitoring-debugging/why-default-logging-verbose"
]
},
{
"group": "Security & access control",
"pages": [
"resources/support-center/knowledge-base/security/check-users-roles",
"resources/support-center/knowledge-base/security/common-rbac-queries",
"resources/support-center/knowledge-base/security/remove-default-user",
"resources/support-center/knowledge-base/security/row-column-policy",
"resources/support-center/knowledge-base/security/windows-active-directory-to-ch-roles"
]
},
{
"group": "Data management",
"pages": [
"resources/support-center/knowledge-base/data-management/backing-up-a-specific-partition",
"resources/support-center/knowledge-base/data-management/calculate-ratio-of-zero-sparse-serialization",
"resources/support-center/knowledge-base/data-management/dictionaries-consistent-state",
"resources/support-center/knowledge-base/data-management/dictionary-using-strings",
"resources/support-center/knowledge-base/data-management/read-consistency",
"resources/support-center/knowledge-base/data-management/when-is-ttl-applied"
]
},
{
"group": "Setup & installation",
"pages": [
"resources/support-center/knowledge-base/setup-installation/difference-between-official-builds-and-3rd-party",
"resources/support-center/knowledge-base/setup-installation/enabling-ssl-with-lets-encrypt",
"resources/support-center/knowledge-base/setup-installation/how-to-increase-thread-pool-size",
"resources/support-center/knowledge-base/setup-installation/install-clickhouse-windows10",
"resources/support-center/knowledge-base/setup-installation/llvm-clang-up-to-date",
"resources/support-center/knowledge-base/setup-installation/production"
]
},
{
"group": "General & FAQs",
"pages": [
{
"group": "General",
"pages": [
"resources/support-center/knowledge-base/general-faqs/columnar-database",
"resources/support-center/knowledge-base/general-faqs/concurrency",
"resources/support-center/knowledge-base/general-faqs/cost-based",
"resources/support-center/knowledge-base/general-faqs/datalake",
"resources/support-center/knowledge-base/general-faqs/dbms-naming",
"resources/support-center/knowledge-base/general-faqs/dependencies",
"resources/support-center/knowledge-base/general-faqs/distributed-join",
"resources/support-center/knowledge-base/general-faqs/federated",
"resources/support-center/knowledge-base/general-faqs/how-do-i-contribute-code-to-clickhouse",
"resources/support-center/knowledge-base/general-faqs/mapreduce",
"resources/support-center/knowledge-base/general-faqs/ne-tormozit",
"resources/support-center/knowledge-base/general-faqs/olap",
"resources/support-center/knowledge-base/general-faqs/sql",
"resources/support-center/knowledge-base/general-faqs/updates",
"resources/support-center/knowledge-base/general-faqs/who-is-using-clickhouse",
"resources/support-center/knowledge-base/general-faqs/why-recommend-clickhouse-keeper-over-zookeeper"
],
"root": "resources/support-center/knowledge-base/general-faqs/index"
},
{
"group": "Use cases",
"pages": [
"resources/support-center/knowledge-base/general-faqs/key-value",
"resources/support-center/knowledge-base/general-faqs/time-series",
"resources/support-center/knowledge-base/general-faqs/use-clickhouse-for-log-analytics",
"resources/support-center/knowledge-base/general-faqs/vector-search"
],
"root": "resources/support-center/knowledge-base/general-faqs/use-cases-index"
},
{
"group": "Integration",
"pages": [
"resources/support-center/knowledge-base/data-import-export/json-import",
"resources/support-center/knowledge-base/integrations/oracle-odbc"
],
"root": "resources/support-center/knowledge-base/integrations/index"
},
{
"group": "Operations",
"pages": [
"resources/support-center/knowledge-base/tables-schema/delete-old-data",
"resources/support-center/knowledge-base/cloud-services/multi-region-replication",
"resources/support-center/knowledge-base/setup-installation/production",
"resources/support-center/knowledge-base/general-faqs/separate-storage"
],
"root": "resources/support-center/knowledge-base/general-faqs/operations-index"
}
],
"root": "resources/support-center/knowledge-base/general-faqs/faq-index"
},
{
"group": "Tips & tricks",
"pages": [
"resources/support-center/tips-and-tricks/community-wisdom",
"resources/support-center/tips-and-tricks/cost-optimization",
"resources/support-center/tips-and-tricks/debugging-insights",
"resources/support-center/tips-and-tricks/materialized-views",
"resources/support-center/tips-and-tricks/performance-optimization",
"resources/support-center/tips-and-tricks/success-stories",
"resources/support-center/tips-and-tricks/too-many-parts"
]
}
],
"root": "resources/support-center/home"
}
],
"icon": "/images/icons/icon-support-center.svg",
"item": "Support center"
},
{
"groups": [
{
"group": "Introduction",
"pages": [
"resources/develop-contribute/introduction/developer-instruction",
"resources/develop-contribute/introduction/architecture"
]
},
{
"group": "Building",
"pages": [
"resources/develop-contribute/build/build",
"resources/develop-contribute/build/build-osx",
"resources/develop-contribute/build/build-cross-osx",
"resources/develop-contribute/build/build-cross-arm",
"resources/develop-contribute/build/build-cross-riscv",
"resources/develop-contribute/build/build-cross-s390x",
"resources/develop-contribute/build/build-cross-loongarch",
"resources/develop-contribute/build/build-e2k"
]
},
{
"group": "Native protocol",
"pages": [
"resources/develop-contribute/native-protocol/basics",
"resources/develop-contribute/native-protocol/client",
"resources/develop-contribute/native-protocol/server",
"resources/develop-contribute/native-protocol/columns",
"resources/develop-contribute/native-protocol/hash"
]
},
{
"group": "Contributing",
"pages": [
"resources/develop-contribute/contribute/tests",
"resources/develop-contribute/contribute/continuous-integration",
"resources/develop-contribute/contribute/contrib",
"resources/develop-contribute/contribute/style",
"resources/develop-contribute/contribute/building-and-benchmarking-deflate-qpl",
"resources/develop-contribute/contribute/integrating-rust-libraries",
"resources/develop-contribute/contribute/profile-guided-optimization",
"resources/develop-contribute/contribute/backports"
]
},
{
"group": "Integration development",
"pages": [
"resources/develop-contribute/integrations/building-integrations",
"resources/develop-contribute/integrations/testing-your-integration",
"resources/develop-contribute/integrations/documenting-your-integration"
],
"root": "resources/develop-contribute/integrations/index"
},
{
"group": "Roadmap",
"pages": [
"resources/develop-contribute/roadmap"
]
}
],
"icon": "/images/icons/icon-contribute.svg",
"item": "Development & contributing",
"root": "resources/develop-contribute/index"
},
{
"groups": [
{
"group": "Cloud",
"pages": [
"resources/changelogs/cloud/2026",
{
"group": "Archive",
"pages": [
"resources/changelogs/cloud/archive/2025",
"resources/changelogs/cloud/archive/2024",
"resources/changelogs/cloud/archive/2023",
"resources/changelogs/cloud/archive/2022"
]
},
"resources/changelogs/cloud/release-status",
{
"group": "Cloud database release changelog",
"pages": [
"resources/changelogs/cloud/release-notes/26_02",
"resources/changelogs/cloud/release-notes/25_12",
"resources/changelogs/cloud/release-notes/25_10",
"resources/changelogs/cloud/release-notes/25_08",
"resources/changelogs/cloud/release-notes/25_06",
"resources/changelogs/cloud/release-notes/25_04",
"resources/changelogs/cloud/release-notes/24_12",
"resources/changelogs/cloud/release-notes/24_10",
"resources/changelogs/cloud/release-notes/24_08",
"resources/changelogs/cloud/release-notes/24_06",
"resources/changelogs/cloud/release-notes/24_05",
"resources/changelogs/cloud/release-notes/24_02"
],
"root": "resources/changelogs/cloud/release-notes-index"
}
],
"root": "resources/changelogs/cloud/index"
},
{
"group": "Self-managed",
"pages": [
"resources/changelogs/oss/2026",
"resources/changelogs/oss/2025",
"resources/changelogs/oss/2024",
"resources/changelogs/oss/2023",
"resources/changelogs/oss/2022",
"resources/changelogs/oss/2021",
"resources/changelogs/oss/2020",
"resources/changelogs/oss/2019",
"resources/changelogs/oss/2018",
"resources/changelogs/oss/2017",
"resources/changelogs/security-changelog"
]
}
],
"icon": "/images/icons/icon-changelogs.svg",
"item": "Changelogs",
"root": "resources/changelogs/cloud/2026"
},
{
"groups": [
{
"group": "About ClickHouse",
"pages": [
"resources/about/adopters",
"resources/about/support"
],
"root": "resources/about/index"
}
],
"icon": "/images/icons/icon-about.svg",
"item": "About"
}
],
"tab": "Resources"
}
]
},
{
"language": "ar",
"$ref": "./ar/docs.json"
},
{
"language": "es",
"$ref": "./es/docs.json"
},
{
"language": "fr",
"$ref": "./fr/docs.json"
},
{
"language": "ja",
"$ref": "./ja/docs.json"
},
{
"language": "ko",
"$ref": "./ko/docs.json"
},
{
"language": "pt-BR",
"$ref": "./pt-BR/docs.json"
},
{
"language": "ru",
"$ref": "./ru/docs.json"
},
{
"language": "zh",
"$ref": "./zh/docs.json"
}
]
},
"redirects": { "$ref": "./_site/redirects.json" },
"scripts": [
{
"src": "/_site/customizations/scroll-reset.js"
},
{
"src": "/_site/customizations/custom-footer.js"
},
{
"src": "/_site/customizations/navbar-cta.js"
},
{
"src": "/_site/customizations/tab-nav.js"
},
{
"src": "/_site/customizations/kapa-init.js"
},
{
"src": "/_site/customizations/ask-ai-button.js"
},
{
"src": "/_site/customizations/inkeep-init.js"
},
{
"src": "/_site/customizations/clickhouse-sql-lexer-wasm.js"
},
{
"src": "/_site/customizations/clickhouse-sql-highlight.js"
},
{
"src": "/_site/customizations/raise-issue-link.js"
}
],
"styling": {
"eyebrows": "breadcrumbs"
},
"integrations": {
"clarity": {
"projectId": "xgummrwgj9"
}
},
"theme": "maple"
}