Merge pull request #2960 from ClickHouse/issue_2916

tags for cloud supported + private preview
ClickHouse · Dec 30, 2024 · ed21b55 · ed21b55
2 parents 86c6de8 + 413eb78
commit ed21b55
Show file tree

Hide file tree

Showing 13 changed files with 83 additions and 7 deletions.
diff --git a/docs/en/_snippets/_self_managed_only_automated.md b/docs/en/_snippets/_self_managed_only_automated.md
@@ -1,3 +1,6 @@
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
+<CloudNotSupportedBadge/>
 
 :::note
 This page is not applicable to [ClickHouse Cloud](https://clickhouse.com/cloud). The procedure documented here is automated in ClickHouse Cloud services.

diff --git a/docs/en/_snippets/_self_managed_only_no_roadmap.md b/docs/en/_snippets/_self_managed_only_no_roadmap.md
@@ -1,4 +1,8 @@
 
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
+<CloudNotSupportedBadge/>
+
 :::note
 This page is not applicable to [ClickHouse Cloud](https://clickhouse.com/cloud). The feature documented here is not available in ClickHouse Cloud services.
 See the ClickHouse [Cloud Compatibility](/docs/en/whats-new/cloud-compatibility) guide for more information.

diff --git a/docs/en/_snippets/_self_managed_only_not_applicable.md b/docs/en/_snippets/_self_managed_only_not_applicable.md
@@ -1,3 +1,6 @@
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
+<CloudNotSupportedBadge/>
 
 :::note
 This page is not applicable to [ClickHouse Cloud](https://clickhouse.com/cloud). The procedure documented here is only necessary in self-managed ClickHouse deployments.

diff --git a/docs/en/_snippets/_self_managed_only_roadmap.md b/docs/en/_snippets/_self_managed_only_roadmap.md
@@ -1,3 +1,6 @@
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
+<CloudNotSupportedBadge/>
 
 :::note
 This page is not applicable to [ClickHouse Cloud](https://clickhouse.com/cloud). The feature documented here is not yet available in ClickHouse Cloud services.

diff --git a/docs/en/cloud/manage/backups.md b/docs/en/cloud/manage/backups.md
@@ -5,6 +5,8 @@ description: Managing backups in ClickHouse Cloud
 keywords: [backups, cloud backups, restore]
 ---
 
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
 # Backups
 
 :::note
@@ -184,6 +186,8 @@ After you have successfully inserted the data into your original service, make s
 
 ## Undeleting or undropping tables
 
+<CloudNotSupportedBadge/>
+
 The `UNDROP` command is not supported in ClickHouse Cloud. If you accidentally `DROP` a table, the best course of action is to restore your last backup and recreate the table from the backup. 
 
 To prevent users from accidentally dropping tables, you can use [`GRANT` statements](/docs/en/sql-reference/statements/grant) to revoke permissions for the [`DROP TABLE` command](/docs/en/sql-reference/statements/drop#drop-table) for a specific user or role.

diff --git a/docs/en/guides/developer/ttl.md b/docs/en/guides/developer/ttl.md
@@ -6,6 +6,8 @@ keywords: [ttl, time to live, clickhouse, old, data]
 description: TTL (time-to-live) refers to the capability of having rows or columns moved, deleted, or rolled up after a certain interval of time has passed.
 ---
 
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
 # Manage Data with TTL (Time-to-live)
 
 ## Overview of TTL
@@ -136,6 +138,8 @@ Some notes on the `hits` table:
 
 ## Implementing a hot/warm/cold architecture
 
+<CloudNotSupportedBadge/>
+
 :::note
 If you are using ClickHouse Cloud, the steps in the lesson are not applicable. You do not need to worry about moving old data around in ClickHouse Cloud.
 :::

diff --git a/docs/en/integrations/data-ingestion/data-formats/binary.md b/docs/en/integrations/data-ingestion/data-formats/binary.md
@@ -3,6 +3,8 @@ sidebar_label: Binary and Native
 slug: /en/integrations/data-formats/binary-native
 ---
 
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
 # Using native and binary formats in ClickHouse
 
 ClickHouse supports multiple binary formats, which result in better performance and space efficiency. Binary formats are also safe in character encoding since data is saved in a binary form.
@@ -166,6 +168,8 @@ FORMAT MsgPack
 
 ## Protocol Buffers
 
+<CloudNotSupportedBadge/>
+
 To work with [Protocol Buffers](/docs/en/interfaces/formats.md/#protobuf) we first need to define a [schema file](assets/schema.proto):
 
 ```protobuf
@@ -191,6 +195,8 @@ This saves data to the [proto.bin](assets/proto.bin) file. ClickHouse also suppo
 
 ## Cap’n Proto
 
+<CloudNotSupportedBadge/>
+
 Another popular binary serialization format supported by ClickHouse is [Cap’n Proto](https://capnproto.org/). Similarly to `Protobuf` format, we have to define a schema file ([schema.capnp](assets/schema.capnp)) in our example:
 
 ```

diff --git a/docs/en/integrations/data-ingestion/dbms/dynamodb/index.md b/docs/en/integrations/data-ingestion/dbms/dynamodb/index.md
@@ -11,11 +11,12 @@ import ExperimentalBadge from '@theme/badges/ExperimentalBadge';
 
 # CDC from DynamoDB to ClickHouse
 
+<ExperimentalBadge/>
+
 This page covers how set up CDC from DynamoDB to ClickHouse using ClickPipes. There are 2 components to this integration:
 1. The initial snapshot via S3 ClickPipes
 2. Real-time updates via Kinesis ClickPipes
 
-
 Data will be ingested into a `ReplacingMergeTree`. This table engine is commonly used for CDC scenarios to allow update operations to be applied. More on this pattern can be found in the following blog articles:
 
 * [Change Data Capture (CDC) with PostgreSQL and ClickHouse - Part 1](https://clickhouse.com/blog/clickhouse-postgresql-change-data-capture-cdc-part-1?loc=docs-rockest-migrations)

diff --git a/docs/en/integrations/data-ingestion/kafka/kafka-table-engine.md b/docs/en/integrations/data-ingestion/kafka/kafka-table-engine.md
@@ -4,9 +4,13 @@ sidebar_position: 5
 slug: /en/integrations/kafka/kafka-table-engine
 description: Using the Kafka Table Engine
 ---
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+
 
 # Using the Kafka table engine
 
+<CloudNotSupportedBadge/>
+
 :::note
 Kafka table engine is not supported on [ClickHouse Cloud](https://clickhouse.com/cloud). Please consider [ClickPipes](../clickpipes/kafka.md) or [Kafka Connect](./kafka-clickhouse-connect-sink.md)
 :::

diff --git a/docs/en/integrations/language-clients/js.md b/docs/en/integrations/language-clients/js.md
@@ -578,8 +578,7 @@ This is a subject to change in the future. See also: [Base parameters for all cl
 
 ### Command method
 
-It can be used for statements that do not have any output, when the format clause is not applicable, or when you are not
-interested in the response at all. An example of such a statement can be `CREATE TABLE` or `ALTER TABLE`.
+It can be used for statements that do not have any output, when the format clause is not applicable, or when you are not interested in the response at all. An example of such a statement can be `CREATE TABLE` or `ALTER TABLE`.
 
 Should be awaited.
 

diff --git a/docs/en/integrations/sql-clients/sql-console.md b/docs/en/integrations/sql-clients/sql-console.md
@@ -135,8 +135,6 @@ You can also use the save button or `cmd / ctrl + s` keyboard shortcut to save a
 
 ## Using GenAI to manage queries
 
-<ExperimentalBadge/>
-
 This feature allows users to write queries as natural language questions and have the query console create SQL queries based on the context of the available tables. GenAI can also help users debug their queries.
 
 For more information on GenAI, checkout the [Announcing GenAI powered query suggestions in ClickHouse Cloud blog post](https://clickhouse.com/blog/announcing-genai-powered-query-suggestions-clickhouse-cloud).
@@ -239,8 +237,6 @@ Let's create a query using natural language.
 
 1. Once you've verified that the query is correct, click **Run** to execute it.
 
-Keep in mind that GenAI is an experimental feature. Use caution when running GenAI-generated queries against any dataset.
-
 ### Debugging
 
 Now, let's test the query debugging capabilities of GenAI.

diff --git a/src/theme/badges/PrivatePreviewBadge/index.js b/src/theme/badges/PrivatePreviewBadge/index.js
@@ -0,0 +1,24 @@
+import React from "react"
+import styles from "./styles.module.css"
+
+const Icon = () => {
+    return (
+        <div className={styles.privatePreviewIcon} style={{marginRight: '8px', marginTop: '4px'}}>
+            <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+                <path d="M5.33301 6.66667V4.66667V4.66667C5.33301 3.194 6.52701 2 7.99967 2V2C9.47234 2 10.6663 3.194 10.6663 4.66667V4.66667V6.66667" stroke="#FEFFC2" stroke-linecap="round" stroke-linejoin="round"/>
+                <path d="M8.00033 9.33337V11.3334" stroke="#FEFFC2" stroke-linecap="round" stroke-linejoin="round"/>
+                <path fill-rule="evenodd" clip-rule="evenodd" d="M11.333 14H4.66634C3.92967 14 3.33301 13.4033 3.33301 12.6666V7.99996C3.33301 7.26329 3.92967 6.66663 4.66634 6.66663H11.333C12.0697 6.66663 12.6663 7.26329 12.6663 7.99996V12.6666C12.6663 13.4033 12.0697 14 11.333 14Z" stroke="#FEFFC2" stroke-linecap="round" stroke-linejoin="round"/>
+            </svg>
+        </div>
+    )
+}
+
+const PrivatePreviewBadge = () => {
+    return (
+        <div classes className={styles.privatePreviewBadge}>
+            <Icon />{'Private preview in ClickHouse Cloud'}
+        </div>
+    )
+}
+
+export default PrivatePreviewBadge
diff --git a/src/theme/badges/PrivatePreviewBadge/styles.module.css b/src/theme/badges/PrivatePreviewBadge/styles.module.css
@@ -0,0 +1,25 @@
+.privatePreviewBadge {
+    background-color: #DCE4B8;
+    color: #4F2B00;
+    border-radius: 16px;
+    margin-top: 15px;
+    margin-bottom: 15px;
+    display: flex;
+    align-items: center;
+    padding: 5px 12px;  
+    display: inline-flex;
+    margin-right: 5px;
+}
+
+[data-theme='dark'] .privatePreviewBadge {
+    background-color: #3C4601;
+    color: #FEFFC2;
+}
+
+.privatePreviewIcon svg path {
+    stroke: #4F2B00;
+}
+
+[data-theme='dark'] .privatePreviewIcon svg path {
+    stroke: #FEFFC2;
+}