diff --git a/.gitignore b/.gitignore index a997a074bca..c75ce46f5cc 100644 --- a/.gitignore +++ b/.gitignore @@ -40,4 +40,10 @@ FormatFactorySettingsDeclaration.h FormatFactorySettings.h Settings.cpp +# Files whose content gets autogenerated +docs/en/cloud/manage/api/invitations-api-reference.md +docs/en/cloud/manage/api/keys-api-reference.md +docs/en/cloud/manage/api/members-api-reference.md +docs/en/cloud/manage/api/organizations-api-reference.md +docs/en/cloud/manage/api/services-api-reference.md .vscode diff --git a/docs/en/chdb/getting-started.md b/docs/en/chdb/getting-started.md index 31bef373875..978c3889afb 100644 --- a/docs/en/chdb/getting-started.md +++ b/docs/en/chdb/getting-started.md @@ -147,7 +147,7 @@ This is fine to do with variables defined in your program, but don't do it with ## Configuring the output format The default output format is `CSV`, but we can change that via the `output_format` parameter. -chDB supports the ClickHouse data formats, as well as [some of its own](data-formats.md), including `DataFrame`, which returns a Pandas DataFrame: +chDB supports the ClickHouse data formats, as well as [some of its own](/docs/en/chdb/reference/data-formats.md), including `DataFrame`, which returns a Pandas DataFrame: ```python result = chdb.query( diff --git a/docs/en/chdb/guides/index.md b/docs/en/chdb/guides/index.md new file mode 100644 index 00000000000..a2c0f17360c --- /dev/null +++ b/docs/en/chdb/guides/index.md @@ -0,0 +1,13 @@ +--- +title: chDB Guides +slug: /en/chdb/guides +description: Index page for chDB guides +keywords: [chdb, guides] +--- + +import TableOfContentsJSON from './table_of_contents.json' +import { TableOfContents } from '/src/components/TableOfContents' + +Take a look at our chDB developer guides below: + + \ No newline at end of file diff --git a/docs/en/chdb/guides/table_of_contents.json b/docs/en/chdb/guides/table_of_contents.json new file mode 100644 index 00000000000..4dcef441d6f --- /dev/null +++ b/docs/en/chdb/guides/table_of_contents.json @@ -0,0 +1,30 @@ +[ + { + "title": "How to query Apache Arrow with chDB", + "slug": "/en/chdb/guides/apache-arrow" + }, + { + "title": "How to query Pandas DataFrames with chDB", + "slug": "/en/chdb/guides/pandas" + }, + { + "title": "How to query Parquet files", + "slug": "/en/chdb/guides/querying-parquet" + }, + { + "title": "How to query a remote ClickHouse server", + "slug": "/en/chdb/guides/query-remote-clickhouse" + }, + { + "title": "How to query data in an S3 bucket", + "slug": "/en/chdb/guides/querying-s3" + }, + { + "title": "JupySQL and chDB", + "slug": "/en/chdb/guides/jupysql" + }, + { + "title": "Using a clickhouse-local database", + "slug": "/en/chdb/guides/clickhouse-local" + } +] diff --git a/docs/en/chdb/install/index.md b/docs/en/chdb/install/index.md new file mode 100644 index 00000000000..a37fd10aeeb --- /dev/null +++ b/docs/en/chdb/install/index.md @@ -0,0 +1,17 @@ +--- +title: Language Integrations Index +slug: /en/chdb/install +description: Index page for chDB language integrations +keywords: [python, NodeJS, Go, Rust, Bun, C, C++] +--- + +Instructions for how to get setup with chDB are available below for the following languages and runtimes: + +| Language | +|----------------------------------------| +| [Python](/docs/en/chdb/install/python) | +| [NodeJS](/docs/en/chdb/install/nodejs) | +| [Go](/docs/en/chdb/install/go) | +| [Rust](/docs/en/chdb/install/rust) | +| [Bun](/docs/en/chdb/install/bun) | +| [C and C++](/docs/en/chdb/install/c) | diff --git a/docs/en/chdb/data-formats.md b/docs/en/chdb/reference/data-formats.md similarity index 99% rename from docs/en/chdb/data-formats.md rename to docs/en/chdb/reference/data-formats.md index 954dc3f43b9..047a46ac55e 100644 --- a/docs/en/chdb/data-formats.md +++ b/docs/en/chdb/reference/data-formats.md @@ -1,7 +1,7 @@ --- title: Data Formats sidebar_label: Data Formats -slug: /en/chdb/data-formats +slug: /en/chdb/reference/data-formats description: Data Formats for chDB keywords: [chdb, data formats] --- diff --git a/docs/en/chdb/reference/index.md b/docs/en/chdb/reference/index.md new file mode 100644 index 00000000000..6e1245597e2 --- /dev/null +++ b/docs/en/chdb/reference/index.md @@ -0,0 +1,11 @@ +--- +title: chDB Technical Reference +slug: /en/chdb/reference +description: Data Formats for chDB +keywords: [chdb, data formats] +--- + +| Reference page | +|----------------------| +| [Data Formats](/en/chdb/reference/data-formats) | +| [SQL Reference](/en/chdb/reference/sql-reference) | \ No newline at end of file diff --git a/docs/en/chdb/reference/sql-reference.md b/docs/en/chdb/reference/sql-reference.md new file mode 100644 index 00000000000..05408a155c2 --- /dev/null +++ b/docs/en/chdb/reference/sql-reference.md @@ -0,0 +1,22 @@ +--- +title: SQL Reference +sidebar_label: SQL Reference +slug: /en/chdb/reference/sql-reference +description: SQL Reference for chDB +keywords: [chdb, sql reference] +--- + +chdb supports the same SQL syntax, statements, engines and functions as ClickHouse: + +| Topic | +|----------------------------| +| [SQL Syntax](/docs/en/sql-reference/syntax) | +| [Statements](/docs/en/sql-reference/statements) | +| [Table Engines](/docs/en/engines/table-engines) | +| [Database Engines](/docs/en/engines/database-engines) | +| [Regular Functions](/docs/en/sql-reference/functions) | +| [Aggregate Functions](/docs/en/sql-reference/aggregate-functions) | +| [Table Functions](/docs/en/sql-reference/table-functions) | +| [Window Functions](/docs/en/sql-reference/window-functions) | + +For further information and examples, see the [ClickHouse SQL Reference](/docs/en/sql-reference). \ No newline at end of file diff --git a/docs/en/chdb/sql-reference.md b/docs/en/chdb/sql-reference.md deleted file mode 100644 index 04bcf061b35..00000000000 --- a/docs/en/chdb/sql-reference.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: SQL Reference -sidebar_label: SQL Reference -slug: /en/chdb/sql-reference -description: SQL Reference for chDB -keywords: [chdb, sql reference] ---- - -chdb supports the same SQL syntax, statements, engines and functions as ClickHouse: - -- [SQL Syntax](/docs/en/sql-reference/syntax) -- [Statements](/docs/en/sql-reference/statements) -- [Table Engines](/docs/en/engines/table-engines) -- [Database Engines](/docs/en/engines/database-engines) -- [Regular Functions](/docs/en/sql-reference/functions) -- [Aggregate Functions](/docs/en/sql-reference/aggregate-functions) -- [Table Functions](/docs/en/sql-reference/table-functions) -- [Window Functions](/docs/en/sql-reference/window-functions) - -For further information and examples, see the [ClickHouse SQL Reference](/docs/en/sql-reference). \ No newline at end of file diff --git a/docs/en/cloud/bestpractices/index.md b/docs/en/cloud/bestpractices/index.md new file mode 100644 index 00000000000..a6a983e3360 --- /dev/null +++ b/docs/en/cloud/bestpractices/index.md @@ -0,0 +1,19 @@ +--- +slug: /en/cloud/bestpractices +keywords: [Cloud, Best Practices, Bulk Inserts, Asynchronous Inserts, Avoid Mutations, Avoid Nullable Columns, Avoid Optimize Final, Low Cardinality Partitioning Key] +title: Overview +hide_title: true +--- + +# Best Practices in ClickHouse + +This section provides six best practices you will want to follow to get the most out of ClickHouse Cloud. + +| Best Practice | +|------------------------------------------------------------------------------------------------------------| +| [Use Bulk Inserts](/docs/en/cloud/bestpractices/bulk-inserts) | +| [Asynchronous Inserts](/docs/en/cloud/bestpractices/asynchronous-inserts) | +| [Avoid Mutations](/docs/en/cloud/bestpractices/avoid-mutations) | +| [Avoid Nullable Columns](/docs/en/cloud/bestpractices/avoid-nullable-columns) | +| [Avoid Optimize Final](/docs/en/cloud/bestpractices/avoid-optimize-final) | +| [Choose a Low Cardinality Partitioning Key](/docs/en/cloud/bestpractices/low-cardinality-partitioning-key) | \ No newline at end of file diff --git a/docs/en/cloud/changelogs/table_of_contents.json b/docs/en/cloud/changelogs/table_of_contents.json new file mode 100644 index 00000000000..8ef90722579 --- /dev/null +++ b/docs/en/cloud/changelogs/table_of_contents.json @@ -0,0 +1,18 @@ +[ + { + "title": "v24.10 Changelog for Cloud", + "slug": "/en/changelogs/24.10" + }, + { + "title": "v24.5 Changelog for Cloud", + "slug": "/en/changelogs/24.5" + }, + { + "title": "v24.6 Changelog for Cloud", + "slug": "/en/changelogs/24.6" + }, + { + "title": "v24.8 Changelog for Cloud", + "slug": "/en/changelogs/24.8" + } +] diff --git a/docs/en/get-started/cloud-quick-start.md b/docs/en/cloud/get-started/cloud-quick-start.md similarity index 99% rename from docs/en/get-started/cloud-quick-start.md rename to docs/en/cloud/get-started/cloud-quick-start.md index aef29c48194..2dd7b02216b 100644 --- a/docs/en/get-started/cloud-quick-start.md +++ b/docs/en/cloud/get-started/cloud-quick-start.md @@ -1,9 +1,9 @@ --- sidebar_position: 1 -slug: /en/cloud-quick-start +slug: /en/cloud/get-started/cloud-quick-start sidebar_label: Cloud Quick Start keywords: [clickhouse, install, getting started, quick start] -pagination_next: en/get-started/sql-console +pagination_next: en/cloud/get-started/sql-console --- import SignUp from '@site/docs/en/_snippets/_sign_in_or_trial.md'; import SQLConsoleDetail from '@site/docs/en/_snippets/_launch_sql_console.md'; diff --git a/docs/en/cloud/get-started/index.md b/docs/en/cloud/get-started/index.md new file mode 100644 index 00000000000..75cc5af60fe --- /dev/null +++ b/docs/en/cloud/get-started/index.md @@ -0,0 +1,18 @@ +--- +slug: en/cloud/get-started +title: Get Started +description: Get Started Table Of Contents +keywords: [Cloud Quick Start, SQL Console, Query Insights, Query API Endpoints, Dashboards, Cloud Support] +--- + +Welcome to ClickHouse Cloud! Explore the pages below to learn more about what ClickHouse Cloud has to offer. + +| Page | Description | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/cloud/overview) | Overview of the benefits of using ClickHouse Cloud and what version of ClickHouse is used for it. | +| [Cloud Quick Start](/docs/en/cloud/get-started/cloud-quick-start) | Quick start guide to get up and running with Cloud. | +| [SQL Console](/docs/en/cloud/get-started/sql-console) | Learn about the interactive SQL console available in CLoud | +| [Query Insights](/docs/en/cloud/get-started/query-insights) | Learn about how Cloud's Query Insights feature makes ClickHouse's built-in query log easier to use through various visualizations and tables. | +| [Query Endpoints](/docs/en/cloud/get-started/query-endpoints) | Learn about the Query API Endpoints feature which allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. | +| [Dashboards](/docs/en/cloud/manage/dashboards) | Learn about how SQL Console’s dashboards feature allows you to collect and share visualizations from saved queries. | +| [Cloud Support](/docs/en/cloud/support) | Learn more about Support Services for ClickHouse Cloud users and customers. | \ No newline at end of file diff --git a/docs/en/get-started/query-endpoints.md b/docs/en/cloud/get-started/query-endpoints.md similarity index 99% rename from docs/en/get-started/query-endpoints.md rename to docs/en/cloud/get-started/query-endpoints.md index 1590fd5a4c6..ae8e6774a5e 100644 --- a/docs/en/get-started/query-endpoints.md +++ b/docs/en/cloud/get-started/query-endpoints.md @@ -1,6 +1,6 @@ --- sidebar_title: Query API Endpoints -slug: /en/get-started/query-endpoints +slug: /en/cloud/get-started/query-endpoints description: Easily spin up REST API endpoints from your saved queries keywords: [api, query api endpoints, query endpoints, query rest api] --- @@ -48,7 +48,7 @@ Next step, we'll go ahead and save the query: ![Save example query](@site/docs/en/cloud/images/sqlconsole/endpoints-savequery.png) -More documentation around saved queries can be found [here](/docs/en/get-started/sql-console#saving-a-query). +More documentation around saved queries can be found [here](/docs/en/cloud/get-started/sql-console#saving-a-query). ### Configuring the Query API Endpoint diff --git a/docs/en/get-started/query-insights.md b/docs/en/cloud/get-started/query-insights.md similarity index 94% rename from docs/en/get-started/query-insights.md rename to docs/en/cloud/get-started/query-insights.md index f1399b29378..2ae5148faf2 100644 --- a/docs/en/get-started/query-insights.md +++ b/docs/en/cloud/get-started/query-insights.md @@ -1,6 +1,6 @@ --- sidebar_title: Query Insights -slug: /en/get-started/query-insights +slug: /en/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] --- @@ -37,7 +37,7 @@ Selecting a query from the recent queries table will open a flyout containing me As we can see from the flyout, this particular query has been run more than 3000 times in the last 24 hours. All metrics in the **Query info** tab are aggregated metrics, but we can also view metrics from individual runs by selecting the **Query history** tab: -Query Insights UI Query Information diff --git a/docs/en/get-started/sql-console.md b/docs/en/cloud/get-started/sql-console.md similarity index 96% rename from docs/en/get-started/sql-console.md rename to docs/en/cloud/get-started/sql-console.md index 4b1547a3a74..96b1ca6af0d 100644 --- a/docs/en/get-started/sql-console.md +++ b/docs/en/cloud/get-started/sql-console.md @@ -1,6 +1,6 @@ --- sidebar_title: SQL Console -slug: /en/get-started/sql-console +slug: /en/cloud/get-started/sql-console description: Run queries and create visualizations using the SQL Console. keywords: [sql console, sql client, cloud console, console] --- @@ -133,11 +133,11 @@ To save a query, simply click the "Save" button immediately next to the "Run" bu Using the shortcut cmd / ctrl + s will also save any work in the current query tab. ::: -![Save query](../images/sql-console-save-query.png) +![Save query](@site/docs/en/images/sql-console-save-query.png) Alternatively, you can simultaneously name and save a query by clicking on "Untitled Query" in the toolbar, adjusting the name, and hitting Enter: -![Rename query](../images/sql-console-rename.png) +![Rename query](../../images/sql-console-rename.png) ### Query Sharing @@ -145,32 +145,32 @@ The SQL console allows you to easily share queries with your team members. The S - Owner (can adjust sharing options) - Write access -- Read only access +- Read-only access - No access After saving a query, click the "Share" button in the toolbar. A modal with sharing options will appear: -![Share query](../images/sql-console-share.png) +![Share query](../../images/sql-console-share.png) To adjust query access for all organization members with access to the service, simply adjust the access level selector in the top line: -![Edit access](../images/sql-console-edit-access.png) +![Edit access](../../images/sql-console-edit-access.png) After applying the above, the query can now be viewed (and executed) by all team members with access to the SQL console for the service. To adjust query access for specific members, select the desired team member from the "Add a team member" selector: -![Add team member](../images/sql-console-add-team.png) +![Add team member](../../images/sql-console-add-team.png) After selecting a team member, a new line item should appear with an access level selector: -![Edit team member access](../images/sql-console-edit-member.png) +![Edit team member access](../../images/sql-console-edit-member.png) ### Accessing Shared Queries If a query has been shared with you, it will be displayed in the "Queries" tab of the SQL console left sidebar: -![Access queries](../images/sql-console-access-queries.png) +![Access queries](../../images/sql-console-access-queries.png) ### Linking to a query (permalinks) diff --git a/docs/en/cloud/manage/api/api-reference-index.md b/docs/en/cloud/manage/api/api-reference-index.md new file mode 100644 index 00000000000..76a4b1c7ede --- /dev/null +++ b/docs/en/cloud/manage/api/api-reference-index.md @@ -0,0 +1,12 @@ +--- +title: Cloud API +slug: /en/cloud/manage/api/ +--- + +| Page | Description | +|--------------------|----------------------------------| +| [Invitations](/docs/en/cloud/manage/api/invitations-api-reference) | API reference for invitations. | +| [Keys](/docs/en/cloud/manage/api/keys-api-reference) | API reference for keys. | +| [Members](/docs/en/cloud/manage/api/members-api-reference) | API reference for requests. | +| [Organizations](/docs/en/cloud/manage/api/organizations-api-reference) | API reference for organizations. | +| [Services](/docs/en/cloud/manage/api/services-api-reference) | API reference for services. | \ No newline at end of file diff --git a/docs/en/cloud/manage/api/index.md b/docs/en/cloud/manage/api/index.md new file mode 100644 index 00000000000..b0ba91d5499 --- /dev/null +++ b/docs/en/cloud/manage/api/index.md @@ -0,0 +1,10 @@ +--- +title: Cloud API +slug: en/cloud/manage/api +--- + +| Page | Description | +|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/cloud/manage/api/api-overview) | Provides an overview of rate limits, Terraform Provider, Swagger (OpenAPI) Endpoint and UI and available support. | +| [Managing API Keys](/docs/en/cloud/manage/openapi)| Learn more about Cloud's API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services. | +| [API Reference](/docs/en/cloud/manage/api) | API reference documentation. | diff --git a/docs/en/cloud/manage/api/invitations-api-reference.md b/docs/en/cloud/manage/api/invitations-api-reference.md index 0a1cb16da2f..0523a976d5e 100644 --- a/docs/en/cloud/manage/api/invitations-api-reference.md +++ b/docs/en/cloud/manage/api/invitations-api-reference.md @@ -5,5 +5,5 @@ title: Invitations ## List all invitations -This file is generated by `clickhouseapi.js` during the build process. If the -content needs changing please edit `clickhouseapi.js`. +This file is generated by `clickhouseapi.js` during the build process. If the +content needs changing please edit `clickhouseapi.js`. \ No newline at end of file diff --git a/docs/en/cloud/manage/api/keys-api-reference.md b/docs/en/cloud/manage/api/keys-api-reference.md index 61ce4d28399..75681109d12 100644 --- a/docs/en/cloud/manage/api/keys-api-reference.md +++ b/docs/en/cloud/manage/api/keys-api-reference.md @@ -5,5 +5,5 @@ title: Keys ## Get list of all keys -This file is generated by `clickhouseapi.js` during the build process. If the -content needs changing please edit `clickhouseapi.js`. +This file is generated by `clickhouseapi.js` during the build process. If the +content needs changing please edit `clickhouseapi.js`. \ No newline at end of file diff --git a/docs/en/cloud/manage/api/members-api-reference.md b/docs/en/cloud/manage/api/members-api-reference.md index c3b587528d9..1f42f1301a0 100644 --- a/docs/en/cloud/manage/api/members-api-reference.md +++ b/docs/en/cloud/manage/api/members-api-reference.md @@ -5,5 +5,5 @@ title: Members ## List organization members -This file is generated by `clickhouseapi.js` during the build process. If the -content needs changing please edit `clickhouseapi.js`. +This file is generated by `clickhouseapi.js` during the build process. If the +content needs changing please edit `clickhouseapi.js`. \ No newline at end of file diff --git a/docs/en/cloud/manage/api/organizations-api-reference.md b/docs/en/cloud/manage/api/organizations-api-reference.md index 9a47f0bc5f3..dd1a826d63b 100644 --- a/docs/en/cloud/manage/api/organizations-api-reference.md +++ b/docs/en/cloud/manage/api/organizations-api-reference.md @@ -5,5 +5,5 @@ title: Organizations ## Get organization details -This file is generated by `clickhouseapi.js` during the build process. If the -content needs changing please edit `clickhouseapi.js`. +This file is generated by `clickhouseapi.js` during the build process. If the +content needs changing please edit `clickhouseapi.js`. \ No newline at end of file diff --git a/docs/en/cloud/manage/api/services-api-reference.md b/docs/en/cloud/manage/api/services-api-reference.md index 5eab7df4299..1b6af86f3d3 100644 --- a/docs/en/cloud/manage/api/services-api-reference.md +++ b/docs/en/cloud/manage/api/services-api-reference.md @@ -5,5 +5,5 @@ title: Services ## List of organization services -This file is generated by `clickhouseapi.js` during the build process. If the -content needs changing please edit `clickhouseapi.js`. +This file is generated by `clickhouseapi.js` during the build process. If the +content needs changing please edit `clickhouseapi.js`. \ No newline at end of file diff --git a/docs/en/cloud/manage/billing.md b/docs/en/cloud/manage/billing.md index e3d2f362c3a..ee0d33ab300 100644 --- a/docs/en/cloud/manage/billing.md +++ b/docs/en/cloud/manage/billing.md @@ -1,6 +1,6 @@ --- sidebar_label: Overview -slug: /en/manage/billing +slug: /en/cloud/manage/billing/overview title: Billing --- diff --git a/docs/en/cloud/manage/billing/index.md b/docs/en/cloud/manage/billing/index.md new file mode 100644 index 00000000000..d41f76cde04 --- /dev/null +++ b/docs/en/cloud/manage/billing/index.md @@ -0,0 +1,13 @@ +--- +slug: /en/cloud/manage/billing +title: Billing +description: Table of contents page for billing. +keywords: [billing, payment thresholds, trouble shooting, marketplace] +--- + +| Page | +|----------------------------------------------------------------------------------| +| [Overview](/docs/en/cloud/marketplace/marketplace-billing) | +| [Payment Thresholds](/docs/en/cloud/billing/payment-thresholds) | +| [Troubleshooting Billing Issues](/docs/en/manage/troubleshooting-billing-issues) | +| [Marketplace](/docs/en/cloud/manage/) | diff --git a/docs/en/cloud/manage/billing/marketplace/index.md b/docs/en/cloud/manage/billing/marketplace/index.md index 71965a4d6d8..6f18678a3a1 100644 --- a/docs/en/cloud/manage/billing/marketplace/index.md +++ b/docs/en/cloud/manage/billing/marketplace/index.md @@ -1,81 +1,16 @@ --- -slug: /en/cloud/marketplace -title: Marketplace Billing -description: Subscribe to ClickHouse Cloud through the AWS, GCP, and Azure marketplace. -keywords: [aws, azure, gcp, google cloud, marketplace, billing] +slug: /en/cloud/manage/marketplace/ +title: Market Place +description: Market Place Table of Contents page +keywords: [Marketplace Billing, AWS, GCP] --- -You can subscribe to ClickHouse Cloud through the AWS, GCP, and Azure marketplaces. This allows you to pay for ClickHouse Cloud through your existing cloud provider billing. - -You can either use pay-as-you-go (PAYG) or commit to a contract with ClickHouse Cloud through the marketplace. The billing will be handled by the cloud provider, and you will receive a single invoice for all your cloud services. - -- [AWS Marketplace PAYG](/en/cloud/billing/marketplace/aws-marketplace-payg) -- [AWS Marketplace Committed Contract](/en/cloud/billing/marketplace/aws-marketplace-committed-contract) -- [GCP Marketplace PAYG](/en/cloud/billing/marketplace/gcp-marketplace-payg) -- [GCP Marketplace Committed Contract](/en/cloud/billing/marketplace/gcp-marketplace-committed-contract) -- [Azure Marketplace PAYG](/en/cloud/billing/marketplace/azure-marketplace-payg) -- [Azure Marketplace Committed Contract](/en/cloud/billing/marketplace/azure-marketplace-committed-contract) - -## FAQs - -### How can I verify that my organization is connected to marketplace billing?​ - -In the ClickHouse Cloud console, navigate to **Billing**. You should see the name of the marketplace and the link in the **Payment details** section. - -### I am an existing ClickHouse Cloud user. What happens when I subscribe to ClickHouse Cloud via AWS / GCP / Azure marketplace?​ - -Signing up for ClickHouse Cloud from the cloud provider marketplace is a two step process: -1. You first "subscribe" to ClickHouse Cloud on the cloud providers' marketplace portal. After you have finished subscribing, you click on "Pay Now" or "Manage on Provider" (depending on the marketplace). This redirects you to ClickHouse Cloud. -2. On Clickhouse Cloud you either register for a new account, or sign in with an existing account. Either way, a new ClickHouse Cloud organization will be created for you which is tied to your marketplace billing. - -NOTE: Your existing services and organizations from any prior ClickHouse Cloud signups will remain and they will not be connected to the marketplace billing. ClickHouse Cloud allows you to use the same account to manage multiple organization, each with different billing. - -You can switch between organizations from the bottom left menu of the ClickHouse Cloud console. - -### I am an existing ClickHouse Cloud user. What should I do if I want my existing services to be billed via marketplace?​ - -You will need to subscribe to ClickHouse Cloud via the cloud provider marketplace. Once you finish subscribing on the marketplace, and redirect to ClickHouse Cloud you will have the option of linking an existing ClickHouse Cloud organization to marketplace billing. From that point on, your existing resources will now get billed via the marketplace. - -![MPSignup_OrgLinking](https://github.com/user-attachments/assets/a0939007-320b-4b12-9d6d-fd63bce31864) - -You can confirm from the organization's billing page that billing is indeed now linked to the marketplace. Please contact [ClickHouse Cloud support](https://clickhouse.com/support/program) if you run into any issues. - -:::note -Your existing services and organizations from any prior ClickHouse Cloud signups will remain and they will not be connected to the marketplace billing. -::: - -### I subscribed to ClickHouse Cloud as a marketplace user. How can I unsubscribe?​ - -Note that you can simply stop using ClickHouse Cloud and delete all existing ClickHouse Cloud services. Even though the subscription will still be active, you will not be paying anything as ClickHouse Cloud doesn't have any recurring fees. - -If you want to unsubscribe, please navigate to the Cloud Provider console and cancel the subscription renewal there. Once the subscription ends, all existing services will be stopped and you will be prompted to add a credit card. If no card was added, after two weeks all existing services will be deleted. - -### I subscribed to ClickHouse Cloud as a marketplace user, and then unsubscribed. Now I want to subscribe back, what is the process?​ - -In that case please subscribe to the ClickHouse Cloud as usual (see sections on subscribing to ClickHouse Cloud via the marketplace). - -- For AWS marketplace a new ClickHouse Cloud organization will be created and connected to the marketplace. -- For the GCP marketplace your old organization will be reactivated. - -If you have any trouble with reactivating your marketplace org, please contact [ClickHouse Cloud Support](https://clickhouse.com/support/program). - -### How do I access my invoice for my marketplace subscription to the ClickHouse Cloud service?​ - -- [AWS billing Console](https://us-east-1.console.aws.amazon.com/billing/home) -- [GCP Marketplace orders](https://console.cloud.google.com/marketplace/orders) (select the billing account that you used for subscription) - -### Why do the dates on the Usage statements not match my Marketplace Invoice?​ - -Marketplace billing follows the calendar month cycle. For example, for usage between December 1st and January 1st, an invoice will be generated between January 3rd and January 5th. - -ClickHouse Cloud usage statements follow a different billing cycle where usage is metered and reported over 30 days starting from the day of sign up. - -The usage and invoice dates will differ if these dates are not the same. Since usage statements track usage by day for a given service, users can rely on statements to see the breakdown of costs. - -### Where can I find general billing information​? - -Please see the [Billing overview page](/en/manage/billing). - -### Is there a difference in ClickHouse Cloud pricing, whether paying through the cloud provider marketplace or directly to ClickHouse? - -There is no difference in pricing between marketplace billing and signing up directly with ClickHouse. In either case, your usage of ClickHouse Cloud is tracked in terms of ClickHouse Cloud Credits (CHCs), which are metered in the same way and billed accordingly. +| Page | +|---------------------------------------------------------------------------------------------------------------------| +| [Marketplace Billing](/docs/en/cloud/marketplace/marketplace-billing) | +| [AWS Marketplace PAYG](/docs/en/cloud/billing/marketplace/aws-marketplace-payg) | +| [AWS Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/aws-marketplace-committed-contract) | +| [GCP Marketplace PAYG](/docs/en/cloud/billing/marketplace/gcp-marketplace-payg) | +| [GCP Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/gcp-marketplace-committed-contract) | +| [Azure Marketplace PAYG](/docs/en/cloud/billing/marketplace/azure-marketplace-payg) | +| [Azure Marketplace Committed Contract](/docs/en/cloud/billing/marketplace/azure-marketplace-committed-contract) | \ No newline at end of file diff --git a/docs/en/cloud/manage/billing/marketplace/overview.md b/docs/en/cloud/manage/billing/marketplace/overview.md new file mode 100644 index 00000000000..e1699dcb4ec --- /dev/null +++ b/docs/en/cloud/manage/billing/marketplace/overview.md @@ -0,0 +1,81 @@ +--- +slug: /en/cloud/marketplace/marketplace-billing +title: Marketplace Billing +description: Subscribe to ClickHouse Cloud through the AWS, GCP, and Azure marketplace. +keywords: [aws, azure, gcp, google cloud, marketplace, billing] +--- + +You can subscribe to ClickHouse Cloud through the AWS, GCP, and Azure marketplaces. This allows you to pay for ClickHouse Cloud through your existing cloud provider billing. + +You can either use pay-as-you-go (PAYG) or commit to a contract with ClickHouse Cloud through the marketplace. The billing will be handled by the cloud provider, and you will receive a single invoice for all your cloud services. + +- [AWS Marketplace PAYG](/en/cloud/billing/marketplace/aws-marketplace-payg) +- [AWS Marketplace Committed Contract](/en/cloud/billing/marketplace/aws-marketplace-committed-contract) +- [GCP Marketplace PAYG](/en/cloud/billing/marketplace/gcp-marketplace-payg) +- [GCP Marketplace Committed Contract](/en/cloud/billing/marketplace/gcp-marketplace-committed-contract) +- [Azure Marketplace PAYG](/en/cloud/billing/marketplace/azure-marketplace-payg) +- [Azure Marketplace Committed Contract](/en/cloud/billing/marketplace/azure-marketplace-committed-contract) + +## FAQs + +### How can I verify that my organization is connected to marketplace billing?​ + +In the ClickHouse Cloud console, navigate to **Billing**. You should see the name of the marketplace and the link in the **Payment details** section. + +### I am an existing ClickHouse Cloud user. What happens when I subscribe to ClickHouse Cloud via AWS / GCP / Azure marketplace?​ + +Signing up for ClickHouse Cloud from the cloud provider marketplace is a two step process: +1. You first "subscribe" to ClickHouse Cloud on the cloud providers' marketplace portal. After you have finished subscribing, you click on "Pay Now" or "Manage on Provider" (depending on the marketplace). This redirects you to ClickHouse Cloud. +2. On Clickhouse Cloud you either register for a new account, or sign in with an existing account. Either way, a new ClickHouse Cloud organization will be created for you which is tied to your marketplace billing. + +NOTE: Your existing services and organizations from any prior ClickHouse Cloud signups will remain and they will not be connected to the marketplace billing. ClickHouse Cloud allows you to use the same account to manage multiple organization, each with different billing. + +You can switch between organizations from the bottom left menu of the ClickHouse Cloud console. + +### I am an existing ClickHouse Cloud user. What should I do if I want my existing services to be billed via marketplace?​ + +You will need to subscribe to ClickHouse Cloud via the cloud provider marketplace. Once you finish subscribing on the marketplace, and redirect to ClickHouse Cloud you will have the option of linking an existing ClickHouse Cloud organization to marketplace billing. From that point on, your existing resources will now get billed via the marketplace. + +![MPSignup_OrgLinking](https://github.com/user-attachments/assets/a0939007-320b-4b12-9d6d-fd63bce31864) + +You can confirm from the organization's billing page that billing is indeed now linked to the marketplace. Please contact [ClickHouse Cloud support](https://clickhouse.com/support/program) if you run into any issues. + +:::note +Your existing services and organizations from any prior ClickHouse Cloud signups will remain and they will not be connected to the marketplace billing. +::: + +### I subscribed to ClickHouse Cloud as a marketplace user. How can I unsubscribe?​ + +Note that you can simply stop using ClickHouse Cloud and delete all existing ClickHouse Cloud services. Even though the subscription will still be active, you will not be paying anything as ClickHouse Cloud doesn't have any recurring fees. + +If you want to unsubscribe, please navigate to the Cloud Provider console and cancel the subscription renewal there. Once the subscription ends, all existing services will be stopped and you will be prompted to add a credit card. If no card was added, after two weeks all existing services will be deleted. + +### I subscribed to ClickHouse Cloud as a marketplace user, and then unsubscribed. Now I want to subscribe back, what is the process?​ + +In that case please subscribe to the ClickHouse Cloud as usual (see sections on subscribing to ClickHouse Cloud via the marketplace). + +- For AWS marketplace a new ClickHouse Cloud organization will be created and connected to the marketplace. +- For the GCP marketplace your old organization will be reactivated. + +If you have any trouble with reactivating your marketplace org, please contact [ClickHouse Cloud Support](https://clickhouse.com/support/program). + +### How do I access my invoice for my marketplace subscription to the ClickHouse Cloud service?​ + +- [AWS billing Console](https://us-east-1.console.aws.amazon.com/billing/home) +- [GCP Marketplace orders](https://console.cloud.google.com/marketplace/orders) (select the billing account that you used for subscription) + +### Why do the dates on the Usage statements not match my Marketplace Invoice?​ + +Marketplace billing follows the calendar month cycle. For example, for usage between December 1st and January 1st, an invoice will be generated between January 3rd and January 5th. + +ClickHouse Cloud usage statements follow a different billing cycle where usage is metered and reported over 30 days starting from the day of sign up. + +The usage and invoice dates will differ if these dates are not the same. Since usage statements track usage by day for a given service, users can rely on statements to see the breakdown of costs. + +### Where can I find general billing information​? + +Please see the [Billing overview page](/en/cloud/manage/billing). + +### Is there a difference in ClickHouse Cloud pricing, whether paying through the cloud provider marketplace or directly to ClickHouse? + +There is no difference in pricing between marketplace billing and signing up directly with ClickHouse. In either case, your usage of ClickHouse Cloud is tracked in terms of ClickHouse Cloud Credits (CHCs), which are metered in the same way and billed accordingly. diff --git a/docs/en/cloud/manage/dashboards.md b/docs/en/cloud/manage/dashboards.md index f1fa6057777..2a0386a4e85 100644 --- a/docs/en/cloud/manage/dashboards.md +++ b/docs/en/cloud/manage/dashboards.md @@ -42,7 +42,7 @@ We can view the results of the query in table format or start building visualiza ![Save query](@site/docs/en/cloud/images/dashboards/3_dashboards.png) -More documentation around saved queries can be found in the [Saving a Query section](/docs/en/get-started/sql-console#saving-a-query). +More documentation around saved queries can be found in the [Saving a Query section](/docs/en/cloud/get-started/sql-console#saving-a-query). We can create and save another query, `query count by query kind`, to count the number of queries by query kind. Here’s a bar chart visualization of the data in the SQL console. diff --git a/docs/en/cloud/manage/index.md b/docs/en/cloud/manage/index.md new file mode 100644 index 00000000000..1bf6a118f5a --- /dev/null +++ b/docs/en/cloud/manage/index.md @@ -0,0 +1,27 @@ +--- +slug: /en/cloud/manage +keywords: [AWS, Cloud, serverless, management] +title: Overview +hide_title: true +--- + +# Managing Cloud + +In this section of the docs you will find all the information you may need about managing ClickHouse cloud. This section contains the following pages: + +| Page | Description | +|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| [Service Types](/docs/en/cloud/manage/service-types) | Describes the different service options, their features, and considerations for choosing the right one. | +| [Integrations](/docs/en/manage/integrations) | Covers ClickHouse Cloud's built-in integrations, custom integrations, and integrations that are not supported. | +| [Backups](/docs/en/cloud/manage/backups) | Describes how backups work in ClickHouse Cloud, what options you have to configure backups for your service, and how to restore from a backup. | +| [Monitoring](/docs/en/integrations/prometheus) | How to integrate Prometheus as a way to monitor ClickHouse cloud. | +| [Billing](/docs/en/cloud/manage/billing/overview) | Explains the pricing model for ClickHouse Cloud, including the factors that affect the cost of your service. | +| [Configuring Settings](/docs/en/manage/settings) | Describes how to configure settings for ClickHouse Cloud. | +| [Replica-aware Routing](/docs/en/manage/replica-aware-routing) | Explains what Replica-aware Routing in ClickHouse Cloud is, its limitations, and how to configure it. | +| [Automatic Scaling](/docs/en/manage/scaling) | Explains how ClickHouse Cloud services can be scaled manually or automatically based on your resource needs. | +| [Service Uptime and SLA](/docs/en/cloud/manage/service-uptime) | Information about service uptimes and Service Level Agreements offered for production instances. | +| [Notifications](/docs/en/cloud/notifications) | Shows how ClickHouse Cloud notifications are received and how they can be customized. | +| [Upgrades](/docs/en/manage/updates) | Information on how upgrades are rolled out in ClickHouse Cloud. | +| [Delete Account](/docs/en/cloud/manage/close_account) | Information on how to close or delete your account when necessary. | +| [Programmatic API Access with Postman](/docs/en/cloud/manage/postman) | A guide to help you test the ClickHouse API using Postman. | +| [Troubleshooting](/docs/en/faq/troubleshooting) | A collection of commonly encountered issues and how to troubleshoot them. | \ No newline at end of file diff --git a/docs/en/cloud/reference/changelog.md b/docs/en/cloud/reference/changelog.md index f67081e6de7..95f174b7eb6 100644 --- a/docs/en/cloud/reference/changelog.md +++ b/docs/en/cloud/reference/changelog.md @@ -54,7 +54,7 @@ We are excited to announce the GA release of Query API Endpoints in ClickHouse C In addition to these improvements, we are excited to announce generic query API endpoints that, leveraging our existing framework, allow you to execute arbitrary SQL queries against your ClickHouse Cloud service(s). Generic endpoints can be enabled and configured from the service settings page. -To get started, follow the [Query API Endpoints documentation](/docs/en/get-started/query-endpoints). +To get started, follow the [Query API Endpoints documentation](/docs/en/cloud/get-started/query-endpoints). API Endpoints diff --git a/docs/en/cloud/security/cloud-access-management.md b/docs/en/cloud/security/cloud-access-management/cloud-access-management.md similarity index 99% rename from docs/en/cloud/security/cloud-access-management.md rename to docs/en/cloud/security/cloud-access-management/cloud-access-management.md index 5b212de4446..f39e34f852b 100644 --- a/docs/en/cloud/security/cloud-access-management.md +++ b/docs/en/cloud/security/cloud-access-management/cloud-access-management.md @@ -1,6 +1,6 @@ --- sidebar_label: Overview -slug: /en/cloud/security/cloud-access-management +slug: /en/cloud/security/cloud-access-management/overview title: Cloud access management --- diff --git a/docs/en/cloud/security/cloud-authentication.md b/docs/en/cloud/security/cloud-access-management/cloud-authentication.md similarity index 100% rename from docs/en/cloud/security/cloud-authentication.md rename to docs/en/cloud/security/cloud-access-management/cloud-authentication.md diff --git a/docs/en/cloud/security/cloud-access-management/index.md b/docs/en/cloud/security/cloud-access-management/index.md new file mode 100644 index 00000000000..bc91c4e7c17 --- /dev/null +++ b/docs/en/cloud/security/cloud-access-management/index.md @@ -0,0 +1,13 @@ +--- +slug: /en/cloud/security/cloud-access-management +title: Cloud Access Management +Description: Cloud Access Management Table Of Contents +--- + +| Page | Description | +|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/cloud/security/cloud-access-management/overview) | Overview of access control in ClickHouse Cloud | +| [Cloud Authentication](/docs/en/cloud/security/cloud-authentication) | A guide which explores some good practices for configuring your authentication | +| [SAML SSO Setup](/docs/en/cloud/security/saml-setup) | A guide on how to setup SAML SSO. | +| [Common Access Management Queries](/docs/en/cloud/security/common-access-management-queries) | Article showing the basics of defining SQL users and roles and applying those privileges and permissions to databases, tables, rows, and columns. | +| [Inviting New Users](/docs/en/cloud/security/inviting-new-users) | A how-to for inviting new users to your organization and how to assign them roles. | diff --git a/docs/en/cloud/security/connectivity-overview.md b/docs/en/cloud/security/connectivity-overview.md new file mode 100644 index 00000000000..660a447d901 --- /dev/null +++ b/docs/en/cloud/security/connectivity-overview.md @@ -0,0 +1,15 @@ +--- +slug: /en/cloud/security/connectivity +title: connectivity overview +--- + +# Connectivity + +This section looks at connectivity and contains the following pages: + +| Page | Description | +|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| [Setting IP Filters](/docs/en/cloud/security/setting-ip-filters) | A guide on how to control traffic to your ClickHouse services using IP access lists. | +| [Private Networking](/docs/en/cloud/security/private-link-overview) | Information on how to connect your services to your cloud virtual network. | +| [Accessing S3 Data Securely](/docs/en/cloud/security/secure-s3) | A guide on how to leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access data securely. | +| [Cloud IP Addresses](/docs/en/manage/security/cloud-endpoints-api) | Tables listing the static IPs and S3 endpoints for each supported cloud and region in ClickHouse Cloud. | \ No newline at end of file diff --git a/docs/en/cloud/security/index.md b/docs/en/cloud/security/index.md new file mode 100644 index 00000000000..4e448255ba1 --- /dev/null +++ b/docs/en/cloud/security/index.md @@ -0,0 +1,19 @@ +--- +slug: /en/cloud/security +keywords: [Cloud, Security] +title: Overview +hide_title: true +--- + +# ClickHouse Cloud Security + +This section delves into security in ClickHouse Cloud and contains the following pages: + +| Page | Description | +|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| [Shared Responsibility Model](en/cloud/security/shared-responsibility-model) | Information on the security features offered for each service type. | +| [Cloud Access Management](.) | Information on access control, authentication, SSO setup, common access management queries and how to invite new users. | +| [Connectivity](.) | Information on setting IP filters, private networking, secure access of S3 data and Cloud IP addresses. | +| [Customer Managed Encryption Keys](.) | Information about how customers can leverage their own Key Management Service (KMS) key. | +| [Audit Logging](en/cloud/security/audit-logging) | A guide to audit logging in ClickHouse Cloud. | +| [Privacy and Compliance](.) | Information on security and compliance of ClickHouse Cloud, a guide on how to view and correct your personal information. | \ No newline at end of file diff --git a/docs/en/cloud/security/privacy-compliance-overview.md b/docs/en/cloud/security/privacy-compliance-overview.md new file mode 100644 index 00000000000..9f3fd751a76 --- /dev/null +++ b/docs/en/cloud/security/privacy-compliance-overview.md @@ -0,0 +1,14 @@ +--- +sidebar_label: Privacy and Compliance Overview +slug: /en/cloud/security/privacy-compliance-overview +title: Privacy Compliance Overview +--- + +# Privacy and Compliance + +This section contains the following pages: + +| Page | Description | +|----------------------------------------------------------------------------|--------------------------------------------------------------| +| [Security and Compliance](/docs/en/cloud/security/security-and-compliance) | Security reports and privacy compliance of ClickHouse Cloud. | +| [Personal Data Access](/docs/en/cloud/security/personal-data-access) | Information on how to access your personal data. | \ No newline at end of file diff --git a/docs/en/data-modeling/index.md b/docs/en/data-modeling/index.md new file mode 100644 index 00000000000..594ef15faa8 --- /dev/null +++ b/docs/en/data-modeling/index.md @@ -0,0 +1,18 @@ +--- +slug: /en/data-modeling/overview +title: Data Modelling Overview +description: Overview of Data Modelling +keywords: [data modelling, schema design, dictionary, materialized view, data compression, denormalizing data] +--- + +# Data Modeling + +This section is about data modeling in ClickHouse and contains the following topics: + +| Page | Description | +|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Schema Design](/docs/en/data-modeling/schema-design) | Discusses ClickHouse schema design for optimal performance, considering factors like queries, data updates, latency, and volume. | +| [Dictionary](/docs/en/dictionary) | An explainer on how to define and use dictionaries to improve query performance and enrich data. | +| [Materialized View](/docs/en/materialized-view) | Information on Materialized Views and Refreshable Materialized Views in ClickHouse. | +| [Data Compression](/docs/en/data-compression/compression-in-clickhouse) | Discusses various compression modes in ClickHouse and how to optimize data storage and query performance by choosing the right compression method for your specific data types and workloads. | +| [Denormalizing Data](/docs/en/data-modeling/denormalization) | Discusses the denormalization approach used in ClickHouse which aims to improve query performance by storing related data in a single table. | diff --git a/docs/en/deployment-guides/index.md b/docs/en/deployment-guides/index.md new file mode 100644 index 00000000000..fedbe1ec0c2 --- /dev/null +++ b/docs/en/deployment-guides/index.md @@ -0,0 +1,15 @@ +--- +slug: /en/deployment-guides/index +title: Deployment Guides Overview +--- + +# Deployment and Scaling + +This section covers the following topics: + +| Topic | +|------------------------------------------------------------------| +| [Introduction](/en/architecture/introduction) | +| [Scaling Out](/en/architecture/horizontal-scaling) | +| [Replication for fault tolerance](/en/architecture/replication) | +| [Cluster Deployment](/en/architecture/cluster-deployment) | \ No newline at end of file diff --git a/docs/en/guides/best-practices/index.md b/docs/en/guides/best-practices/index.md new file mode 100644 index 00000000000..4488abda6d1 --- /dev/null +++ b/docs/en/guides/best-practices/index.md @@ -0,0 +1,25 @@ +--- +slug: /en/operations/overview +sidebar_label: Performance and Optimizations Overview +description: Overview page of Performance and Optimizations +--- + +# Performance and Optimizations + +This section covers the following topics: + +| Topic | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/optimize) | Provides an overview and suggested reading before working through this section of the docs. | +| [Analyzer](/docs/en/operations/analyzer) | Looks at the ClickHouse Analyzer, a tool for analyzing and optimizing queries. Discusses how the Analyzer works, its benefits (e.g., identifying performance bottlenecks), and how to use it to improve your ClickHouse queries' efficiency. | +| [Asynchronous Inserts](/docs/en/optimize/asynchronous-inserts) | Focuses on ClickHouse's asynchronous inserts feature. It likely explains how asynchronous inserts work (batching data on the server for efficient insertion) and their benefits (improved performance by offloading insert processing). It might also cover enabling asynchronous inserts and considerations for using them effectively in your ClickHouse environment. | +| [Avoid Mutations](/docs/en/optimize/avoid-mutations) | Discusses the importance of avoiding mutations (updates and deletes) in ClickHouse. It recommends using append-only inserts for optimal performance and suggests alternative approaches for handling data changes. | +| [Avoid Nullable Columns](/docs/en/optimize/avoid-nullable-columns)| Discusses why you may want to avoid Nullable columns to save space and increase performance. Demosntrates how to set a default value for a column. | +| [Avoid Optimize Final](/docs/en/optimize/avoidoptimizefinal) | Explains how the `OPTIMIZE TABLE ... FINAL` query is resource-intensive and suggests alternative approaches to optimize ClickHouse performance. | +| [Bulk Inserts](/docs/en/optimize/bulk-inserts) | Explains the benefits of using bulk inserts in ClickHouse. | +| [Partitioning Key](/docs/en/optimize/partitioning-key) | Delves into ClickHouse partition key optimization. Explains how choosing the right partition key can significantly improve query performance by allowing ClickHouse to quickly locate relevant data segments. Covers best practices for selecting efficient partition keys and potential pitfalls to avoid. | +| [Data Skipping Indexes](/docs/en/optimize/skipping-indexes) | Explains data skipping indexes as a way to optimize performance. | +| [Sparse Primary Indexes](/docs/en/optimize/sparse-primary-indexes)| Discusses sparse primary indexes in ClickHouse which are used to significantly accelerate query execution. | +| [Query Profiling](/docs/en/operations/optimizing-performance/sampling-query-profiler) | Explains ClickHouse's Sampling Query Profiler, a tool that helps analyze query execution. | +| [Testing Hardware](/docs/en/operations/performance-test) | How to run a basic ClickHouse performance test on any server without installation of ClickHouse packages. (Not applicable to ClickHouse Cloud) | +| [Query Cache](/docs/en/operations/query-cache) | Details ClickHouse's Query Cache, a feature that aims to improve performance by caching the results of frequently executed `SELECT` queries. | diff --git a/docs/en/guides/developer/index.md b/docs/en/guides/developer/index.md new file mode 100644 index 00000000000..cfdd6bd5f3b --- /dev/null +++ b/docs/en/guides/developer/index.md @@ -0,0 +1,21 @@ +--- +slug: /en/guides/developer/overview +sidebar_label: Advanced Guides Overview +description: Overview of the advanced guides +--- + +# Advanced Guides + +This section contains the following advanced guides: + +| Guide | Description | +|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Alternative Query Languages](en/guides/developer/alternative-query-languages) | A guide on alternative supported dialects and how to use them. Provides examples of queries in each dialect. | +| [Cascading Materialized Views](en/guides/developer/cascading-materialized-views) | A guide on how to create Materialized Views and cascade them together, combine multiple source tables into a single destination table. Contains an example of using cascading materialized views to aggregate data by month and year for a group of domain names. | +| [Debugging memory issues](en/guides/developer/debugging-memory-issues) | A guide on how to debug memory issues within ClickHouse. | +| [Deduplicating Inserts on Retries](en/guides/developer/deduplicating-inserts-on-retries) | A guide on how to handle situations where you might retry failed inserts. | +| [Deduplication Strategies](en/guides/developer/deduplication) | A guide which dives into data deduplication, a technique for removing duplicate rows from your database. Explains differences from primary key-based deduplication in OLTP systems, ClickHouse's approach to deduplication and how to handle duplicate data scenarios within your ClickHouse queries. | +| [Filling gaps in time-series data](en/guides/developer/time-series-filling-gaps) | A guide which provides insights into ClickHouse's capabilities for handling time-series data, including techniques for filling gaps in data to create a more complete and continuous representation of time-series information. | +| [Manage Data with TTL (Time-to-live)](en/guides/developer/ttl) | A guide discussing how to use the `WITH FILL` clause to fill gaps in time-series data. It covers how to fill gaps with 0 values, how to specify a starting point for filling gaps, how to fill gaps up to a specific end point, and how to interpolate values for cumulative calculations. | +| [Understanding Query Execution with the Analyzer](en/guides/developer/understanding-query-execution-with-the-analyzer) | A guide which demystifies ClickHouse query execution by introducing the analyzer tool. It explains how the analyzer breaks down a query into a series of steps, allowing you to visualize and troubleshoot the entire execution process for optimal performance. | +| [Using JOINs in ClickHouse](en/guides/joining-tables) | A guide that simplifies joining tables in ClickHouse. It covers different join types (`INNER`, `LEFT`, `RIGHT`, etc.), explores best practices for efficient joins (like placing smaller tables on the right), and provides insights on ClickHouse's internal join algorithms to help you optimize your queries for complex data relationships. | \ No newline at end of file diff --git a/docs/en/guides/manage-and-deploy-index.md b/docs/en/guides/manage-and-deploy-index.md new file mode 100644 index 00000000000..9e429c4e7fa --- /dev/null +++ b/docs/en/guides/manage-and-deploy-index.md @@ -0,0 +1,34 @@ +--- +title: Manage and Deploy Overview +description: Overview page for Manage and Deploy +--- + +# Manage and Deploy + +This section contains the following topics: + +| Topic | Description | +|-------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| [Deployment and Scaling](/en/deployment-guides/index) | Working deployment examples based on the advice provided to ClickHouse users by the ClickHouse Support and Services organization. | +| [Separation of Storage and Compute](/docs/en/guides/separation-storage-compute) | Guide exploring how you can use ClickHouse and S3 to implement an architecture with separated storage and compute. | +| [Sizing and Hardware Recommendations](/docs/en/guides/sizing-and-hardware-recommendations) | Guide discussing general recommendations regarding hardware, compute, memory, and disk configurations for open-source users. | +| [Configuring ClickHouse Keeper](/docs/en/guides/sre/keeper/clickhouse-keeper) | Information and examples on how to configure ClickHouse Keeper. | +| [Network ports](/docs/en/guides/sre/network-ports) | List of network ports used by ClickHouse. | +| [Re-balancing Shards](/docs/en/guides/sre/scaling-clusters) | Recommendations on re-balancing shards. | +| [Does ClickHouse support multi-region replication?](/docs/en/faq/operations/multi-region-replication) | FAQ on multi-region replication. | +| [Which ClickHouse version to use in production?](/docs/en/faq/operations/production) | FAQ on ClickHouse versions for production use. | +| [Cluster Discovery](/docs/en/operations/cluster-discovery) | Information and examples of ClickHouse's cluster discovery feature. | +| [Monitoring](/docs/en/operations/monitoring) | Information on how you can monitor hardware resource utilization and server metrics of ClickHouse. | +| [Tracing ClickHouse with OpenTelemetry](/docs/en/operations/opentelemetry) | Information on using OpenTelemetry with ClickHouse. | +| [Quotas](/docs/en/operations/quotas) | Information and examples on quotas in ClickHouse. | +| [Secured Communication with Zookeeper](/docs/en/operations/ssl-zookeeper) | Guide to setting up secured communication between ClickHouse and Zookeeper. | +| [Startup Scripts](/docs/en/operations/startup-scripts) | Example of how to run startup scripts during startup, useful for migrations or automatic schema creation. | +| [External Disks for Storing Data](/docs/en/operations/storing-data) | Information and examples on configuring external storage with ClickHouse. | +| [Allocation profiling](/docs/en/operations/allocation-profiling) | Information and examples on allocation sampling and profiling with jemalloc. | +| [Backup and Restore](/docs/en/operations/backup) | Guide to backing up to a local disk or external storage. | +| [Caches](/docs/en/operations/caches) | Explainer on the various cache types in ClickHouse. | +| [Workload scheduling](/docs/en/operations/workload-scheduling) | Explainer on workload scheduling in ClickHouse. | +| [Self-managed Upgrade](/docs/en/operations/update) | Guidelines on carrying out a self-managed upgrade. | +| [Troubleshooting](/docs/en/guides/troubleshooting) | Assorted troubleshooting tips. | +| [Usage Recommendations](/docs/en/operations/tips) | Assorted ClickHouse hardware and software usage recommendations. | +| [Distributed DDL](/docs/en/sql-reference/distributed-ddl) | Explainer of the `ON CLUSTER` clause. | \ No newline at end of file diff --git a/docs/en/integrations/data-ingestion/data-ingestion-index.md b/docs/en/integrations/data-ingestion/data-ingestion-index.md new file mode 100644 index 00000000000..26aba4463d2 --- /dev/null +++ b/docs/en/integrations/data-ingestion/data-ingestion-index.md @@ -0,0 +1,20 @@ +--- +slug: /en/integrations/data-ingestion-overview +keywords: [Airbyte, Amazon Glue, Apache Beam, dbt, Fivetran, NiFi, dlt, Vector] +--- + +# Data Ingestion + +ClickHouse integrates with a number of solutions for data integration and transformation. +For more information check out the pages below: + +| Data Ingestion Tool | Description | +|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Airbyte](/docs/en/integrations/airbyte) | An open-source data integration platform. It allows the creation of ELT data pipelines and is shipped with more than 140 out-of-the-box connectors. | +| [Amazon Glue](/docs/en/integrations/glue) | A fully managed, serverless data integration service provided by Amazon Web Services (AWS) simplifying the process of discovering, preparing, and transforming data for analytics, machine learning, and application development. | +| [Apache Beam](/docs/en/integrations/apache-beam) | An open-source, unified programming model that enables developers to define and execute both batch and stream (continuous) data processing pipelines. | +| [dbt](/docs/en/integrations/dbt) | Enables analytics engineers to transform data in their warehouses by simply writing select statements. | +| [dlt](/docs/en/integrations/dlt) | An open-source library that you can add to your Python scripts to load data from various and often messy data sources into well-structured, live datasets. | +| [Fivetran](/docs/en/integrations/fivetran) | An automated data movement platform moving data out of, into and across your cloud data platforms. | +| [NiFi](/docs/en/integrations/nifi) | An open-source workflow management software designed to automate data flow between software systems. | +| [Vector](/docs/en/integrations/vector) | A high-performance observability data pipeline that puts organizations in control of their observability data. | \ No newline at end of file diff --git a/docs/en/integrations/data-ingestion/data-sources-index.md b/docs/en/integrations/data-ingestion/data-sources-index.md new file mode 100644 index 00000000000..ee82da39ad7 --- /dev/null +++ b/docs/en/integrations/data-ingestion/data-sources-index.md @@ -0,0 +1,36 @@ +--- +slug: /en/integrations/index +keywords: [AWS S3, PostgreSQL, Kafka, Apache Spark, MySQL, Cassandra, Redis, RabbitMQ, MongoDB, Google Cloud Storage, Hive, Hudi, Iceberg, MiniIO, Delta Lake, RocksDB, Splunk, SQlite, NATS, EMQX, local files, JDBC, ODBC] +description: Datasources overview page +--- + +# Data Sources + +ClickHouse allows you to easily ingest data into your database from a variety of sources. +For further information see the pages listed below: + +| Data Source | +|-------------------------------------------------------------------------------| +| [AWS S3](/docs/en/integrations/s3) | +| [PostgreSQL](/docs/en/integrations/postgresql) | +| [Kafka](/docs/en/integrations/kafka) | +| [Apache Spark](/docs/en/integrations/apache-spark) | +| [MySQL](/docs/en/integrations/mysql) | +| [Cassandra](/docs/en/integrations/cassandra) | +| [Redis](/docs/en/integrations/redis) | +| [RabbitMQ](/docs/en/integrations/rabbitmq) | +| [MongoDB](/docs/en/integrations/mongodb) | +| [Google Cloud Storage (GCS)](/docs/en/integrations/gcs) | +| [Hive](/docs/en/integrations/hive) | +| [Hudi](/docs/en/integrations/hudi) | +| [Iceberg](/docs/en/integrations/iceberg) | +| [MinIO](/docs/en/integrations/minio) | +| [Delta Lake](/docs/en/integrations/deltalake) | +| [RocksDB](/docs/en/integrations/rocksdb) | +| [Splunk](/docs/en/integrations/splunk) | +| [SQlite](/docs/en/integrations/sqlite) | +| [NATS](/docs/en/integrations/nats) | +| [EMQX](/docs/en/integrations/emqx) | +| [Insert Local Files](/docs/en/integrations/data-ingestion/insert-local-files) | +| [JDBC](/docs/en/integrations/jdbc/jdbc-with-clickhouse) | +| [ODBC](/docs/en/integrations/data-ingestion/dbms/odbc-with-clickhouse) | \ No newline at end of file diff --git a/docs/en/integrations/migration/index.md b/docs/en/integrations/migration/index.md index 2566c2a2317..33a787529ba 100644 --- a/docs/en/integrations/migration/index.md +++ b/docs/en/integrations/migration/index.md @@ -2,29 +2,19 @@ sidebar_label: Overview sidebar_position: 1 keywords: [clickhouse, migrate, migration, migrating, data] +description: Migrating To Cloud Table Of Contents +title: Migrating To Cloud --- -# Migrating Data into ClickHouse +This section of the docs explores how you can migrate from ClickHouse to ClickHouse Cloud. +Take a look at the pages below for further information. -
- -
- -
- -There are several options for migrating data into ClickHouse Cloud, depending on where your data resides now: - -- [Self-managed to Cloud](./clickhouse-to-cloud.md): use the `remoteSecure` function to transfer data -- [Another DBMS](./clickhouse-local-etl.md): use the [clickhouse-local] ETL tool along with the appropriate ClickHouse table function for your current DBMS -- [Anywhere!](./etl-tool-to-clickhouse.md): use one of the many popular ETL/ELT tools that connect to all kinds of different data sources -- [Object Storage](./object-storage-to-clickhouse.md): easily insert data from S3 into ClickHouse - -In the example [Migrate from Redshift](/docs/en/integrations/data-ingestion/redshift/index.md), we present three different ways to migrate data to ClickHouse. +| Page | Description | +|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/integrations/migration/overview) | Provides an overview of the available ways to migrate from ClickHouse to ClickHouse Cloud | +| [Migrating to ClickHouse using clickhouse-local](/docs/en/cloud/migration/clickhouse-local) | Learn how to migrate to ClickHouse using clickhouse-local. | | +| [ClickHouse to ClickHouse Cloud](/docs/en/cloud/migration/clickhouse-to-cloud) | This guide will show how to migrate from a self-managed ClickHouse server to ClickHouse Cloud, and also how to migrate between ClickHouse Cloud services. | +| [Using a 3rd-party ETL Tool](/docs/en/cloud/migration/etl-tool-to-clickhouse) | Learn more about the popular ETL and ELT tools for moving data from an external data source into ClickHouse. | +| [Object Storage to ClickHouse Cloud](/docs/en/integrations/migration/object-storage-to-clickhouse) | Learn how to use various table functions to import data from Cloud Object Storage into ClickHouse Cloud. | +| [Upload a CSV File](/docs/en/integrations/migration/upload-a-csv-file) | Learn how to upload data to ClickHouse Cloud using a CSV or TSV file. | +| [Migrating From Rocksset](/docs/en/migrations/rockset) | Learn how to migrate from Rockset to ClickHouse Cloud. | \ No newline at end of file diff --git a/docs/en/integrations/migration/overview.md b/docs/en/integrations/migration/overview.md new file mode 100644 index 00000000000..437e25023c9 --- /dev/null +++ b/docs/en/integrations/migration/overview.md @@ -0,0 +1,31 @@ +--- +sidebar_label: Overview +sidebar_position: 1 +slug: /en/integrations/migration/overview +keywords: [clickhouse, migrate, migration, migrating, data] +--- + +# Migrating Data into ClickHouse + +
+ +
+ +
+ +There are several options for migrating data into ClickHouse Cloud, depending on where your data resides now: + +- [Self-managed to Cloud](./clickhouse-to-cloud.md): use the `remoteSecure` function to transfer data +- [Another DBMS](./clickhouse-local-etl.md): use the [clickhouse-local] ETL tool along with the appropriate ClickHouse table function for your current DBMS +- [Anywhere!](./etl-tool-to-clickhouse.md): use one of the many popular ETL/ELT tools that connect to all kinds of different data sources +- [Object Storage](./object-storage-to-clickhouse.md): easily insert data from S3 into ClickHouse + +In the example [Migrate from Redshift](/docs/en/integrations/data-ingestion/redshift/index.md), we present three different ways to migrate data to ClickHouse. diff --git a/docs/en/integrations/migration/rockset.md b/docs/en/integrations/migration/rockset.md index be453a7a6a2..40181503ab6 100644 --- a/docs/en/integrations/migration/rockset.md +++ b/docs/en/integrations/migration/rockset.md @@ -65,7 +65,7 @@ ClickHouse adds extra functions on top of the ones in the SQL standard to give y ### Query Lambdas Rockset supports query lambdas, named parameterized queries stored in Rockset that can be executed from a dedicated REST endpoint. -ClickHouse Cloud's [Query API Endpoints](/en/get-started/query-endpoints) offer similar functionality. +ClickHouse Cloud's [Query API Endpoints](/en/cloud/get-started/query-endpoints) offer similar functionality. ### Views diff --git a/docs/en/integrations/sql-clients/index.md b/docs/en/integrations/sql-clients/index.md new file mode 100644 index 00000000000..e28a26d0a5b --- /dev/null +++ b/docs/en/integrations/sql-clients/index.md @@ -0,0 +1,19 @@ +--- +slug: /en/integrations/sql-clients/ +description: Overview page for ClickHouse SQL clients. +keywords: [integrations, DataGrip, DBeaver, DBVisaulizer, Jupyter Notebooks, qStudio,TABLUM.IO] +--- + +# SQL Client Integrations + +This section describes how to integrate ClickHouse with various common database management, analysis and visualization tools. + +| Tool | Description | +|-----------------------------------------------------|-------------------------------------------------------------| +| [DataGrip](/docs/en/integrations/datagrip) | Powerful database IDE | +| [DBeaver](/docs/en/integrations/dbeaver) | Database administration and development tool | +| [DBVisaulizer](/docs/en/integrations/dbvisualizer) | Database management tool for developers, DBAs, and analysts | +| [Jupyter Notebooks](/docs/en/integrations/jupysql) | Interactive notebooks for code, visualizations, and text | +| [qStudio](/docs/en/integrations/qstudio) | Free, open-source SQL GUI client | +| [TABLUM.IO](/docs/en/integrations/tablumio) | Cloud-based data visualization platform | + diff --git a/docs/en/interfaces/native-clients-interfaces-index.md b/docs/en/interfaces/native-clients-interfaces-index.md new file mode 100644 index 00000000000..9bf69386e14 --- /dev/null +++ b/docs/en/interfaces/native-clients-interfaces-index.md @@ -0,0 +1,17 @@ +--- +slug: /en/interfaces/natives-clients-and-interfaces +keywords: [clients, interfaces, CLI, SQL console, drivers] +description: Native clients and interfaces for ClickHouse +--- + +# Native Clients & Interfaces + +ClickHouse provides a number of different native clients and interfaces that allow you to connect to ClickHouse. + +For more information see the pages below: + +| Section | Summary | +|--------------------------------------------------------------|-------------------------------------------------------------------------------------| +| [Command-Line Client](/docs/en/interfaces/cli) | Native command-line client supporting command-line options and configuration files. | +| [Drivers & Interfaces](/docs/en/interfaces/overview) | A number of network interfaces, libraries and visual interfaces. | +| [SQL Console](/docs/en/integrations/sql-clients/sql-console) | A fast and easy way to interact with your data in ClickHouse Cloud. | \ No newline at end of file diff --git a/docs/en/managing-data/core-concepts/index.md b/docs/en/managing-data/core-concepts/index.md new file mode 100644 index 00000000000..d9aeb597b28 --- /dev/null +++ b/docs/en/managing-data/core-concepts/index.md @@ -0,0 +1,15 @@ +--- +slug: /en/concepts +title: Core Concepts +description: Learn Core Concepts of how ClickHouse works +keywords: [concepts, part, partition, primary index] +--- + +In this section of the documentation, +you will learn some of the core concepts of how ClickHouse works. + +| Page | Description | +|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Table parts](/docs/en/parts) | Learn what table parts are in ClickHouse. | +| [Table partitions](/docs/en/partitions) | Learn what table partitions are and what they are used for. | +| [Primary indexes](/docs/en/optimize/sparse-primary-indexes) | A deep dive into ClickHouse indexing including how it differs from other DB systems, how ClickHouse builds and uses a table's spare primary index and what some of the best practices are for indexing in ClickHouse. | diff --git a/docs/en/managing-data/delete_mutations.md b/docs/en/managing-data/deleting-data/delete_mutations.md similarity index 100% rename from docs/en/managing-data/delete_mutations.md rename to docs/en/managing-data/deleting-data/delete_mutations.md diff --git a/docs/en/managing-data/deleting-data/index.md b/docs/en/managing-data/deleting-data/index.md new file mode 100644 index 00000000000..c9bd85e3c12 --- /dev/null +++ b/docs/en/managing-data/deleting-data/index.md @@ -0,0 +1,18 @@ +--- +slug: /en/managing-data/deleting-data/overview +title: Deleting Data +description: How to delete data in ClickHouse Table Of Contents +keywords: [delete, truncate, drop, lightweight delete] +--- + +In this section of the documentation, +we will explore how to delete data in ClickHouse. + +| Page | Description | +|---------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/deletes/overview) | Provides an overview of the various ways to delete data in ClickHouse. | +| [Lightweight Deletes](/docs/en/guides/developer/lightweight-delete) | Learn how to use the Lightweight Delete to delete data. | +| [Delete Mutations](/docs/en/managing-data/delete_mutations) | Learn about Delete Mutations. | +| [Truncate Table](/docs/en/managing-data/truncate) | Learn about how to use Truncate, which allows the data in a table or database to be removed, while preserving its existence. | +| [Drop Partitions](/docs/en/managing-data/drop_partition) | Learn about Dropping Partitions in ClickHouse. | + diff --git a/docs/en/managing-data/deletes.md b/docs/en/managing-data/deleting-data/overview.md similarity index 99% rename from docs/en/managing-data/deletes.md rename to docs/en/managing-data/deleting-data/overview.md index 98cdc7ab174..ff3cc556642 100644 --- a/docs/en/managing-data/deletes.md +++ b/docs/en/managing-data/deleting-data/overview.md @@ -1,6 +1,6 @@ --- -slug: /en/deletes -title: Deleting Data +slug: /en/deletes/overview +title: Overview description: How to delete data in ClickHouse keywords: [delete, truncate, drop, lightweight delete] --- diff --git a/docs/en/managing-data/updating-data/index.md b/docs/en/managing-data/updating-data/index.md new file mode 100644 index 00000000000..aac57f62a0e --- /dev/null +++ b/docs/en/managing-data/updating-data/index.md @@ -0,0 +1,15 @@ +--- +slug: /en/updating-data +title: Updating Data +description: Updating Data Table Of Contents +keywords: [update, updating data] +--- + +In this section of the documentation, you will learn how you can update your data. + +| Page | Description | +|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Overview](/docs/en/updating-data/overview) | Provides an overview of the differences in updating data between ClickHouse and OLTP databases, as well as the various methods available to do so in ClickHouse. | +| [Update Mutations](/docs/en/managing-data/update_mutations) | Learn how to update using Update Mutations. | +| [Lightweight Updates](/docs/en/guides/developer/lightweight-update) | Learn how to update using Lightweight Updates. | +| [ReplacingMergeTree](/docs/en/guides/replacing-merge-tree) | Learn how to update using the ReplacingMergeTree. | \ No newline at end of file diff --git a/docs/en/managing-data/updates.md b/docs/en/managing-data/updating-data/overview.md similarity index 99% rename from docs/en/managing-data/updates.md rename to docs/en/managing-data/updating-data/overview.md index 17993f42fa8..820a74a4af8 100644 --- a/docs/en/managing-data/updates.md +++ b/docs/en/managing-data/updating-data/overview.md @@ -1,6 +1,6 @@ --- -slug: /en/updating-data -title: Updating Data +slug: /en/updating-data/overview +title: Overview description: How to update data in ClickHouse keywords: [update, updating data] --- diff --git a/docs/en/managing-data/update_mutations.md b/docs/en/managing-data/updating-data/update_mutations.md similarity index 100% rename from docs/en/managing-data/update_mutations.md rename to docs/en/managing-data/updating-data/update_mutations.md diff --git a/docs/en/migrations/bigquery/equivalent-concepts.md b/docs/en/migrations/bigquery/equivalent-concepts.md index afb74080da7..ede880fad56 100644 --- a/docs/en/migrations/bigquery/equivalent-concepts.md +++ b/docs/en/migrations/bigquery/equivalent-concepts.md @@ -50,7 +50,7 @@ Lastly, I/O scheduling allows users to restrict local and remote disk accesses f ### Permissions -ClickHouse Cloud [controls user access](/en/cloud/security/cloud-access-management) in two places, via the [cloud console](/en/get-started/sql-console) and via the database. Console access is managed via the [clickhouse.cloud](https://clickhouse.cloud) user interface. Database access is managed via database user accounts and roles. Additionally, console users can be granted roles within the database that enable the console user to interact with the database via our [SQL console](/en/integrations/sql-clients/sql-console). +ClickHouse Cloud [controls user access](/en/cloud/security/cloud-access-management) in two places, via the [cloud console](/en/cloud/get-started/sql-console) and via the database. Console access is managed via the [clickhouse.cloud](https://clickhouse.cloud) user interface. Database access is managed via database user accounts and roles. Additionally, console users can be granted roles within the database that enable the console user to interact with the database via our [SQL console](/en/integrations/sql-clients/sql-console). ## Data types diff --git a/docs/en/whats-new/changelog/index.md b/docs/en/whats-new/changelog/index.md index 833b020f20a..32aa4df5b95 100644 --- a/docs/en/whats-new/changelog/index.md +++ b/docs/en/whats-new/changelog/index.md @@ -5,4 +5,3 @@ sidebar_label: 2025 title: 2025 Changelog note: This file is autogenerated by the yarn new-build --- - diff --git a/docs/index.md b/docs/index.md index 304a35b76da..8a229df4512 100644 --- a/docs/index.md +++ b/docs/index.md @@ -86,7 +86,7 @@ export const ConnectToClickHouse = ({ children, color}) => {
} link='/docs/en/interfaces/cli'>ClickHouse CLI - } link='/docs/en/get-started/sql-console'>Cloud SQL Console + } link='/docs/en/cloud/get-started/sql-console'>Cloud SQL Console Node.js
diff --git a/docusaurus.config.js b/docusaurus.config.js index 321eba04501..6274a7b6130 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -4,6 +4,13 @@ import katex from 'rehype-katex'; import chHeader from './plugins/header.js'; import fixLinks from './src/hooks/fixLinks.js'; +// Helper function to skip over index.md files. +function skipIndex(items) { + return items.filter(({ type, id }) => { + return type !== 'doc' || !id.match(/index$/); + }); +} + /** @type {import('@docusaurus/types').Config} */ const config = { scripts: [{ @@ -68,6 +75,12 @@ const config = { ] }, sidebarPath: require.resolve('./sidebars.js'), + // Implements a custom sidebar to override default behaviour where index.md page shows underneath the category name. + // With this sidebar the category name is clickable to show the index.md contents. + async sidebarItemsGenerator({ defaultSidebarItemsGenerator, ...args }) { + const sidebarItems = await defaultSidebarItemsGenerator(args); + return skipIndex(sidebarItems); + }, editCurrentVersion: true, breadcrumbs: true, editUrl: ({ docPath }) => { @@ -328,7 +341,7 @@ const config = { }, { from: '/en/faq/marketplace', - to: '/en/cloud/marketplace' + to: '/en/cloud/marketplace/marketplace-billing' }, { from: '/en/integrations/data-ingestion/data-formats/json', @@ -368,7 +381,7 @@ const config = { }, { from: '/en/faq/billing', - to: '/en/manage/billing' + to: '/en/cloud/manage/billing/overview' }, { from: '/en/guides/developer/lightweght-delete', @@ -423,7 +436,6 @@ const config = { to: '/en/optimize/skipping-indexes', }, { from: '/en/analyze', to: '/en/sql-reference' }, - { from: '/en/engines', to: '/en/engines/table-engines' }, { from: '/en/guides', to: '/en/guides/creating-tables' }, { from: '/en/guides/improving-query-performance/sparse-primary-indexes', @@ -471,7 +483,7 @@ const config = { from: '/en/integrations/migration/etl-tool-to-clickhouse', to: '/en/cloud/migration/etl-tool-to-clickhouse', }, - { from: '/en/integrations/sql-clients', to: '/en/integrations' }, + { from: '/en/integrations/sql-clients/index', to: '/en/integrations' }, { from: '/en/interfaces', to: '/en/interfaces/overview' }, { from: '/en/native-protocol', to: '/en/native-protocol/basics' }, { from: '/en/manage/users', to: '/en/operations/access-rights' }, @@ -853,27 +865,27 @@ const config = { }, { from: '/en/get-started/sql-console/opening', - to: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console', }, { from: '/en/get-started/sql-console/exploring-tables', - to: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console', }, { from: '/en/get-started/sql-console/filtering', - to: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console', }, { from: '/en/get-started/sql-console/creating', - to: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console', }, { from: '/en/get-started/sql-console/advanced', - to: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console', }, { from: '/en/get-started/sql-console/visualizing', - to: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console', }, { from: '/en/connect-a-ui', @@ -2304,7 +2316,7 @@ const config = { { from: '/en/getting-started/tutorial', to: '/en/tutorial' }, { from: '/en/getting-started/install', to: '/en/install' }, { from: '/quick-start', to: '/en/getting-started/quick-start' }, - { from: '/en/quick-start', to: '/en/cloud-quick-start' }, + { from: '/en/quick-start', to: '/en/cloud/get-started/cloud-quick-start' }, { from: '/ru/whats-new/index', to: '/ru/whats-new' }, { from: '/en/faq', to: '/knowledgebase' }, // { from: '/en/faq/billing', to: '/knowledgebase' }, @@ -2340,7 +2352,43 @@ const config = { { from: '/en/home', to: '/' - } + }, + { + from: '/en/chdb/data-formats', + to: '/en/chdb/reference/data-formats' + }, + { + from: '/en/chdb/sql-reference', + to: '/en/chdb/reference/sql-reference' + }, + { + from: '/en/cloud-quick-start', + to: '/en/cloud/get-started/cloud-quick-start' + }, + { + from: '/en/get-started/query-endpoints', + to: '/en/cloud/get-started/query-endpoints' + }, + { + from: '/en/get-started/query-insights', + to: '/en/cloud/get-started/query-insights' + }, + { + from: '/en/get-started/sql-console', + to: '/en/cloud/get-started/sql-console' + }, + { + from: '/en/manage/billing', + to: '/en/cloud/manage/billing/overview' + }, + { + from: '/en/cloud/marketplace', + to: '/en/cloud/manage/marketplace/' + }, + { + from: '/en/deletes', + to: '/en/deletes/overview' + }, ], }, ], diff --git a/scripts/autogenerate_table_of_contents.py b/scripts/autogenerate_table_of_contents.py new file mode 100644 index 00000000000..ab9feafd1e5 --- /dev/null +++ b/scripts/autogenerate_table_of_contents.py @@ -0,0 +1,43 @@ +import json +import os + +""" +This script can be used to automatically generate a table of contents (JSON file) from the markdown files in a directory. +TO DO: modify to run with a list of directories and place the JSON files at those directories. +""" + + +def extract_title_and_slug(filename): + with open(filename, "r") as f: + lines = f.readlines() + + title, slug = None, None + for line in lines: + if line.startswith("title:"): + title = line.strip().split(": ")[1] + elif line.startswith("slug:"): + slug = line.strip().split(": ")[1] + if title and slug: + return {"title": title, "slug": slug} + + return None + + +def main(): + json_array = [] + current_directory = os.getcwd() + for filename in os.listdir(current_directory): + if filename.endswith(".md") and filename != "index.md": + result = extract_title_and_slug(filename) + if result: + json_array.append(result) + + json_array = sorted(json_array, key=lambda x: x["title"]) + json_array.append("\n") + with open("table_of_contents.json", "w") as f: + json.dump(json_array, f, indent=4) + f.write('\n') + +if __name__ == "__main__": + main() + diff --git a/sidebars.js b/sidebars.js index 3d207bc1a9a..93ebb89d4cb 100644 --- a/sidebars.js +++ b/sidebars.js @@ -35,12 +35,12 @@ const sidebars = { collapsed: true, collapsible: true, items: [ - "en/faq/general/index", - "en/faq/general/mapreduce", - "en/faq/general/ne-tormozit", - "en/faq/general/olap", - "en/faq/general/who-is-using-clickhouse", - "en/concepts/why-clickhouse-is-so-fast", + "en/faq/general/index", + "en/faq/general/mapreduce", + "en/faq/general/ne-tormozit", + "en/faq/general/olap", + "en/faq/general/who-is-using-clickhouse", + "en/concepts/why-clickhouse-is-so-fast", ], } ], @@ -91,23 +91,23 @@ const sidebars = { items: [ { type: "category", - label: "BigQuery", - collapsed: true, - collapsible: true, - items: [ - { - type: "doc", - id: "en/migrations/bigquery/equivalent-concepts", - }, - { - type: "doc", - id: "en/migrations/bigquery/migrating-to-clickhouse-cloud", - }, - { - type: "doc", - id: "en/migrations/bigquery/loading-data", - }, - ] + label: "BigQuery", + collapsed: true, + collapsible: true, + items: [ + { + type: "doc", + id: "en/migrations/bigquery/equivalent-concepts", + }, + { + type: "doc", + id: "en/migrations/bigquery/migrating-to-clickhouse-cloud", + }, + { + type: "doc", + id: "en/migrations/bigquery/loading-data", + }, + ] }, "en/migrations/snowflake", { @@ -141,7 +141,7 @@ const sidebars = { }, ], }, - { + { type: "category", label: "Example Datasets", className: "top-nav-item", @@ -176,8 +176,8 @@ const sidebars = { "en/getting-started/example-datasets/uk-price-paid", "en/getting-started/example-datasets/wikistat", "en/getting-started/example-datasets/youtube-dislikes", - ], - } + ], + } ], cloud: [ @@ -187,15 +187,16 @@ const sidebars = { collapsed: false, collapsible: false, className: "top-nav-item", + link: {type: "doc", id: "en/cloud/get-started/index"}, items: [ "en/cloud-index", { type: "doc", - id: "en/get-started/cloud-quick-start", + id: "en/cloud/get-started/cloud-quick-start", }, - "en/get-started/sql-console", - "en/get-started/query-insights", - "en/get-started/query-endpoints", + "en/cloud/get-started/sql-console", + "en/cloud/get-started/query-insights", + "en/cloud/get-started/query-endpoints", "en/cloud/manage/dashboards", "en/cloud/support", ], @@ -206,6 +207,7 @@ const sidebars = { collapsed: false, collapsible: false, className: "top-nav-item", + link: {type: "doc", id: "en/cloud/manage/index"}, items: [ "en/cloud/manage/service-types", "en/cloud/manage/integrations", @@ -217,22 +219,23 @@ const sidebars = { collapsible: true, items: [ "en/integrations/prometheus", - + ], }, { type: "category", label: "Billing", + link: {type: "doc", id: "en/cloud/manage/billing/index"}, items: [ "en/cloud/manage/billing", "en/cloud/manage/billing/payment-thresholds", "en/cloud/manage/troubleshooting-billing-issues", - , { type: "category", label: "Marketplace", + link: {type: "doc", id: "en/cloud/manage/billing/marketplace/index"}, items: [ - "en/cloud/manage/billing/marketplace/index", + "en/cloud/manage/billing/marketplace/overview", "en/cloud/manage/billing/marketplace/aws-marketplace-payg", "en/cloud/manage/billing/marketplace/aws-marketplace-committed", "en/cloud/manage/billing/marketplace/gcp-marketplace-payg", @@ -260,15 +263,14 @@ const sidebars = { collapsed: false, collapsible: false, className: "top-nav-item", + link: {type: "doc", id: "en/cloud/manage/api/index"}, items: [ - { - type: "doc", - id: "en/cloud/manage/api/api-overview", - }, + "en/cloud/manage/api/api-overview", "en/cloud/manage/openapi", { type: "category", label: "API Reference", + link: {type: "doc", id: "en/cloud/manage/api/api-reference-index"}, items: [ "en/cloud/manage/api/invitations-api-reference", "en/cloud/manage/api/keys-api-reference", @@ -285,6 +287,7 @@ const sidebars = { collapsed: false, collapsible: false, className: "top-nav-item", + link: {type: "doc", id: "en/cloud/reference/index"}, items: [ "en/cloud/reference/architecture", "en/cloud/reference/shared-merge-tree", @@ -292,6 +295,7 @@ const sidebars = { "en/cloud/reference/byoc", { type: "category", + link: {type: "doc", id: "en/cloud/reference/changelogs-index"}, label: "Changelogs", collapsed: true, items: [ @@ -300,6 +304,7 @@ const sidebars = { type: "category", label: "Release Notes", collapsed: true, + link: {type: "doc", id: "en/cloud/reference/release-notes-index"}, items: [ "en/cloud/changelogs/changelog-24-10", "en/cloud/changelogs/changelog-24-8", @@ -320,6 +325,7 @@ const sidebars = { collapsed: false, collapsible: false, className: "top-nav-item", + link: {type: "doc", id: "en/cloud/bestpractices/index"}, items: [ "en/cloud/bestpractices/bulkinserts", "en/cloud/bestpractices/asyncinserts", @@ -336,14 +342,16 @@ const sidebars = { collapsed: false, collapsible: false, className: "top-nav-item", + link: {type: "doc", id: "en/cloud/security/index"}, items: [ "en/cloud/security/shared-responsibility-model", { type: "category", label: "Cloud Access Management", + link: {type: "doc", id: "en/cloud/security/cloud-access-management/index"}, items: [ - "en/cloud/security/cloud-access-management", - "en/cloud/security/cloud-authentication", + "en/cloud/security/cloud-access-management/cloud-access-management", + "en/cloud/security/cloud-access-management/cloud-authentication", "en/cloud/security/saml-sso-setup", "en/cloud/security/common-access-management-queries", "en/cloud/security/inviting-new-users", @@ -352,13 +360,14 @@ const sidebars = { { type: "category", label: "Connectivity", + link: {type: "doc", id: "en/cloud/security/connectivity-overview"}, items: [ "en/cloud/security/setting-ip-filters", { type: "category", label: "Private Networking", + link: {type: "doc", id: "en/cloud/security/private-link-overview"}, items: [ - "en/cloud/security/private-link-overview", "en/cloud/security/aws-privatelink", "en/cloud/security/gcp-private-service-connect", "en/cloud/security/azure-privatelink", @@ -375,6 +384,7 @@ const sidebars = { label: "Privacy and Compliance", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/cloud/security/privacy-compliance-overview"}, items: [ "en/cloud/security/compliance-overview", "en/cloud/security/personal-data-access", @@ -387,8 +397,9 @@ const sidebars = { label: "Migrating to Cloud", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/integrations/migration/index"}, items: [ - "en/integrations/migration/index", + "en/integrations/migration/overview", "en/integrations/migration/clickhouse-to-cloud", "en/integrations/migration/clickhouse-local-etl", "en/integrations/migration/etl-tool-to-clickhouse", @@ -410,11 +421,8 @@ const sidebars = { className: "top-nav-item", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/sql-reference/index"}, items: [ - { - type: "doc", - id: "en/sql-reference/index", - }, { type: "doc", id: "en/sql-reference/syntax", @@ -430,6 +438,7 @@ const sidebars = { { type: "category", label: "Data Types", + link: {type: "doc", id: "en/sql-reference/data-types/index"}, items: [ { type: "autogenerated", @@ -440,6 +449,7 @@ const sidebars = { { type: "category", label: "Statements", + link: {type: "doc", id: "en/sql-reference/statements/index"}, items: [ { type: "autogenerated", @@ -472,6 +482,7 @@ const sidebars = { label: "Regular Functions", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/sql-reference/functions/index"}, items: [ { type: "autogenerated", @@ -484,6 +495,7 @@ const sidebars = { label: "Aggregate Functions", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/sql-reference/aggregate-functions/index"}, items: [ { type: "autogenerated", @@ -496,6 +508,7 @@ const sidebars = { label: "Table Functions", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/sql-reference/table-functions/index"}, items: [ { type: "autogenerated", @@ -508,6 +521,7 @@ const sidebars = { label: "Window Functions", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/sql-reference/window-functions/index"}, items: [ { type: "autogenerated", @@ -590,8 +604,8 @@ const sidebars = { label: "ClickPipes", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/integrations/data-ingestion/clickpipes/index"}, items: [ - "en/integrations/data-ingestion/clickpipes/index", "en/integrations/data-ingestion/clickpipes/kafka", "en/integrations/data-ingestion/clickpipes/object-storage", "en/integrations/data-ingestion/clickpipes/kinesis", @@ -626,16 +640,16 @@ const sidebars = { label: "Native Clients & Interfaces", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/interfaces/native-clients-interfaces-index"}, items: [ "en/interfaces/cli", - "en/integrations/sql-clients/sql-console", { type: "category", label: "Drivers and Interfaces", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/interfaces/overview"}, items: [ - "en/interfaces/overview", "en/interfaces/http", "en/interfaces/tcp", "en/interfaces/jdbc", @@ -646,6 +660,7 @@ const sidebars = { "en/interfaces/grpc", ], }, + "en/integrations/sql-clients/sql-console", ], }, { @@ -653,6 +668,7 @@ const sidebars = { label: "Data Sources", collapsed: false, collapsible: true, + link: {type: "doc", id: "en/integrations/data-ingestion/data-sources-index"}, items: [ { type: "category", @@ -661,8 +677,8 @@ const sidebars = { collapsed: true, collapsible: true, items: [ - "en/integrations/data-ingestion/s3/index", - "en/integrations/data-ingestion/s3/performance" + "en/integrations/data-ingestion/s3/index", + "en/integrations/data-ingestion/s3/performance" ], }, "en/integrations/data-sources/postgres", @@ -723,8 +739,8 @@ const sidebars = { label: "Data Visualization", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/integrations/data-visualization"}, items: [ - "en/integrations/data-visualization", "en/integrations/data-visualization/deepnote", "en/integrations/data-visualization/astrato-and-clickhouse", "en/integrations/data-visualization/draxlr-and-clickhouse", @@ -787,8 +803,8 @@ const sidebars = { className: "top-nav-item", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/integrations/data-ingestion/data-formats/json/intro"}, items: [ - "en/integrations/data-ingestion/data-formats/json/intro", "en/integrations/data-ingestion/data-formats/json/loading", "en/integrations/data-ingestion/data-formats/json/inference", "en/integrations/data-ingestion/data-formats/json/schema", @@ -822,14 +838,15 @@ const sidebars = { label: "Data Ingestion", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/integrations/data-ingestion/data-ingestion-index"}, items: [ "en/integrations/data-ingestion/etl-tools/airbyte-and-clickhouse", "en/integrations/data-ingestion/aws-glue/index", "en/integrations/data-ingestion/etl-tools/apache-beam", "en/integrations/data-ingestion/etl-tools/dbt/index", + "en/integrations/data-ingestion/etl-tools/dlt-and-clickhouse", "en/integrations/data-ingestion/etl-tools/fivetran/index", "en/integrations/data-ingestion/etl-tools/nifi-and-clickhouse", - "en/integrations/data-ingestion/etl-tools/dlt-and-clickhouse", "en/integrations/data-ingestion/etl-tools/vector-to-clickhouse", ], }, @@ -844,6 +861,7 @@ const sidebars = { label: "SQL Clients", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/integrations/sql-clients/index"}, items: [ "en/integrations/sql-clients/datagrip", "en/integrations/sql-clients/dbeaver", @@ -858,7 +876,37 @@ const sidebars = { label: "Data Integration", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/integrations/data-visualization"}, items: [ + "en/integrations/data-visualization/deepnote", + "en/integrations/data-visualization/draxlr-and-clickhouse", + "en/integrations/data-visualization/embeddable-and-clickhouse", + "en/integrations/data-visualization/explo-and-clickhouse", + { + type: "category", + label: "Grafana", + className: "top-nav-item", + collapsed: true, + collapsible: true, + items: [ + "en/integrations/data-visualization/grafana/index", + "en/integrations/data-visualization/grafana/query-builder", + "en/integrations/data-visualization/grafana/config", + ], + }, + "en/integrations/data-visualization/hashboard-and-clickhouse", + "en/integrations/data-visualization/looker-and-clickhouse", + "en/integrations/data-visualization/looker-studio-and-clickhouse", + "en/integrations/data-visualization/metabase-and-clickhouse", + "en/integrations/data-visualization/mitzu-and-clickhouse", + "en/integrations/data-visualization/omni-and-clickhouse", + "en/integrations/data-visualization/powerbi-and-clickhouse", + "en/integrations/data-visualization/quicksight-and-clickhouse", + "en/integrations/data-visualization/rocketbi-and-clickhouse", + "en/integrations/data-visualization/superset-and-clickhouse", + "en/integrations/data-visualization/tableau/tableau-and-clickhouse", + "en/integrations/data-visualization/tableau/tableau-online-and-clickhouse", + "en/integrations/data-visualization/zingdata-and-clickhouse", "en/integrations/no-code/retool", "en/integrations/deployment/easypanel/index" ], @@ -884,9 +932,10 @@ const sidebars = { managingData: [ { type: "category", - label: "Core concepts", + label: "Core Concepts", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/managing-data/core-concepts/index"}, items: [ "en/managing-data/core-concepts/parts", "en/managing-data/core-concepts/partitions", @@ -898,9 +947,10 @@ const sidebars = { label: "Updating Data", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/managing-data/updating-data/index"}, items: [ - "en/managing-data/updates", - "en/managing-data/update_mutations", + "en/managing-data/updating-data/overview", + "en/managing-data/updating-data/update_mutations", { type: "doc", label: "Lightweight Updates", @@ -915,30 +965,28 @@ const sidebars = { }, { type: "category", - label: "Deleting Data", - collapsed: false, - collapsible: false, - items: [ - { - type: "doc", - label: "Overview", - id: "en/managing-data/deletes", - }, - { - type: "doc", - label: "Lightweight Deletes", - id: "en/guides/developer/lightweight-delete" - }, - "en/managing-data/delete_mutations", - "en/managing-data/truncate", - "en/managing-data/drop_partition", - ] - }, - { + label: "Deleting Data", + collapsed: false, + collapsible: false, + link: {type: "doc", id: "en/managing-data/deleting-data/index"}, + items: [ + "en/managing-data/deleting-data/overview", + { + type: "doc", + label: "Lightweight Deletes", + id: "en/guides/developer/lightweight-delete" + }, + "en/managing-data/deleting-data/delete_mutations", + "en/managing-data/truncate", + "en/managing-data/drop_partition", + ] + }, + { type: "category", label: "Data Modeling", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/data-modeling/index"}, items: [ "en/data-modeling/schema-design", { @@ -966,12 +1014,8 @@ const sidebars = { label: "Data Compression", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/data-compression/compression-in-clickhouse"}, items: [ - { - label: "Overview", - type: "doc", - id: "en/data-compression/compression-in-clickhouse", - }, "en/data-compression/compression-modes" ], }, @@ -984,6 +1028,7 @@ const sidebars = { label: "Advanced Guides", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/guides/developer/index"}, items: [ "en/guides/developer/alternative-query-languages", "en/guides/developer/cascading-materialized-views", @@ -1002,6 +1047,7 @@ const sidebars = { label: "Performance and Optimizations", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/guides/best-practices/index"}, items: [ "en/optimize/index", "en/operations/analyzer", @@ -1101,12 +1147,14 @@ const sidebars = { label: "Manage and Deploy", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/guides/manage-and-deploy-index"}, items: [ { type: "category", label: "Deployment and Scaling", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/deployment-guides/index"}, items: [ "en/deployment-guides/terminology", "en/deployment-guides/horizontal-scaling", @@ -1143,8 +1191,8 @@ const sidebars = { label: "Settings", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/operations/settings/index"}, items: [ - "en/operations/settings/index", "en/operations/server-configuration-parameters/settings", "en/operations/settings/composable-protocols", "en/operations/settings/constraints-on-settings", @@ -1167,8 +1215,8 @@ const sidebars = { label: "System Tables", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/operations/system-tables/index"}, items: [ - "en/operations/system-tables/index", "en/operations/system-tables/asynchronous_insert_log", "en/operations/system-tables/asynchronous_inserts", "en/operations/system-tables/asynchronous_loader", @@ -1276,12 +1324,8 @@ const sidebars = { label: "External Authenticators", collapsed: true, collapsible: true, + link: {type: "doc", id: "en/operations/external-authenticators/index"}, items: [ - { - type: "doc", - label: "Overview", - id: "en/operations/external-authenticators/index", - }, { type: "category", label: "SSL", @@ -1314,12 +1358,8 @@ const sidebars = { label: "Tools and Utilities", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/operations/utilities/index"}, items: [ - { - label: "Overview", - id: "en/operations/utilities/index", - type: "doc", - }, "en/operations/utilities/backupview", "en/operations/utilities/clickhouse-benchmark", "en/operations/utilities/clickhouse-compressor", @@ -1330,9 +1370,9 @@ const sidebars = { "en/operations/utilities/clickhouse-obfuscator", "en/operations/utilities/odbc-bridge", "en/tools-and-utilities/static-files-disk-uploader", - "en/getting-started/playground", + "en/getting-started/playground", ], - }], + }], chdb: [ { @@ -1352,6 +1392,7 @@ const sidebars = { className: "top-nav-item", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/chdb/install/index"}, items: [ "en/chdb/install/python", "en/chdb/install/nodejs", @@ -1367,6 +1408,7 @@ const sidebars = { className: "top-nav-item", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/chdb/guides/index"}, items: [ "en/chdb/guides/jupysql", "en/chdb/guides/querying-pandas", @@ -1374,7 +1416,7 @@ const sidebars = { "en/chdb/guides/querying-s3-bucket", "en/chdb/guides/querying-parquet", "en/chdb/guides/query-remote-clickhouse", - "en/chdb/guides/clickhouse-local" + "en/chdb/guides/clickhouse-local" ], }, { @@ -1383,9 +1425,10 @@ const sidebars = { className: "top-nav-item", collapsed: false, collapsible: false, + link: {type: "doc", id: "en/chdb/reference/index"}, items: [ - "en/chdb/data-formats", - "en/chdb/sql-reference" + "en/chdb/reference/data-formats", + "en/chdb/reference/sql-reference" ], }, { @@ -1500,59 +1543,59 @@ const sidebars = { ] }, { - type: 'category', - label: 'Cloud', - //description: 'The fastest way to deploy ClickHouse', - items: [ - { - type: 'link', - label: 'Get Started', - //description: 'Start quickly with ClickHouse Cloud', - href: '/docs/en/cloud/overview' - }, - { - type: 'link', - label: 'Best Practices', - //description: 'How to get the most out of ClickHouse Cloud', - href: '/docs/en/cloud/bestpractices/bulk-inserts' - }, - { - type: 'link', - label: 'Managing Cloud', - //description: 'Manage your ClickHouse Cloud services', - href: '/docs/en/cloud/manage/service-types' - }, - { - type: 'link', - label: 'Security', - //description: 'Secure your ClickHouse Cloud services', - href: '/docs/en/cloud/security/shared-responsibility-model' - }, - { - type: 'link', - label: 'Cloud API', - //description: 'Automate your ClickHouse Cloud services', - href: '/docs/en/cloud/manage/api/api-overview' - }, - { - type: 'link', - label: 'Migrating to Cloud', - //description: 'Migrate your database to ClickHouse Cloud', - href: '/docs/en/integrations/migration' - }, - { - type: 'link', - label: 'Cloud Reference', - //description: 'Understanding how ClickHouse Cloud works', - href: '/docs/en/cloud/reference/architecture' - }, - ] + type: 'category', + label: 'Cloud', + //description: 'The fastest way to deploy ClickHouse', + items: [ + { + type: 'link', + label: 'Get Started', + //description: 'Start quickly with ClickHouse Cloud', + href: '/docs/en/cloud/overview' + }, + { + type: 'link', + label: 'Best Practices', + //description: 'How to get the most out of ClickHouse Cloud', + href: '/docs/en/cloud/bestpractices/bulk-inserts' + }, + { + type: 'link', + label: 'Managing Cloud', + //description: 'Manage your ClickHouse Cloud services', + href: '/docs/en/cloud/manage/service-types' + }, + { + type: 'link', + label: 'Security', + //description: 'Secure your ClickHouse Cloud services', + href: '/docs/en/cloud/security/shared-responsibility-model' + }, + { + type: 'link', + label: 'Cloud API', + //description: 'Automate your ClickHouse Cloud services', + href: '/docs/en/cloud/manage/api/api-overview' + }, + { + type: 'link', + label: 'Migrating to Cloud', + //description: 'Migrate your database to ClickHouse Cloud', + href: '/docs/en/integrations/migration' + }, + { + type: 'link', + label: 'Cloud Reference', + //description: 'Understanding how ClickHouse Cloud works', + href: '/docs/en/cloud/reference/architecture' + }, + ] }, { - type: 'category', - label: 'Managing Data', - //description: 'How to manage data in ClickHouse', - items: [ + type: 'category', + label: 'Managing Data', + //description: 'How to manage data in ClickHouse', + items: [ { type: 'link', label: 'Updating Data', @@ -1569,7 +1612,7 @@ const sidebars = { type: 'link', label: 'Deleting Data', //description: 'Deleting data in ClickHouse', - href: '/docs/en/deletes' + href: '/docs/en/managing-data/deleting-data/overview' }, { type: 'link', @@ -1736,4 +1779,4 @@ const sidebars = { }, ]}; -module.exports = sidebars; +module.exports = sidebars \ No newline at end of file diff --git a/src/components/TableOfContents/index.ts b/src/components/TableOfContents/index.ts new file mode 100644 index 00000000000..c89d8874729 --- /dev/null +++ b/src/components/TableOfContents/index.ts @@ -0,0 +1 @@ +export { TableOfContents } from "./table_of_contents"; diff --git a/src/components/TableOfContents/styles.scss b/src/components/TableOfContents/styles.scss new file mode 100644 index 00000000000..e69de29bb2d diff --git a/src/components/TableOfContents/table_of_contents.tsx b/src/components/TableOfContents/table_of_contents.tsx new file mode 100644 index 00000000000..be9a4e4b8fd --- /dev/null +++ b/src/components/TableOfContents/table_of_contents.tsx @@ -0,0 +1,17 @@ +import React from 'react' +import './styles.scss' +import { Link } from 'react-router-dom'; + +type ListProps = { + items: [title: any, slug: string] +} + +export function TableOfContents(props: ListProps) { + return ( +
    + {props.items.map((item, index) => ( +
  • {item.title}
    • + ))} +
+ ) +} diff --git a/src/theme/Navbar/Content/index.js b/src/theme/Navbar/Content/index.js index 8a959d71ebd..163632c932d 100644 --- a/src/theme/Navbar/Content/index.js +++ b/src/theme/Navbar/Content/index.js @@ -87,7 +87,7 @@ const dropdownCategories = [{ { title: 'Get Started', description: 'Start quickly with ClickHouse Cloud', - link: '/docs/en/cloud-quick-start' + link: '/docs/en/cloud/get-started/cloud-quick-start' }, { title: 'Best Practices',