Skip to content

Update table of contents files: align with navigation #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update table of contents files: align with navigation #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clickstack/ingesting-data/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Managed and Open Source ClickStack provides multiple ways to ingest observabilit
|------|-------------|
| [Overview](/clickstack/ingesting-data/overview) | Introduction to data ingestion methods and architecture |
| [Ingesting data with OpenTelemetry](/clickstack/ingesting-data/opentelemetry) | For users using OpenTelemetry and looking to quickly integrate with ClickStack |
| [OpenTelemetry collector](/clickstack/ingesting-data/collector) | Advanced details for the ClickStack OpenTelemetry collector |
| [Ingesting data with Vector](/clickstack/ingesting-data/vector) | For users using Vector and looking to quickly integrate with ClickStack |
| [OpenTelemetry collector](/clickstack/ingesting-data/collector) | Advanced details for the ClickStack OpenTelemetry collector |
| [Tables and Schemas](/clickstack/ingesting-data/schemas) | Overview of the ClickHouse tables and their schemas used by ClickStack |
| [Map vs JSON type for ClickStack](/clickstack/ingesting-data/schema/map-vs-json) | Comparing the Map and JSON types for ClickStack tables |
| [Trace sampling](/clickstack/ingesting-data/trace-sampling) | Configuring trace sampling for ClickStack |
Expand Down
10 changes: 5 additions & 5 deletions concepts/features/tools-and-utilities/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ doc_type: 'landing-page'

| Tool/Utility | Description |
|------|-------------|
|[clickhouse-local](/concepts/features/tools-and-utilities/clickhouse-local) | Allows running SQL queries on data without starting the ClickHouse server, similar to how `awk` does this.|
| [clickhouse_backupview](/concepts/features/tools-and-utilities/backupview) | A python module to analyze ClickHouse backups.|
|[clickhouse-benchmark](/concepts/features/tools-and-utilities/clickhouse-benchmark) | Loads server with the custom queries and settings.|
| [clickhouse-format](/concepts/features/tools-and-utilities/clickhouse-format) | Enables formatting input queries.|
|[ClickHouse obfuscator](/concepts/features/tools-and-utilities/clickhouse-obfuscator) | Obfuscates data.|
|[ClickHouse compressor](/concepts/features/tools-and-utilities/clickhouse-compressor) | Compresses and decompresses data.|
| [clickhouse-disks](/concepts/features/tools-and-utilities/clickhouse-disks) | Provides filesystem-like operations on files among different ClickHouse disks.|
| [clickhouse-odbc-bridge](/concepts/features/tools-and-utilities/odbc-bridge) | A proxy server for ODBC driver.|
| [clickhouse_backupview](/concepts/features/tools-and-utilities/backupview) | A python module to analyze ClickHouse backups.|
| [clickhouse-format](/concepts/features/tools-and-utilities/clickhouse-format) | Enables formatting input queries.|
| [clickhouse-keeper-client](/concepts/features/tools-and-utilities/clickhouse-keeper-client) | A client application to interact with ClickHouse Keeper.|
| [Keeper HTTP API](/concepts/features/tools-and-utilities/clickhouse-keeper-http-api) | HTTP API and embedded dashboard for ClickHouse Keeper.|
|[clickhouse-local](/concepts/features/tools-and-utilities/clickhouse-local) | Allows running SQL queries on data without starting the ClickHouse server, similar to how `awk` does this.|
|[ClickHouse obfuscator](/concepts/features/tools-and-utilities/clickhouse-obfuscator) | Obfuscates data.|
| [clickhouse-odbc-bridge](/concepts/features/tools-and-utilities/odbc-bridge) | A proxy server for ODBC driver.|
| [clickhouse-static-files-disk-uploader](/concepts/features/tools-and-utilities/static-files-disk-uploader) | Uploads data to the static files web server.|
3 changes: 3 additions & 0 deletions concepts/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ In this section of the docs we'll dive into the concepts around what makes Click
| [Why is ClickHouse unique?](/get-started/about/distinctive-features) | Learn what makes ClickHouse unique.
| [Glossary](/concepts/core-concepts/glossary) | This page contains a glossary of terms you'll commonly encounter throughout the docs.
| [FAQ](/resources/support-center/knowledge-base/general-faqs/faq-index) | A compilation of the most frequently asked questions we get about ClickHouse.
| [Core concepts](/managing-data/core-concepts) | Learn Core Concepts of how ClickHouse works |
| [ClickHouse Concepts](/guides/manage-and-deploy) | Explore ClickHouse concepts including materialized views, dictionaries, performance tuning, operations, configuration, security, and more. |
| [Best practices in ClickHouse](/best-practices) | Landing page for Best Practices section in ClickHouse |
4 changes: 2 additions & 2 deletions guides/use-cases/data-warehousing/reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ ClickHouse integrates with a range of data lake catalogs through the [`DataLakeC
| Catalog | Description |
|---------|-------------|
| [AWS Glue](/guides/use-cases/data-warehousing/glue-catalog) | Query Iceberg tables registered in the AWS Glue Data Catalog from data stored in S3. |
| [Databricks Unity Catalog](/guides/use-cases/data-warehousing/unity-catalog) | Connect to Databricks Unity Catalog for Delta Lake and Iceberg tables. |
| [Iceberg REST Catalog](/guides/use-cases/data-warehousing/rest-catalog) | Use any catalog implementing the Iceberg REST specification, such as Tabular. |
| [Lakekeeper](/guides/use-cases/data-warehousing/lakekeeper-catalog) | Connect to the Lakekeeper Catalog for Iceberg tables. |
| [Project Nessie](/guides/use-cases/data-warehousing/nessie-catalog) | Query Iceberg tables using the Nessie Catalog with Git-like data version control. |
| [Microsoft OneLake](/guides/use-cases/data-warehousing/onelake-catalog) | Query Iceberg tables in Microsoft Fabric OneLake. |
| [Polaris catalog](/guides/use-cases/data-warehousing/polaris-catalog) | Connect to the Polaris catalog for Iceberg tables. |
| [Iceberg REST Catalog](/guides/use-cases/data-warehousing/rest-catalog) | Use any catalog implementing the Iceberg REST specification, such as Tabular. |
| [Databricks Unity Catalog](/guides/use-cases/data-warehousing/unity-catalog) | Connect to Databricks Unity Catalog for Delta Lake and Iceberg tables. |
| [BigLake Metastore](/guides/use-cases/data-warehousing/biglake-catalog) | Query Iceberg tables registered in BigLake Metastore. |
2 changes: 1 addition & 1 deletion guides/use-cases/observability/build-your-own/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide helps you build a custom observability stack using ClickHouse as the
|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Introduction](/guides/use-cases/observability/build-your-own/introduction) | This guide is designed for if you're looking to build your own observability solution using ClickHouse, focusing on logs and traces. |
| [Schema design](/guides/use-cases/observability/build-your-own/schema-design) | Learn why users are recommended to create their own schema for logs and traces, along with some best practices for doing so. |
| [Managing data](/guides/use-cases/observability/build-your-own/managing-data) | Deployments of ClickHouse for observability invariably involve large datasets, which need to be managed. ClickHouse offers features to assist with data management. |
| [Integrating OpenTelemetry](/guides/use-cases/observability/build-your-own/integrating-opentelemetry) | Collecting and exporting logs and traces using OpenTelemetry with ClickHouse. |
| [Managing data](/guides/use-cases/observability/build-your-own/managing-data) | Deployments of ClickHouse for observability invariably involve large datasets, which need to be managed. ClickHouse offers features to assist with data management. |
| [Using Visualization Tools](/guides/use-cases/observability/build-your-own/grafana) | Learn how to use observability visualization tools for ClickHouse, including HyperDX and Grafana. |
| [Demo Application](/guides/use-cases/observability/build-your-own/demo-application) | Explore the OpenTelemetry demo application forked to work with ClickHouse for logs and traces. |
1 change: 1 addition & 0 deletions integrations/connectors/data-ingestion/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ For more information check out the pages below:
| [Fivetran](/integrations/connectors/data-ingestion/etl-tools/fivetran/index) | An automated data movement platform moving data out of, into and across your cloud data platforms. |
| [NiFi](/integrations/connectors/data-ingestion/etl-tools/nifi-and-clickhouse) | An open-source workflow management software designed to automate data flow between software systems. |
| [Vector](/integrations/connectors/data-ingestion/etl-tools/vector-to-clickhouse) | A high-performance observability data pipeline that puts organizations in control of their observability data. |
| [Connect Apify to ClickHouse](/integrations/apify) | Load web scraping and automation data from Apify into ClickHouse |
2 changes: 1 addition & 1 deletion integrations/connectors/sql-clients/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ This section describes how to integrate ClickHouse with various common database
| Tool | Description |
|-----------------------------------------------------|-------------------------------------------------------------|
| [SQL Console](/integrations/connectors/sql-clients/sql-console) | Built-in SQL client for ClickHouse Cloud |
| [clickhouse-client](/integrations/connectors/sql-clients/cli) | Native command-line SQL client |
| [DataGrip](/integrations/connectors/sql-clients/datagrip) | Powerful database IDE |
| [DBeaver](/integrations/connectors/sql-clients/dbeaver) | Database administration and development tool |
| [DbVisualizer](/integrations/connectors/sql-clients/dbvisualizer) | Database management tool for developers, DBAs, and analysts |
| [Jupyter Notebooks](/integrations/connectors/sql-clients/jupysql) | Interactive notebooks for code, visualizations, and text |
| [QStudio](/integrations/connectors/sql-clients/qstudio) | Free, open-source SQL GUI client |
| [TABLUM.IO](/integrations/connectors/sql-clients/tablum) | Cloud-based data visualization platform |
| [marimo](/integrations/connectors/sql-clients/marimo) | Open-source reactive notebook for Python with SQL built-in |
| [clickhouse-client](/integrations/connectors/sql-clients/cli) | Native command-line SQL client |
2 changes: 1 addition & 1 deletion integrations/connectors/tools/data-integration-index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ doc_type: 'landing-page'

| Page | Description |
|-----------|---------------------------------------------------------------------------------------------------------------------------------|
| [Retool](/integrations/connectors/data-integrations/integrations/retool) | Quickly build web and mobile apps with rich user interfaces, automate complex tasks, and integrate AI—all powered by your data. |
| [Easypanel](/integrations/connectors/data-integrations/integrations/easypanel) | Easypanel allows you to deploy ClickHouse on your own server |
| [Middleware](/integrations/connectors/data-integrations/integrations/middleware) | Connect ClickHouse with Middleware for observability and monitoring workflows. |
| [Notion](/integrations/connectors/data-integrations/integrations/notion) | Connect ClickHouse Cloud to a Notion Custom Agent via the ClickHouse Remote MCP server. |
| [Retool](/integrations/connectors/data-integrations/integrations/retool) | Quickly build web and mobile apps with rich user interfaces, automate complex tasks, and integrate AI—all powered by your data. |
| [Splunk](/integrations/connectors/data-integrations/integrations/splunk) | Store ClickHouse Cloud audit logs into Splunk. |
3 changes: 3 additions & 0 deletions integrations/connectors/tools/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ doc_type: 'landing-page'
| [SQL Client](/integrations/connectors/sql-clients/index) | How to integrate ClickHouse with various common database management, analysis and visualization tools |
| [Data Integrations](/integrations/connectors/tools/data-integration-index) | Data integrations for ClickHouse |
| [Misc](/integrations/connectors/tools/misc-index) | Miscellaneous tooling for ClickHouse |
| [Visual Interfaces from Third-party Developers](/interfaces/third-party/gui) | List of third-party GUI tools and applications for working with ClickHouse |
| [Proxy Servers from Third-party Developers](/interfaces/third-party/proxy) | Describes available third-party proxy solutions for ClickHouse |
| [Integration Libraries from Third-party Developers](/interfaces/third-party/integrations) | Documentation on integrating ClickHouse with various third-party systems |
2 changes: 1 addition & 1 deletion products/cloud/features/ai-ml/agents/builder/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ This section covers each part of the Agent Builder and contains the following pa

| Page | Description |
|------|-------------|
| [Model parameters](/products/cloud/features/ai-ml/agents/builder/model-parameters) | Configure model parameters for an agent. |
| [Code interpreter](/products/cloud/features/ai-ml/agents/builder/code-interpreter) | Sandboxed code execution. |
| [Web search](/products/cloud/features/ai-ml/agents/builder/web-search) | Public-web lookups. |
| [Image generation](/products/cloud/features/ai-ml/agents/builder/image-generation) | Generate images from text. |
| [Vision](/products/cloud/features/ai-ml/agents/builder/vision) | Accept image inputs. |
| [MCP servers](/products/cloud/features/ai-ml/agents/builder/mcp-servers) | Attach third-party MCP servers to an agent. |
| [Skills](/products/cloud/features/ai-ml/agents/builder/skills) | Reusable instruction packs. |
| [Subagents](/products/cloud/features/ai-ml/agents/builder/subagents) | Delegate work to child agents. |
| [Model parameters](/products/cloud/features/ai-ml/agents/builder/model-parameters) | Configure model parameters for an agent. |
2 changes: 1 addition & 1 deletion products/cloud/guides/data-sources/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ This section contains guides and references for integrating ClickHouse Cloud wit
|-----------------------------------------------------------------|------------------------------------------------------------------------|
| [Cloud IP addresses](/products/cloud/guides/data-sources/cloud-endpoints-api) | Networking information needed for some table functions and connections |
| [Accessing S3 data securely](/products/cloud/guides/data-sources/accessing-s3-data-securely) | Access external data sources in AWS S3 using role based access |
| [Accessing GCS data securely](/products/cloud/guides/data-sources/secure-gcs) | Access external data sources in GCS securely using HMAC keys |
| [Connecting ClickHouse Cloud to Azure Blob Storage](/products/cloud/guides/data-sources/secure-azure) | Connect ClickHouse Cloud to Azure Blob Storage |
| [Accessing GCS data securely](/products/cloud/guides/data-sources/secure-gcs) | Access external data sources in GCS securely using HMAC keys |
| [Accessing Iceberg data securely](/products/cloud/guides/data-sources/accessing-iceberg-data-securely) | Access Iceberg data securely |

## Additional connections for external data sources {#additional-connections-for-external-data-sources}
Expand Down
4 changes: 2 additions & 2 deletions products/cloud/guides/security/cloud-access-management/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ This section contains detailed guides for managing access in ClickHouse Cloud
| [Manage custom roles](/products/cloud/guides/security/cloud-access-management/manage-custom-roles) | An administrator's guide to creating and managing custom roles |
| [Manage SQL console role assignments](/products/cloud/guides/security/cloud-access-management/manage-sql-console-role-assignments) | An administrator's guide to managing SQL console users |
| [Manage database users](/products/cloud/guides/security/cloud-access-management/manage-database-users) | An administrator's guide to managing database users |
| [Manage database service accounts](/products/cloud/guides/security/cloud-access-management/manage-database-service-accounts) | An administrator's guide to managing database service accounts |
| [SAML SSO setup](/products/cloud/guides/security/cloud-access-management/saml-sso-setup) | An administrator's guide to configuring and troubleshooting SAML integrations |
| [SAML SSO removal](/products/cloud/guides/security/saml-sso-removal) | An administrator's guide to removing SAML SSO |
| [SCIM provisioning with Okta](/products/cloud/guides/security/cloud-access-management/scim-setup) | An administrator's guide to automating user and group lifecycle with SCIM |
| [Common access management queries](/products/cloud/guides/security/cloud-access-management/common-access-management-queries) | Detailed examples of setting up and verifying database permissions |
| [Manage database service accounts](/products/cloud/guides/security/cloud-access-management/manage-database-service-accounts) | An administrator's guide to managing database service accounts |
| [SAML SSO removal](/products/cloud/guides/security/saml-sso-removal) | An administrator's guide to removing SAML SSO |
8 changes: 4 additions & 4 deletions products/cloud/reference/billing/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ This section of the documentation covers topics related to billing, and contains
| Page | Description |
|---------------------------------------|----------------------------------------------------------------------|
| [Overview](/products/cloud/reference/billing/billing-overview) | Pricing examples and FAQs for billing. |
| [Marketplace](/products/cloud/reference/billing/marketplace/index) | Landing page for further marketplace related topics. |
| [ClickPipes](/products/cloud/reference/billing/clickpipes/index) | Billing for ClickPipes. |
| [Data Transfer](/products/cloud/reference/billing/network-data-transfer) | Information about network data transfer charges. |
| [Payment Thresholds](/products/cloud/reference/billing/payment-thresholds) | Learn more about how payment thresholds work and how to adjust them. |
| [Spend Alerts](/products/cloud/reference/billing/spend-alerts) | Configure spend alerts to monitor usage against thresholds within a billing period. |
| [Troubleshooting Billing Issues](/products/cloud/reference/billing/billing-compliance) | Troubleshoot common billing issues. |
| [Managing Payment Methods](/products/cloud/reference/billing/managing-payment-methods) | Manage your payment methods for ClickHouse Cloud. |
| [Data Transfer](/products/cloud/reference/billing/network-data-transfer) | Information about network data transfer charges. |
| [ClickPipes](/products/cloud/reference/billing/clickpipes/index) | Billing for ClickPipes. |
| [Marketplace](/products/cloud/reference/billing/marketplace/index) | Landing page for further marketplace related topics. |
| [Troubleshooting Billing Issues](/products/cloud/reference/billing/billing-compliance) | Troubleshoot common billing issues. |
Loading