Skip to content
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
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 docs/about-us/cloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: /about-us/cloud
sidebar_label: 'Cloud Service'
sidebar_label: 'Cloud service'
sidebar_position: 10
description: 'ClickHouse Cloud'
title: 'ClickHouse Cloud'
Expand Down
2 changes: 1 addition & 1 deletion docs/about-us/history.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: /about-us/history
sidebar_label: 'ClickHouse History'
sidebar_label: 'ClickHouse history'
sidebar_position: 40
description: 'History of ClickHouse development'
keywords: ['history','development','Metrica']
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/avoid_optimize_final.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /best-practices/avoid-optimize-final
sidebar_position: 10
sidebar_label: 'Avoid Optimize Final'
sidebar_label: 'Avoid optimize final'
title: 'Avoid OPTIMIZE FINAL'
description: 'Page describing why you should avoid the OPTIMIZE FINAL clause in ClickHouse'
keywords: ['avoid OPTIMIZE FINAL', 'background merges']
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/choosing_a_primary_key.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /best-practices/choosing-a-primary-key
sidebar_position: 10
sidebar_label: 'Choosing a Primary Key'
sidebar_label: 'Choosing a primary key'
title: 'Choosing a Primary Key'
description: 'Page describing how to choose a primary key in ClickHouse'
keywords: ['primary key']
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/minimize_optimize_joins.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /best-practices/minimize-optimize-joins
sidebar_position: 10
sidebar_label: 'Minimize and Optimize JOINs'
sidebar_label: 'Minimize and optimize JOINs'
title: 'Minimize and optimize JOINs'
description: 'Page describing best practices for JOINs'
keywords: ['JOIN', 'Parallel Hash JOIN']
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/partitioning_keys.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /best-practices/choosing-a-partitioning-key
sidebar_position: 10
sidebar_label: 'Choosing a Partitioning Key'
sidebar_label: 'Choosing a partitioning key'
title: 'Choosing a Partitioning Key'
description: 'Page describing how to choose a partitioning key'
keywords: ['partitioning key']
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/use_materialized_views.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /best-practices/use-materialized-views
sidebar_position: 10
sidebar_label: 'Use Materialized Views'
sidebar_label: 'Use materialized views'
title: 'Use Materialized Views'
description: 'Page describing Materialized Views'
keywords: ['materialized views', 'medallion architecture']
Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/using_data_skipping_indices.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /best-practices/use-data-skipping-indices-where-appropriate
sidebar_position: 10
sidebar_label: 'Data Skipping Indices'
sidebar_label: 'Data skipping indices'
title: 'Use data skipping indices where appropriate'
description: 'Page describing how and when to use data skipping indices'
keywords: ['data skipping index', 'skip index']
Expand Down
2 changes: 1 addition & 1 deletion docs/chdb/reference/data-formats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Data Formats'
sidebar_label: 'Data Formats'
sidebar_label: 'Data formats'
slug: /chdb/reference/data-formats
description: 'Data Formats for chDB'
keywords: ['chdb', 'data formats']
Expand Down
2 changes: 1 addition & 1 deletion docs/chdb/reference/sql-reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'SQL Reference'
sidebar_label: 'SQL Reference'
sidebar_label: 'SQL reference'
slug: /chdb/reference/sql-reference
description: 'SQL Reference for chDB'
keywords: ['chdb', 'sql reference']
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/features/01_cloud_tiers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'ClickHouse Cloud Tiers'
sidebar_label: 'ClickHouse Cloud tiers'
slug: /cloud/manage/cloud-tiers
title: 'ClickHouse Cloud Tiers'
description: 'Cloud tiers available in ClickHouse Cloud'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
sidebar_title: 'SQL Console'
sidebar_title: 'SQL console'
slug: /cloud/get-started/sql-console
description: 'Run queries and create visualizations using the SQL Console.'
keywords: ['sql console', 'sql client', 'cloud console', 'console']
title: 'SQL Console'
title: 'SQL console'
doc_type: 'guide'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
sidebar_title: 'Query Insights'
sidebar_title: 'Query insights'
slug: /cloud/get-started/query-insights
description: 'Visualize system.query_log data to simplify query debugging and performance optimization'
keywords: ['query insights', 'query log', 'query log ui', 'system.query_log insights']
title: 'Query Insights'
title: 'Query insights'
doc_type: 'guide'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
sidebar_title: 'Query API Endpoints'
sidebar_title: 'Query API dndpoints'
slug: /cloud/features/query-api-endpoints
description: 'Easily spin up REST API endpoints from your saved queries'
keywords: ['api', 'query api endpoints', 'query endpoints', 'query rest api']
title: 'Query API Endpoints'
title: 'Query API endpoints'
doc_type: 'guide'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 1
sidebar_label: 'Automatic Scaling'
sidebar_label: 'Automatic scaling'
slug: /manage/scaling
description: 'Configuring automatic scaling in ClickHouse Cloud'
keywords: ['autoscaling', 'auto scaling', 'scaling', 'horizontal', 'vertical', 'bursts']
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Replica-aware Routing'
title: 'Replica-aware routing'
slug: /manage/replica-aware-routing
description: 'How to use Replica-aware routing to increase cache re-use'
keywords: ['cloud', 'sticky endpoints', 'sticky', 'endpoints', 'sticky routing', 'routing', 'replica aware routing']
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/features/04_infrastructure/shared-catalog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /cloud/reference/shared-catalog
sidebar_label: 'Shared Catalog'
title: 'Shared Catalog and Shared Database Engine'
sidebar_label: 'Shared catalog'
title: 'Shared catalog and shared database engine'
keywords: ['SharedCatalog', 'SharedDatabaseEngine']
description: 'Describes the Shared Catalog component and the Shared database engine in ClickHouse Cloud'
doc_type: 'reference'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/features/05_admin_features/api/openapi.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Managing API Keys'
sidebar_label: 'Managing API keys'
slug: /cloud/manage/openapi
title: 'Managing API Keys'
description: 'ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/features/08_backups/configurable-backups.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Configurable Backups'
sidebar_label: 'Configurable backups'
slug: /cloud/manage/backups/configurable-backups
description: 'Configurable Backups'
title: 'Configurable Backups'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Export Backups to your Own Cloud Account'
sidebar_label: 'Export backups to your own Cloud account'
slug: /cloud/manage/backups/export-backups-to-own-cloud-account
title: 'Export Backups to your Own Cloud Account'
description: 'Describes how to export backups to your own Cloud account'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/features/09_support.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Cloud Support'
sidebar_label: 'Cloud support'
title: 'Support'
slug: /cloud/support
description: 'Learn about Cloud Support'
Expand Down
29 changes: 29 additions & 0 deletions docs/cloud/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,33 @@ doc_type: 'landing-page'
---

<!--AUTOGENERATED_START-->
| Page | Description |
|-----|-----|
| [Accessing S3 data securely](/cloud/data-sources/secure-s3) | This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely. |
| [AWS PrivateLink](/manage/security/aws-privatelink) | This document describes how to connect to ClickHouse Cloud using AWS PrivateLink. |
| [Azure Private Link](/cloud/security/azure-privatelink) | How to set up Azure Private Link |
| [BYOC (Bring Your Own Cloud) for AWS](/cloud/reference/byoc) | Deploy ClickHouse on your own cloud infrastructure |
| [BYOC security playbook](/cloud/security/audit-logging/byoc-security-playbook) | This page illustrates methods customers can use to identify potential security events |
| [ClickHouse Government](/cloud/infrastructure/clickhouse-government) | Overview of ClickHouse Government offering |
| [ClickHouse Private](/cloud/infrastructure/clickhouse-private) | Overview of ClickHouse Private offering |
| [Cloud Compatibility](/whats-new/cloud-compatibility) | This guide provides an overview of what to expect functionally and operationally in ClickHouse Cloud. |
| [Cloud IP addresses](/manage/data-sources/cloud-endpoints-api) | This page documents the Cloud Endpoints API security features within ClickHouse. It details how to secure your ClickHouse deployments by managing access through authentication and authorization mechanisms. |
| [Common access management queries](/cloud/security/common-access-management-queries) | This article shows the basics of defining SQL users and roles and applying those privileges and permissions to databases, tables, rows, and columns. |
| [Console audit log](/cloud/security/audit-logging/console-audit-log) | This page describes how users can review the cloud audit log |
| [Data encryption](/cloud/security/cmek) | Learn more about data encryption in ClickHouse Cloud |
| [Data masking in ClickHouse](/cloud/guides/data-masking) | A guide to data masking in ClickHouse |
| [Database audit log](/cloud/security/audit-logging/database-audit-log) | This page describes how users can review the database audit log |
| [Gather your connection details](/cloud/guides/sql-console/gather-connection-details) | Gather your connection details |
| [GCP Private Service Connect](/manage/security/gcp-private-service-connect) | This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists. |
| [HIPAA onboarding](/cloud/security/compliance/hipaa-onboarding) | Learn more about how to onboard to HIPAA compliant services |
| [Manage cloud users](/cloud/security/manage-cloud-users) | This page describes how administrators can add users, manage assignments, and remove users |
| [Manage database users](/cloud/security/manage-database-users) | This page describes how administrators can add database users, manage assignments, and remove database users |
| [Manage my account](/cloud/security/manage-my-account) | This page describes how users can accept invitations, manage MFA settings, and reset passwords |
| [Manage SQL console role assignments](/cloud/guides/sql-console/manage-sql-console-role-assignments) | Guide showing how to manage SQL console role assignments |
| [Multi tenancy](/cloud/bestpractices/multi-tenancy) | Best practices to implement multi tenancy |
| [PCI onboarding](/cloud/security/compliance/pci-onboarding) | Learn more about how to onboard to PCI compliant services |
| [Query API Endpoints](/cloud/get-started/query-endpoints) | Easily spin up REST API endpoints from your saved queries |
| [SAML SSO setup](/cloud/security/saml-setup) | How to set up SAML SSO with ClickHouse Cloud |
| [Setting IP filters](/cloud/security/setting-ip-filters) | This page explains how to set IP filters in ClickHouse Cloud to control access to ClickHouse services. |
| [Usage limits](/cloud/bestpractices/usage-limits) | Describes the recommended usage limits in ClickHouse Cloud |
<!--AUTOGENERATED_END-->
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'GCP Private Service Connect'
title: 'GCP private service connect'
description: 'This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists.'
sidebar_label: 'GCP Private Service Connect'
sidebar_label: 'GCP private service connect'
slug: /manage/security/gcp-private-service-connect
doc_type: 'guide'
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Using a 3rd-party ETL Tool'
sidebar_label: 'Using a third-party ETL Tool'
keywords: ['clickhouse', 'migrate', 'migration', 'migrating', 'data', 'etl', 'elt', 'clickhouse-local', 'clickhouse-client']
slug: /cloud/migration/etl-tool-to-clickhouse
title: 'Using a 3rd-party ETL Tool'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/reference/01_changelog/01_changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: /whats-new/cloud
sidebar_label: 'Cloud Changelog'
sidebar_label: 'Cloud changelog'
title: 'Cloud Changelog'
description: 'ClickHouse Cloud changelog providing descriptions of what is new in each ClickHouse Cloud release'
doc_type: 'changelog'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Data Transfer'
sidebar_label: 'Data transfer'
slug: /cloud/manage/network-data-transfer
title: 'Data Transfer'
description: 'Understand how ClickHouse Cloud meters data transferred ingress and egress'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/reference/03_billing/05_payment-thresholds.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Payment Thresholds'
sidebar_label: 'Payment thresholds'
slug: /cloud/billing/payment-thresholds
title: 'Payment thresholds'
description: 'Payment thresholds and automatic invoicing for ClickHouse Cloud.'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/reference/05_supported-regions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Supported Cloud Regions'
title: 'Supported Cloud regions'
sidebar_label: 'Supported Cloud regions'
keywords: ['aws', 'gcp', 'google cloud', 'azure', 'cloud', 'regions']
description: 'Supported regions for ClickHouse Cloud'
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/reference/06_service-uptime.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: 'Service Uptime and SLA'
sidebar_label: 'Service uptime and SLA'
slug: /cloud/manage/service-uptime
title: 'Service uptime'
description: 'Users can now see regional uptimes on the status page and subscribe to alerts on service disruptions.'
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/why-clickhouse-is-so-fast.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 1
sidebar_label: 'Why is ClickHouse so Fast?'
sidebar_label: 'Why is ClickHouse so fast?'
description: 'It was designed to be fast. Query execution performance has always been a top priority during the development process, but other important characteristics like user-friendliness, scalability, and security were also considered so ClickHouse could become a real production system.'
title: 'Why is ClickHouse so fast?'
slug: /concepts/why-clickhouse-is-so-fast
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/general/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /faq/general/
sidebar_position: 1
sidebar_label: 'General Questions about ClickHouse'
sidebar_label: 'General questions about ClickHouse'
keywords: ['faq', 'questions', 'what is']
title: 'General Questions About ClickHouse'
description: 'Index page listing general questions about ClickHouse'
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/operations/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /faq/operations/
sidebar_position: 3
sidebar_label: 'Question about Operating ClickHouse Servers and Clusters'
sidebar_label: 'Question about operating ClickHouse servers and clusters'
title: 'Question about operating ClickHouse servers and clusters'
description: 'Landing page for questions about operating ClickHouse servers and clusters'
doc_type: 'landing-page'
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/example-datasets/amazon-reviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: 'Over 150M customer reviews of Amazon products'
sidebar_label: 'Amazon customer reviews'
slug: /getting-started/example-datasets/amazon-reviews
title: 'Amazon Customer Review'
doc_type: 'reference'
doc_type: 'guide'
---

This dataset contains over 150M customer reviews of Amazon products. The data is in snappy-compressed Parquet files in AWS S3 that total 49GB in size (compressed). Let's walk through the steps to insert it into ClickHouse.
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/example-datasets/amplab-benchmark.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
description: 'A benchmark dataset used for comparing the performance of data warehousing
solutions.'
sidebar_label: 'AMPLab Big Data Benchmark'
sidebar_label: 'AMPLab big data benchmark'
slug: /getting-started/example-datasets/amplab-benchmark
title: 'AMPLab Big Data Benchmark'
doc_type: 'reference'
doc_type: 'guide'
---

See https://amplab.cs.berkeley.edu/benchmark/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
description: 'Dataset consisting of two tables containing anonymized web analytics
data with hits and visits'
sidebar_label: 'Web Analytics Data'
sidebar_label: 'Anonymized web analytics'
slug: /getting-started/example-datasets/metrica
title: 'Anonymized Web Analytics'
doc_type: 'reference'
title: 'Anonymized web analytics'
doc_type: 'guide'
---

# Anonymized web analytics data
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/example-datasets/brown-benchmark.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
description: 'A new analytical benchmark for machine-generated log data'
sidebar_label: 'Brown University Benchmark'
sidebar_label: 'Brown university benchmark'
slug: /getting-started/example-datasets/brown-benchmark
title: 'Brown University Benchmark'
doc_type: 'reference'
doc_type: 'guide'
---

`MgBench` is a new analytical benchmark for machine-generated log data, [Andrew Crotty](http://cs.brown.edu/people/acrotty/).
Expand Down
5 changes: 2 additions & 3 deletions docs/getting-started/example-datasets/cell-towers.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
description: 'Learn how to load OpenCelliD data into ClickHouse, connect Apache Superset
to ClickHouse and build a dashboard based on data'
sidebar_label: 'Geo Data'
sidebar_position: 3
sidebar_label: 'Cell towers'
slug: /getting-started/example-datasets/cell-towers
title: 'Geo Data using the Cell Tower Dataset'
doc_type: 'reference'
doc_type: 'guide'
---

import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx';
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/example-datasets/covid19.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
description: 'COVID-19 Open-Data is a large, open-source database of COVID-19 epidemiological
data and related factors like demographics, economics, and government responses'
sidebar_label: 'COVID-19 Open-Data'
sidebar_label: 'COVID-19 open-data'
slug: /getting-started/example-datasets/covid19
title: 'COVID-19 Open-Data'
doc_type: 'reference'
doc_type: 'guide'
---

COVID-19 Open-Data attempts to assemble the largest Covid-19 epidemiological database, in addition to a powerful set of expansive covariates. It includes open, publicly sourced, licensed data relating to demographics, economy, epidemiology, geography, health, hospitalizations, mobility, government response, weather, and more.
Expand Down
8 changes: 4 additions & 4 deletions docs/getting-started/example-datasets/criteo.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
description: 'A terabyte of Click Logs from Criteo'
sidebar_label: 'Terabyte Click Logs from Criteo'
description: 'A terabyte of click logs from Criteo'
sidebar_label: 'Criteo 1TB click logs'
slug: /getting-started/example-datasets/criteo
title: 'Terabyte Click Logs from Criteo'
doc_type: 'reference'
title: 'Terabyte click logs from Criteo'
doc_type: 'guide'
---

Download the data from http://labs.criteo.com/downloads/download-terabyte-click-logs/
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/example-datasets/dbpedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: 'dbpedia dataset'
slug: /getting-started/example-datasets/dbpedia-dataset
title: 'dbpedia dataset'
keywords: ['semantic search', 'vector similarity', 'approximate nearest neighbours', 'embeddings']
doc_type: 'reference'
doc_type: 'guide'
---

The [dbpedia dataset](https://huggingface.co/datasets/Qdrant/dbpedia-entities-openai3-text-embedding-3-large-1536-1M) contains 1 million articles from Wikipedia and their vector embeddings generated using the [text-embedding-3-large](https://platform.openai.com/docs/models/text-embedding-3-large) model from OpenAI.
Expand Down
Loading