diff --git a/docs/_placeholders/api/_invitations-api-reference.md b/docs/_placeholders/api/_invitations-api-reference.md index cd669fd09d2..16dfccfb71d 100644 --- a/docs/_placeholders/api/_invitations-api-reference.md +++ b/docs/_placeholders/api/_invitations-api-reference.md @@ -1,6 +1,7 @@ --- sidebar_label: Invitations title: Invitations +doc_type: 'reference' --- ## List all invitations {#list-all-invitations} diff --git a/docs/_placeholders/api/_keys-api-reference.md b/docs/_placeholders/api/_keys-api-reference.md index 4d946f3d80d..302df99a633 100644 --- a/docs/_placeholders/api/_keys-api-reference.md +++ b/docs/_placeholders/api/_keys-api-reference.md @@ -1,6 +1,7 @@ --- sidebar_label: Keys title: Keys +doc_type: 'reference' --- ## Get list of all keys {#get-list-of-all-keys} diff --git a/docs/_placeholders/api/_members-api-reference.md b/docs/_placeholders/api/_members-api-reference.md index 01970e1589b..64daa985bab 100644 --- a/docs/_placeholders/api/_members-api-reference.md +++ b/docs/_placeholders/api/_members-api-reference.md @@ -1,6 +1,7 @@ --- sidebar_label: Members title: Members +doc_type: 'reference' --- ## List organization members {#list-organization-members} diff --git a/docs/_placeholders/api/_organizations-api-reference.md b/docs/_placeholders/api/_organizations-api-reference.md index 1c4fab9b6db..cec4e83cdfd 100644 --- a/docs/_placeholders/api/_organizations-api-reference.md +++ b/docs/_placeholders/api/_organizations-api-reference.md @@ -1,6 +1,7 @@ --- sidebar_label: Organizations title: Organizations +doc_type: 'reference' --- ## Get organization details {#get-organization-details} diff --git a/docs/_placeholders/api/_services-api-reference.md b/docs/_placeholders/api/_services-api-reference.md index 51405b7a4c9..3968f0a276b 100644 --- a/docs/_placeholders/api/_services-api-reference.md +++ b/docs/_placeholders/api/_services-api-reference.md @@ -1,6 +1,7 @@ --- sidebar_label: Services title: Services +doc_type: 'landing-page' --- ## List of organization services {#list-of-organization-services} diff --git a/docs/_placeholders/changelog/_index.md b/docs/_placeholders/changelog/_index.md index 4a14fcb7dbf..c5c638730ba 100644 --- a/docs/_placeholders/changelog/_index.md +++ b/docs/_placeholders/changelog/_index.md @@ -5,5 +5,6 @@ slug: /whats-new/changelog/ sidebar_position: 2 sidebar_label: '2025' title: '2025 Changelog' +doc_type: 'changelog' --- diff --git a/docs/_snippets/_tabs.md b/docs/_snippets/_tabs.md deleted file mode 100644 index bf6f077ed53..00000000000 --- a/docs/_snippets/_tabs.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -sidebar_label: Tabs Sample ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import CodeBlock from '@theme/CodeBlock'; - -## Step 1. {#step-1} - - - - -Cloud - - - - -Self-managed - - - diff --git a/docs/about-us/about-faq-index.md b/docs/about-us/about-faq-index.md index a517d39a919..8f42b97f6a6 100644 --- a/docs/about-us/about-faq-index.md +++ b/docs/about-us/about-faq-index.md @@ -2,6 +2,7 @@ title: 'FAQ' slug: /about-us/faq description: 'Landing page' +doc_type: 'landing-page' --- | FAQ | diff --git a/docs/about-us/adopters.md b/docs/about-us/adopters.md index 2e78d9a7fe6..93daa43b8cf 100644 --- a/docs/about-us/adopters.md +++ b/docs/about-us/adopters.md @@ -4,6 +4,7 @@ sidebar_label: 'Adopters' title: 'ClickHouse Adopters' sidebar_position: 60 description: 'A list of companies using ClickHouse and their success stories' +doc_type: 'reference' --- The following list of companies using ClickHouse and their success stories is assembled from public sources, thus might differ from current reality. We'd appreciate it if you share the story of adopting ClickHouse in your company and [add it to the list](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/about-us/adopters.md), but please make sure you won't have any NDA issues by doing so. Providing updates with publications from other companies is also useful. diff --git a/docs/about-us/beta-and-experimental-features.md b/docs/about-us/beta-and-experimental-features.md index a38c8d9ab5b..f41dfea15b9 100644 --- a/docs/about-us/beta-and-experimental-features.md +++ b/docs/about-us/beta-and-experimental-features.md @@ -4,6 +4,7 @@ sidebar_label: 'Beta Features and Experimental' title: 'Beta and Experimental Features' description: 'ClickHouse has beta and experimental features. This documentation page discusses definition.' slug: /beta-and-experimental-features +doc_type: 'reference' --- Because ClickHouse is open-source, it receives many contributions not only from ClickHouse employees but also from the community. These contributions are often developed at different speeds; certain features may require a lengthy prototyping phase or more time for sufficient community feedback and iteration to be considered generally available (GA). @@ -44,4 +45,118 @@ Please note: no additional experimental features are allowed to be enabled in Cl --> +## Beta settings {#beta-settings} + +| Name | Default | +|------|--------| +| [geotoh3_argument_order](/operations/settings/settings#geotoh3_argument_order) | `lat_lon` | +| [enable_lightweight_update](/operations/settings/settings#enable_lightweight_update) | `1` | +| [allow_experimental_correlated_subqueries](/operations/settings/settings#allow_experimental_correlated_subqueries) | `1` | +| [allow_experimental_parallel_reading_from_replicas](/operations/settings/settings#allow_experimental_parallel_reading_from_replicas) | `0` | +| [parallel_replicas_mode](/operations/settings/settings#parallel_replicas_mode) | `read_tasks` | +| [parallel_replicas_count](/operations/settings/settings#parallel_replicas_count) | `0` | +| [parallel_replica_offset](/operations/settings/settings#parallel_replica_offset) | `0` | +| [parallel_replicas_custom_key](/operations/settings/settings#parallel_replicas_custom_key) | `` | +| [parallel_replicas_custom_key_range_lower](/operations/settings/settings#parallel_replicas_custom_key_range_lower) | `0` | +| [parallel_replicas_custom_key_range_upper](/operations/settings/settings#parallel_replicas_custom_key_range_upper) | `0` | +| [cluster_for_parallel_replicas](/operations/settings/settings#cluster_for_parallel_replicas) | `` | +| [parallel_replicas_allow_in_with_subquery](/operations/settings/settings#parallel_replicas_allow_in_with_subquery) | `1` | +| [parallel_replicas_for_non_replicated_merge_tree](/operations/settings/settings#parallel_replicas_for_non_replicated_merge_tree) | `0` | +| [parallel_replicas_min_number_of_rows_per_replica](/operations/settings/settings#parallel_replicas_min_number_of_rows_per_replica) | `0` | +| [parallel_replicas_prefer_local_join](/operations/settings/settings#parallel_replicas_prefer_local_join) | `1` | +| [parallel_replicas_mark_segment_size](/operations/settings/settings#parallel_replicas_mark_segment_size) | `0` | +| [parallel_replicas_local_plan](/operations/settings/settings#parallel_replicas_local_plan) | `1` | +| [parallel_replicas_index_analysis_only_on_coordinator](/operations/settings/settings#parallel_replicas_index_analysis_only_on_coordinator) | `1` | +| [parallel_replicas_support_projection](/operations/settings/settings#parallel_replicas_support_projection) | `1` | +| [parallel_replicas_only_with_analyzer](/operations/settings/settings#parallel_replicas_only_with_analyzer) | `1` | +| [parallel_replicas_insert_select_local_pipeline](/operations/settings/settings#parallel_replicas_insert_select_local_pipeline) | `1` | +| [parallel_replicas_connect_timeout_ms](/operations/settings/settings#parallel_replicas_connect_timeout_ms) | `300` | +| [allow_experimental_database_iceberg](/operations/settings/settings#allow_experimental_database_iceberg) | `0` | +| [allow_experimental_database_unity_catalog](/operations/settings/settings#allow_experimental_database_unity_catalog) | `0` | +| [allow_experimental_database_glue_catalog](/operations/settings/settings#allow_experimental_database_glue_catalog) | `0` | +| [session_timezone](/operations/settings/settings#session_timezone) | `` | +| [low_priority_query_wait_time_ms](/operations/settings/settings#low_priority_query_wait_time_ms) | `1000` | +| [allow_experimental_delta_kernel_rs](/operations/settings/settings#allow_experimental_delta_kernel_rs) | `1` | + + +## Experimental settings {#experimental-settings} + +| Name | Default | +|------|--------| +| [allow_experimental_time_time64_type](/operations/settings/settings#allow_experimental_time_time64_type) | `0` | +| [allow_experimental_kafka_offsets_storage_in_keeper](/operations/settings/settings#allow_experimental_kafka_offsets_storage_in_keeper) | `0` | +| [allow_experimental_materialized_postgresql_table](/operations/settings/settings#allow_experimental_materialized_postgresql_table) | `0` | +| [allow_experimental_funnel_functions](/operations/settings/settings#allow_experimental_funnel_functions) | `0` | +| [allow_experimental_nlp_functions](/operations/settings/settings#allow_experimental_nlp_functions) | `0` | +| [allow_experimental_hash_functions](/operations/settings/settings#allow_experimental_hash_functions) | `0` | +| [allow_experimental_object_type](/operations/settings/settings#allow_experimental_object_type) | `0` | +| [allow_experimental_time_series_table](/operations/settings/settings#allow_experimental_time_series_table) | `0` | +| [allow_experimental_codecs](/operations/settings/settings#allow_experimental_codecs) | `0` | +| [throw_on_unsupported_query_inside_transaction](/operations/settings/settings#throw_on_unsupported_query_inside_transaction) | `1` | +| [wait_changes_become_visible_after_commit_mode](/operations/settings/settings#wait_changes_become_visible_after_commit_mode) | `wait_unknown` | +| [implicit_transaction](/operations/settings/settings#implicit_transaction) | `0` | +| [grace_hash_join_initial_buckets](/operations/settings/settings#grace_hash_join_initial_buckets) | `1` | +| [grace_hash_join_max_buckets](/operations/settings/settings#grace_hash_join_max_buckets) | `1024` | +| [join_to_sort_minimum_perkey_rows](/operations/settings/settings#join_to_sort_minimum_perkey_rows) | `40` | +| [join_to_sort_maximum_table_rows](/operations/settings/settings#join_to_sort_maximum_table_rows) | `10000` | +| [allow_experimental_join_right_table_sorting](/operations/settings/settings#allow_experimental_join_right_table_sorting) | `0` | +| [allow_statistics_optimize](/operations/settings/settings#allow_statistics_optimize) | `0` | +| [allow_experimental_statistics](/operations/settings/settings#allow_experimental_statistics) | `0` | +| [allow_experimental_full_text_index](/operations/settings/settings#allow_experimental_full_text_index) | `0` | +| [allow_experimental_live_view](/operations/settings/settings#allow_experimental_live_view) | `0` | +| [live_view_heartbeat_interval](/operations/settings/settings#live_view_heartbeat_interval) | `15` | +| [max_live_view_insert_blocks_before_refresh](/operations/settings/settings#max_live_view_insert_blocks_before_refresh) | `64` | +| [allow_experimental_window_view](/operations/settings/settings#allow_experimental_window_view) | `0` | +| [window_view_clean_interval](/operations/settings/settings#window_view_clean_interval) | `60` | +| [window_view_heartbeat_interval](/operations/settings/settings#window_view_heartbeat_interval) | `15` | +| [wait_for_window_view_fire_signal_timeout](/operations/settings/settings#wait_for_window_view_fire_signal_timeout) | `10` | +| [stop_refreshable_materialized_views_on_startup](/operations/settings/settings#stop_refreshable_materialized_views_on_startup) | `0` | +| [allow_experimental_database_materialized_postgresql](/operations/settings/settings#allow_experimental_database_materialized_postgresql) | `0` | +| [allow_experimental_query_deduplication](/operations/settings/settings#allow_experimental_query_deduplication) | `0` | +| [allow_experimental_database_hms_catalog](/operations/settings/settings#allow_experimental_database_hms_catalog) | `0` | +| [allow_experimental_kusto_dialect](/operations/settings/settings#allow_experimental_kusto_dialect) | `0` | +| [allow_experimental_prql_dialect](/operations/settings/settings#allow_experimental_prql_dialect) | `0` | +| [enable_adaptive_memory_spill_scheduler](/operations/settings/settings#enable_adaptive_memory_spill_scheduler) | `0` | +| [allow_experimental_insert_into_iceberg](/operations/settings/settings#allow_experimental_insert_into_iceberg) | `0` | +| [allow_experimental_iceberg_compaction](/operations/settings/settings#allow_experimental_iceberg_compaction) | `0` | +| [write_full_path_in_iceberg_metadata](/operations/settings/settings#write_full_path_in_iceberg_metadata) | `0` | +| [iceberg_metadata_compression_method](/operations/settings/settings#iceberg_metadata_compression_method) | `` | +| [make_distributed_plan](/operations/settings/settings#make_distributed_plan) | `0` | +| [distributed_plan_execute_locally](/operations/settings/settings#distributed_plan_execute_locally) | `0` | +| [distributed_plan_default_shuffle_join_bucket_count](/operations/settings/settings#distributed_plan_default_shuffle_join_bucket_count) | `8` | +| [distributed_plan_default_reader_bucket_count](/operations/settings/settings#distributed_plan_default_reader_bucket_count) | `8` | +| [distributed_plan_force_exchange_kind](/operations/settings/settings#distributed_plan_force_exchange_kind) | `` | +| [distributed_plan_max_rows_to_broadcast](/operations/settings/settings#distributed_plan_max_rows_to_broadcast) | `20000` | +| [allow_experimental_ytsaurus_table_engine](/operations/settings/settings#allow_experimental_ytsaurus_table_engine) | `0` | +| [allow_experimental_ytsaurus_table_function](/operations/settings/settings#allow_experimental_ytsaurus_table_function) | `0` | +| [allow_experimental_ytsaurus_dictionary_source](/operations/settings/settings#allow_experimental_ytsaurus_dictionary_source) | `0` | +| [distributed_plan_force_shuffle_aggregation](/operations/settings/settings#distributed_plan_force_shuffle_aggregation) | `0` | +| [allow_experimental_time_series_aggregate_functions](/operations/settings/settings#allow_experimental_time_series_aggregate_functions) | `0` | +| [promql_database](/operations/settings/settings#promql_database) | `` | +| [promql_table](/operations/settings/settings#promql_table) | `` | +| [evaluation_time](/operations/settings/settings#evaluation_time) | `auto` | +| [allow_experimental_replacing_merge_with_cleanup](/operations/settings/merge-tree-settings#allow_experimental_replacing_merge_with_cleanup) | `0` | +| [allow_experimental_reverse_key](/operations/settings/merge-tree-settings#allow_experimental_reverse_key) | `0` | +| [allow_remote_fs_zero_copy_replication](/operations/settings/merge-tree-settings#allow_remote_fs_zero_copy_replication) | `0` | +| [enable_replacing_merge_with_cleanup_for_min_age_to_force_merge](/operations/settings/merge-tree-settings#enable_replacing_merge_with_cleanup_for_min_age_to_force_merge) | `0` | +| [force_read_through_cache_for_merges](/operations/settings/merge-tree-settings#force_read_through_cache_for_merges) | `0` | +| [merge_selector_algorithm](/operations/settings/merge-tree-settings#merge_selector_algorithm) | `Simple` | +| [notify_newest_block_number](/operations/settings/merge-tree-settings#notify_newest_block_number) | `0` | +| [part_moves_between_shards_delay_seconds](/operations/settings/merge-tree-settings#part_moves_between_shards_delay_seconds) | `30` | +| [part_moves_between_shards_enable](/operations/settings/merge-tree-settings#part_moves_between_shards_enable) | `0` | +| [remote_fs_zero_copy_path_compatible_mode](/operations/settings/merge-tree-settings#remote_fs_zero_copy_path_compatible_mode) | `0` | +| [remote_fs_zero_copy_zookeeper_path](/operations/settings/merge-tree-settings#remote_fs_zero_copy_zookeeper_path) | `/clickhouse/zero_copy` | +| [remove_rolled_back_parts_immediately](/operations/settings/merge-tree-settings#remove_rolled_back_parts_immediately) | `1` | +| [shared_merge_tree_enable_coordinated_merges](/operations/settings/merge-tree-settings#shared_merge_tree_enable_coordinated_merges) | `0` | +| [shared_merge_tree_enable_keeper_parts_extra_data](/operations/settings/merge-tree-settings#shared_merge_tree_enable_keeper_parts_extra_data) | `0` | +| [shared_merge_tree_merge_coordinator_election_check_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_election_check_period_ms) | `30000` | +| [shared_merge_tree_merge_coordinator_factor](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_factor) | `2` | +| [shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms) | `10000` | +| [shared_merge_tree_merge_coordinator_max_merge_request_size](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_merge_request_size) | `20` | +| [shared_merge_tree_merge_coordinator_max_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_period_ms) | `10000` | +| [shared_merge_tree_merge_coordinator_merges_prepare_count](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_merges_prepare_count) | `100` | +| [shared_merge_tree_merge_coordinator_min_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_min_period_ms) | `1` | +| [shared_merge_tree_merge_worker_fast_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_fast_timeout_ms) | `100` | +| [shared_merge_tree_merge_worker_regular_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_regular_timeout_ms) | `10000` | +| [shared_merge_tree_virtual_parts_discovery_batch](/operations/settings/merge-tree-settings#shared_merge_tree_virtual_parts_discovery_batch) | `1` | diff --git a/docs/about-us/cloud.md b/docs/about-us/cloud.md index 4c641112492..d4c02e35e5b 100644 --- a/docs/about-us/cloud.md +++ b/docs/about-us/cloud.md @@ -4,6 +4,7 @@ sidebar_label: 'Cloud Service' sidebar_position: 10 description: 'ClickHouse Cloud' title: 'ClickHouse Cloud' +doc_type: 'reference' --- # ClickHouse Cloud diff --git a/docs/about-us/distinctive-features.md b/docs/about-us/distinctive-features.md index 1454498c3b5..c90b05bd416 100644 --- a/docs/about-us/distinctive-features.md +++ b/docs/about-us/distinctive-features.md @@ -5,6 +5,7 @@ sidebar_position: 50 description: 'Understand what makes ClickHouse stand apart from other database management systems' title: 'Distinctive Features of ClickHouse' keywords: ['compression', 'secondary-indexes','column-oriented'] +doc_type: 'guide' --- # Distinctive features of ClickHouse diff --git a/docs/about-us/history.md b/docs/about-us/history.md index 83c015a9b59..5cf269d055b 100644 --- a/docs/about-us/history.md +++ b/docs/about-us/history.md @@ -5,6 +5,7 @@ sidebar_position: 40 description: 'History of ClickHouse development' keywords: ['history','development','Metrica'] title: 'ClickHouse History' +doc_type: 'reference' --- # ClickHouse history {#clickhouse-history} diff --git a/docs/about-us/index.md b/docs/about-us/index.md index d61d835efd8..e4fe70bd794 100644 --- a/docs/about-us/index.md +++ b/docs/about-us/index.md @@ -2,6 +2,7 @@ slug: /about title: 'About ClickHouse' description: 'Landing page for About ClickHouse' +doc_type: 'landing-page' --- # About ClickHouse diff --git a/docs/about-us/support.md b/docs/about-us/support.md index fb02f17832c..11198d3c22d 100644 --- a/docs/about-us/support.md +++ b/docs/about-us/support.md @@ -4,6 +4,7 @@ sidebar_label: 'Support' title: 'ClickHouse Cloud support services' sidebar_position: 30 description: 'Information on ClickHouse Cloud support services' +doc_type: 'reference' --- # ClickHouse Cloud support services diff --git a/docs/best-practices/avoid_mutations.md b/docs/best-practices/avoid_mutations.md index 8f1e942c6d7..13b8008ba40 100644 --- a/docs/best-practices/avoid_mutations.md +++ b/docs/best-practices/avoid_mutations.md @@ -5,6 +5,7 @@ sidebar_label: 'Avoid mutations' title: 'Avoid mutations' description: 'Page describing why to avoid mutations in ClickHouse' keywords: ['mutations'] +doc_type: 'guide' --- import Content from '@site/docs/best-practices/_snippets/_avoid_mutations.md'; diff --git a/docs/best-practices/avoid_optimize_final.md b/docs/best-practices/avoid_optimize_final.md index f016dd551df..f569b97f6a2 100644 --- a/docs/best-practices/avoid_optimize_final.md +++ b/docs/best-practices/avoid_optimize_final.md @@ -6,6 +6,7 @@ title: 'Avoid OPTIMIZE FINAL' description: 'Page describing why you should avoid the OPTIMIZE FINAL clause in ClickHouse' keywords: ['avoid OPTIMIZE FINAL', 'background merges'] hide_title: true +doc_type: 'guide' --- # Avoid `OPTIMIZE FINAL` diff --git a/docs/best-practices/choosing_a_primary_key.md b/docs/best-practices/choosing_a_primary_key.md index b1266749e2d..1f829d03f76 100644 --- a/docs/best-practices/choosing_a_primary_key.md +++ b/docs/best-practices/choosing_a_primary_key.md @@ -6,6 +6,7 @@ title: 'Choosing a Primary Key' description: 'Page describing how to choose a primary key in ClickHouse' keywords: ['primary key'] show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/best-practices/index.md b/docs/best-practices/index.md index b4721106510..4fdaa772493 100644 --- a/docs/best-practices/index.md +++ b/docs/best-practices/index.md @@ -4,6 +4,7 @@ keywords: ['Cloud', 'Primary key', 'Ordering key', 'Materialized Views', 'Best P title: 'Overview' hide_title: true description: 'Landing page for Best Practices section in ClickHouse' +doc_type: 'landing-page' --- import TableOfContents from '@site/docs/best-practices/_snippets/_table_of_contents.md'; diff --git a/docs/best-practices/json_type.md b/docs/best-practices/json_type.md index 22fad8198fb..c5e4ede0757 100644 --- a/docs/best-practices/json_type.md +++ b/docs/best-practices/json_type.md @@ -6,6 +6,7 @@ title: 'Use JSON where appropriate' description: 'Page describing when to use JSON' keywords: ['JSON'] show_related_blogs: true +doc_type: 'reference' --- ClickHouse now offers a native JSON column type designed for semi-structured and dynamic data. It's important to clarify that **this is a column type, not a data format**—you can insert JSON into ClickHouse as a string or via supported formats like [JSONEachRow](/docs/interfaces/formats/JSONEachRow), but that does not imply using the JSON column type. Users should only use the JSON type when the structure of their data is dynamic, not when they simply happen to store JSON. diff --git a/docs/best-practices/minimize_optimize_joins.md b/docs/best-practices/minimize_optimize_joins.md index fd7018e1826..dca4f036dde 100644 --- a/docs/best-practices/minimize_optimize_joins.md +++ b/docs/best-practices/minimize_optimize_joins.md @@ -6,6 +6,7 @@ title: 'Minimize and optimize JOINs' description: 'Page describing best practices for JOINs' keywords: ['JOIN', 'Parallel Hash JOIN'] show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/best-practices/select_data_type.md b/docs/best-practices/select_data_type.md index 2552f9008b5..42bfb343615 100644 --- a/docs/best-practices/select_data_type.md +++ b/docs/best-practices/select_data_type.md @@ -5,6 +5,7 @@ sidebar_label: 'Selecting data Types' title: 'Selecting data Types' description: 'Page describing how to choose data types in ClickHouse' keywords: ['data types'] +doc_type: 'reference' --- import NullableColumns from '@site/docs/best-practices/_snippets/_avoid_nullable_columns.md'; diff --git a/docs/best-practices/selecting_an_insert_strategy.md b/docs/best-practices/selecting_an_insert_strategy.md index c9442d20275..9bc94865411 100644 --- a/docs/best-practices/selecting_an_insert_strategy.md +++ b/docs/best-practices/selecting_an_insert_strategy.md @@ -6,6 +6,7 @@ title: 'Selecting an insert strategy' description: 'Page describing how to choose an insert strategy in ClickHouse' keywords: ['INSERT', 'asynchronous inserts', 'compression', 'batch inserts'] show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/best-practices/sizing-and-hardware-recommendations.md b/docs/best-practices/sizing-and-hardware-recommendations.md index 037c0ac6398..0aabfd4ed55 100644 --- a/docs/best-practices/sizing-and-hardware-recommendations.md +++ b/docs/best-practices/sizing-and-hardware-recommendations.md @@ -4,6 +4,7 @@ sidebar_label: 'Sizing and hardware recommendations' sidebar_position: 4 title: 'Sizing and hardware recommendations' description: 'This guide discusses our general recommendations regarding hardware, compute, memory, and disk configurations for open-source users.' +doc_type: 'guide' --- # Sizing and hardware recommendations diff --git a/docs/best-practices/use_materialized_views.md b/docs/best-practices/use_materialized_views.md index cc71d0a1cd9..a7497f00b1c 100644 --- a/docs/best-practices/use_materialized_views.md +++ b/docs/best-practices/use_materialized_views.md @@ -6,6 +6,7 @@ title: 'Use Materialized Views' description: 'Page describing Materialized Views' keywords: ['materialized views', 'medallion architecture'] show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/best-practices/using_data_skipping_indices.md b/docs/best-practices/using_data_skipping_indices.md index 53a9ef01949..c962ff827d4 100644 --- a/docs/best-practices/using_data_skipping_indices.md +++ b/docs/best-practices/using_data_skipping_indices.md @@ -6,6 +6,7 @@ title: 'Use data skipping indices where appropriate' description: 'Page describing how and when to use data skipping indices' keywords: ['data skipping index', 'skip index'] show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/chdb/getting-started.md b/docs/chdb/getting-started.md index adc6ca5fda5..875f13ff221 100644 --- a/docs/chdb/getting-started.md +++ b/docs/chdb/getting-started.md @@ -4,6 +4,7 @@ sidebar_label: 'Getting started' slug: /chdb/getting-started description: 'chDB is an in-process SQL OLAP Engine powered by ClickHouse' keywords: ['chdb', 'embedded', 'clickhouse-lite', 'in-process', 'in process'] +doc_type: 'guide' --- # Getting started with chDB diff --git a/docs/chdb/guides/clickhouse-local.md b/docs/chdb/guides/clickhouse-local.md index 61e200ef8c6..fd7348f6dfe 100644 --- a/docs/chdb/guides/clickhouse-local.md +++ b/docs/chdb/guides/clickhouse-local.md @@ -4,6 +4,7 @@ sidebar_label: 'Using clickhouse-local database' slug: /chdb/guides/clickhouse-local description: 'Learn how to use a clickhouse-local database with chDB' keywords: ['chdb', 'clickhouse-local'] +doc_type: 'guide' --- [clickhouse-local](/operations/utilities/clickhouse-local) is a CLI with an embedded version of ClickHouse. diff --git a/docs/chdb/guides/index.md b/docs/chdb/guides/index.md index 2fb11eba418..ba5a8abf33d 100644 --- a/docs/chdb/guides/index.md +++ b/docs/chdb/guides/index.md @@ -3,6 +3,7 @@ title: 'chDB Guides' slug: /chdb/guides description: 'Index page for chDB guides' keywords: ['chdb', 'guides'] +doc_type: 'landing-page' --- Take a look at our chDB developer guides below: diff --git a/docs/chdb/guides/jupysql.md b/docs/chdb/guides/jupysql.md index e9030b23076..fd91b223d5e 100644 --- a/docs/chdb/guides/jupysql.md +++ b/docs/chdb/guides/jupysql.md @@ -4,6 +4,7 @@ sidebar_label: 'JupySQL' slug: /chdb/guides/jupysql description: 'How to install chDB for Bun' keywords: ['chdb', 'JupySQL'] +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/chdb/guides/query-remote-clickhouse.md b/docs/chdb/guides/query-remote-clickhouse.md index 1a9509f0e93..ca5706e46dc 100644 --- a/docs/chdb/guides/query-remote-clickhouse.md +++ b/docs/chdb/guides/query-remote-clickhouse.md @@ -4,6 +4,7 @@ sidebar_label: 'Querying remote ClickHouse' slug: /chdb/guides/query-remote-clickhouse description: 'In this guide, we will learn how to query a remote ClickHouse server from chDB.' keywords: ['chdb', 'clickhouse'] +doc_type: 'guide' --- In this guide, we're going to learn how to query a remote ClickHouse server from chDB. diff --git a/docs/chdb/guides/querying-apache-arrow.md b/docs/chdb/guides/querying-apache-arrow.md index 0fdf29dcef9..418f2bc3fc4 100644 --- a/docs/chdb/guides/querying-apache-arrow.md +++ b/docs/chdb/guides/querying-apache-arrow.md @@ -4,6 +4,7 @@ sidebar_label: 'Querying Apache Arrow' slug: /chdb/guides/apache-arrow description: 'In this guide, we will learn how to query Apache Arrow tables with chDB' keywords: ['chdb', 'Apache Arrow'] +doc_type: 'guide' --- [Apache Arrow](https://arrow.apache.org/) is a standardized column-oriented memory format that's gained popularity in the data community. diff --git a/docs/chdb/guides/querying-pandas.md b/docs/chdb/guides/querying-pandas.md index faa78627ac2..28ec1619571 100644 --- a/docs/chdb/guides/querying-pandas.md +++ b/docs/chdb/guides/querying-pandas.md @@ -5,6 +5,7 @@ slug: /chdb/guides/pandas description: 'Learn how to query Pandas DataFrames with chDB' keywords: ['chDB', 'Pandas'] show_related_blogs: true +doc_type: 'guide' --- [Pandas](https://pandas.pydata.org/) is a popular library for data manipulation and analysis in Python. diff --git a/docs/chdb/guides/querying-parquet.md b/docs/chdb/guides/querying-parquet.md index ecc63923236..d4332a6f8cc 100644 --- a/docs/chdb/guides/querying-parquet.md +++ b/docs/chdb/guides/querying-parquet.md @@ -4,6 +4,7 @@ sidebar_label: 'Querying Parquet files' slug: /chdb/guides/querying-parquet description: 'Learn how to query Parquet files with chDB.' keywords: ['chdb', 'parquet'] +doc_type: 'guide' --- A lot of the world's data lives in Amazon S3 buckets. diff --git a/docs/chdb/guides/querying-s3-bucket.md b/docs/chdb/guides/querying-s3-bucket.md index 101f24e491b..23bfff26465 100644 --- a/docs/chdb/guides/querying-s3-bucket.md +++ b/docs/chdb/guides/querying-s3-bucket.md @@ -4,6 +4,7 @@ sidebar_label: 'Querying data in S3' slug: /chdb/guides/querying-s3 description: 'Learn how to query data in an S3 bucket with chDB.' keywords: ['chdb', 's3'] +doc_type: 'guide' --- A lot of the world's data lives in Amazon S3 buckets. diff --git a/docs/chdb/index.md b/docs/chdb/index.md index a051b8f028a..57a064858c8 100644 --- a/docs/chdb/index.md +++ b/docs/chdb/index.md @@ -4,6 +4,7 @@ sidebar_label: 'Overview' slug: /chdb description: 'chDB is an in-process SQL OLAP Engine powered by ClickHouse' keywords: ['chdb', 'embedded', 'clickhouse-lite', 'in-process', 'in process'] +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/chdb/install/bun.md b/docs/chdb/install/bun.md index a228391706a..0e9aeea9eaf 100644 --- a/docs/chdb/install/bun.md +++ b/docs/chdb/install/bun.md @@ -4,6 +4,7 @@ sidebar_label: 'Bun' slug: /chdb/install/bun description: 'How to install and use chDB with Bun runtime' keywords: ['chdb', 'bun', 'javascript', 'typescript', 'embedded', 'clickhouse', 'sql', 'olap'] +doc_type: 'guide' --- # chDB for Bun diff --git a/docs/chdb/install/c.md b/docs/chdb/install/c.md index 9a9efb80727..f61fc917170 100644 --- a/docs/chdb/install/c.md +++ b/docs/chdb/install/c.md @@ -4,6 +4,7 @@ sidebar_label: 'C and C++' slug: /chdb/install/c description: 'How to install and use chDB with C and C++' keywords: ['chdb', 'c', 'cpp', 'embedded', 'clickhouse', 'sql', 'olap', 'api'] +doc_type: 'guide' --- # chDB for C and C++ diff --git a/docs/chdb/install/go.md b/docs/chdb/install/go.md index 95b6a5424e7..b029fdbeaa5 100644 --- a/docs/chdb/install/go.md +++ b/docs/chdb/install/go.md @@ -4,6 +4,7 @@ sidebar_label: 'Go' slug: /chdb/install/go description: 'How to install and use chDB with Go' keywords: ['chdb', 'go', 'golang', 'embedded', 'clickhouse', 'sql', 'olap'] +doc_type: 'guide' --- # chDB for Go diff --git a/docs/chdb/install/index.md b/docs/chdb/install/index.md index 10a8dffc43f..3079ae49321 100644 --- a/docs/chdb/install/index.md +++ b/docs/chdb/install/index.md @@ -3,6 +3,7 @@ title: 'Language Integrations Index' slug: /chdb/install description: 'Index page for chDB language integrations' keywords: ['python', 'NodeJS', 'Go', 'Rust', 'Bun', 'C', 'C++'] +doc_type: 'landing-page' --- Instructions for how to get setup with chDB are available below for the following languages and runtimes: diff --git a/docs/chdb/install/nodejs.md b/docs/chdb/install/nodejs.md index 88207aa5459..1976a669287 100644 --- a/docs/chdb/install/nodejs.md +++ b/docs/chdb/install/nodejs.md @@ -4,6 +4,7 @@ sidebar_label: 'Node.js' slug: /chdb/install/nodejs description: 'How to install and use chDB with Node.js' keywords: ['chdb', 'nodejs', 'javascript', 'embedded', 'clickhouse', 'sql', 'olap'] +doc_type: 'guide' --- # chDB for Node.js diff --git a/docs/chdb/install/python.md b/docs/chdb/install/python.md index 65fa61055cd..1300f1556e7 100644 --- a/docs/chdb/install/python.md +++ b/docs/chdb/install/python.md @@ -4,6 +4,7 @@ sidebar_label: 'Python' slug: /chdb/install/python description: 'How to install chDB for Python' keywords: ['chdb', 'embedded', 'clickhouse-lite', 'python', 'install'] +doc_type: 'guide' --- ## Requirements {#requirements} diff --git a/docs/chdb/install/rust.md b/docs/chdb/install/rust.md index 0b8457c48be..b34bed661d3 100644 --- a/docs/chdb/install/rust.md +++ b/docs/chdb/install/rust.md @@ -4,6 +4,7 @@ sidebar_label: 'Rust' slug: /chdb/install/rust description: 'How to install and use chDB Rust bindingsd' keywords: ['chdb', 'embedded', 'clickhouse-lite', 'rust', 'install', 'ffi', 'bindings'] +doc_type: 'guide' --- # chDB for Rust {#chdb-for-rust} diff --git a/docs/chdb/reference/data-formats.md b/docs/chdb/reference/data-formats.md index 76224cb273d..6a9a3772e9d 100644 --- a/docs/chdb/reference/data-formats.md +++ b/docs/chdb/reference/data-formats.md @@ -4,6 +4,7 @@ sidebar_label: 'Data Formats' slug: /chdb/reference/data-formats description: 'Data Formats for chDB' keywords: ['chdb', 'data formats'] +doc_type: 'reference' --- When it comes to data formats, chDB is 100% feature compatible with ClickHouse. diff --git a/docs/chdb/reference/index.md b/docs/chdb/reference/index.md index 9f0bf650586..b5dc07ae58c 100644 --- a/docs/chdb/reference/index.md +++ b/docs/chdb/reference/index.md @@ -3,6 +3,7 @@ title: 'chDB Technical Reference' slug: /chdb/reference description: 'Data Formats for chDB' keywords: ['chdb', 'data formats'] +doc_type: 'reference' --- | Reference page | diff --git a/docs/chdb/reference/sql-reference.md b/docs/chdb/reference/sql-reference.md index 517f51432fa..acd3c506c33 100644 --- a/docs/chdb/reference/sql-reference.md +++ b/docs/chdb/reference/sql-reference.md @@ -4,6 +4,7 @@ sidebar_label: 'SQL Reference' slug: /chdb/reference/sql-reference description: 'SQL Reference for chDB' keywords: ['chdb', 'sql reference'] +doc_type: 'reference' --- chdb supports the same SQL syntax, statements, engines and functions as ClickHouse: diff --git a/docs/cloud-index.md b/docs/cloud-index.md new file mode 100644 index 00000000000..7699a0217f8 --- /dev/null +++ b/docs/cloud-index.md @@ -0,0 +1,12 @@ +--- +slug: /cloud/about-us +keywords: ['AWS', 'Cloud', 'serverless'] +title: 'Overview' +hide_title: true +description: 'Overview page for Cloud' +doc_type: 'landing-page' +--- + +import Content from '@site/docs/about-us/cloud.md'; + + diff --git a/docs/cloud/features/01_cloud_tiers.md b/docs/cloud/features/01_cloud_tiers.md index 68a47cd365d..782d9d70cb1 100644 --- a/docs/cloud/features/01_cloud_tiers.md +++ b/docs/cloud/features/01_cloud_tiers.md @@ -3,6 +3,7 @@ sidebar_label: 'ClickHouse Cloud Tiers' slug: /cloud/manage/cloud-tiers title: 'ClickHouse Cloud Tiers' description: 'Cloud tiers available in ClickHouse Cloud' +doc_type: 'reference' --- # ClickHouse Cloud tiers diff --git a/docs/cloud/features/02_integrations.md b/docs/cloud/features/02_integrations.md index d30fb71e7e1..3f1b5fd135b 100644 --- a/docs/cloud/features/02_integrations.md +++ b/docs/cloud/features/02_integrations.md @@ -3,6 +3,7 @@ sidebar_label: 'Integrations' slug: /manage/integrations title: 'Integrations' description: 'Integrations for ClickHouse' +doc_type: 'landing-page' --- import Kafkasvg from '@site/static/images/integrations/logos/kafka.svg'; diff --git a/docs/cloud/features/03_sql_console_features/01_sql-console.md b/docs/cloud/features/03_sql_console_features/01_sql-console.md index 59ba2e1be61..f0c0d4b2e8e 100644 --- a/docs/cloud/features/03_sql_console_features/01_sql-console.md +++ b/docs/cloud/features/03_sql_console_features/01_sql-console.md @@ -4,6 +4,7 @@ slug: /cloud/get-started/sql-console description: 'Run queries and create visualizations using the SQL Console.' keywords: ['sql console', 'sql client', 'cloud console', 'console'] title: 'SQL Console' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/03_sql_console_features/02_query-insights.md b/docs/cloud/features/03_sql_console_features/02_query-insights.md index 5dbddedccb2..b70126f0804 100644 --- a/docs/cloud/features/03_sql_console_features/02_query-insights.md +++ b/docs/cloud/features/03_sql_console_features/02_query-insights.md @@ -4,6 +4,7 @@ slug: /cloud/get-started/query-insights description: 'Visualize system.query_log data to simplify query debugging and performance optimization' keywords: ['query insights', 'query log', 'query log ui', 'system.query_log insights'] title: 'Query Insights' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/03_sql_console_features/03_query-endpoints.md b/docs/cloud/features/03_sql_console_features/03_query-endpoints.md index 07c332e5fdc..80dff31fb3e 100644 --- a/docs/cloud/features/03_sql_console_features/03_query-endpoints.md +++ b/docs/cloud/features/03_sql_console_features/03_query-endpoints.md @@ -4,6 +4,7 @@ slug: /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'] title: 'Query API Endpoints' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/03_sql_console_features/04_dashboards.md b/docs/cloud/features/03_sql_console_features/04_dashboards.md index c33953aa82b..c01a59c2d1b 100644 --- a/docs/cloud/features/03_sql_console_features/04_dashboards.md +++ b/docs/cloud/features/03_sql_console_features/04_dashboards.md @@ -3,6 +3,7 @@ sidebar_label: 'Dashboards' slug: /cloud/manage/dashboards title: 'Dashboards' description: 'The SQL Console''s dashboards feature allows you to collect and share visualizations from saved queries.' +doc_type: 'guide' --- import BetaBadge from '@theme/badges/BetaBadge'; diff --git a/docs/cloud/features/03_sql_console_features/hyperdx.md b/docs/cloud/features/03_sql_console_features/hyperdx.md index 71e5cee6102..2e4ddc62ab7 100644 --- a/docs/cloud/features/03_sql_console_features/hyperdx.md +++ b/docs/cloud/features/03_sql_console_features/hyperdx.md @@ -3,6 +3,7 @@ sidebar_label: 'HyperDX' slug: /cloud/manage/hyperdx title: 'HyperDX' description: 'Provides HyperDX, the UI for ClickStack - a production-grade observability platform built on ClickHouse and OpenTelemetry (OTel), unifying logs, traces, metrics, and sessions in a single high-performance scalable solution.' +doc_type: 'guide' --- import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge'; diff --git a/docs/cloud/features/04_infrastructure/automatic_scaling.md b/docs/cloud/features/04_infrastructure/automatic_scaling.md index 7dd7c5a6a91..fd0972b4a62 100644 --- a/docs/cloud/features/04_infrastructure/automatic_scaling.md +++ b/docs/cloud/features/04_infrastructure/automatic_scaling.md @@ -5,6 +5,7 @@ slug: /manage/scaling description: 'Configuring automatic scaling in ClickHouse Cloud' keywords: ['autoscaling', 'auto scaling', 'scaling', 'horizontal', 'vertical', 'bursts'] title: 'Automatic Scaling' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/04_infrastructure/byoc.md b/docs/cloud/features/04_infrastructure/byoc.md index 6cf661f3c3f..d79761cf908 100644 --- a/docs/cloud/features/04_infrastructure/byoc.md +++ b/docs/cloud/features/04_infrastructure/byoc.md @@ -4,6 +4,7 @@ slug: /cloud/reference/byoc sidebar_label: 'BYOC (Bring Your Own Cloud)' keywords: ['BYOC', 'cloud', 'bring your own cloud'] description: 'Deploy ClickHouse on your own cloud infrastructure' +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/04_infrastructure/replica-aware-routing.md b/docs/cloud/features/04_infrastructure/replica-aware-routing.md index 370e46737cd..8e8ebabd94d 100644 --- a/docs/cloud/features/04_infrastructure/replica-aware-routing.md +++ b/docs/cloud/features/04_infrastructure/replica-aware-routing.md @@ -3,6 +3,7 @@ title: 'Replica-aware Routing' slug: /manage/replica-aware-routing description: 'How to use Replica-aware routing to increase cache re-use' keywords: ['cloud', 'sticky endpoints', 'sticky', 'endpoints', 'sticky routing', 'routing', 'replica aware routing'] +doc_type: 'guide' --- import PrivatePreviewBadge from '@theme/badges/PrivatePreviewBadge'; diff --git a/docs/cloud/features/04_infrastructure/shared-catalog.md b/docs/cloud/features/04_infrastructure/shared-catalog.md index fa474c41b74..33e0c090380 100644 --- a/docs/cloud/features/04_infrastructure/shared-catalog.md +++ b/docs/cloud/features/04_infrastructure/shared-catalog.md @@ -4,6 +4,7 @@ sidebar_label: 'Shared Catalog' title: 'Shared Catalog and Shared Database Engine' keywords: ['SharedCatalog', 'SharedDatabaseEngine'] description: 'Describes the Shared Catalog component and the Shared database engine in ClickHouse Cloud' +doc_type: 'reference' --- # Shared catalog and shared database engine {#shared-catalog-and-shared-database-engine} diff --git a/docs/cloud/features/04_infrastructure/shared-merge-tree.md b/docs/cloud/features/04_infrastructure/shared-merge-tree.md index 4098a2ae756..3b5e400d84c 100644 --- a/docs/cloud/features/04_infrastructure/shared-merge-tree.md +++ b/docs/cloud/features/04_infrastructure/shared-merge-tree.md @@ -4,6 +4,7 @@ sidebar_label: 'SharedMergeTree' title: 'SharedMergeTree' keywords: ['SharedMergeTree'] description: 'Describes the SharedMergeTree table engine' +doc_type: 'reference' --- import shared_merge_tree from '@site/static/images/cloud/reference/shared-merge-tree-1.png'; diff --git a/docs/cloud/features/04_infrastructure/warehouses.md b/docs/cloud/features/04_infrastructure/warehouses.md index 6ef40c0c159..1ec9dd0d912 100644 --- a/docs/cloud/features/04_infrastructure/warehouses.md +++ b/docs/cloud/features/04_infrastructure/warehouses.md @@ -3,6 +3,7 @@ title: 'Warehouses' slug: /cloud/reference/warehouses keywords: ['compute separation', 'cloud', 'architecture', 'compute-compute', 'warehouse', 'warehouses', 'hydra'] description: 'Compute-compute separation in ClickHouse Cloud' +doc_type: 'reference' --- import compute_1 from '@site/static/images/cloud/reference/compute-compute-1.png'; diff --git a/docs/cloud/features/05_admin_features/api/api-overview.md b/docs/cloud/features/05_admin_features/api/api-overview.md index 95a75a1c886..9d284bace3a 100644 --- a/docs/cloud/features/05_admin_features/api/api-overview.md +++ b/docs/cloud/features/05_admin_features/api/api-overview.md @@ -4,6 +4,7 @@ sidebar_position: 1 title: 'ClickHouse Cloud API' slug: /cloud/manage/api/api-overview description: 'Learn about ClickHouse Cloud API' +doc_type: 'reference' --- # ClickHouse Cloud API diff --git a/docs/cloud/features/05_admin_features/api/index.md b/docs/cloud/features/05_admin_features/api/index.md index da8d8e74c0a..aca38eca54a 100644 --- a/docs/cloud/features/05_admin_features/api/index.md +++ b/docs/cloud/features/05_admin_features/api/index.md @@ -2,6 +2,7 @@ title: 'Cloud API' slug: /cloud/manage/cloud-api description: 'Landing page for the Cloud API section' +doc_type: 'landing-page' --- This section contains reference documentation for Cloud API and contains the following pages: diff --git a/docs/cloud/features/05_admin_features/api/openapi.md b/docs/cloud/features/05_admin_features/api/openapi.md index 6e9b0d4fad3..8ae99dcc940 100644 --- a/docs/cloud/features/05_admin_features/api/openapi.md +++ b/docs/cloud/features/05_admin_features/api/openapi.md @@ -3,6 +3,7 @@ sidebar_label: 'Managing API Keys' slug: /cloud/manage/openapi title: 'Managing API Keys' description: 'ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.' +doc_type: 'guide' --- import image_01 from '@site/static/images/cloud/manage/openapi1.png'; diff --git a/docs/cloud/features/05_admin_features/api/postman.md b/docs/cloud/features/05_admin_features/api/postman.md index 2abe452bf2f..35f77dc90b6 100644 --- a/docs/cloud/features/05_admin_features/api/postman.md +++ b/docs/cloud/features/05_admin_features/api/postman.md @@ -3,6 +3,7 @@ slug: /cloud/manage/postman sidebar_label: 'Programmatic API access with Postman' title: 'Programmatic API access with Postman' description: 'This guide will help you test the ClickHouse Cloud API using Postman' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/05_admin_features/upgrades.md b/docs/cloud/features/05_admin_features/upgrades.md index ad28955ffe6..6da26206653 100644 --- a/docs/cloud/features/05_admin_features/upgrades.md +++ b/docs/cloud/features/05_admin_features/upgrades.md @@ -3,6 +3,7 @@ sidebar_label: 'Upgrades' slug: /manage/updates title: 'Upgrades' description: 'With ClickHouse Cloud you never have to worry about patching and upgrades. We roll out upgrades that include fixes, new features and performance improvements on a periodic basis.' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/06_security/01_shared-responsibility-model.md b/docs/cloud/features/06_security/01_shared-responsibility-model.md index 08c6a3e073c..c9ed24a4bd3 100644 --- a/docs/cloud/features/06_security/01_shared-responsibility-model.md +++ b/docs/cloud/features/06_security/01_shared-responsibility-model.md @@ -3,6 +3,7 @@ sidebar_label: 'Shared responsibility model' slug: /cloud/security/shared-responsibility-model title: 'Shared responsibility model' description: 'Learn more about the security model of ClickHouse Cloud' +doc_type: 'reference' --- ## Service types {#service-types} diff --git a/docs/cloud/features/06_security/02_cloud-access-management/cloud-access-management.md b/docs/cloud/features/06_security/02_cloud-access-management/cloud-access-management.md index cfab1faad61..93d60727883 100644 --- a/docs/cloud/features/06_security/02_cloud-access-management/cloud-access-management.md +++ b/docs/cloud/features/06_security/02_cloud-access-management/cloud-access-management.md @@ -3,6 +3,7 @@ sidebar_label: 'Overview' slug: /cloud/security/cloud-access-management/overview title: 'Cloud access management' description: 'Describes how access control in ClickHouse cloud works, including information on role types' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/06_security/02_cloud-access-management/cloud-authentication.md b/docs/cloud/features/06_security/02_cloud-access-management/cloud-authentication.md index d44f6d19c5a..49845bc15a4 100644 --- a/docs/cloud/features/06_security/02_cloud-access-management/cloud-authentication.md +++ b/docs/cloud/features/06_security/02_cloud-access-management/cloud-authentication.md @@ -3,6 +3,7 @@ sidebar_label: 'Cloud Authentication' slug: /cloud/security/cloud-authentication title: 'Cloud Authentication' description: 'This guide explains some good practices for configuring your authentication.' +doc_type: 'guide' --- import ScalePlanFeatureBadge from '@theme/badges/ScalePlanFeatureBadge' diff --git a/docs/cloud/features/06_security/02_cloud-access-management/index.md b/docs/cloud/features/06_security/02_cloud-access-management/index.md index a38cae8a44d..b0fa9a8ffff 100644 --- a/docs/cloud/features/06_security/02_cloud-access-management/index.md +++ b/docs/cloud/features/06_security/02_cloud-access-management/index.md @@ -2,6 +2,7 @@ slug: /cloud/security/cloud-access-management title: 'Cloud access management' description: 'Cloud Access Management Table Of Contents' +doc_type: 'landing-page' --- | Page | Description | diff --git a/docs/cloud/features/06_security/03_connectivity/01_private-link-overview.md b/docs/cloud/features/06_security/03_connectivity/01_private-link-overview.md index ad104f8c759..4744e5a78f4 100644 --- a/docs/cloud/features/06_security/03_connectivity/01_private-link-overview.md +++ b/docs/cloud/features/06_security/03_connectivity/01_private-link-overview.md @@ -3,6 +3,7 @@ sidebar_label: 'Private link overview' slug: /cloud/security/private-link-overview title: 'Private link overview' description: 'Landing page for private link' +doc_type: 'landing-page' --- # Private link overview diff --git a/docs/cloud/features/06_security/03_connectivity/index.md b/docs/cloud/features/06_security/03_connectivity/index.md index 0c70b053376..f347256dd00 100644 --- a/docs/cloud/features/06_security/03_connectivity/index.md +++ b/docs/cloud/features/06_security/03_connectivity/index.md @@ -2,6 +2,7 @@ slug: /cloud/security/connectivity title: 'connectivity overview' description: 'Landing page for Connectivity' +doc_type: 'landing-page' --- # Connectivity diff --git a/docs/cloud/features/06_security/cmek.md b/docs/cloud/features/06_security/cmek.md index 229aa0ee1d2..d0c4f683e19 100644 --- a/docs/cloud/features/06_security/cmek.md +++ b/docs/cloud/features/06_security/cmek.md @@ -3,6 +3,7 @@ sidebar_label: 'Enhanced Encryption' slug: /cloud/security/cmek title: 'Customer Managed Encryption Keys (CMEK)' description: 'Learn more about customer managed encryption keys' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/07_monitoring/advanced_dashboard.md b/docs/cloud/features/07_monitoring/advanced_dashboard.md index 578a412846e..9cb7cdabbc8 100644 --- a/docs/cloud/features/07_monitoring/advanced_dashboard.md +++ b/docs/cloud/features/07_monitoring/advanced_dashboard.md @@ -6,6 +6,7 @@ sidebar_label: 'Advanced dashboard' sidebar_position: 45 slug: /cloud/manage/monitor/advanced-dashboard title: 'Advanced dashboard in ClickHouse Cloud' +doc_type: 'guide' --- import AdvancedDashboard from '@site/static/images/cloud/manage/monitoring/advanced_dashboard.png'; diff --git a/docs/cloud/features/07_monitoring/notifications.md b/docs/cloud/features/07_monitoring/notifications.md index 84e619082e3..4f3a25c6323 100644 --- a/docs/cloud/features/07_monitoring/notifications.md +++ b/docs/cloud/features/07_monitoring/notifications.md @@ -3,6 +3,7 @@ title: 'Notifications' slug: /cloud/notifications description: 'Notifications for your ClickHouse Cloud service' keywords: ['cloud', 'notifications'] +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/features/07_monitoring/prometheus.md b/docs/cloud/features/07_monitoring/prometheus.md index 9a0c8254579..8ca2dc305eb 100644 --- a/docs/cloud/features/07_monitoring/prometheus.md +++ b/docs/cloud/features/07_monitoring/prometheus.md @@ -4,6 +4,7 @@ sidebar_label: 'Prometheus' title: 'Prometheus' description: 'Export ClickHouse metrics to Prometheus' keywords: ['prometheus', 'grafana', 'monitoring', 'metrics', 'exporter'] +doc_type: 'reference' --- import prometheus_grafana_metrics_endpoint from '@site/static/images/integrations/prometheus-grafana-metrics-endpoint.png'; diff --git a/docs/cloud/features/08_backups/configurable-backups.md b/docs/cloud/features/08_backups/configurable-backups.md index c4c55ad86c8..19b7443d746 100644 --- a/docs/cloud/features/08_backups/configurable-backups.md +++ b/docs/cloud/features/08_backups/configurable-backups.md @@ -4,6 +4,7 @@ slug: /cloud/manage/backups/configurable-backups description: 'Configurable Backups' title: 'Configurable Backups' keywords: ['backups', 'cloud backups', 'restore'] +doc_type: 'guide' --- import backup_settings from '@site/static/images/cloud/manage/backup-settings.png'; diff --git a/docs/cloud/features/08_backups/export-backups-to-own-cloud-account.md b/docs/cloud/features/08_backups/export-backups-to-own-cloud-account.md index 0bb2be7cda7..3a7aa1136c9 100644 --- a/docs/cloud/features/08_backups/export-backups-to-own-cloud-account.md +++ b/docs/cloud/features/08_backups/export-backups-to-own-cloud-account.md @@ -3,6 +3,7 @@ sidebar_label: 'Export Backups to your Own Cloud Account' slug: /cloud/manage/backups/export-backups-to-own-cloud-account title: 'Export Backups to your Own Cloud Account' description: 'Describes how to export backups to your own Cloud account' +doc_type: 'guide' --- import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge' diff --git a/docs/cloud/features/08_backups/index.md b/docs/cloud/features/08_backups/index.md index d42ed0ef899..a22582d4ea0 100644 --- a/docs/cloud/features/08_backups/index.md +++ b/docs/cloud/features/08_backups/index.md @@ -3,6 +3,7 @@ slug: /cloud/manage/backups title: 'Backups' description: 'Table of contents page for backups.' keywords: ['backups', 'configurable backups', 'export backups to own cloud'] +doc_type: 'landing-page' --- | Page | Description | diff --git a/docs/cloud/features/08_backups/overview.md b/docs/cloud/features/08_backups/overview.md index 785fdb34ec1..6495f1fdcf2 100644 --- a/docs/cloud/features/08_backups/overview.md +++ b/docs/cloud/features/08_backups/overview.md @@ -5,6 +5,7 @@ slug: /cloud/manage/backups/overview title: 'Overview' keywords: ['backups', 'cloud backups', 'restore'] description: 'Provides an overview of backups in ClickHouse Cloud' +doc_type: 'guide' --- import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; diff --git a/docs/cloud/features/09_support.md b/docs/cloud/features/09_support.md index e6b73fc87a0..773ff9ac573 100644 --- a/docs/cloud/features/09_support.md +++ b/docs/cloud/features/09_support.md @@ -4,6 +4,7 @@ title: 'Support' slug: /cloud/support description: 'Learn about Cloud Support' hide_title: true +doc_type: 'guide' --- import Content from '@site/docs/about-us/support.md'; diff --git a/docs/cloud/guides/best_practices/index.md b/docs/cloud/guides/best_practices/index.md index 4719ea2750a..86f6a53df8b 100644 --- a/docs/cloud/guides/best_practices/index.md +++ b/docs/cloud/guides/best_practices/index.md @@ -4,6 +4,7 @@ keywords: ['Cloud', 'Best Practices', 'Bulk Inserts', 'Asynchronous Inserts', 'A title: 'Overview' hide_title: true description: 'Landing page for Best Practices section in ClickHouse Cloud' +doc_type: 'landing-page' --- import TableOfContents from '@site/docs/best-practices/_snippets/_table_of_contents.md'; diff --git a/docs/cloud/guides/best_practices/multitenancy.md b/docs/cloud/guides/best_practices/multitenancy.md index 5f7df65427a..59aa582966c 100644 --- a/docs/cloud/guides/best_practices/multitenancy.md +++ b/docs/cloud/guides/best_practices/multitenancy.md @@ -3,6 +3,7 @@ slug: /cloud/bestpractices/multi-tenancy sidebar_label: 'Multi tenancy' title: 'Multi tenancy' description: 'Best practices to implement multi tenancy' +doc_type: 'guide' --- On a SaaS data analytics platform, it is common for multiple tenants, such as organizations, customers, or business units, to share the same database infrastructure while maintaining logical separation of their data. This allows different users to securely access their own data within the same platform. diff --git a/docs/cloud/guides/best_practices/usagelimits.md b/docs/cloud/guides/best_practices/usagelimits.md index af49f5956be..78f5743adcf 100644 --- a/docs/cloud/guides/best_practices/usagelimits.md +++ b/docs/cloud/guides/best_practices/usagelimits.md @@ -3,6 +3,7 @@ slug: /cloud/bestpractices/usage-limits sidebar_label: 'Service limits' title: 'Usage limits' description: 'Describes the recommended usage limits in ClickHouse Cloud' +doc_type: 'reference' --- While ClickHouse is known for its speed and reliability, optimal performance is diff --git a/docs/cloud/guides/cloud-compatibility.md b/docs/cloud/guides/cloud-compatibility.md index 59c238c9c08..5ccfb044d02 100644 --- a/docs/cloud/guides/cloud-compatibility.md +++ b/docs/cloud/guides/cloud-compatibility.md @@ -3,6 +3,7 @@ slug: /whats-new/cloud-compatibility sidebar_label: 'Cloud compatibility' title: 'Cloud Compatibility' description: 'This guide provides an overview of what to expect functionally and operationally in ClickHouse Cloud.' +doc_type: 'guide' --- # ClickHouse Cloud compatibility guide diff --git a/docs/cloud/guides/security/cloud_access_management/common-access-management-queries.md b/docs/cloud/guides/security/cloud_access_management/common-access-management-queries.md index 24b98073491..2420d7cc77d 100644 --- a/docs/cloud/guides/security/cloud_access_management/common-access-management-queries.md +++ b/docs/cloud/guides/security/cloud_access_management/common-access-management-queries.md @@ -3,6 +3,7 @@ sidebar_label: 'Common Access Management Queries' title: 'Common Access Management Queries' slug: /cloud/security/common-access-management-queries description: 'This article shows the basics of defining SQL users and roles and applying those privileges and permissions to databases, tables, rows, and columns.' +doc_type: 'guide' --- import CommonUserRolesContent from '@site/docs/_snippets/_users-and-roles-common.md'; diff --git a/docs/cloud/guides/security/cloud_access_management/inviting-new-users.md b/docs/cloud/guides/security/cloud_access_management/inviting-new-users.md index 38dc099a6cb..d462a1cba89 100644 --- a/docs/cloud/guides/security/cloud_access_management/inviting-new-users.md +++ b/docs/cloud/guides/security/cloud_access_management/inviting-new-users.md @@ -3,6 +3,7 @@ sidebar_label: 'Inviting new users' slug: /cloud/security/inviting-new-users title: 'Inviting new users' description: 'This page describes how administrators can invite new users to their organisation and assign roles to them' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/cloud_access_management/saml-sso-setup.md b/docs/cloud/guides/security/cloud_access_management/saml-sso-setup.md index 7d42305c1a9..62868ba9541 100644 --- a/docs/cloud/guides/security/cloud_access_management/saml-sso-setup.md +++ b/docs/cloud/guides/security/cloud_access_management/saml-sso-setup.md @@ -3,6 +3,7 @@ sidebar_label: 'SAML SSO Setup' slug: /cloud/security/saml-setup title: 'SAML SSO Setup' description: 'How to set up SAML SSO with ClickHouse Cloud' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/connectivity/accessing-s3-data-securely.md b/docs/cloud/guides/security/connectivity/accessing-s3-data-securely.md index f86b42b86eb..85e2facfd61 100644 --- a/docs/cloud/guides/security/connectivity/accessing-s3-data-securely.md +++ b/docs/cloud/guides/security/connectivity/accessing-s3-data-securely.md @@ -3,6 +3,7 @@ slug: /cloud/security/secure-s3 sidebar_label: 'Accessing S3 Data Securely' title: 'Accessing S3 Data Securely' description: 'This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely.' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/connectivity/cloud-endpoints-api.md b/docs/cloud/guides/security/connectivity/cloud-endpoints-api.md index d55ec618f67..babdc8c3688 100644 --- a/docs/cloud/guides/security/connectivity/cloud-endpoints-api.md +++ b/docs/cloud/guides/security/connectivity/cloud-endpoints-api.md @@ -3,6 +3,7 @@ slug: /manage/security/cloud-endpoints-api sidebar_label: 'Cloud IP Addresses' title: 'Cloud IP Addresses' description: 'This page documents the Cloud Endpoints API security features within ClickHouse. It details how to secure your ClickHouse deployments by managing access through authentication and authorization mechanisms.' +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/connectivity/private_networking/02_aws-privatelink.md b/docs/cloud/guides/security/connectivity/private_networking/02_aws-privatelink.md index 720a3a88852..f1de0b79c4a 100644 --- a/docs/cloud/guides/security/connectivity/private_networking/02_aws-privatelink.md +++ b/docs/cloud/guides/security/connectivity/private_networking/02_aws-privatelink.md @@ -2,6 +2,7 @@ title: 'AWS PrivateLink' description: 'This document describes how to connect to ClickHouse Cloud using AWS PrivateLink.' slug: /manage/security/aws-privatelink +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/connectivity/private_networking/03_gcp-private-service-connect.md b/docs/cloud/guides/security/connectivity/private_networking/03_gcp-private-service-connect.md index cc573e09b6c..f77d27e61ed 100644 --- a/docs/cloud/guides/security/connectivity/private_networking/03_gcp-private-service-connect.md +++ b/docs/cloud/guides/security/connectivity/private_networking/03_gcp-private-service-connect.md @@ -3,6 +3,7 @@ title: 'GCP Private Service Connect' description: 'This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists.' sidebar_label: 'GCP Private Service Connect' slug: /manage/security/gcp-private-service-connect +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/connectivity/private_networking/04_azure-privatelink.md b/docs/cloud/guides/security/connectivity/private_networking/04_azure-privatelink.md index 37355b6c332..8ac50cb28f6 100644 --- a/docs/cloud/guides/security/connectivity/private_networking/04_azure-privatelink.md +++ b/docs/cloud/guides/security/connectivity/private_networking/04_azure-privatelink.md @@ -4,6 +4,7 @@ sidebar_label: 'Azure Private Link' slug: /cloud/security/azure-privatelink description: 'How to set up Azure Private Link' keywords: ['azure', 'private link', 'privatelink'] +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/guides/security/connectivity/setting-ip-filters.md b/docs/cloud/guides/security/connectivity/setting-ip-filters.md index a779b7695a7..2415b6df228 100644 --- a/docs/cloud/guides/security/connectivity/setting-ip-filters.md +++ b/docs/cloud/guides/security/connectivity/setting-ip-filters.md @@ -3,6 +3,7 @@ sidebar_label: 'Setting IP Filters' slug: /cloud/security/setting-ip-filters title: 'Setting IP Filters' description: 'This page explains how to set IP filters in ClickHouse Cloud to control access to ClickHouse services.' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/01_discover/01_what_is.md b/docs/cloud/onboard/01_discover/01_what_is.md index 37a515a551f..98c7a5abf6c 100644 --- a/docs/cloud/onboard/01_discover/01_what_is.md +++ b/docs/cloud/onboard/01_discover/01_what_is.md @@ -4,6 +4,7 @@ title: 'Introduction' description: 'Learn what ClickHouse Cloud is, its benefits over open-source, and key features of the fully managed analytics platform' keywords: ['clickhouse cloud', 'what is clickhouse cloud', 'clickhouse cloud overview', 'clickhouse cloud features'] hide_title: true +doc_type: 'guide' --- ## What is ClickHouse Cloud? {#what-is-clickhouse-cloud} diff --git a/docs/cloud/onboard/01_discover/02_use_cases/00_overview.md b/docs/cloud/onboard/01_discover/02_use_cases/00_overview.md index 8bbd22c0914..79fa15dc2bc 100644 --- a/docs/cloud/onboard/01_discover/02_use_cases/00_overview.md +++ b/docs/cloud/onboard/01_discover/02_use_cases/00_overview.md @@ -4,6 +4,7 @@ title: 'Building on ClickHouse Cloud' description: 'Explore ClickHouse Cloud use cases including real-time analytics, observability, data lake & warehouse, and machine learning applications' keywords: ['use cases', 'Cloud'] sidebar_label: 'Overview' +doc_type: 'landing-page' --- ClickHouse Cloud is suitable for use as both a **primary data store** and as an **analytics diff --git a/docs/cloud/onboard/01_discover/02_use_cases/01_real-time-analytics.md b/docs/cloud/onboard/01_discover/02_use_cases/01_real-time-analytics.md index 67aa054a4b0..abff368feac 100644 --- a/docs/cloud/onboard/01_discover/02_use_cases/01_real-time-analytics.md +++ b/docs/cloud/onboard/01_discover/02_use_cases/01_real-time-analytics.md @@ -4,6 +4,7 @@ title: 'Real-time analytics' description: 'Learn how to build real-time analytics applications with ClickHouse Cloud for instant insights and data-driven decision making' keywords: ['use cases', 'real-time analytics'] sidebar_label: 'Real-time analytics' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/01_discover/02_use_cases/02_observability.md b/docs/cloud/onboard/01_discover/02_use_cases/02_observability.md index 97bfb5b263f..367c7bfdbce 100644 --- a/docs/cloud/onboard/01_discover/02_use_cases/02_observability.md +++ b/docs/cloud/onboard/01_discover/02_use_cases/02_observability.md @@ -4,6 +4,7 @@ title: 'Observability' description: 'Use ClickHouse Cloud for observability, monitoring, logging, and system performance analysis in distributed applications' keywords: ['use cases', 'observability'] sidebar_label: 'Observability' +doc_type: 'guide' --- diff --git a/docs/cloud/onboard/01_discover/02_use_cases/03_data_warehousing.md b/docs/cloud/onboard/01_discover/02_use_cases/03_data_warehousing.md index 3b2e325161c..b2460585065 100644 --- a/docs/cloud/onboard/01_discover/02_use_cases/03_data_warehousing.md +++ b/docs/cloud/onboard/01_discover/02_use_cases/03_data_warehousing.md @@ -4,6 +4,7 @@ title: 'Data Lakehouse' description: 'Build modern data warehousing architectures with ClickHouse Cloud combining the flexibility of data lakes with database performance' keywords: ['use cases', 'data lake and warehouse'] sidebar_label: 'Data warehousing' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/01_machine_learning.md b/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/01_machine_learning.md index 8f05907fe07..598255938ed 100644 --- a/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/01_machine_learning.md +++ b/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/01_machine_learning.md @@ -4,6 +4,7 @@ title: 'Machine learning' description: 'Learn how ClickHouse powers machine learning applications across the ML pipeline.' keywords: ['use cases', 'Machine Learning', 'Generative AI'] sidebar_label: 'Machine learning' +doc_type: 'guide' --- import machine_learning_data_layer from '@site/static/images/cloud/onboard/discover/use_cases/ml_data_layer.png' diff --git a/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/02_agent_facing_analytics.md b/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/02_agent_facing_analytics.md index 518c78c700e..40e825a3c48 100644 --- a/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/02_agent_facing_analytics.md +++ b/docs/cloud/onboard/01_discover/02_use_cases/04_machine_learning_and_genAI/02_agent_facing_analytics.md @@ -4,6 +4,7 @@ title: 'Agent facing analytics' description: 'Build agent-facing analytics systems with ClickHouse Cloud for AI agents and autonomous systems requiring real-time data access' keywords: ['use cases', 'Machine Learning', 'Generative AI', 'agent facing analytics', 'agents'] sidebar_label: 'Agent facing analytics' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/01_overview.md b/docs/cloud/onboard/02_migrate/01_migration_guides/01_overview.md index 652a40c74f8..065a48042aa 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/01_overview.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/01_overview.md @@ -5,6 +5,7 @@ slug: /integrations/migration/overview keywords: ['clickhouse', 'migrate', 'migration', 'migrating', 'data'] title: 'Migrating Data into ClickHouse' description: 'Page describing the options available for migrating data into ClickHouse' +doc_type: 'guide' --- # Migrating data into ClickHouse diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/01_overview.md b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/01_overview.md index b8be25dcc58..9209765a154 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/01_overview.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/01_overview.md @@ -4,6 +4,7 @@ title: 'Comparing PostgreSQL and ClickHouse' description: 'A guide to migrating from PostgreSQL to ClickHouse' keywords: ['postgres', 'postgresql', 'migrate', 'migration'] sidebar_label: 'Overview' +doc_type: 'guide' --- # Comparing ClickHouse and PostgreSQL diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/appendix.md b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/appendix.md index 532967514da..785aac2172d 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/appendix.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/appendix.md @@ -3,6 +3,7 @@ slug: /migrations/postgresql/appendix title: 'Appendix' keywords: ['postgres', 'postgresql', 'data types', 'types'] description: 'Additional information relative to migrating from PostgreSQL' +doc_type: 'reference' --- import postgresReplicas from '@site/static/images/integrations/data-ingestion/dbms/postgres-replicas.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/index.md b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/index.md index 35837f4d34c..1f0887f2776 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/index.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/index.md @@ -4,6 +4,7 @@ pagination_prev: null pagination_next: null title: 'PostgreSQL' description: 'Landing page for the PostgreSQL migrations section' +doc_type: 'landing-page' --- | Page | Description | diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/01_migration_guide_part1.md b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/01_migration_guide_part1.md index a2260255e9b..659fb88e8b5 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/01_migration_guide_part1.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/01_migration_guide_part1.md @@ -5,6 +5,7 @@ description: 'Dataset example to migrate from PostgreSQL to ClickHouse' keywords: ['Postgres'] show_related_blogs: true sidebar_label: 'Part 1' +doc_type: 'guide' --- import postgres_stackoverflow_schema from '@site/static/images/migrations/postgres-stackoverflow-schema.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/02_migration_guide_part2.md b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/02_migration_guide_part2.md index 8866fb91cd9..0cd554409c9 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/02_migration_guide_part2.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/02_migration_guide_part2.md @@ -4,6 +4,7 @@ title: 'Rewriting PostgreSQL Queries' keywords: ['postgres', 'postgresql', 'rewriting queries'] description: 'Part 2 of a guide on migrating from PostgreSQL to ClickHouse' sidebar_label: 'Part 2' +doc_type: 'guide' --- > This is **Part 2** of a guide on migrating from PostgreSQL to ClickHouse. Using a practical example, it demonstrates how to efficiently carry out the migration with a real-time replication (CDC) approach. Many of the concepts covered are also applicable to manual bulk data transfers from PostgreSQL to ClickHouse. diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/03_migration_guide_part3.md b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/03_migration_guide_part3.md index db4468289d8..be59bf3edea 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/03_migration_guide_part3.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/02_postgres/migration_guide/03_migration_guide_part3.md @@ -5,6 +5,7 @@ description: 'Part 3 of a guide on migrating from PostgreSQL to ClickHouse' keywords: ['postgres', 'postgresql'] show_related_blogs: true sidebar_label: 'Part 3' +doc_type: 'guide' --- import postgres_b_tree from '@site/static/images/migrations/postgres-b-tree.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/01_overview.md b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/01_overview.md index 729112ee81e..2f68e320bf5 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/01_overview.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/01_overview.md @@ -5,6 +5,7 @@ description: 'How BigQuery differs from ClickHouse Cloud' keywords: ['BigQuery'] show_related_blogs: true sidebar_label: 'Overview' +doc_type: 'guide' --- import bigquery_1 from '@site/static/images/migrations/bigquery-1.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/02_migrating-to-clickhouse-cloud.md b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/02_migrating-to-clickhouse-cloud.md index 0118a912fec..30693c1ba73 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/02_migrating-to-clickhouse-cloud.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/02_migrating-to-clickhouse-cloud.md @@ -5,6 +5,7 @@ description: 'How to migrate your data from BigQuery to ClickHouse Cloud' keywords: ['BigQuery'] show_related_blogs: true sidebar_label: 'Migration guide' +doc_type: 'guide' --- import bigquery_2 from '@site/static/images/migrations/bigquery-2.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/03_loading-data.md b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/03_loading-data.md index add277a4004..7c3b470aebc 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/03_loading-data.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/03_loading-data.md @@ -4,6 +4,7 @@ title: 'Loading data from BigQuery to ClickHouse' slug: /migrations/bigquery/loading-data description: 'How to load data from BigQuery to ClickHouse' keywords: ['migrate', 'migration', 'migrating', 'data', 'etl', 'elt', 'BigQuery'] +doc_type: 'guide' --- _This guide is compatible with ClickHouse Cloud and for self-hosted ClickHouse v23.5+._ diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/index.md b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/index.md index 9b793545e38..c56b71f9794 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/index.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/03_bigquery/index.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null description: 'Landing page for the BigQuery migrations section' keywords: ['BigQuery', 'migration'] +doc_type: 'landing-page' --- In this section of the docs, learn more about the similarities and differences between BigQuery and ClickHouse Cloud, as well as why you might want to migrate and how to do so. diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/01_overview.md b/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/01_overview.md index 6139ff66887..f23b6ecebca 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/01_overview.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/01_overview.md @@ -5,6 +5,7 @@ description: 'Migrating from Snowflake to ClickHouse' keywords: ['Snowflake'] title: 'Migrate from Snowflake to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import snowflake_architecture from '@site/static/images/cloud/onboard/discover/use_cases/snowflake_architecture.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/02_migration_guide.md b/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/02_migration_guide.md index 468a8b6193b..425b108057f 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/02_migration_guide.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/02_migration_guide.md @@ -5,6 +5,7 @@ description: 'Migrating from Snowflake to ClickHouse' keywords: ['Snowflake'] title: 'Migrating from Snowflake to ClickHouse' show_related_blogs: false +doc_type: 'guide' --- import migrate_snowflake_clickhouse from '@site/static/images/migrations/migrate_snowflake_clickhouse.png'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/03_sql_translation_reference.md b/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/03_sql_translation_reference.md index 04d7462d0a4..22b00f8c876 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/03_sql_translation_reference.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/04_snowflake/03_sql_translation_reference.md @@ -5,6 +5,7 @@ description: 'SQL translation reference' keywords: ['Snowflake'] title: 'Migrating from Snowflake to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- # Snowflake SQL translation guide diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/05_elastic/01_overview.md b/docs/cloud/onboard/02_migrate/01_migration_guides/05_elastic/01_overview.md index 2104a173b02..1e78d10a3b3 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/05_elastic/01_overview.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/05_elastic/01_overview.md @@ -5,6 +5,7 @@ description: 'Migrating from Snowflake to ClickHouse' keywords: ['Snowflake'] title: 'Migrate from Snowflake to ClickHouse' show_related_blogs: true +doc_type: 'landing-page' --- # Elasticsearch to ClickHouse migration diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/01_overview.md b/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/01_overview.md index 785eba5d98a..e233884bc5c 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/01_overview.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/01_overview.md @@ -4,6 +4,7 @@ slug: /migrations/redshift-overview description: 'Migrating from Amazon Redshift to ClickHouse' keywords: ['Redshift'] title: 'Comparing ClickHouse Cloud and Amazon Redshift' +doc_type: 'guide' --- # Amazon Redshift to ClickHouse migration diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/02_migration_guide.md b/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/02_migration_guide.md index 506c9957e58..cfb41fe1d4f 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/02_migration_guide.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/02_migration_guide.md @@ -4,6 +4,7 @@ slug: /migrations/redshift/migration-guide description: 'Migrating from Amazon Redshift to ClickHouse' keywords: ['Redshift'] title: 'Amazon Redshift to ClickHouse migration guide' +doc_type: 'guide' --- import MigrationGuide from '@site/docs/integrations/data-ingestion/redshift/_snippets/_migration_guide.md' diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/03_sql_translation_reference.md b/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/03_sql_translation_reference.md index 67585e4ea72..e87e5a7e301 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/03_sql_translation_reference.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/06_redshift/03_sql_translation_reference.md @@ -4,6 +4,7 @@ slug: /migrations/redshift/sql-translation-reference description: 'SQL translation reference for Amazon Redshift to ClickHouse' keywords: ['Redshift'] title: 'Amazon Redshift SQL translation guide' +doc_type: 'reference' --- # Amazon Redshift SQL translation guide diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/07_OSS_to_Cloud/01_clickhouse-to-cloud.md b/docs/cloud/onboard/02_migrate/01_migration_guides/07_OSS_to_Cloud/01_clickhouse-to-cloud.md index fed90c525c3..8449d7ed6d4 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/07_OSS_to_Cloud/01_clickhouse-to-cloud.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/07_OSS_to_Cloud/01_clickhouse-to-cloud.md @@ -3,6 +3,7 @@ sidebar_label: 'ClickHouse OSS' slug: /cloud/migration/clickhouse-to-cloud title: 'Migrating between self-managed ClickHouse and ClickHouse Cloud' description: 'Page describing how to migrate between self-managed ClickHouse and ClickHouse Cloud' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/01_clickhouse-local-etl.md b/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/01_clickhouse-local-etl.md index 5e3eabc70c9..7488206c5ae 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/01_clickhouse-local-etl.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/01_clickhouse-local-etl.md @@ -4,6 +4,7 @@ keywords: ['clickhouse', 'migrate', 'migration', 'migrating', 'data', 'etl', 'el slug: /cloud/migration/clickhouse-local title: 'Migrating to ClickHouse using clickhouse-local' description: 'Guide showing how to migrate to ClickHouse using clickhouse-local' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/02_etl-tool-to-clickhouse.md b/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/02_etl-tool-to-clickhouse.md index 32a0c168c5a..f7836b6a166 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/02_etl-tool-to-clickhouse.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/02_etl-tool-to-clickhouse.md @@ -4,6 +4,7 @@ keywords: ['clickhouse', 'migrate', 'migration', 'migrating', 'data', 'etl', 'el slug: /cloud/migration/etl-tool-to-clickhouse title: 'Using a 3rd-party ETL Tool' description: 'Page describing how to use a 3rd-party ETL tool with ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/03_object-storage-to-clickhouse.md b/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/03_object-storage-to-clickhouse.md index a0788a80aa0..b72c3a4f4de 100644 --- a/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/03_object-storage-to-clickhouse.md +++ b/docs/cloud/onboard/02_migrate/01_migration_guides/08_other_methods/03_object-storage-to-clickhouse.md @@ -3,6 +3,7 @@ title: 'Using object storage' description: 'Moving data from object storage to ClickHouse Cloud' keywords: ['object storage', 's3', 'azure blob', 'gcs', 'migration'] slug: /integrations/migration/object-storage-to-clickhouse +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/onboard/03_tune/resource_tour.md b/docs/cloud/onboard/03_tune/resource_tour.md index 09217a392f9..c17b862dfac 100644 --- a/docs/cloud/onboard/03_tune/resource_tour.md +++ b/docs/cloud/onboard/03_tune/resource_tour.md @@ -4,6 +4,7 @@ title: 'Resource tour' description: 'Overview of ClickHouse Cloud documentation resources for query optimization, scaling strategies, monitoring, and best practices' keywords: ['clickhouse cloud'] hide_title: true +doc_type: 'guide' --- import TableOfContentsBestPractices from '@site/docs/best-practices/_snippets/_table_of_contents.md'; diff --git a/docs/cloud/onboard/index.md b/docs/cloud/onboard/index.md index 742a9c87254..8d04bc07b97 100644 --- a/docs/cloud/onboard/index.md +++ b/docs/cloud/onboard/index.md @@ -3,6 +3,7 @@ slug: /cloud/get-started title: 'Get started with ClickHouse Cloud' description: 'Complete guide to getting started with ClickHouse Cloud - from discovering features to deployment and optimization' hide_title: true +doc_type: 'guide' --- # Get started with ClickHouse Cloud diff --git a/docs/cloud/reference/01_changelog/01_changelog.md b/docs/cloud/reference/01_changelog/01_changelog.md index 44197a15198..d46b36e6524 100644 --- a/docs/cloud/reference/01_changelog/01_changelog.md +++ b/docs/cloud/reference/01_changelog/01_changelog.md @@ -3,6 +3,7 @@ slug: /whats-new/cloud sidebar_label: 'Cloud Changelog' title: 'Cloud Changelog' description: 'ClickHouse Cloud changelog providing descriptions of what is new in each ClickHouse Cloud release' +doc_type: 'changelog' --- import Image from '@theme/IdealImage'; diff --git a/docs/cloud/reference/01_changelog/02_release_notes/24_02.md b/docs/cloud/reference/01_changelog/02_release_notes/24_02.md index fa418da75a8..0600119bc76 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/24_02.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/24_02.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v24.2' keywords: ['changelog'] sidebar_label: '24.2' sidebar_position: 8 +doc_type: 'changelog' --- ### ClickHouse release tag: 24.2.2.15987 {#clickhouse-release-tag-242215987} diff --git a/docs/cloud/reference/01_changelog/02_release_notes/24_05.md b/docs/cloud/reference/01_changelog/02_release_notes/24_05.md index b6f90bf2eea..ad97ed2b6ac 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/24_05.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/24_05.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v24.5' keywords: ['changelog', 'cloud'] sidebar_label: '24.5' sidebar_position: 7 +doc_type: 'changelog' --- # V24.5 changelog for Cloud diff --git a/docs/cloud/reference/01_changelog/02_release_notes/24_06.md b/docs/cloud/reference/01_changelog/02_release_notes/24_06.md index aeed4a90f3c..1436edd5227 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/24_06.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/24_06.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v24.6' keywords: ['changelog', 'cloud'] sidebar_label: '24.6' sidebar_position: 6 +doc_type: 'changelog' --- # V24.6 changelog for Cloud diff --git a/docs/cloud/reference/01_changelog/02_release_notes/24_08.md b/docs/cloud/reference/01_changelog/02_release_notes/24_08.md index 09a7aa86779..5567fdccb05 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/24_08.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/24_08.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v24.8' keywords: ['changelog', 'cloud'] sidebar_label: '24.8' sidebar_position: 5 +doc_type: 'changelog' --- Relevant changes for ClickHouse Cloud services based on the v24.8 release. diff --git a/docs/cloud/reference/01_changelog/02_release_notes/24_10.md b/docs/cloud/reference/01_changelog/02_release_notes/24_10.md index 419c488272b..097e6fa5f91 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/24_10.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/24_10.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v24.10' keywords: ['changelog', 'cloud'] sidebar_label: '24.10' sidebar_position: 4 +doc_type: 'changelog' --- Relevant changes for ClickHouse Cloud services based on the v24.10 release. diff --git a/docs/cloud/reference/01_changelog/02_release_notes/24_12.md b/docs/cloud/reference/01_changelog/02_release_notes/24_12.md index 629ca84d8e2..239257061ea 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/24_12.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/24_12.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v24.12' keywords: ['changelog', 'cloud'] sidebar_label: '24.12' sidebar_position: 3 +doc_type: 'changelog' --- Relevant changes for ClickHouse Cloud services based on the v24.12 release. diff --git a/docs/cloud/reference/01_changelog/02_release_notes/25_04.md b/docs/cloud/reference/01_changelog/02_release_notes/25_04.md index 3e7067dddc9..248509a5425 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/25_04.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/25_04.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v25.4' keywords: ['changelog', 'cloud'] sidebar_label: '25.4' sidebar_position: 2 +doc_type: 'changelog' --- ## Backward incompatible changes {#backward-incompatible-changes} diff --git a/docs/cloud/reference/01_changelog/02_release_notes/25_06.md b/docs/cloud/reference/01_changelog/02_release_notes/25_06.md index 0120d27df1b..5f8735fc4a2 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/25_06.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/25_06.md @@ -5,6 +5,7 @@ description: 'Fast release changelog for v25.6' keywords: ['changelog', 'cloud'] sidebar_label: '25.6' sidebar_position: 1 +doc_type: 'changelog' --- ## Backward incompatible change {#backward-incompatible-change} diff --git a/docs/cloud/reference/01_changelog/02_release_notes/index.md b/docs/cloud/reference/01_changelog/02_release_notes/index.md index ab87960c306..b147678fe10 100644 --- a/docs/cloud/reference/01_changelog/02_release_notes/index.md +++ b/docs/cloud/reference/01_changelog/02_release_notes/index.md @@ -2,6 +2,7 @@ slug: /cloud/reference/changelogs/release-notes title: 'Cloud Release Notes' description: 'Landing page for Cloud release notes' +doc_type: 'changelog' --- diff --git a/docs/concepts/index.md b/docs/concepts/index.md index 481a1d11ee9..d564a46cf6f 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -5,6 +5,7 @@ description: 'Landing page for concepts' pagination_next: null pagination_prev: null keywords: ['concepts', 'OLAP', 'fast'] +doc_type: 'landing-page' --- In this section of the docs we'll dive into the concepts around what makes ClickHouse so fast and efficient. diff --git a/docs/concepts/olap.md b/docs/concepts/olap.md index 5dd056abf13..9c7c72a77e6 100644 --- a/docs/concepts/olap.md +++ b/docs/concepts/olap.md @@ -5,6 +5,7 @@ description: 'OLAP stands for Online Analytical Processing. It is a broad term t title: 'What is OLAP?' slug: /concepts/olap keywords: ['OLAP'] +doc_type: 'reference' --- # What is OLAP? diff --git a/docs/data-compression/compression-in-clickhouse.md b/docs/data-compression/compression-in-clickhouse.md index 5a23e55176e..a23f6d0080b 100644 --- a/docs/data-compression/compression-in-clickhouse.md +++ b/docs/data-compression/compression-in-clickhouse.md @@ -3,6 +3,7 @@ slug: /data-compression/compression-in-clickhouse title: 'Compression in ClickHouse' description: 'Choosing ClickHouse compression algorithms' keywords: ['compression', 'codec', 'encoding'] +doc_type: 'reference' --- One of the secrets to ClickHouse query performance is compression. diff --git a/docs/data-compression/compression-modes.md b/docs/data-compression/compression-modes.md index 0bdd0a052a1..6a9b3b70390 100644 --- a/docs/data-compression/compression-modes.md +++ b/docs/data-compression/compression-modes.md @@ -4,6 +4,7 @@ sidebar_position: 6 title: 'Compression Modes' description: 'ClickHouse column compression modes' keywords: ['compression', 'codec', 'encoding', 'modes'] +doc_type: 'reference' --- import CompressionBlock from '@site/static/images/data-compression/ch_compression_block.png'; diff --git a/docs/data-modeling/backfilling.md b/docs/data-modeling/backfilling.md index 714bfce330d..6f690b10849 100644 --- a/docs/data-modeling/backfilling.md +++ b/docs/data-modeling/backfilling.md @@ -3,6 +3,7 @@ slug: /data-modeling/backfilling title: 'Backfilling Data' description: 'How to use backfill large datasets in ClickHouse' keywords: ['materialized views', 'backfilling', 'inserting data', 'resilient data load'] +doc_type: 'guide' --- import nullTableMV from '@site/static/images/data-modeling/null_table_mv.png'; diff --git a/docs/data-modeling/denormalization.md b/docs/data-modeling/denormalization.md index 4b308e67f9c..866e1f2c0b3 100644 --- a/docs/data-modeling/denormalization.md +++ b/docs/data-modeling/denormalization.md @@ -3,6 +3,7 @@ slug: /data-modeling/denormalization title: 'Denormalizing Data' description: 'How to use denormalization to improve query performance' keywords: ['data denormalization', 'denormalize', 'query optimization'] +doc_type: 'guide' --- import denormalizationDiagram from '@site/static/images/data-modeling/denormalization-diagram.png'; diff --git a/docs/data-modeling/index.md b/docs/data-modeling/index.md index 43ed151580c..d40f0d09c9f 100644 --- a/docs/data-modeling/index.md +++ b/docs/data-modeling/index.md @@ -3,6 +3,7 @@ slug: /data-modeling/overview title: 'Data Modelling Overview' description: 'Overview of Data Modelling' keywords: ['data modelling', 'schema design', 'dictionary', 'materialized view', 'data compression', 'denormalizing data'] +doc_type: 'landing-page' --- # Data Modeling diff --git a/docs/data-modeling/projections/1_projections.md b/docs/data-modeling/projections/1_projections.md index 0a87c11dc55..6c06677f08b 100644 --- a/docs/data-modeling/projections/1_projections.md +++ b/docs/data-modeling/projections/1_projections.md @@ -5,6 +5,7 @@ description: 'Page describing what projections are, how they can be used to impr query performance, and how they differ from materialized views.' keywords: ['projection', 'projections', 'query optimization'] sidebar_order: 1 +doc_type: 'guide' --- import projections_1 from '@site/static/images/data-modeling/projections_1.png'; diff --git a/docs/data-modeling/projections/2_materialized-views-versus-projections.md b/docs/data-modeling/projections/2_materialized-views-versus-projections.md index 9819dbf5278..227a505e595 100644 --- a/docs/data-modeling/projections/2_materialized-views-versus-projections.md +++ b/docs/data-modeling/projections/2_materialized-views-versus-projections.md @@ -4,6 +4,7 @@ sidebar_label: 'Materialized views vs projections' title: 'Materialized Views versus Projections' hide_title: false description: 'Article comparing materialized views and projections in ClickHouse, including their use cases, performance, and limitations.' +doc_type: 'reference' --- > A common question from users is when they should use materialized views versus diff --git a/docs/data-modeling/schema-design.md b/docs/data-modeling/schema-design.md index 7e67288929d..7b3aba6c19f 100644 --- a/docs/data-modeling/schema-design.md +++ b/docs/data-modeling/schema-design.md @@ -3,6 +3,7 @@ slug: /data-modeling/schema-design title: 'Schema Design' description: 'Optimizing ClickHouse schema for query performance' keywords: ['schema', 'schema design', 'query optimization'] +doc_type: 'guide' --- import stackOverflowSchema from '@site/static/images/data-modeling/stackoverflow-schema.png'; diff --git a/docs/deployment-guides/index.md b/docs/deployment-guides/index.md index 81f83e1c016..abc5beff565 100644 --- a/docs/deployment-guides/index.md +++ b/docs/deployment-guides/index.md @@ -2,6 +2,7 @@ slug: /deployment-guides/index title: 'Deployment Guides Overview' description: 'Landing page for the deployment and scaling section' +doc_type: 'landing-page' --- # Deployment and scaling diff --git a/docs/deployment-guides/replication-sharding-examples/01_1_shard_2_replicas.md b/docs/deployment-guides/replication-sharding-examples/01_1_shard_2_replicas.md index 6485ccb9b2b..1c7c3c4558a 100644 --- a/docs/deployment-guides/replication-sharding-examples/01_1_shard_2_replicas.md +++ b/docs/deployment-guides/replication-sharding-examples/01_1_shard_2_replicas.md @@ -4,6 +4,7 @@ sidebar_label: 'Replication' sidebar_position: 10 title: 'Replicating data' description: 'Page describing an example architecture with five servers configured. Two are used to host copies of the data and the rest are used to coordinate the replication of data' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/deployment-guides/replication-sharding-examples/02_2_shards_1_replica.md b/docs/deployment-guides/replication-sharding-examples/02_2_shards_1_replica.md index b8f0b6bedaf..c14a731340b 100644 --- a/docs/deployment-guides/replication-sharding-examples/02_2_shards_1_replica.md +++ b/docs/deployment-guides/replication-sharding-examples/02_2_shards_1_replica.md @@ -4,6 +4,7 @@ sidebar_label: 'Scaling' sidebar_position: 10 title: 'Scaling' description: 'Page describing an example architecture designed to provide scalability' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/deployment-guides/replication-sharding-examples/03_2_shards_2_replicas.md b/docs/deployment-guides/replication-sharding-examples/03_2_shards_2_replicas.md index 520e085d8f2..badef3913f7 100644 --- a/docs/deployment-guides/replication-sharding-examples/03_2_shards_2_replicas.md +++ b/docs/deployment-guides/replication-sharding-examples/03_2_shards_2_replicas.md @@ -4,6 +4,7 @@ sidebar_label: 'Replication + Scaling' sidebar_position: 100 title: 'Replication + Scaling' description: 'By going through this tutorial, you will learn how to set up a simple ClickHouse cluster.' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/deployment-guides/terminology.md b/docs/deployment-guides/terminology.md index 1c200db2379..6433cfabf85 100644 --- a/docs/deployment-guides/terminology.md +++ b/docs/deployment-guides/terminology.md @@ -4,6 +4,7 @@ sidebar_label: 'Introduction' title: 'Introduction' sidebar_position: 1 description: 'Page with deployment examples that are based on the advice provided to ClickHouse users by the ClickHouse Support and Services organization' +doc_type: 'guide' --- import ReplicationShardingTerminology from '@site/docs/_snippets/_replication-sharding-terminology.md'; diff --git a/docs/deployment-modes.md b/docs/deployment-modes.md index 057bc0a98a8..edc0afed0d0 100644 --- a/docs/deployment-modes.md +++ b/docs/deployment-modes.md @@ -5,6 +5,7 @@ description: 'ClickHouse offers four deployment options that all use the same po title: 'Deployment modes' keywords: ['Deployment Modes', 'chDB'] show_related_blogs: true +doc_type: 'guide' --- import chServer from '@site/static/images/deployment-modes/ch-server.png'; diff --git a/docs/dictionary/index.md b/docs/dictionary/index.md index dfe18b195a1..095ef903aea 100644 --- a/docs/dictionary/index.md +++ b/docs/dictionary/index.md @@ -3,6 +3,7 @@ slug: /dictionary title: 'Dictionary' keywords: ['dictionary', 'dictionaries'] description: 'A dictionary provides a key-value representation of data for fast lookups.' +doc_type: 'reference' --- import dictionaryUseCases from '@site/static/images/dictionary/dictionary-use-cases.png'; diff --git a/docs/faq/general/columnar-database.md b/docs/faq/general/columnar-database.md index 41f8c69497f..d81610676be 100644 --- a/docs/faq/general/columnar-database.md +++ b/docs/faq/general/columnar-database.md @@ -4,6 +4,7 @@ title: 'What is a columnar database?' toc_hidden: true toc_priority: 101 description: 'This page describes what a columnar database is' +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/faq/general/dbms-naming.md b/docs/faq/general/dbms-naming.md index 5c54e43fe07..36f455fd03f 100644 --- a/docs/faq/general/dbms-naming.md +++ b/docs/faq/general/dbms-naming.md @@ -4,6 +4,7 @@ toc_hidden: true toc_priority: 10 slug: /faq/general/dbms-naming description: 'Learn about What does "ClickHouse" mean?' +doc_type: 'reference' --- # What does "ClickHouse" mean? {#what-does-clickhouse-mean} diff --git a/docs/faq/general/index.md b/docs/faq/general/index.md index d7faa5313a6..fa36bafc728 100644 --- a/docs/faq/general/index.md +++ b/docs/faq/general/index.md @@ -5,6 +5,7 @@ sidebar_label: 'General Questions about ClickHouse' keywords: ['faq', 'questions', 'what is'] title: 'General Questions About ClickHouse' description: 'Index page listing general questions about ClickHouse' +doc_type: 'landing-page' --- # General questions about ClickHouse diff --git a/docs/faq/general/mapreduce.md b/docs/faq/general/mapreduce.md index b056ea32858..34c1e23601f 100644 --- a/docs/faq/general/mapreduce.md +++ b/docs/faq/general/mapreduce.md @@ -5,6 +5,7 @@ toc_hidden: true toc_priority: 110 description: 'This page explains why you would use ClickHouse over MapReduce' keywords: ['MapReduce'] +doc_type: 'reference' --- # Why not use something like MapReduce? {#why-not-use-something-like-mapreduce} diff --git a/docs/faq/general/ne-tormozit.md b/docs/faq/general/ne-tormozit.md index ec09494e9a8..dc1336c1b45 100644 --- a/docs/faq/general/ne-tormozit.md +++ b/docs/faq/general/ne-tormozit.md @@ -5,6 +5,7 @@ toc_hidden: true toc_priority: 11 description: 'This page explains what "Не тормозит" means' keywords: ['Yandex'] +doc_type: 'reference' --- # What does "Не тормозит" mean? {#what-does-ne-tormozit-mean} diff --git a/docs/faq/general/olap.md b/docs/faq/general/olap.md index f63850713b8..bbb939b7182 100644 --- a/docs/faq/general/olap.md +++ b/docs/faq/general/olap.md @@ -5,6 +5,7 @@ toc_hidden: true toc_priority: 100 description: 'An explainer on what Online Analytical Processing is' keywords: ['OLAP'] +doc_type: 'reference' --- # What Is OLAP? {#what-is-olap} diff --git a/docs/faq/general/who-is-using-clickhouse.md b/docs/faq/general/who-is-using-clickhouse.md index 2ddb8df6898..142693a6e94 100644 --- a/docs/faq/general/who-is-using-clickhouse.md +++ b/docs/faq/general/who-is-using-clickhouse.md @@ -5,6 +5,7 @@ toc_hidden: true toc_priority: 9 description: 'Describes who is using ClickHouse' keywords: ['customer'] +doc_type: 'reference' --- # Who is using ClickHouse? {#who-is-using-clickhouse} diff --git a/docs/faq/index.md b/docs/faq/index.md index f5da4fe328a..f23f724ba26 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -4,6 +4,7 @@ title: 'FAQ' description: 'Landing page for FAQ' pagination_prev: null pagination_next: null +doc_type: 'landing-page' --- | Page | Description | diff --git a/docs/faq/integration/index.md b/docs/faq/integration/index.md index bbe8e93f276..012620387b1 100644 --- a/docs/faq/integration/index.md +++ b/docs/faq/integration/index.md @@ -5,6 +5,7 @@ sidebar_label: 'Integrating ClickHouse with other systems' keywords: ['clickhouse', 'faq', 'questions', 'integrations'] title: 'Questions about integrating ClickHouse and other systems' description: 'Landing page listing questions related to integrating ClickHouse with other systems' +doc_type: 'landing-page' --- # Questions about integrating ClickHouse and other systems diff --git a/docs/faq/integration/json-import.md b/docs/faq/integration/json-import.md index 6363b725a52..2257c40d3a3 100644 --- a/docs/faq/integration/json-import.md +++ b/docs/faq/integration/json-import.md @@ -4,6 +4,7 @@ title: 'How to import JSON into ClickHouse?' toc_hidden: true toc_priority: 11 description: 'This page shows you how to import JSON into ClickHouse' +doc_type: 'guide' --- # How to Import JSON Into ClickHouse? {#how-to-import-json-into-clickhouse} diff --git a/docs/faq/integration/oracle-odbc.md b/docs/faq/integration/oracle-odbc.md index 630e99c089c..5bb9fae96db 100644 --- a/docs/faq/integration/oracle-odbc.md +++ b/docs/faq/integration/oracle-odbc.md @@ -4,6 +4,7 @@ title: 'What if I have a problem with encodings when using Oracle via ODBC?' toc_hidden: true toc_priority: 20 description: 'This page provides guidance on what to do if you have a problem with encodings when using Oracle via ODBC' +doc_type: 'guide' --- # What if I have a problem with encodings when using Oracle via ODBC? {#oracle-odbc-encodings} diff --git a/docs/faq/operations/delete-old-data.md b/docs/faq/operations/delete-old-data.md index 2db4ff949b4..34da5be0983 100644 --- a/docs/faq/operations/delete-old-data.md +++ b/docs/faq/operations/delete-old-data.md @@ -4,6 +4,7 @@ title: 'Is it possible to delete old records from a ClickHouse table?' toc_hidden: true toc_priority: 20 description: 'This page answers the question of whether it is possible to delete old records from a ClickHouse table' +doc_type: 'reference' --- # Is it possible to delete old records from a ClickHouse table? {#is-it-possible-to-delete-old-records-from-a-clickhouse-table} diff --git a/docs/faq/operations/index.md b/docs/faq/operations/index.md index bd289cac316..295b09a395a 100644 --- a/docs/faq/operations/index.md +++ b/docs/faq/operations/index.md @@ -4,6 +4,7 @@ sidebar_position: 3 sidebar_label: 'Question about Operating ClickHouse Servers and Clusters' title: 'Question about operating ClickHouse servers and clusters' description: 'Landing page for questions about operating ClickHouse servers and clusters' +doc_type: 'landing-page' --- # Question about operating ClickHouse servers and clusters diff --git a/docs/faq/operations/multi-region-replication.md b/docs/faq/operations/multi-region-replication.md index f97f1065773..c8ad6a17970 100644 --- a/docs/faq/operations/multi-region-replication.md +++ b/docs/faq/operations/multi-region-replication.md @@ -4,6 +4,7 @@ title: 'Does ClickHouse support multi-region replication?' toc_hidden: true toc_priority: 30 description: 'This page answers whether ClickHouse supports multi-region replication' +doc_type: 'reference' --- # Does ClickHouse support multi-region replication? {#does-clickhouse-support-multi-region-replication} diff --git a/docs/faq/operations/production.md b/docs/faq/operations/production.md index cd06bbe6913..96d53e0ecaf 100644 --- a/docs/faq/operations/production.md +++ b/docs/faq/operations/production.md @@ -4,6 +4,7 @@ title: 'Which ClickHouse version to use in production?' toc_hidden: true toc_priority: 10 description: 'This page provides guidance on which ClickHouse version to use in production' +doc_type: 'guide' --- # Which ClickHouse version to use in production? {#which-clickhouse-version-to-use-in-production} diff --git a/docs/faq/operations/separate_storage.md b/docs/faq/operations/separate_storage.md index be3eae0247e..f875bebff6e 100644 --- a/docs/faq/operations/separate_storage.md +++ b/docs/faq/operations/separate_storage.md @@ -5,6 +5,7 @@ sidebar_label: 'Is it possible to deploy ClickHouse with separate storage and co toc_hidden: true toc_priority: 20 description: 'This page provides an answer as to whether it is possible to deploy ClickHouse with separate storage and compute' +doc_type: 'guide' --- The short answer is "yes". diff --git a/docs/faq/use-cases/index.md b/docs/faq/use-cases/index.md index cb8a120cdfc..3f7420a9cd2 100644 --- a/docs/faq/use-cases/index.md +++ b/docs/faq/use-cases/index.md @@ -4,6 +4,7 @@ sidebar_position: 2 sidebar_label: 'Questions about ClickHouse use cases' title: 'Questions About ClickHouse Use Cases' description: 'Landing page listing common questions about ClickHouse use cases' +doc_type: 'landing-page' --- # Questions about ClickHouse use cases diff --git a/docs/faq/use-cases/key-value.md b/docs/faq/use-cases/key-value.md index b044eb38ef1..5f14161682b 100644 --- a/docs/faq/use-cases/key-value.md +++ b/docs/faq/use-cases/key-value.md @@ -4,6 +4,7 @@ title: 'Can I use ClickHouse as a key-value storage?' toc_hidden: true toc_priority: 101 description: 'Answers the frequently asked question of whether or not ClickHouse can be used as a key-value storage?' +doc_type: 'reference' --- # Can I use ClickHouse as a key-value storage? {#can-i-use-clickhouse-as-a-key-value-storage} diff --git a/docs/faq/use-cases/time-series.md b/docs/faq/use-cases/time-series.md index dc62d67c50b..7c470ca1fee 100644 --- a/docs/faq/use-cases/time-series.md +++ b/docs/faq/use-cases/time-series.md @@ -4,6 +4,7 @@ title: 'Can I use ClickHouse as a time-series database?' toc_hidden: true toc_priority: 101 description: 'Page describing how to use ClickHouse as a time-series database' +doc_type: 'guide' --- # Can I use ClickHouse as a time-series database? {#can-i-use-clickhouse-as-a-time-series-database} diff --git a/docs/getting-started/example-datasets/amazon-reviews.md b/docs/getting-started/example-datasets/amazon-reviews.md index 941d4433fb3..bd259a5996d 100644 --- a/docs/getting-started/example-datasets/amazon-reviews.md +++ b/docs/getting-started/example-datasets/amazon-reviews.md @@ -3,6 +3,7 @@ description: 'Over 150M customer reviews of Amazon products' sidebar_label: 'Amazon customer reviews' slug: /getting-started/example-datasets/amazon-reviews title: 'Amazon Customer Review' +doc_type: 'reference' --- This dataset contains over 150M customer reviews of Amazon products. The data is in snappy-compressed Parquet files in AWS S3 that total 49GB in size (compressed). Let's walk through the steps to insert it into ClickHouse. diff --git a/docs/getting-started/example-datasets/amplab-benchmark.md b/docs/getting-started/example-datasets/amplab-benchmark.md index 125ed55e96b..1e48db6e510 100644 --- a/docs/getting-started/example-datasets/amplab-benchmark.md +++ b/docs/getting-started/example-datasets/amplab-benchmark.md @@ -4,6 +4,7 @@ description: 'A benchmark dataset used for comparing the performance of data war sidebar_label: 'AMPLab Big Data Benchmark' slug: /getting-started/example-datasets/amplab-benchmark title: 'AMPLab Big Data Benchmark' +doc_type: 'reference' --- See https://amplab.cs.berkeley.edu/benchmark/ diff --git a/docs/getting-started/example-datasets/brown-benchmark.md b/docs/getting-started/example-datasets/brown-benchmark.md index 8ad45ec5d8a..7a571719043 100644 --- a/docs/getting-started/example-datasets/brown-benchmark.md +++ b/docs/getting-started/example-datasets/brown-benchmark.md @@ -3,6 +3,7 @@ description: 'A new analytical benchmark for machine-generated log data' sidebar_label: 'Brown University Benchmark' slug: /getting-started/example-datasets/brown-benchmark title: 'Brown University Benchmark' +doc_type: 'reference' --- `MgBench` is a new analytical benchmark for machine-generated log data, [Andrew Crotty](http://cs.brown.edu/people/acrotty/). diff --git a/docs/getting-started/example-datasets/cell-towers.md b/docs/getting-started/example-datasets/cell-towers.md index 5626cb4bf89..b0c4b0bf5a6 100644 --- a/docs/getting-started/example-datasets/cell-towers.md +++ b/docs/getting-started/example-datasets/cell-towers.md @@ -5,6 +5,7 @@ sidebar_label: 'Geo Data' sidebar_position: 3 slug: /getting-started/example-datasets/cell-towers title: 'Geo Data using the Cell Tower Dataset' +doc_type: 'reference' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/getting-started/example-datasets/covid19.md b/docs/getting-started/example-datasets/covid19.md index 64e534eff11..12f789d77b1 100644 --- a/docs/getting-started/example-datasets/covid19.md +++ b/docs/getting-started/example-datasets/covid19.md @@ -4,6 +4,7 @@ description: 'COVID-19 Open-Data is a large, open-source database of COVID-19 ep sidebar_label: 'COVID-19 Open-Data' slug: /getting-started/example-datasets/covid19 title: 'COVID-19 Open-Data' +doc_type: 'reference' --- COVID-19 Open-Data attempts to assemble the largest Covid-19 epidemiological database, in addition to a powerful set of expansive covariates. It includes open, publicly sourced, licensed data relating to demographics, economy, epidemiology, geography, health, hospitalizations, mobility, government response, weather, and more. diff --git a/docs/getting-started/example-datasets/criteo.md b/docs/getting-started/example-datasets/criteo.md index db86ae7647f..854a251ae1f 100644 --- a/docs/getting-started/example-datasets/criteo.md +++ b/docs/getting-started/example-datasets/criteo.md @@ -3,6 +3,7 @@ description: 'A terabyte of Click Logs from Criteo' sidebar_label: 'Terabyte Click Logs from Criteo' slug: /getting-started/example-datasets/criteo title: 'Terabyte Click Logs from Criteo' +doc_type: 'reference' --- Download the data from http://labs.criteo.com/downloads/download-terabyte-click-logs/ diff --git a/docs/getting-started/example-datasets/dbpedia.md b/docs/getting-started/example-datasets/dbpedia.md index 9a84f04abc3..db27c6fb874 100644 --- a/docs/getting-started/example-datasets/dbpedia.md +++ b/docs/getting-started/example-datasets/dbpedia.md @@ -4,6 +4,7 @@ sidebar_label: 'dbpedia dataset' slug: /getting-started/example-datasets/dbpedia-dataset title: 'dbpedia dataset' keywords: ['semantic search', 'vector similarity', 'approximate nearest neighbours', 'embeddings'] +doc_type: 'reference' --- The [dbpedia dataset](https://huggingface.co/datasets/Qdrant/dbpedia-entities-openai3-text-embedding-3-large-1536-1M) contains 1 million articles from Wikipedia and their vector embeddings generated using the [text-embedding-3-large](https://platform.openai.com/docs/models/text-embedding-3-large) model from OpenAI. diff --git a/docs/getting-started/example-datasets/environmental-sensors.md b/docs/getting-started/example-datasets/environmental-sensors.md index 136cf65bcfd..e82a8987039 100644 --- a/docs/getting-started/example-datasets/environmental-sensors.md +++ b/docs/getting-started/example-datasets/environmental-sensors.md @@ -4,6 +4,7 @@ description: 'Over 20 billion records of data from Sensor.Community, a contribut sidebar_label: 'Environmental Sensors Data' slug: /getting-started/example-datasets/environmental-sensors title: 'Environmental Sensors Data' +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/getting-started/example-datasets/foursquare-os-places.md b/docs/getting-started/example-datasets/foursquare-os-places.md index 026bee817ff..51c48510a4a 100644 --- a/docs/getting-started/example-datasets/foursquare-os-places.md +++ b/docs/getting-started/example-datasets/foursquare-os-places.md @@ -5,6 +5,7 @@ sidebar_label: 'Foursquare places' slug: /getting-started/example-datasets/foursquare-places title: 'Foursquare places' keywords: ['visualizing'] +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/getting-started/example-datasets/github-events.md b/docs/getting-started/example-datasets/github-events.md index 5dca999b883..3255d44c2f5 100644 --- a/docs/getting-started/example-datasets/github-events.md +++ b/docs/getting-started/example-datasets/github-events.md @@ -4,6 +4,7 @@ description: 'Dataset containing all events on GitHub from 2011 to Dec 6 2020, w sidebar_label: 'GitHub Events' slug: /getting-started/example-datasets/github-events title: 'GitHub Events Dataset' +doc_type: 'reference' --- Dataset contains all events on GitHub from 2011 to Dec 6 2020, the size is 3.1 billion records. Download size is 75 GB and it will require up to 200 GB space on disk if stored in a table with lz4 compression. diff --git a/docs/getting-started/example-datasets/github.md b/docs/getting-started/example-datasets/github.md index 6dc66b7f5e9..b7ed259c8d3 100644 --- a/docs/getting-started/example-datasets/github.md +++ b/docs/getting-started/example-datasets/github.md @@ -7,6 +7,7 @@ slug: /getting-started/example-datasets/github title: 'Writing Queries in ClickHouse using GitHub Data' keywords: ['Github'] show_related_blogs: true +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/getting-started/example-datasets/hacker-news-vector-search.md b/docs/getting-started/example-datasets/hacker-news-vector-search.md index 5dde80ddee8..d956cd55bc6 100644 --- a/docs/getting-started/example-datasets/hacker-news-vector-search.md +++ b/docs/getting-started/example-datasets/hacker-news-vector-search.md @@ -4,6 +4,7 @@ sidebar_label: 'Hacker News Vector Search dataset' slug: /getting-started/example-datasets/hackernews-vector-search-dataset title: 'Hacker News Vector Search dataset' keywords: ['semantic search', 'vector similarity', 'approximate nearest neighbours', 'embeddings'] +doc_type: 'guide' --- ## Introduction {#introduction} diff --git a/docs/getting-started/example-datasets/hacker-news.md b/docs/getting-started/example-datasets/hacker-news.md index 0a6a0f6eb45..79da4fa64ba 100644 --- a/docs/getting-started/example-datasets/hacker-news.md +++ b/docs/getting-started/example-datasets/hacker-news.md @@ -3,6 +3,7 @@ description: 'Dataset containing 28 million rows of hacker news data.' sidebar_label: 'Hacker News' slug: /getting-started/example-datasets/hacker-news title: 'Hacker News dataset' +doc_type: 'reference' --- # Hacker News dataset diff --git a/docs/getting-started/example-datasets/laion.md b/docs/getting-started/example-datasets/laion.md index 0da93e5a58a..7d601ab5ecf 100644 --- a/docs/getting-started/example-datasets/laion.md +++ b/docs/getting-started/example-datasets/laion.md @@ -3,6 +3,7 @@ description: 'Dataset containing 400 million images with English image captions' sidebar_label: 'Laion-400M dataset' slug: /getting-started/example-datasets/laion-400m-dataset title: 'Laion-400M dataset' +doc_type: 'reference' --- The [Laion-400M dataset](https://laion.ai/blog/laion-400-open-dataset/) contains 400 million images with English image captions. Laion nowadays provides [an even larger dataset](https://laion.ai/blog/laion-5b/) but working with it will be similar. diff --git a/docs/getting-started/example-datasets/laion5b.md b/docs/getting-started/example-datasets/laion5b.md index be1825635df..4ee771e35a7 100644 --- a/docs/getting-started/example-datasets/laion5b.md +++ b/docs/getting-started/example-datasets/laion5b.md @@ -4,6 +4,7 @@ sidebar_label: 'LAION 5B dataset' slug: /getting-started/example-datasets/laion-5b-dataset title: 'LAION 5B dataset' keywords: ['semantic search', 'vector similarity', 'approximate nearest neighbours', 'embeddings'] +doc_type: 'reference' --- import search_results_image from '@site/static/images/getting-started/example-datasets/laion5b_visualization_1.png' diff --git a/docs/getting-started/example-datasets/menus.md b/docs/getting-started/example-datasets/menus.md index bace0087323..097cca3fc60 100644 --- a/docs/getting-started/example-datasets/menus.md +++ b/docs/getting-started/example-datasets/menus.md @@ -4,6 +4,7 @@ description: 'Dataset containing 1.3 million records of historical data on the m sidebar_label: 'New York Public Library "What''s on the Menu?" Dataset' slug: /getting-started/example-datasets/menus title: 'New York Public Library "What''s on the Menu?" Dataset' +doc_type: 'reference' --- The dataset is created by the New York Public Library. It contains historical data on the menus of hotels, restaurants and cafes with the dishes along with their prices. diff --git a/docs/getting-started/example-datasets/metrica.md b/docs/getting-started/example-datasets/metrica.md index b06074140bd..0dd597c96ed 100644 --- a/docs/getting-started/example-datasets/metrica.md +++ b/docs/getting-started/example-datasets/metrica.md @@ -4,6 +4,7 @@ description: 'Dataset consisting of two tables containing anonymized web analyti sidebar_label: 'Web Analytics Data' slug: /getting-started/example-datasets/metrica title: 'Anonymized Web Analytics' +doc_type: 'reference' --- # Anonymized web analytics data diff --git a/docs/getting-started/example-datasets/noaa.md b/docs/getting-started/example-datasets/noaa.md index 5c14cb1110a..e196861f49a 100644 --- a/docs/getting-started/example-datasets/noaa.md +++ b/docs/getting-started/example-datasets/noaa.md @@ -4,6 +4,7 @@ sidebar_label: 'NOAA Global Historical Climatology Network ' sidebar_position: 1 slug: /getting-started/example-datasets/noaa title: 'NOAA Global Historical Climatology Network' +doc_type: 'reference' --- This dataset contains weather measurements for the last 120 years. Each row is a measurement for a point in time and station. diff --git a/docs/getting-started/example-datasets/nyc-taxi.md b/docs/getting-started/example-datasets/nyc-taxi.md index 43a2c8eea63..69d33045eca 100644 --- a/docs/getting-started/example-datasets/nyc-taxi.md +++ b/docs/getting-started/example-datasets/nyc-taxi.md @@ -5,6 +5,7 @@ sidebar_label: 'New York Taxi Data' sidebar_position: 2 slug: /getting-started/example-datasets/nyc-taxi title: 'New York Taxi Data' +doc_type: 'reference' --- import Tabs from '@theme/Tabs'; diff --git a/docs/getting-started/example-datasets/nypd_complaint_data.md b/docs/getting-started/example-datasets/nypd_complaint_data.md index d53fb4ffac2..82ef8d26ea5 100644 --- a/docs/getting-started/example-datasets/nypd_complaint_data.md +++ b/docs/getting-started/example-datasets/nypd_complaint_data.md @@ -3,6 +3,7 @@ description: 'Ingest and query Tab Separated Value data in 5 steps' sidebar_label: 'NYPD Complaint Data' slug: /getting-started/example-datasets/nypd_complaint_data title: 'NYPD Complaint Data' +doc_type: 'reference' --- Tab separated value, or TSV, files are common and may include field headings as the first line of the file. ClickHouse can ingest TSVs, and also can query TSVs without ingesting the files. This guide covers both of these cases. If you need to query or ingest CSV files, the same techniques work, simply substitute `TSV` with `CSV` in your format arguments. diff --git a/docs/getting-started/example-datasets/ontime.md b/docs/getting-started/example-datasets/ontime.md index add5a46654a..a1bccee21e9 100644 --- a/docs/getting-started/example-datasets/ontime.md +++ b/docs/getting-started/example-datasets/ontime.md @@ -3,6 +3,7 @@ description: 'Dataset containing the on-time performance of airline flights' sidebar_label: 'OnTime Airline Flight Data' slug: /getting-started/example-datasets/ontime title: 'OnTime' +doc_type: 'reference' --- This dataset contains data from Bureau of Transportation Statistics. diff --git a/docs/getting-started/example-datasets/stackoverflow.md b/docs/getting-started/example-datasets/stackoverflow.md index 1f56e4bfd8c..50d441c4b0e 100644 --- a/docs/getting-started/example-datasets/stackoverflow.md +++ b/docs/getting-started/example-datasets/stackoverflow.md @@ -6,6 +6,7 @@ slug: /getting-started/example-datasets/stackoverflow title: 'Analyzing Stack Overflow data with ClickHouse' keywords: ['StackOverflow'] show_related_blogs: true +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/getting-started/example-datasets/star-schema.md b/docs/getting-started/example-datasets/star-schema.md index d4080a073e8..1aab602659d 100644 --- a/docs/getting-started/example-datasets/star-schema.md +++ b/docs/getting-started/example-datasets/star-schema.md @@ -3,6 +3,7 @@ description: 'The Star Schema Benchmark (SSB) data set and queries' sidebar_label: 'Star Schema Benchmark' slug: /getting-started/example-datasets/star-schema title: 'Star Schema Benchmark (SSB, 2009)' +doc_type: 'reference' --- The Star Schema Benchmark is roughly based on the [TPC-H](tpch.md)'s tables and queries but unlike TPC-H, it uses a star schema layout. diff --git a/docs/getting-started/example-datasets/tpcds.md b/docs/getting-started/example-datasets/tpcds.md index 4577d94e5cd..c97ed998d02 100644 --- a/docs/getting-started/example-datasets/tpcds.md +++ b/docs/getting-started/example-datasets/tpcds.md @@ -3,6 +3,7 @@ description: 'The TPC-DS benchmark data set and queries.' sidebar_label: 'TPC-DS' slug: /getting-started/example-datasets/tpcds title: 'TPC-DS (2012)' +doc_type: 'reference' --- Similar to the [Star Schema Benchmark (SSB)](star-schema.md), TPC-DS is based on [TPC-H](tpch.md), but it took the opposite route, i.e. it expanded the number of joins needed by storing the data in a complex snowflake schema (24 instead of 8 tables). diff --git a/docs/getting-started/example-datasets/tpch.md b/docs/getting-started/example-datasets/tpch.md index e2197c6341e..b59be54c3af 100644 --- a/docs/getting-started/example-datasets/tpch.md +++ b/docs/getting-started/example-datasets/tpch.md @@ -3,6 +3,7 @@ description: 'The TPC-H benchmark data set and queries.' sidebar_label: 'TPC-H' slug: /getting-started/example-datasets/tpch title: 'TPC-H (1999)' +doc_type: 'reference' --- A popular benchmark which models the internal data warehouse of a wholesale supplier. diff --git a/docs/getting-started/example-datasets/tw-weather.md b/docs/getting-started/example-datasets/tw-weather.md index b5d969681bc..ad91d91c803 100644 --- a/docs/getting-started/example-datasets/tw-weather.md +++ b/docs/getting-started/example-datasets/tw-weather.md @@ -4,6 +4,7 @@ sidebar_label: 'Taiwan Historical Weather Datasets' sidebar_position: 1 slug: /getting-started/example-datasets/tw-weather title: 'Taiwan Historical Weather Datasets' +doc_type: 'reference' --- This dataset contains historical meteorological observations measurements for the last 128 years. Each row is a measurement for a point in date time and weather station. diff --git a/docs/getting-started/example-datasets/uk-price-paid.md b/docs/getting-started/example-datasets/uk-price-paid.md index 21623fd8fa1..bf238148c6c 100644 --- a/docs/getting-started/example-datasets/uk-price-paid.md +++ b/docs/getting-started/example-datasets/uk-price-paid.md @@ -6,6 +6,7 @@ sidebar_label: 'UK Property Prices' sidebar_position: 1 slug: /getting-started/example-datasets/uk-price-paid title: 'The UK property prices dataset' +doc_type: 'tutorial' --- This data contains prices paid for real-estate property in England and Wales. The data is available since 1995, and the size of the dataset in uncompressed form is about 4 GiB (which will only take about 278 MiB in ClickHouse). diff --git a/docs/getting-started/example-datasets/wikistat.md b/docs/getting-started/example-datasets/wikistat.md index f13fe397cb7..0f17507e39f 100644 --- a/docs/getting-started/example-datasets/wikistat.md +++ b/docs/getting-started/example-datasets/wikistat.md @@ -3,6 +3,7 @@ description: 'Explore the WikiStat dataset containing 0.5 trillion records.' sidebar_label: 'WikiStat' slug: /getting-started/example-datasets/wikistat title: 'WikiStat' +doc_type: 'reference' --- The dataset contains 0.5 trillion records. diff --git a/docs/getting-started/example-datasets/youtube-dislikes.md b/docs/getting-started/example-datasets/youtube-dislikes.md index eb78ab7b9be..14b1a5b029c 100644 --- a/docs/getting-started/example-datasets/youtube-dislikes.md +++ b/docs/getting-started/example-datasets/youtube-dislikes.md @@ -3,6 +3,7 @@ description: 'A collection is dislikes of YouTube videos.' sidebar_label: 'YouTube Dislikes' slug: /getting-started/example-datasets/youtube-dislikes title: 'YouTube dataset of dislikes' +doc_type: 'reference' --- In November of 2021, YouTube removed the public ***dislike*** count from all of its videos. While creators can still see the number of dislikes, viewers can only see how many ***likes*** a video has received. diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 02ff69186f1..f65a26e4203 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -6,6 +6,7 @@ sidebar_label: 'Overview' sidebar_position: 0 slug: /getting-started/example-datasets/ title: 'Tutorials and Example Datasets' +doc_type: 'landing-page' --- # Tutorials and example datasets diff --git a/docs/getting-started/install/advanced.md b/docs/getting-started/install/advanced.md index 7f3d7953a62..e42613d21d7 100644 --- a/docs/getting-started/install/advanced.md +++ b/docs/getting-started/install/advanced.md @@ -5,6 +5,7 @@ sidebar_label: 'Advanced install' slug: /install/advanced title: 'Advanced installation methods' hide_title: false +doc_type: 'guide' --- ## Compile from source {#compile-from-source} diff --git a/docs/getting-started/install/debian_ubuntu.md b/docs/getting-started/install/debian_ubuntu.md index 7c579ac8ffd..d3e5aafd421 100644 --- a/docs/getting-started/install/debian_ubuntu.md +++ b/docs/getting-started/install/debian_ubuntu.md @@ -5,6 +5,7 @@ sidebar_label: 'Debian/Ubuntu' slug: /install/debian_ubuntu title: 'Install ClickHouse on Debian/Ubuntu' hide_title: true +doc_type: 'guide' --- import DebianProd from './_snippets/_deb_install.md' diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md index 098831005b0..029e51e5354 100644 --- a/docs/getting-started/install/docker.md +++ b/docs/getting-started/install/docker.md @@ -5,6 +5,7 @@ sidebar_label: 'Docker' slug: /install/docker title: 'Install ClickHouse using Docker' hide_title: true +doc_type: 'guide' --- import Docker from './_snippets/_docker.md' diff --git a/docs/getting-started/install/macos.md b/docs/getting-started/install/macos.md index 47fc7326738..747fd53429b 100644 --- a/docs/getting-started/install/macos.md +++ b/docs/getting-started/install/macos.md @@ -5,6 +5,7 @@ sidebar_label: 'MacOS' slug: /install/macOS title: 'Install ClickHouse using Homebrew' hide_title: true +doc_type: 'guide' --- import MacOSProd from './_snippets/_macos.md' diff --git a/docs/getting-started/install/other_linux.md b/docs/getting-started/install/other_linux.md index 79415aa3b86..b10f2c2e5c6 100644 --- a/docs/getting-started/install/other_linux.md +++ b/docs/getting-started/install/other_linux.md @@ -5,6 +5,7 @@ sidebar_label: 'Other Linux' slug: /install/linux_other title: 'Install ClickHouse using tgz archives' hide_title: true +doc_type: 'guide' --- import Tar from './_snippets/_linux_tar_install.md' diff --git a/docs/getting-started/install/quick-install-curl.md b/docs/getting-started/install/quick-install-curl.md index 1338ea87f96..b8de0052cfd 100644 --- a/docs/getting-started/install/quick-install-curl.md +++ b/docs/getting-started/install/quick-install-curl.md @@ -5,6 +5,7 @@ sidebar_label: 'Quick install' slug: /install/quick-install-curl title: 'Install ClickHouse via script using curl' hide_title: true +doc_type: 'guide' --- import QuickInstall from './_snippets/_quick_install.md' diff --git a/docs/getting-started/install/redhat.md b/docs/getting-started/install/redhat.md index 30d49ab8200..f7540654b8c 100644 --- a/docs/getting-started/install/redhat.md +++ b/docs/getting-started/install/redhat.md @@ -5,6 +5,7 @@ sidebar_label: 'Redhat/CentOS' slug: /install/redhat title: 'Install ClickHouse on rpm-based Linux distributions' hide_title: true +doc_type: 'guide' --- import RPM from './_snippets/_rpm_install.md' diff --git a/docs/getting-started/install/windows.md b/docs/getting-started/install/windows.md index e81fe7b88d9..936eda78170 100644 --- a/docs/getting-started/install/windows.md +++ b/docs/getting-started/install/windows.md @@ -5,6 +5,7 @@ sidebar_label: 'Windows' slug: /install/windows title: 'Install ClickHouse on Windows with WSL' hide_title: true +doc_type: 'guide' --- import Windows from './_snippets/_windows_install.md' diff --git a/docs/getting-started/playground.md b/docs/getting-started/playground.md index 90371035308..6870f21c735 100644 --- a/docs/getting-started/playground.md +++ b/docs/getting-started/playground.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'playground', 'getting', 'started', 'docs'] sidebar_label: 'ClickHouse Playground' slug: /getting-started/playground title: 'ClickHouse Playground' +doc_type: 'guide' --- # ClickHouse playground diff --git a/docs/guides/best-practices/asyncinserts.md b/docs/guides/best-practices/asyncinserts.md index 49c33ecb515..dddd0c7d5a1 100644 --- a/docs/guides/best-practices/asyncinserts.md +++ b/docs/guides/best-practices/asyncinserts.md @@ -3,6 +3,7 @@ slug: /optimize/asynchronous-inserts sidebar_label: 'Asynchronous Inserts' title: 'Asynchronous Inserts (async_insert)' description: 'Use asynchronous inserts as an alternative to batching data.' +doc_type: 'guide' --- import Content from '@site/docs/best-practices/_snippets/_async_inserts.md'; diff --git a/docs/guides/best-practices/avoidmutations.md b/docs/guides/best-practices/avoidmutations.md index c9a2af3a42f..e08716782f0 100644 --- a/docs/guides/best-practices/avoidmutations.md +++ b/docs/guides/best-practices/avoidmutations.md @@ -3,6 +3,7 @@ slug: /optimize/avoid-mutations sidebar_label: 'Avoid Mutations' title: 'Avoid Mutations' description: 'Mutations refers to ALTER queries that manipulate table data' +doc_type: 'guide' --- import Content from '@site/docs/best-practices/_snippets/_avoid_mutations.md'; diff --git a/docs/guides/best-practices/avoidnullablecolumns.md b/docs/guides/best-practices/avoidnullablecolumns.md index b7666559481..74cba990613 100644 --- a/docs/guides/best-practices/avoidnullablecolumns.md +++ b/docs/guides/best-practices/avoidnullablecolumns.md @@ -3,6 +3,7 @@ slug: /optimize/avoid-nullable-columns sidebar_label: 'Avoid nullable Columns' title: 'Avoid nullable Columns' description: 'Why Nullable Columns should be avoided in ClickHouse' +doc_type: 'guide' --- import Content from '@site/docs/best-practices/_snippets/_avoid_nullable_columns.md'; diff --git a/docs/guides/best-practices/avoidoptimizefinal.md b/docs/guides/best-practices/avoidoptimizefinal.md index 55529f979aa..82b9ddebb36 100644 --- a/docs/guides/best-practices/avoidoptimizefinal.md +++ b/docs/guides/best-practices/avoidoptimizefinal.md @@ -3,6 +3,7 @@ slug: /optimize/avoidoptimizefinal sidebar_label: 'Avoid Optimize Final' title: 'Avoid Optimize Final' description: 'Using the OPTIMIZE TABLE ... FINAL query will initiate an unscheduled merge of data parts.' +doc_type: 'guide' --- import Content from '@site/docs/best-practices/_snippets/_avoid_optimize_final.md'; diff --git a/docs/guides/best-practices/bulkinserts.md b/docs/guides/best-practices/bulkinserts.md index d9b5ec1d45d..17875929633 100644 --- a/docs/guides/best-practices/bulkinserts.md +++ b/docs/guides/best-practices/bulkinserts.md @@ -3,6 +3,7 @@ slug: /optimize/bulk-inserts sidebar_label: 'Bulk Inserts' title: 'Bulk Inserts' description: 'Sending a smaller amount of inserts that each contain more data will reduce the number of writes required.' +doc_type: 'guide' --- import Content from '@site/docs/best-practices/_snippets/_bulk_inserts.md'; diff --git a/docs/guides/best-practices/index.md b/docs/guides/best-practices/index.md index ef320eaf03c..8a64b752c79 100644 --- a/docs/guides/best-practices/index.md +++ b/docs/guides/best-practices/index.md @@ -3,6 +3,7 @@ slug: /operations/overview sidebar_label: 'Performance and Optimizations Overview' description: 'Overview page of Performance and Optimizations' title: 'Performance and Optimizations' +doc_type: 'reference' --- import TableOfContents from '@site/docs/guides/best-practices/_snippets/_performance_optimizations_table_of_contents.md'; diff --git a/docs/guides/best-practices/partitioningkey.md b/docs/guides/best-practices/partitioningkey.md index a41fa1bf3eb..e6487f602ef 100644 --- a/docs/guides/best-practices/partitioningkey.md +++ b/docs/guides/best-practices/partitioningkey.md @@ -3,6 +3,7 @@ slug: /optimize/partitioning-key sidebar_label: 'Partitioning Key' title: 'Choose a Low Cardinality Partitioning Key' description: 'Use a low cardinality partitioning key or avoid using any partitioning key for your table.' +doc_type: 'guide' --- import Content from '@site/docs/best-practices/partitioning_keys.mdx'; diff --git a/docs/guides/best-practices/prewhere.md b/docs/guides/best-practices/prewhere.md index b334687c133..bd4edc0e51a 100644 --- a/docs/guides/best-practices/prewhere.md +++ b/docs/guides/best-practices/prewhere.md @@ -4,6 +4,7 @@ sidebar_label: 'PREWHERE Optimization' sidebar_position: 21 description: 'PREWHERE reduces I/O by avoiding reading unnecessary column data.' title: 'How does the PREWHERE optimization work?' +doc_type: 'guide' --- import visual01 from '@site/static/images/guides/best-practices/prewhere_01.gif'; diff --git a/docs/guides/best-practices/query-optimization.md b/docs/guides/best-practices/query-optimization.md index fe044138603..7639a1d7658 100644 --- a/docs/guides/best-practices/query-optimization.md +++ b/docs/guides/best-practices/query-optimization.md @@ -3,6 +3,7 @@ slug: /optimize/query-optimization sidebar_label: 'Query optimization' title: 'Guide for Query optimization' description: 'A simple guide for query optimization that describe common path to improve query performance' +doc_type: 'guide' --- import queryOptimizationDiagram1 from '@site/static/images/guides/best-practices/query_optimization_diagram_1.png'; diff --git a/docs/guides/best-practices/query-parallelism.md b/docs/guides/best-practices/query-parallelism.md index 81aa7776915..5f5b58f640f 100644 --- a/docs/guides/best-practices/query-parallelism.md +++ b/docs/guides/best-practices/query-parallelism.md @@ -4,6 +4,7 @@ sidebar_label: 'Query Parallelism' sidebar_position: 20 description: 'ClickHouse parallelizes query execution using processing lanes and the max_threads setting.' title: 'How ClickHouse executes a query in parallel' +doc_type: 'guide' --- import visual01 from '@site/static/images/guides/best-practices/query-parallelism_01.gif'; diff --git a/docs/guides/best-practices/skipping-indexes.md b/docs/guides/best-practices/skipping-indexes.md index d2488ab8ab0..7a15a2566a9 100644 --- a/docs/guides/best-practices/skipping-indexes.md +++ b/docs/guides/best-practices/skipping-indexes.md @@ -4,6 +4,7 @@ sidebar_label: 'Data Skipping Indexes' sidebar_position: 2 description: 'Skip indexes enable ClickHouse to skip reading significant chunks of data that are guaranteed to have no matching values.' title: 'Understanding ClickHouse Data Skipping Indexes' +doc_type: 'guide' --- import simple_skip from '@site/static/images/guides/best-practices/simple_skip.png'; diff --git a/docs/guides/best-practices/sparse-primary-indexes.md b/docs/guides/best-practices/sparse-primary-indexes.md index bac5455453e..0182a21cef6 100644 --- a/docs/guides/best-practices/sparse-primary-indexes.md +++ b/docs/guides/best-practices/sparse-primary-indexes.md @@ -5,6 +5,7 @@ description: 'In this guide we are going to do a deep dive into ClickHouse index title: 'A Practical Introduction to Primary Indexes in ClickHouse' slug: /guides/best-practices/sparse-primary-indexes show_related_blogs: true +doc_type: 'guide' --- import sparsePrimaryIndexes01 from '@site/static/images/guides/best-practices/sparse-primary-indexes-01.png'; diff --git a/docs/guides/creating-tables.md b/docs/guides/creating-tables.md index fe1ecf915df..926968ad8fb 100644 --- a/docs/guides/creating-tables.md +++ b/docs/guides/creating-tables.md @@ -4,6 +4,7 @@ sidebar_label: 'Creating tables' title: 'Creating tables in ClickHouse' slug: /guides/creating-tables description: 'Learn about Creating Tables in ClickHouse' +doc_type: 'guide' --- # Creating tables in ClickHouse diff --git a/docs/guides/developer/alternative-query-languages.md b/docs/guides/developer/alternative-query-languages.md index 7e62fdc8a14..06e7dc12789 100644 --- a/docs/guides/developer/alternative-query-languages.md +++ b/docs/guides/developer/alternative-query-languages.md @@ -3,6 +3,7 @@ slug: /guides/developer/alternative-query-languages sidebar_label: 'Alternative Query Languages' title: 'Alternative Query Languages' description: 'Use alternative query languages in ClickHouse' +doc_type: 'reference' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/guides/developer/cascading-materialized-views.md b/docs/guides/developer/cascading-materialized-views.md index 83c4828a4e5..6333a8d79ad 100644 --- a/docs/guides/developer/cascading-materialized-views.md +++ b/docs/guides/developer/cascading-materialized-views.md @@ -3,6 +3,7 @@ slug: /guides/developer/cascading-materialized-views title: 'Cascading Materialized Views' description: 'How to use multiple materialized views from a source table.' keywords: ['materialized view', 'aggregation'] +doc_type: 'guide' --- # Cascading materialized views diff --git a/docs/guides/developer/debugging-memory-issues.md b/docs/guides/developer/debugging-memory-issues.md index 44b0191a4af..408090a64f7 100644 --- a/docs/guides/developer/debugging-memory-issues.md +++ b/docs/guides/developer/debugging-memory-issues.md @@ -5,6 +5,7 @@ sidebar_position: 1 description: 'Queries to help you debug memory issues.' keywords: ['memory issues'] title: 'Debugging memory issues' +doc_type: 'guide' --- # Debugging memory issues {#debugging-memory-issues} diff --git a/docs/guides/developer/deduplicating-inserts-on-retries.md b/docs/guides/developer/deduplicating-inserts-on-retries.md index 12646387a58..1ab71a57824 100644 --- a/docs/guides/developer/deduplicating-inserts-on-retries.md +++ b/docs/guides/developer/deduplicating-inserts-on-retries.md @@ -3,6 +3,7 @@ slug: /guides/developer/deduplicating-inserts-on-retries title: 'Deduplicating Inserts on Retries' description: 'Preventing duplicate data when retrying insert operations' keywords: ['deduplication', 'deduplicate', 'insert retries', 'inserts'] +doc_type: 'guide' --- Insert operations can sometimes fail due to errors such as timeouts. When inserts fail, data may or may not have been successfully inserted. This guide covers how to enable deduplication on insert retries such that the same data does not get inserted more than once. diff --git a/docs/guides/developer/deduplication.md b/docs/guides/developer/deduplication.md index f7e6057cb84..e72ff889e76 100644 --- a/docs/guides/developer/deduplication.md +++ b/docs/guides/developer/deduplication.md @@ -4,6 +4,7 @@ sidebar_label: 'Deduplication Strategies' sidebar_position: 3 description: 'Use deduplication when you need to perform frequent upserts, updates and deletes.' title: 'Deduplication Strategies' +doc_type: 'guide' --- import deduplication from '@site/static/images/guides/developer/de_duplication.png'; diff --git a/docs/guides/developer/dynamic-column-selection.md b/docs/guides/developer/dynamic-column-selection.md index 39594767137..486bc02a1d0 100644 --- a/docs/guides/developer/dynamic-column-selection.md +++ b/docs/guides/developer/dynamic-column-selection.md @@ -3,6 +3,7 @@ slug: /guides/developer/dynamic-column-selection sidebar_label: 'Dynamic column selection' title: 'Dynamic column selection' description: 'Use alternative query languages in ClickHouse' +doc_type: 'guide' --- [Dynamic column selection](/docs/sql-reference/statements/select#dynamic-column-selection) is a powerful but underutilized ClickHouse feature that allows you to select columns using regular expressions instead of naming each column individually. You can also apply functions to matching columns using the [`APPLY`](/sql-reference/statements/select#apply) modifier, making it incredibly useful for data analysis and transformation tasks. diff --git a/docs/guides/developer/index.md b/docs/guides/developer/index.md index aad644e8cda..feb680bc8f6 100644 --- a/docs/guides/developer/index.md +++ b/docs/guides/developer/index.md @@ -3,6 +3,7 @@ slug: /guides/developer/overview sidebar_label: 'Advanced Guides Overview' description: 'Overview of the advanced guides' title: 'Advanced Guides' +doc_type: 'guide' --- # Advanced guides diff --git a/docs/guides/developer/lightweight-delete.md b/docs/guides/developer/lightweight-delete.md index bf7a6bff220..70f1d010ca7 100644 --- a/docs/guides/developer/lightweight-delete.md +++ b/docs/guides/developer/lightweight-delete.md @@ -3,6 +3,7 @@ slug: /guides/developer/lightweight-delete title: 'Lightweight Delete' keywords: ['lightweight delete'] description: 'Provides an overview of lightweight deletes in ClickHouse' +doc_type: 'reference' --- import Content from '@site/docs/sql-reference/statements/delete.md'; diff --git a/docs/guides/developer/merge-table-function.md b/docs/guides/developer/merge-table-function.md index d6e1208acfe..dc2f0e3ec19 100644 --- a/docs/guides/developer/merge-table-function.md +++ b/docs/guides/developer/merge-table-function.md @@ -3,6 +3,7 @@ slug: /guides/developer/merge-table-function sidebar_label: 'Merge table function' title: 'Merge table function' description: 'Query multiple tables at the same time.' +doc_type: 'reference' --- The [merge table function](https://clickhouse.com/docs/sql-reference/table-functions/merge) lets us query multiple tables in parallel. diff --git a/docs/guides/developer/mutations.md b/docs/guides/developer/mutations.md index 1cd4c4fd9dc..b12159d1356 100644 --- a/docs/guides/developer/mutations.md +++ b/docs/guides/developer/mutations.md @@ -6,6 +6,7 @@ keywords: ['UPDATE', 'DELETE', 'mutations'] title: 'Updating and deleting ClickHouse data' description: 'Describes how to perform update and delete operations in ClickHouse' show_related_blogs: false +doc_type: 'guide' --- # Updating and deleting ClickHouse data with mutations diff --git a/docs/guides/developer/on-fly-mutations.md b/docs/guides/developer/on-fly-mutations.md index fe42d48bcd4..a28689c01b0 100644 --- a/docs/guides/developer/on-fly-mutations.md +++ b/docs/guides/developer/on-fly-mutations.md @@ -4,6 +4,7 @@ sidebar_label: 'On-the-fly mutation' title: 'On-the-fly Mutations' keywords: ['On-the-fly mutation'] description: 'Provides a description of on-the-fly mutations' +doc_type: 'guide' --- ## On-the-fly mutations {#on-the-fly-mutations} diff --git a/docs/guides/developer/replacing-merge-tree.md b/docs/guides/developer/replacing-merge-tree.md index aa71858f6f6..3def2b9a483 100644 --- a/docs/guides/developer/replacing-merge-tree.md +++ b/docs/guides/developer/replacing-merge-tree.md @@ -3,6 +3,7 @@ slug: /guides/replacing-merge-tree title: 'ReplacingMergeTree' description: 'Using the ReplacingMergeTree engine in ClickHouse' keywords: ['replacingmergetree', 'inserts', 'deduplication'] +doc_type: 'guide' --- import postgres_replacingmergetree from '@site/static/images/migrations/postgres-replacingmergetree.png'; diff --git a/docs/guides/developer/time-series-filling-gaps.md b/docs/guides/developer/time-series-filling-gaps.md index a1aa33c938b..c3b8ea2cdce 100644 --- a/docs/guides/developer/time-series-filling-gaps.md +++ b/docs/guides/developer/time-series-filling-gaps.md @@ -5,6 +5,7 @@ sidebar_position: 10 description: 'Filling gaps in time-series data.' keywords: ['time series', 'gap fill'] title: 'Filling gaps in time-series data' +doc_type: 'guide' --- # Filling gaps in time-series data diff --git a/docs/guides/developer/ttl.md b/docs/guides/developer/ttl.md index 49361a6c6cc..dfd08c375f9 100644 --- a/docs/guides/developer/ttl.md +++ b/docs/guides/developer/ttl.md @@ -6,6 +6,7 @@ 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.' title: 'Manage Data with TTL (Time-to-live)' show_related_blogs: true +doc_type: 'guide' --- import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; diff --git a/docs/guides/developer/understanding-query-execution-with-the-analyzer.md b/docs/guides/developer/understanding-query-execution-with-the-analyzer.md index 07b70028b3e..5841c3411bc 100644 --- a/docs/guides/developer/understanding-query-execution-with-the-analyzer.md +++ b/docs/guides/developer/understanding-query-execution-with-the-analyzer.md @@ -3,6 +3,7 @@ slug: /guides/developer/understanding-query-execution-with-the-analyzer sidebar_label: 'Understanding Query Execution with the Analyzer' title: 'Understanding Query Execution with the Analyzer' description: 'Describes how you can use the analyzer to understand how ClickHouse executes your queries' +doc_type: 'guide' --- import analyzer1 from '@site/static/images/guides/developer/analyzer1.png'; diff --git a/docs/guides/examples/aggregate_function_combinators/anyIf.md b/docs/guides/examples/aggregate_function_combinators/anyIf.md index a0368717512..896d9704f45 100644 --- a/docs/guides/examples/aggregate_function_combinators/anyIf.md +++ b/docs/guides/examples/aggregate_function_combinators/anyIf.md @@ -4,6 +4,7 @@ title: 'anyIf' description: 'Example of using the anyIf combinator' keywords: ['any', 'if', 'combinator', 'examples', 'anyIf'] sidebar_label: 'anyIf' +doc_type: 'reference' --- # anyIf {#avgif} diff --git a/docs/guides/examples/aggregate_function_combinators/argMaxIf.md b/docs/guides/examples/aggregate_function_combinators/argMaxIf.md index f3ebb5dc512..bfa860a8680 100644 --- a/docs/guides/examples/aggregate_function_combinators/argMaxIf.md +++ b/docs/guides/examples/aggregate_function_combinators/argMaxIf.md @@ -4,6 +4,7 @@ title: 'argMaxIf' description: 'Example of using the argMaxIf combinator' keywords: ['argMax', 'if', 'combinator', 'examples', 'argMaxIf'] sidebar_label: 'argMaxIf' +doc_type: 'reference' --- # argMaxIf {#argmaxif} diff --git a/docs/guides/examples/aggregate_function_combinators/argMinIf.md b/docs/guides/examples/aggregate_function_combinators/argMinIf.md index 9fd236e7ac7..35197ba5297 100644 --- a/docs/guides/examples/aggregate_function_combinators/argMinIf.md +++ b/docs/guides/examples/aggregate_function_combinators/argMinIf.md @@ -4,6 +4,7 @@ title: 'argMinIf' description: 'Example of using the argMinIf combinator' keywords: ['argMin', 'if', 'combinator', 'examples', 'argMinIf'] sidebar_label: 'argMinIf' +doc_type: 'reference' --- # argMinIf {#argminif} diff --git a/docs/guides/examples/aggregate_function_combinators/avgIf.md b/docs/guides/examples/aggregate_function_combinators/avgIf.md index a77130bef53..535ee31d1da 100644 --- a/docs/guides/examples/aggregate_function_combinators/avgIf.md +++ b/docs/guides/examples/aggregate_function_combinators/avgIf.md @@ -4,6 +4,7 @@ title: 'avgIf' description: 'Example of using the avgIf combinator' keywords: ['avg', 'if', 'combinator', 'examples', 'avgIf'] sidebar_label: 'avgIf' +doc_type: 'reference' --- # avgIf {#avgif} diff --git a/docs/guides/examples/aggregate_function_combinators/avgMap.md b/docs/guides/examples/aggregate_function_combinators/avgMap.md index 51f73f3cf48..16a91058834 100644 --- a/docs/guides/examples/aggregate_function_combinators/avgMap.md +++ b/docs/guides/examples/aggregate_function_combinators/avgMap.md @@ -4,6 +4,7 @@ title: 'avgMap' description: 'Example of using the avgMap combinator' keywords: ['avg', 'map', 'combinator', 'examples', 'avgMap'] sidebar_label: 'avgMap' +doc_type: 'reference' --- # avgMap {#avgmap} diff --git a/docs/guides/examples/aggregate_function_combinators/avgMerge.md b/docs/guides/examples/aggregate_function_combinators/avgMerge.md index 34a9827561f..e209a3aeb54 100644 --- a/docs/guides/examples/aggregate_function_combinators/avgMerge.md +++ b/docs/guides/examples/aggregate_function_combinators/avgMerge.md @@ -4,6 +4,7 @@ title: 'avgMerge' description: 'Example of using the avgMerge combinator' keywords: ['avg', 'merge', 'combinator', 'examples', 'avgMerge'] sidebar_label: 'avgMerge' +doc_type: 'reference' --- # avgMerge {#avgMerge} diff --git a/docs/guides/examples/aggregate_function_combinators/avgMergeState.md b/docs/guides/examples/aggregate_function_combinators/avgMergeState.md index 916e21fb12a..2e1de95c91e 100644 --- a/docs/guides/examples/aggregate_function_combinators/avgMergeState.md +++ b/docs/guides/examples/aggregate_function_combinators/avgMergeState.md @@ -4,6 +4,7 @@ title: 'avgMergeState' description: 'Example of using the avgMergeState combinator' keywords: ['avg', 'MergeState', 'combinator', 'examples', 'avgMergeState'] sidebar_label: 'avgMergeState' +doc_type: 'reference' --- import Tabs from '@theme/Tabs'; diff --git a/docs/guides/examples/aggregate_function_combinators/avgResample.md b/docs/guides/examples/aggregate_function_combinators/avgResample.md index bdbeb9f91d5..7e54f873241 100644 --- a/docs/guides/examples/aggregate_function_combinators/avgResample.md +++ b/docs/guides/examples/aggregate_function_combinators/avgResample.md @@ -4,6 +4,7 @@ title: 'avgResample' description: 'Example of using the Resample combinator with avg' keywords: ['avg', 'Resample', 'combinator', 'examples', 'avgResample'] sidebar_label: 'avgResample' +doc_type: 'reference' --- # countResample {#countResample} diff --git a/docs/guides/examples/aggregate_function_combinators/avgState.md b/docs/guides/examples/aggregate_function_combinators/avgState.md index e0e2317701d..1dec7554042 100644 --- a/docs/guides/examples/aggregate_function_combinators/avgState.md +++ b/docs/guides/examples/aggregate_function_combinators/avgState.md @@ -4,6 +4,7 @@ title: 'avgState' description: 'Example of using the avgState combinator' keywords: ['avg', 'state', 'combinator', 'examples', 'avgState'] sidebar_label: 'avgState' +doc_type: 'reference' --- # avgState {#avgState} diff --git a/docs/guides/examples/aggregate_function_combinators/countIf.md b/docs/guides/examples/aggregate_function_combinators/countIf.md index 53aac092dd4..ee5131edf08 100644 --- a/docs/guides/examples/aggregate_function_combinators/countIf.md +++ b/docs/guides/examples/aggregate_function_combinators/countIf.md @@ -4,6 +4,7 @@ title: 'countIf' description: 'Example of using the countIf combinator' keywords: ['count', 'if', 'combinator', 'examples', 'countIf'] sidebar_label: 'countIf' +doc_type: 'reference' --- # countIf {#countif} diff --git a/docs/guides/examples/aggregate_function_combinators/countResample.md b/docs/guides/examples/aggregate_function_combinators/countResample.md index f90bb6a168c..826e8806fa8 100644 --- a/docs/guides/examples/aggregate_function_combinators/countResample.md +++ b/docs/guides/examples/aggregate_function_combinators/countResample.md @@ -4,6 +4,7 @@ title: 'countResample' description: 'Example of using the Resample combinator with count' keywords: ['count', 'Resample', 'combinator', 'examples', 'countResample'] sidebar_label: 'countResample' +doc_type: 'reference' --- # countResample {#countResample} diff --git a/docs/guides/examples/aggregate_function_combinators/groupArrayDistinct.md b/docs/guides/examples/aggregate_function_combinators/groupArrayDistinct.md index dd7350258fc..9f950dde551 100644 --- a/docs/guides/examples/aggregate_function_combinators/groupArrayDistinct.md +++ b/docs/guides/examples/aggregate_function_combinators/groupArrayDistinct.md @@ -4,6 +4,7 @@ title: 'groupArrayDistinct' description: 'Example of using the groupArrayDistinct combinator' keywords: ['groupArray', 'Distinct', 'combinator', 'examples', 'groupArrayDistinct'] sidebar_label: 'groupArrayDistinct' +doc_type: 'reference' --- # groupArrayDistinct {#sumdistinct} diff --git a/docs/guides/examples/aggregate_function_combinators/groupArrayResample.md b/docs/guides/examples/aggregate_function_combinators/groupArrayResample.md index 38176eaa49f..c392ffebbfe 100644 --- a/docs/guides/examples/aggregate_function_combinators/groupArrayResample.md +++ b/docs/guides/examples/aggregate_function_combinators/groupArrayResample.md @@ -4,6 +4,7 @@ title: 'groupArrayResample' description: 'Example of using the Resample combinator with groupArray' keywords: ['groupArray', 'Resample', 'combinator', 'examples', 'groupArrayResample'] sidebar_label: 'groupArrayResample' +doc_type: 'reference' --- # groupArrayResample {#grouparrayresample} diff --git a/docs/guides/examples/aggregate_function_combinators/maxMap.md b/docs/guides/examples/aggregate_function_combinators/maxMap.md index e1ffe4907fb..68fb587d575 100644 --- a/docs/guides/examples/aggregate_function_combinators/maxMap.md +++ b/docs/guides/examples/aggregate_function_combinators/maxMap.md @@ -4,6 +4,7 @@ title: 'maxMap' description: 'Example of using the maxMap combinator' keywords: ['max', 'map', 'combinator', 'examples', 'maxMap'] sidebar_label: 'maxMap' +doc_type: 'reference' --- # maxMap {#maxmap} diff --git a/docs/guides/examples/aggregate_function_combinators/maxSimpleState.md b/docs/guides/examples/aggregate_function_combinators/maxSimpleState.md index 729637ce814..8ebd8e272ac 100644 --- a/docs/guides/examples/aggregate_function_combinators/maxSimpleState.md +++ b/docs/guides/examples/aggregate_function_combinators/maxSimpleState.md @@ -4,6 +4,7 @@ title: 'maxSimpleState' description: 'Example of using the minSimpleState combinator' keywords: ['min', 'state', 'simple', 'combinator', 'examples', 'minSimpleState'] sidebar_label: 'minSimpleState' +doc_type: 'reference' --- # minSimpleState {#minsimplestate} diff --git a/docs/guides/examples/aggregate_function_combinators/minMap.md b/docs/guides/examples/aggregate_function_combinators/minMap.md index e8843244f64..d73f9a91b25 100644 --- a/docs/guides/examples/aggregate_function_combinators/minMap.md +++ b/docs/guides/examples/aggregate_function_combinators/minMap.md @@ -4,6 +4,7 @@ title: 'minMap' description: 'Example of using the minMap combinator' keywords: ['min', 'map', 'combinator', 'examples', 'minMap'] sidebar_label: 'minMap' +doc_type: 'reference' --- # minMap {#minmap} diff --git a/docs/guides/examples/aggregate_function_combinators/minSimpleState.md b/docs/guides/examples/aggregate_function_combinators/minSimpleState.md index 0d7fa86a4ac..0e70bc48160 100644 --- a/docs/guides/examples/aggregate_function_combinators/minSimpleState.md +++ b/docs/guides/examples/aggregate_function_combinators/minSimpleState.md @@ -4,6 +4,7 @@ title: 'minSimpleState' description: 'Example of using the minSimpleState combinator' keywords: ['min', 'state', 'simple', 'combinator', 'examples', 'minSimpleState'] sidebar_label: 'minSimpleState' +doc_type: 'reference' --- # minSimpleState {#minsimplestate} diff --git a/docs/guides/examples/aggregate_function_combinators/quantilesTimingArrayIf.md b/docs/guides/examples/aggregate_function_combinators/quantilesTimingArrayIf.md index 3df6548f982..837c008d03a 100644 --- a/docs/guides/examples/aggregate_function_combinators/quantilesTimingArrayIf.md +++ b/docs/guides/examples/aggregate_function_combinators/quantilesTimingArrayIf.md @@ -4,6 +4,7 @@ title: 'quantilesTimingArrayIf' description: 'Example of using the quantilesTimingArrayIf combinator' keywords: ['quantilesTiming', 'array', 'if', 'combinator', 'examples', 'quantilesTimingArrayIf'] sidebar_label: 'quantilesTimingArrayIf' +doc_type: 'reference' --- # quantilesTimingArrayIf {#quantilestimingarrayif} diff --git a/docs/guides/examples/aggregate_function_combinators/quantilesTimingIf.md b/docs/guides/examples/aggregate_function_combinators/quantilesTimingIf.md index 4dc1ae5743b..0564ab5eb62 100644 --- a/docs/guides/examples/aggregate_function_combinators/quantilesTimingIf.md +++ b/docs/guides/examples/aggregate_function_combinators/quantilesTimingIf.md @@ -4,6 +4,7 @@ title: 'quantilesTimingIf' description: 'Example of using the quantilesTimingIf combinator' keywords: ['quantilesTiming', 'if', 'combinator', 'examples', 'quantilesTimingIf'] sidebar_label: 'quantilesTimingIf' +doc_type: 'reference' --- # quantilesTimingIf {#quantilestimingif} diff --git a/docs/guides/examples/aggregate_function_combinators/sumArray.md b/docs/guides/examples/aggregate_function_combinators/sumArray.md index 0f1fdabf461..ff05b916c8e 100644 --- a/docs/guides/examples/aggregate_function_combinators/sumArray.md +++ b/docs/guides/examples/aggregate_function_combinators/sumArray.md @@ -4,6 +4,7 @@ title: 'sumArray' description: 'Example of using the sumArray combinator' keywords: ['sum', 'array', 'combinator', 'examples', 'sumArray'] sidebar_label: 'sumArray' +doc_type: 'reference' --- # sumArray {#sumarray} diff --git a/docs/guides/examples/aggregate_function_combinators/sumForEach.md b/docs/guides/examples/aggregate_function_combinators/sumForEach.md index 67b2ed98e3c..ffe94333ef4 100644 --- a/docs/guides/examples/aggregate_function_combinators/sumForEach.md +++ b/docs/guides/examples/aggregate_function_combinators/sumForEach.md @@ -4,6 +4,7 @@ title: 'sumForEach' description: 'Example of using the sumForEach aggregate function' keywords: ['sum', 'ForEach', 'combinator', 'examples', 'sumForEach'] sidebar_label: 'sumForEach' +doc_type: 'reference' --- # sumForEach {#sumforeach} diff --git a/docs/guides/examples/aggregate_function_combinators/sumIf.md b/docs/guides/examples/aggregate_function_combinators/sumIf.md index 7b70e7117ea..624eb0aef1c 100644 --- a/docs/guides/examples/aggregate_function_combinators/sumIf.md +++ b/docs/guides/examples/aggregate_function_combinators/sumIf.md @@ -4,6 +4,7 @@ title: 'sumIf' description: 'Example of using the sumIf combinator' keywords: ['sum', 'if', 'combinator', 'examples', 'sumIf'] sidebar_label: 'sumIf' +doc_type: 'reference' --- # sumIf {#sumif} diff --git a/docs/guides/examples/aggregate_function_combinators/sumMap.md b/docs/guides/examples/aggregate_function_combinators/sumMap.md index fda6b895388..edf49b60d05 100644 --- a/docs/guides/examples/aggregate_function_combinators/sumMap.md +++ b/docs/guides/examples/aggregate_function_combinators/sumMap.md @@ -4,6 +4,7 @@ title: 'sumMap' description: 'Example of using the sumMap combinator' keywords: ['sum', 'map', 'combinator', 'examples', 'sumMap'] sidebar_label: 'sumMap' +doc_type: 'reference' --- # sumMap {#summap} diff --git a/docs/guides/examples/aggregate_function_combinators/sumSimpleState.md b/docs/guides/examples/aggregate_function_combinators/sumSimpleState.md index 35b8759ea35..a6a6d315f9c 100644 --- a/docs/guides/examples/aggregate_function_combinators/sumSimpleState.md +++ b/docs/guides/examples/aggregate_function_combinators/sumSimpleState.md @@ -4,6 +4,7 @@ title: 'sumSimpleState' description: 'Example of using the sumSimpleState combinator' keywords: ['sum', 'state', 'simple', 'combinator', 'examples', 'sumSimpleState'] sidebar_label: 'sumSimpleState' +doc_type: 'reference' --- # sumSimpleState {#sumsimplestate} diff --git a/docs/guides/examples/aggregate_function_combinators/uniqArray.md b/docs/guides/examples/aggregate_function_combinators/uniqArray.md index 07c651fb298..84f9aa59848 100644 --- a/docs/guides/examples/aggregate_function_combinators/uniqArray.md +++ b/docs/guides/examples/aggregate_function_combinators/uniqArray.md @@ -4,6 +4,7 @@ title: 'uniqArray' description: 'Example of using the uniqArray combinator' keywords: ['uniq', 'array', 'combinator', 'examples', 'uniqArray'] sidebar_label: 'uniqArray' +doc_type: 'reference' --- # uniqArray {#uniqarray} diff --git a/docs/guides/examples/aggregate_function_combinators/uniqArrayIf.md b/docs/guides/examples/aggregate_function_combinators/uniqArrayIf.md index 31470be7e31..38f07ce03f3 100644 --- a/docs/guides/examples/aggregate_function_combinators/uniqArrayIf.md +++ b/docs/guides/examples/aggregate_function_combinators/uniqArrayIf.md @@ -4,6 +4,7 @@ title: 'uniqArrayIf' description: 'Example of using the uniqArrayIf combinator' keywords: ['uniq', 'array', 'if', 'combinator', 'examples', 'uniqArrayIf'] sidebar_label: 'uniqArrayIf' +doc_type: 'reference' --- # uniqArrayIf {#uniqarrayif} diff --git a/docs/guides/inserting-data.md b/docs/guides/inserting-data.md index 360cc36e0cc..8c4ba0c08f4 100644 --- a/docs/guides/inserting-data.md +++ b/docs/guides/inserting-data.md @@ -5,6 +5,7 @@ keywords: ['INSERT', 'Batch Insert'] sidebar_label: 'Inserting ClickHouse data' slug: /guides/inserting-data show_related_blogs: true +doc_type: 'guide' --- import postgres_inserts from '@site/static/images/guides/postgres-inserts.png'; diff --git a/docs/guides/joining-tables.md b/docs/guides/joining-tables.md index 77ba8d118f6..2dff656e607 100644 --- a/docs/guides/joining-tables.md +++ b/docs/guides/joining-tables.md @@ -3,6 +3,7 @@ title: 'Using JOINs in ClickHouse' description: 'How to join tables in ClickHouse' keywords: ['joins', 'join tables'] slug: /guides/joining-tables +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/guides/manage-and-deploy-index.md b/docs/guides/manage-and-deploy-index.md index 388bfcaa4c1..1191a6a4092 100644 --- a/docs/guides/manage-and-deploy-index.md +++ b/docs/guides/manage-and-deploy-index.md @@ -2,6 +2,7 @@ title: 'Manage and Deploy Overview' description: 'Overview page for Manage and Deploy' slug: /guides/manage-and-deploy-index +doc_type: 'landing-page' --- # Manage and deploy diff --git a/docs/guides/separation-storage-compute.md b/docs/guides/separation-storage-compute.md index b404f55e7f1..b18cc806ff1 100644 --- a/docs/guides/separation-storage-compute.md +++ b/docs/guides/separation-storage-compute.md @@ -4,6 +4,7 @@ sidebar_label: 'Separation of Storage and Compute' slug: /guides/separation-storage-compute title: 'Separation of Storage and Compute' description: 'This guide explores how you can use ClickHouse and S3 to implement an architecture with separated storage and compute.' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/guides/sre/configuring-ssl.md b/docs/guides/sre/configuring-ssl.md index 5837b8f322b..16a8598d4da 100644 --- a/docs/guides/sre/configuring-ssl.md +++ b/docs/guides/sre/configuring-ssl.md @@ -4,6 +4,7 @@ sidebar_label: 'Configuring SSL-TLS' sidebar_position: 20 title: 'Configuring SSL-TLS' description: 'This guide provides simple and minimal settings to configure ClickHouse to use OpenSSL certificates to validate connections.' +doc_type: 'guide' --- import SelfManaged from '@site/docs/_snippets/_self_managed_only_automated.md'; diff --git a/docs/guides/sre/index.md b/docs/guides/sre/index.md index a19a1c49ea3..26ccc26789a 100644 --- a/docs/guides/sre/index.md +++ b/docs/guides/sre/index.md @@ -2,6 +2,7 @@ slug: /security-and-authentication title: 'Security and Authentication' description: 'Landing page for Security and Authentication' +doc_type: 'landing-page' --- | Page | Description | diff --git a/docs/guides/sre/keeper/index.md b/docs/guides/sre/keeper/index.md index 7f31356fbd8..39e18dc7baa 100644 --- a/docs/guides/sre/keeper/index.md +++ b/docs/guides/sre/keeper/index.md @@ -6,6 +6,7 @@ sidebar_position: 10 keywords: ['Keeper', 'ZooKeeper', 'clickhouse-keeper'] description: 'ClickHouse Keeper, or clickhouse-keeper, replaces ZooKeeper and provides replication and coordination.' title: 'ClickHouse Keeper' +doc_type: 'guide' --- # ClickHouse Keeper (clickhouse-keeper) diff --git a/docs/guides/sre/network-ports.md b/docs/guides/sre/network-ports.md index 7e28f510db3..209756547fc 100644 --- a/docs/guides/sre/network-ports.md +++ b/docs/guides/sre/network-ports.md @@ -3,6 +3,7 @@ slug: /guides/sre/network-ports sidebar_label: 'Network ports' title: 'Network ports' description: 'Description of available network ports and what they are used for' +doc_type: 'reference' --- # Network ports diff --git a/docs/guides/sre/scaling-clusters.md b/docs/guides/sre/scaling-clusters.md index b9a6bfecbcd..0bcf4a8283f 100644 --- a/docs/guides/sre/scaling-clusters.md +++ b/docs/guides/sre/scaling-clusters.md @@ -4,6 +4,7 @@ sidebar_label: 'Rebalancing Shards' sidebar_position: 20 description: 'ClickHouse does not support automatic shard rebalancing, so we provide some best practices for how to rebalance shards.' title: 'Rebalancing Data' +doc_type: 'guide' --- # Rebalancing data diff --git a/docs/guides/sre/user-management/configuring-ldap.md b/docs/guides/sre/user-management/configuring-ldap.md index 65837089d09..6f950f3c562 100644 --- a/docs/guides/sre/user-management/configuring-ldap.md +++ b/docs/guides/sre/user-management/configuring-ldap.md @@ -4,6 +4,7 @@ sidebar_position: 2 slug: /guides/sre/configuring-ldap title: 'Configuring ClickHouse to Use LDAP for Authentication and Role Mapping' description: 'Describes how to configure ClickHouse to use LDAP for authentication and role mapping' +doc_type: 'guide' --- import SelfManaged from '@site/docs/_snippets/_self_managed_only_no_roadmap.md'; diff --git a/docs/guides/sre/user-management/index.md b/docs/guides/sre/user-management/index.md index df945e7c0ae..69856c34c32 100644 --- a/docs/guides/sre/user-management/index.md +++ b/docs/guides/sre/user-management/index.md @@ -5,6 +5,7 @@ sidebar_label: 'Users and Roles' title: 'Access Control and Account Management' keywords: ['ClickHouse Cloud', 'Access Control', 'User Management', 'RBAC', 'Security'] description: 'Describes access control and account management in ClickHouse Cloud' +doc_type: 'guide' --- # Creating users and roles in ClickHouse diff --git a/docs/guides/sre/user-management/ssl-user-auth.md b/docs/guides/sre/user-management/ssl-user-auth.md index 501e8173347..387f8cc37fd 100644 --- a/docs/guides/sre/user-management/ssl-user-auth.md +++ b/docs/guides/sre/user-management/ssl-user-auth.md @@ -4,6 +4,7 @@ sidebar_position: 3 slug: /guides/sre/ssl-user-auth title: 'Configuring SSL User Certificate for Authentication' description: 'This guide provides simple and minimal settings to configure authentication with SSL user certificates.' +doc_type: 'guide' --- # Configuring SSL user certificate for authentication diff --git a/docs/guides/troubleshooting.md b/docs/guides/troubleshooting.md index 65cd5ddfeaa..77eaceb881a 100644 --- a/docs/guides/troubleshooting.md +++ b/docs/guides/troubleshooting.md @@ -2,6 +2,7 @@ title: 'Troubleshooting' description: 'Installation troubleshooting guide' slug: /guides/troubleshooting +doc_type: 'guide' --- ## Installation {#installation} diff --git a/docs/guides/writing-queries.md b/docs/guides/writing-queries.md index 0ca890be3a5..79a868c6ba7 100644 --- a/docs/guides/writing-queries.md +++ b/docs/guides/writing-queries.md @@ -6,6 +6,7 @@ slug: /guides/writing-queries description: 'Learn about Selecting ClickHouse Data' keywords: ['SELECT', 'data formats'] show_related_blogs: true +doc_type: 'guide' --- ClickHouse is a SQL database, and you query your data by writing the same type of `SELECT` queries you are already familiar with. For example: diff --git a/docs/integrations/data-ingestion/apache-spark/index.md b/docs/integrations/data-ingestion/apache-spark/index.md index 73e3726200a..7e46f668261 100644 --- a/docs/integrations/data-ingestion/apache-spark/index.md +++ b/docs/integrations/data-ingestion/apache-spark/index.md @@ -5,6 +5,7 @@ slug: /integrations/apache-spark description: 'Introduction to Apache Spark with ClickHouse' keywords: ['clickhouse', 'Apache Spark', 'migrating', 'data'] title: 'Integrating Apache Spark with ClickHouse' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/integrations/data-ingestion/apache-spark/spark-jdbc.md b/docs/integrations/data-ingestion/apache-spark/spark-jdbc.md index 68e0683b048..65e0738ff33 100644 --- a/docs/integrations/data-ingestion/apache-spark/spark-jdbc.md +++ b/docs/integrations/data-ingestion/apache-spark/spark-jdbc.md @@ -5,6 +5,7 @@ slug: /integrations/apache-spark/spark-jdbc description: 'Introduction to Apache Spark with ClickHouse' keywords: ['clickhouse', 'Apache Spark', 'jdbc', 'migrating', 'data'] title: 'Spark JDBC' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/integrations/data-ingestion/apache-spark/spark-native-connector.md b/docs/integrations/data-ingestion/apache-spark/spark-native-connector.md index b5506ee0ead..ab984cfd1a2 100644 --- a/docs/integrations/data-ingestion/apache-spark/spark-native-connector.md +++ b/docs/integrations/data-ingestion/apache-spark/spark-native-connector.md @@ -5,6 +5,7 @@ slug: /integrations/apache-spark/spark-native-connector description: 'Introduction to Apache Spark with ClickHouse' keywords: ['clickhouse', 'Apache Spark', 'migrating', 'data'] title: 'Spark Connector' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/integrations/data-ingestion/aws-glue/index.md b/docs/integrations/data-ingestion/aws-glue/index.md index cdd12c384b0..5ca02c890c8 100644 --- a/docs/integrations/data-ingestion/aws-glue/index.md +++ b/docs/integrations/data-ingestion/aws-glue/index.md @@ -5,6 +5,7 @@ slug: /integrations/glue description: 'Integrate ClickHouse and Amazon Glue' keywords: ['clickhouse', 'amazon', 'aws', 'glue', 'migrating', 'data', 'spark'] title: 'Integrating Amazon Glue with ClickHouse and Spark' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/azure-data-factory/index.md b/docs/integrations/data-ingestion/azure-data-factory/index.md index 40787c3adad..cb5e01ec5dd 100644 --- a/docs/integrations/data-ingestion/azure-data-factory/index.md +++ b/docs/integrations/data-ingestion/azure-data-factory/index.md @@ -3,6 +3,7 @@ slug: /integrations/azure-data-factory description: 'Bringing Azure Data into ClickHouse' keywords: ['azure data factory', 'azure', 'microsoft', 'data'] title: 'Bringing Azure Data into ClickHouse' +doc_type: 'guide' --- | Page | Description | diff --git a/docs/integrations/data-ingestion/azure-data-factory/overview.md b/docs/integrations/data-ingestion/azure-data-factory/overview.md index b2de22d0af0..cba2200b2f7 100644 --- a/docs/integrations/data-ingestion/azure-data-factory/overview.md +++ b/docs/integrations/data-ingestion/azure-data-factory/overview.md @@ -4,6 +4,7 @@ slug: /integrations/azure-data-factory/overview description: 'Bringing Azure Data into ClickHouse - Overview' keywords: ['azure data factory', 'azure', 'microsoft', 'data'] title: 'Bringing Azure Data into ClickHouse' +doc_type: 'guide' --- # Bringing Azure Data into ClickHouse diff --git a/docs/integrations/data-ingestion/azure-data-factory/using_azureblobstorage.md b/docs/integrations/data-ingestion/azure-data-factory/using_azureblobstorage.md index 910b145215a..2e76d3d9c6e 100644 --- a/docs/integrations/data-ingestion/azure-data-factory/using_azureblobstorage.md +++ b/docs/integrations/data-ingestion/azure-data-factory/using_azureblobstorage.md @@ -4,6 +4,7 @@ slug: /integrations/azure-data-factory/table-function description: 'Using ClickHouse''s azureBlobStorage table function' keywords: ['azure data factory', 'azure', 'microsoft', 'data', 'azureBlobStorage'] title: 'Using ClickHouse''s azureBlobStorage table function to bring Azure data into ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/azure-data-factory/using_http_interface.md b/docs/integrations/data-ingestion/azure-data-factory/using_http_interface.md index 7128678a2f6..a64060de294 100644 --- a/docs/integrations/data-ingestion/azure-data-factory/using_http_interface.md +++ b/docs/integrations/data-ingestion/azure-data-factory/using_http_interface.md @@ -4,6 +4,7 @@ slug: /integrations/azure-data-factory/http-interface description: 'Using ClickHouse''s HTTP interface to bring data from Azure Data Factory into ClickHouse' keywords: ['azure data factory', 'azure', 'microsoft', 'data', 'http interface'] title: 'Using ClickHouse HTTP Interface to bring Azure data into ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/azure-synapse/index.md b/docs/integrations/data-ingestion/azure-synapse/index.md index d962dff19a2..a92b98dcaa5 100644 --- a/docs/integrations/data-ingestion/azure-synapse/index.md +++ b/docs/integrations/data-ingestion/azure-synapse/index.md @@ -4,6 +4,7 @@ slug: /integrations/azure-synapse description: 'Introduction to Azure Synapse with ClickHouse' keywords: ['clickhouse', 'azure synapse', 'azure', 'synapse', 'microsoft', 'azure spark', 'data'] title: 'Integrating Azure Synapse with ClickHouse' +doc_type: 'guide' --- import TOCInline from '@theme/TOCInline'; diff --git a/docs/integrations/data-ingestion/clickpipes/aws-privatelink.md b/docs/integrations/data-ingestion/clickpipes/aws-privatelink.md index 11b92b4268d..9afce369b7a 100644 --- a/docs/integrations/data-ingestion/clickpipes/aws-privatelink.md +++ b/docs/integrations/data-ingestion/clickpipes/aws-privatelink.md @@ -3,6 +3,7 @@ sidebar_label: 'AWS PrivateLink for ClickPipes' description: 'Establish a secure connection between ClickPipes and a data source using AWS PrivateLink.' slug: /integrations/clickpipes/aws-privatelink title: 'AWS PrivateLink for ClickPipes' +doc_type: 'guide' --- import cp_service from '@site/static/images/integrations/data-ingestion/clickpipes/cp_service.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/index.md b/docs/integrations/data-ingestion/clickpipes/index.md index ee9e0e91c2d..50be61c2902 100644 --- a/docs/integrations/data-ingestion/clickpipes/index.md +++ b/docs/integrations/data-ingestion/clickpipes/index.md @@ -3,6 +3,7 @@ sidebar_label: 'Introduction' description: 'Seamlessly connect your external data sources to ClickHouse Cloud.' slug: /integrations/clickpipes title: 'Integrating with ClickHouse Cloud' +doc_type: 'guide' --- import Kafkasvg from '@site/static/images/integrations/logos/kafka.svg'; diff --git a/docs/integrations/data-ingestion/clickpipes/kafka/01_create-kafka-clickpipe.md b/docs/integrations/data-ingestion/clickpipes/kafka/01_create-kafka-clickpipe.md index 2a6f6ac4bca..0472fd0867d 100644 --- a/docs/integrations/data-ingestion/clickpipes/kafka/01_create-kafka-clickpipe.md +++ b/docs/integrations/data-ingestion/clickpipes/kafka/01_create-kafka-clickpipe.md @@ -4,6 +4,7 @@ description: 'Step-by-step guide to creating your first Kafka ClickPipe.' slug: /integrations/clickpipes/kafka/create-your-first-kafka-clickpipe sidebar_position: 1 title: 'Creating your first Kafka ClickPipe' +doc_type: 'guide' --- import cp_step0 from '@site/static/images/integrations/data-ingestion/clickpipes/cp_step0.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/kafka/02_schema-registries.md b/docs/integrations/data-ingestion/clickpipes/kafka/02_schema-registries.md index 7a1dd4fa075..1697e89dc5c 100644 --- a/docs/integrations/data-ingestion/clickpipes/kafka/02_schema-registries.md +++ b/docs/integrations/data-ingestion/clickpipes/kafka/02_schema-registries.md @@ -4,6 +4,7 @@ description: 'How to integrate for ClickPipes with a schema registry for schema slug: /integrations/clickpipes/kafka/schema-registries sidebar_position: 1 title: 'Schema registries for Kafka ClickPipe' +doc_type: 'guide' --- # Schema registries {#schema-registries} diff --git a/docs/integrations/data-ingestion/clickpipes/kafka/03_reference.md b/docs/integrations/data-ingestion/clickpipes/kafka/03_reference.md index fcf1220f55e..73090fd61fc 100644 --- a/docs/integrations/data-ingestion/clickpipes/kafka/03_reference.md +++ b/docs/integrations/data-ingestion/clickpipes/kafka/03_reference.md @@ -4,6 +4,7 @@ description: 'Details supported formats, sources, delivery semantics, authentica slug: /integrations/clickpipes/kafka/reference sidebar_position: 1 title: 'Reference' +doc_type: 'reference' --- import Kafkasvg from '@site/static/images/integrations/logos/kafka.svg'; diff --git a/docs/integrations/data-ingestion/clickpipes/kafka/04_best_practices.md b/docs/integrations/data-ingestion/clickpipes/kafka/04_best_practices.md index 9172015d632..9e78a838c9d 100644 --- a/docs/integrations/data-ingestion/clickpipes/kafka/04_best_practices.md +++ b/docs/integrations/data-ingestion/clickpipes/kafka/04_best_practices.md @@ -4,6 +4,7 @@ description: 'Details best practices to follow when working with Kafka ClickPipe slug: /integrations/clickpipes/kafka/best-practices sidebar_position: 1 title: 'Best practices' +doc_type: 'guide' --- # Best practices {#best-practices} diff --git a/docs/integrations/data-ingestion/clickpipes/kafka/05_faq.md b/docs/integrations/data-ingestion/clickpipes/kafka/05_faq.md index 2efda87b5b5..890dc76cbae 100644 --- a/docs/integrations/data-ingestion/clickpipes/kafka/05_faq.md +++ b/docs/integrations/data-ingestion/clickpipes/kafka/05_faq.md @@ -4,6 +4,7 @@ description: 'Frequently asked questions about ClickPipes for Kafka' slug: /integrations/clickpipes/kafka/faq sidebar_position: 1 title: 'Kafka ClickPipes FAQ' +doc_type: 'guide' --- ## Kafka ClickPipes FAQ {#faq} diff --git a/docs/integrations/data-ingestion/clickpipes/kafka/index.md b/docs/integrations/data-ingestion/clickpipes/kafka/index.md index e8b4e027cc2..798e170e550 100644 --- a/docs/integrations/data-ingestion/clickpipes/kafka/index.md +++ b/docs/integrations/data-ingestion/clickpipes/kafka/index.md @@ -3,6 +3,7 @@ description: 'Landing page with table of contents for the Kafka ClickPipes secti slug: /integrations/clickpipes/kafka sidebar_position: 1 title: 'Kafka ClickPipes' +doc_type: 'landing-page' --- diff --git a/docs/integrations/data-ingestion/clickpipes/kinesis.md b/docs/integrations/data-ingestion/clickpipes/kinesis.md index 9a6532b3d5d..64615f36fbf 100644 --- a/docs/integrations/data-ingestion/clickpipes/kinesis.md +++ b/docs/integrations/data-ingestion/clickpipes/kinesis.md @@ -3,6 +3,7 @@ sidebar_label: 'ClickPipes for Amazon Kinesis' description: 'Seamlessly connect your Amazon Kinesis data sources to ClickHouse Cloud.' slug: /integrations/clickpipes/kinesis title: 'Integrating Amazon Kinesis with ClickHouse Cloud' +doc_type: 'guide' --- import cp_service from '@site/static/images/integrations/data-ingestion/clickpipes/cp_service.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/add_table.md b/docs/integrations/data-ingestion/clickpipes/mongodb/add_table.md index 1de664c7ed8..1e46a40c9bc 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/add_table.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/add_table.md @@ -4,6 +4,7 @@ description: 'Describes the steps needed to add specific tables to a ClickPipe.' sidebar_label: 'Add Table' slug: /integrations/clickpipes/mongodb/add_table show_title: false +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/controlling_sync.md b/docs/integrations/data-ingestion/clickpipes/mongodb/controlling_sync.md index 86cca874390..fa2a6967f7e 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/controlling_sync.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/controlling_sync.md @@ -3,6 +3,7 @@ title: 'Controlling the Syncing of a MongoDB ClickPipe' description: 'Doc for controllling the sync a MongoDB ClickPipe' slug: /integrations/clickpipes/mongodb/sync_control sidebar_label: 'Controlling syncs' +doc_type: 'guide' --- import edit_sync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/edit_sync_button.png' diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/datatypes.md b/docs/integrations/data-ingestion/clickpipes/mongodb/datatypes.md index b487a34a52a..bf09a8f4f17 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/datatypes.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/datatypes.md @@ -2,6 +2,7 @@ title: 'Supported data types' slug: /integrations/clickpipes/mongodb/datatypes description: 'Page describing MongoDB ClickPipe datatype mapping from MongoDB to ClickHouse' +doc_type: 'reference' --- MongoDB stores data records as BSON documents. In ClickPipes, you can configure to ingest BSON documents to ClickHouse as either JSON or JSON String. The following table shows the supported BSON to JSON field type mapping: diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/index.md b/docs/integrations/data-ingestion/clickpipes/mongodb/index.md index 84e04e1b413..7c27e63d61d 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/index.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/index.md @@ -3,6 +3,7 @@ sidebar_label: 'Ingesting Data from MongoDB to ClickHouse' description: 'Describes how to seamlessly connect your MongoDB to ClickHouse Cloud.' slug: /integrations/clickpipes/mongodb title: 'Ingesting data from MongoDB to ClickHouse (using CDC)' +doc_type: 'guide' --- import BetaBadge from '@theme/badges/BetaBadge'; diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/lifecycle.md b/docs/integrations/data-ingestion/clickpipes/mongodb/lifecycle.md index 0241ae6722a..17fcdf1c906 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/lifecycle.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/lifecycle.md @@ -3,6 +3,7 @@ sidebar_label: 'Lifecycle of a MongoDB ClickPipe' description: 'Various pipe statuses and their meanings' slug: /integrations/clickpipes/mongodb/lifecycle title: 'Lifecycle of a MongoDB ClickPipe' +doc_type: 'guide' --- # Lifecycle of a MongoDB ClickPipe {#lifecycle} diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/pause_and_resume.md b/docs/integrations/data-ingestion/clickpipes/mongodb/pause_and_resume.md index 56383e8bf63..a4696440a41 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/pause_and_resume.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/pause_and_resume.md @@ -3,6 +3,7 @@ title: 'Pausing and Resuming a MongoDB ClickPipe' description: 'Pausing and Resuming a MongoDB ClickPipe' sidebar_label: 'Pause Table' slug: /integrations/clickpipes/mongodb/pause_and_resume +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/quickstart.md b/docs/integrations/data-ingestion/clickpipes/mongodb/quickstart.md index 00c87f17c31..16ff53a80f7 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/quickstart.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/quickstart.md @@ -3,6 +3,7 @@ title: 'Working with JSON in ClickHouse' sidebar_label: 'Working with JSON' slug: /integrations/clickpipes/mongodb/quickstart description: 'Common patterns for working with JSON data replicated from MongoDB to ClickHouse via ClickPipes' +doc_type: 'guide' --- # Working with JSON in ClickHouse diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/remove_table.md b/docs/integrations/data-ingestion/clickpipes/mongodb/remove_table.md index b3f0fda176c..eca2e1e7647 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/remove_table.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/remove_table.md @@ -3,6 +3,7 @@ title: 'Removing specific tables from a ClickPipe' description: 'Removing specific tables from a ClickPipe' sidebar_label: 'Remove Table' slug: /integrations/clickpipes/mongodb/removing_tables +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/resync.md b/docs/integrations/data-ingestion/clickpipes/mongodb/resync.md index 351a06540e5..6e346ed5378 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/resync.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/resync.md @@ -3,6 +3,7 @@ title: 'Resyncing a Database ClickPipe' description: 'Doc for resyncing a database ClickPipe' slug: /integrations/clickpipes/mongodb/resync sidebar_label: 'Resync ClickPipe' +doc_type: 'guide' --- import resync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/resync_button.png' diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/source/atlas.md b/docs/integrations/data-ingestion/clickpipes/mongodb/source/atlas.md index a2d1754a642..25c831322ed 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/source/atlas.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/source/atlas.md @@ -3,6 +3,7 @@ sidebar_label: 'MongoDB Atlas' description: 'Step-by-step guide on how to set up MongoDB Atlas as a source for ClickPipes' slug: /integrations/clickpipes/mongodb/source/atlas title: 'MongoDB Atlas source setup guide' +doc_type: 'guide' --- import mongo_atlas_configuration from '@site/static/images/integrations/data-ingestion/clickpipes/mongodb/mongo-atlas-cluster-overview-configuration.png' diff --git a/docs/integrations/data-ingestion/clickpipes/mongodb/source/generic.md b/docs/integrations/data-ingestion/clickpipes/mongodb/source/generic.md index a3dcaf660c4..fdcae906f83 100644 --- a/docs/integrations/data-ingestion/clickpipes/mongodb/source/generic.md +++ b/docs/integrations/data-ingestion/clickpipes/mongodb/source/generic.md @@ -3,6 +3,7 @@ sidebar_label: 'Generic MongoDB' description: 'Set up any MongoDB instance as a source for ClickPipes' slug: /integrations/clickpipes/mongodb/source/generic title: 'Generic MongoDB source setup guide' +doc_type: 'guide' --- # Generic MongoDB source setup guide diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/add_table.md b/docs/integrations/data-ingestion/clickpipes/mysql/add_table.md index 4074755b0b4..d857f42671b 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/add_table.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/add_table.md @@ -4,6 +4,7 @@ description: 'Describes the steps need to add specific tables to a ClickPipe.' sidebar_label: 'Add Table' slug: /integrations/clickpipes/mysql/add_table show_title: false +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/controlling_sync.md b/docs/integrations/data-ingestion/clickpipes/mysql/controlling_sync.md index b42feefab0f..887a8af43a7 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/controlling_sync.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/controlling_sync.md @@ -3,6 +3,7 @@ title: 'Controlling the Syncing of a MySQL ClickPipe' description: 'Doc for controllling the sync a MySQL ClickPipe' slug: /integrations/clickpipes/mysql/sync_control sidebar_label: 'Controlling syncs' +doc_type: 'guide' --- import edit_sync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/edit_sync_button.png' diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/datatypes.md b/docs/integrations/data-ingestion/clickpipes/mysql/datatypes.md index 3f1181cb55c..e4245fcd664 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/datatypes.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/datatypes.md @@ -2,6 +2,7 @@ title: 'Supported data types' slug: /integrations/clickpipes/mysql/datatypes description: 'Page describing MySQL ClickPipe datatype mapping from MySQL to ClickHouse' +doc_type: 'reference' --- Here is the supported data-type mapping for the MySQL ClickPipe: diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/faq.md b/docs/integrations/data-ingestion/clickpipes/mysql/faq.md index 0c59ab16a80..8a8e71d1596 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/faq.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/faq.md @@ -4,6 +4,7 @@ description: 'Frequently asked questions about ClickPipes for MySQL.' slug: /integrations/clickpipes/mysql/faq sidebar_position: 2 title: 'ClickPipes for MySQL FAQ' +doc_type: 'reference' --- # ClickPipes for MySQL FAQ diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/index.md b/docs/integrations/data-ingestion/clickpipes/mysql/index.md index 001983d636f..62ca71ddc64 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/index.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/index.md @@ -3,6 +3,7 @@ sidebar_label: 'Ingesting Data from MySQL to ClickHouse' description: 'Describes how to seamlessly connect your MySQL to ClickHouse Cloud.' slug: /integrations/clickpipes/mysql title: 'Ingesting data from MySQL to ClickHouse (using CDC)' +doc_type: 'guide' --- import BetaBadge from '@theme/badges/BetaBadge'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/lifecycle.md b/docs/integrations/data-ingestion/clickpipes/mysql/lifecycle.md index 7ecc74be422..ed717650d7e 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/lifecycle.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/lifecycle.md @@ -3,6 +3,7 @@ sidebar_label: 'Lifecycle of a MySQL ClickPipe' description: 'Various pipe statuses and their meanings' slug: /integrations/clickpipes/mysql/lifecycle title: 'Lifecycle of a MySQL ClickPipe' +doc_type: 'guide' --- # Lifecycle of a MySQL ClickPipe {#lifecycle} diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/parallel_initial_load.md b/docs/integrations/data-ingestion/clickpipes/mysql/parallel_initial_load.md index bf93de349ef..42beaddf31c 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/parallel_initial_load.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/parallel_initial_load.md @@ -3,6 +3,7 @@ title: 'Parallel Snapshot In The MySQL ClickPipe' description: 'Doc for explaining parallel snapshot in the MySQL ClickPipe' slug: /integrations/clickpipes/mysql/parallel_initial_load sidebar_label: 'How parallel snapshot works' +doc_type: 'guide' --- import snapshot_params from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/snapshot_params.png' diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/pause_and_resume.md b/docs/integrations/data-ingestion/clickpipes/mysql/pause_and_resume.md index 88daec6e532..71a858a8c72 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/pause_and_resume.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/pause_and_resume.md @@ -3,6 +3,7 @@ title: 'Pausing and Resuming a MySQL ClickPipe' description: 'Pausing and Resuming a MySQL ClickPipe' sidebar_label: 'Pause Table' slug: /integrations/clickpipes/mysql/pause_and_resume +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/remove_table.md b/docs/integrations/data-ingestion/clickpipes/mysql/remove_table.md index 58fbc56dc9d..5a25cb2c013 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/remove_table.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/remove_table.md @@ -3,6 +3,7 @@ title: 'Removing specific tables from a ClickPipe' description: 'Removing specific tables from a ClickPipe' sidebar_label: 'Remove Table' slug: /integrations/clickpipes/mysql/removing_tables +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/resync.md b/docs/integrations/data-ingestion/clickpipes/mysql/resync.md index 37a65a4249a..41e19f5d2fc 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/resync.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/resync.md @@ -3,6 +3,7 @@ title: 'Resyncing a Database ClickPipe' description: 'Doc for resyncing a database ClickPipe' slug: /integrations/clickpipes/mysql/resync sidebar_label: 'Resync ClickPipe' +doc_type: 'guide' --- import resync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/resync_button.png' diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/schema-changes.md b/docs/integrations/data-ingestion/clickpipes/mysql/schema-changes.md index d2c8e37d0df..ec6979aeee5 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/schema-changes.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/schema-changes.md @@ -2,6 +2,7 @@ title: 'Schema Changes Propagation Support' slug: /integrations/clickpipes/mysql/schema-changes description: 'Page describing schema change types detectable by ClickPipes in the source tables' +doc_type: 'reference' --- ClickPipes for MySQL can detect schema changes in the source tables and, in some cases, automatically propagate the changes to the destination tables. The way each DDL operation is handled is documented below: diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/source/aurora.md b/docs/integrations/data-ingestion/clickpipes/mysql/source/aurora.md index ec11c9bff48..9bed84338c7 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/source/aurora.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/source/aurora.md @@ -3,6 +3,7 @@ sidebar_label: 'Amazon Aurora MySQL' description: 'Step-by-step guide on how to set up Amazon Aurora MySQL as a source for ClickPipes' slug: /integrations/clickpipes/mysql/source/aurora title: 'Aurora MySQL source setup guide' +doc_type: 'guide' --- import rds_backups from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/source/rds/rds-backups.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/source/gcp.md b/docs/integrations/data-ingestion/clickpipes/mysql/source/gcp.md index 3a87882f74c..c93cd2b08a7 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/source/gcp.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/source/gcp.md @@ -3,6 +3,7 @@ sidebar_label: 'Cloud SQL For MySQL ' description: 'Step-by-step guide on how to set up Cloud SQL for MySQL as a source for ClickPipes' slug: /integrations/clickpipes/mysql/source/gcp title: 'Cloud SQL for MySQL source setup guide' +doc_type: 'guide' --- import gcp_pitr from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/source/gcp/gcp-mysql-pitr.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/source/generic.md b/docs/integrations/data-ingestion/clickpipes/mysql/source/generic.md index 438cda38455..a41d6c17521 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/source/generic.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/source/generic.md @@ -3,6 +3,7 @@ sidebar_label: 'Generic MySQL' description: 'Set up any MySQL instance as a source for ClickPipes' slug: /integrations/clickpipes/mysql/source/generic title: 'Generic MySQL source setup guide' +doc_type: 'guide' --- # Generic MySQL source setup guide diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/source/generic_maria.md b/docs/integrations/data-ingestion/clickpipes/mysql/source/generic_maria.md index 7099425aae4..dbc58e79f29 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/source/generic_maria.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/source/generic_maria.md @@ -3,6 +3,7 @@ sidebar_label: 'Generic MariaDB' description: 'Set up any MariaDB instance as a source for ClickPipes' slug: /integrations/clickpipes/mysql/source/generic_maria title: 'Generic MariaDB source setup guide' +doc_type: 'guide' --- # Generic MariaDB source setup guide diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/source/rds.md b/docs/integrations/data-ingestion/clickpipes/mysql/source/rds.md index b2a84c21bb9..8e6da3bebb7 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/source/rds.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/source/rds.md @@ -3,6 +3,7 @@ sidebar_label: 'Amazon RDS MySQL' description: 'Step-by-step guide on how to set up Amazon RDS MySQL as a source for ClickPipes' slug: /integrations/clickpipes/mysql/source/rds title: 'RDS MySQL source setup guide' +doc_type: 'guide' --- import rds_backups from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/source/rds/rds-backups.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/mysql/source/rds_maria.md b/docs/integrations/data-ingestion/clickpipes/mysql/source/rds_maria.md index 81341917ea1..c88b0b9c373 100644 --- a/docs/integrations/data-ingestion/clickpipes/mysql/source/rds_maria.md +++ b/docs/integrations/data-ingestion/clickpipes/mysql/source/rds_maria.md @@ -3,6 +3,7 @@ sidebar_label: 'Amazon RDS MariaDB' description: 'Step-by-step guide on how to set up Amazon RDS MariaDB as a source for ClickPipes' slug: /integrations/clickpipes/mysql/source/rds_maria title: 'RDS MariaDB source setup guide' +doc_type: 'guide' --- import rds_backups from '@site/static/images/integrations/data-ingestion/clickpipes/mysql/source/rds/rds-backups.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/object-storage.md b/docs/integrations/data-ingestion/clickpipes/object-storage.md index f443031759d..2d42d918f36 100644 --- a/docs/integrations/data-ingestion/clickpipes/object-storage.md +++ b/docs/integrations/data-ingestion/clickpipes/object-storage.md @@ -3,6 +3,7 @@ sidebar_label: 'ClickPipes for Object Storage' description: 'Seamlessly connect your object storage to ClickHouse Cloud.' slug: /integrations/clickpipes/object-storage title: 'Integrating Object Storage with ClickHouse Cloud' +doc_type: 'guide' --- import S3svg from '@site/static/images/integrations/logos/amazon_s3_logo.svg'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/add_table.md b/docs/integrations/data-ingestion/clickpipes/postgres/add_table.md index 9de4ca503ce..5f529f62e29 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/add_table.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/add_table.md @@ -4,6 +4,7 @@ description: 'Describes the steps need to add specific tables to a ClickPipe.' sidebar_label: 'Add Table' slug: /integrations/clickpipes/postgres/add_table show_title: false +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/controlling_sync.md b/docs/integrations/data-ingestion/clickpipes/postgres/controlling_sync.md index dca3b2a7e83..28cf0be2ed0 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/controlling_sync.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/controlling_sync.md @@ -3,6 +3,7 @@ title: 'Controlling the Syncing of a Postgres ClickPipe' description: 'Doc for controlling the sync a Postgres ClickPipe' slug: /integrations/clickpipes/postgres/sync_control sidebar_label: 'Controlling syncs' +doc_type: 'guide' --- import edit_sync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/edit_sync_button.png' diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/deduplication.md b/docs/integrations/data-ingestion/clickpipes/postgres/deduplication.md index a46c74122fa..0fbcda76070 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/deduplication.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/deduplication.md @@ -3,6 +3,7 @@ sidebar_label: 'Deduplication Strategies' description: 'Handle duplicates and deleted rows.' slug: /integrations/clickpipes/postgres/deduplication title: 'Deduplication strategies (using CDC)' +doc_type: 'guide' --- import clickpipes_initial_load from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/postgres-cdc-initial-load.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/faq.md b/docs/integrations/data-ingestion/clickpipes/postgres/faq.md index 27bdf551db4..9e21a0b6210 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/faq.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/faq.md @@ -4,6 +4,7 @@ description: 'Frequently asked questions about ClickPipes for Postgres.' slug: /integrations/clickpipes/postgres/faq sidebar_position: 2 title: 'ClickPipes for Postgres FAQ' +doc_type: 'reference' --- # ClickPipes for Postgres FAQ diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/index.md b/docs/integrations/data-ingestion/clickpipes/postgres/index.md index 754e0f6096d..8c4af9ed75b 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/index.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/index.md @@ -3,6 +3,7 @@ sidebar_label: 'Ingesting Data from Postgres to ClickHouse' description: 'Seamlessly connect your Postgres to ClickHouse Cloud.' slug: /integrations/clickpipes/postgres title: 'Ingesting Data from Postgres to ClickHouse (using CDC)' +doc_type: 'guide' --- import BetaBadge from '@theme/badges/BetaBadge'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/lifecycle.md b/docs/integrations/data-ingestion/clickpipes/postgres/lifecycle.md index 3e7f30120b9..7f6a3e9cec2 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/lifecycle.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/lifecycle.md @@ -3,6 +3,7 @@ sidebar_label: 'Lifecycle of a Postgres ClickPipe' description: 'Various pipe statuses and their meanings' slug: /integrations/clickpipes/postgres/lifecycle title: 'Lifecycle of a Postgres ClickPipe' +doc_type: 'guide' --- # Lifecycle of a Postgres ClickPipe {#lifecycle} diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/maintenance.md b/docs/integrations/data-ingestion/clickpipes/postgres/maintenance.md index 2e0e0bc9393..4220d63f7e8 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/maintenance.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/maintenance.md @@ -3,6 +3,7 @@ sidebar_label: 'Maintenance Windows' description: 'Maintenance windows for ClickPipes for Postgres.' slug: /integrations/clickpipes/postgres/maintenance title: 'Maintenance windows for ClickPipes for Postgres' +doc_type: 'reference' --- # Maintenance windows for ClickPipes for Postgres diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/ordering_keys.md b/docs/integrations/data-ingestion/clickpipes/postgres/ordering_keys.md index 91337e28051..f2c011a6eb6 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/ordering_keys.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/ordering_keys.md @@ -3,6 +3,7 @@ sidebar_label: 'Ordering keys' description: 'How to define custom ordering keys.' slug: /integrations/clickpipes/postgres/ordering_keys title: 'Ordering Keys' +doc_type: 'guide' --- Ordering Keys (a.k.a. sorting keys) define how data is sorted on disk and indexed for a table in ClickHouse. When replicating from Postgres, ClickPipes sets the Postgres primary key of a table as the ordering key for the corresponding table in ClickHouse. In most cases, the Postgres primary key serves as a sufficient ordering key, as ClickHouse is already optimized for fast scans, and custom ordering keys are often not required. diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/parallel_initial_load.md b/docs/integrations/data-ingestion/clickpipes/postgres/parallel_initial_load.md index 1314213f81c..07c3db2e0df 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/parallel_initial_load.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/parallel_initial_load.md @@ -3,6 +3,7 @@ title: 'Parallel Snapshot In The Postgres ClickPipe' description: 'Doc for explaining parallel snapshot in the Postgres ClickPipe' slug: /integrations/clickpipes/postgres/parallel_initial_load sidebar_label: 'How parallel snapshot works' +doc_type: 'guide' --- import snapshot_params from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/snapshot_params.png' diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/pause_and_resume.md b/docs/integrations/data-ingestion/clickpipes/postgres/pause_and_resume.md index a5ac35d00d1..35d756ac22d 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/pause_and_resume.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/pause_and_resume.md @@ -3,6 +3,7 @@ title: 'Pausing and Resuming a Postgres ClickPipe' description: 'Pausing and Resuming a Postgres ClickPipe' sidebar_label: 'Pause Table' slug: /integrations/clickpipes/postgres/pause_and_resume +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/postgres_generated_columns.md b/docs/integrations/data-ingestion/clickpipes/postgres/postgres_generated_columns.md index 34887d5cff9..304f720b680 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/postgres_generated_columns.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/postgres_generated_columns.md @@ -2,6 +2,7 @@ title: 'Postgres Generated Columns: Gotchas and Best Practices' slug: /integrations/clickpipes/postgres/generated_columns description: 'Page describing important considerations to keep in mind when using PostgreSQL generated columns in tables that are being replicated' +doc_type: 'guide' --- When using PostgreSQL's generated columns in tables that are being replicated, there are some important considerations to keep in mind. These gotchas can affect the replication process and data consistency in your destination systems. diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/remove_table.md b/docs/integrations/data-ingestion/clickpipes/postgres/remove_table.md index ea21858d47d..e63c0129739 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/remove_table.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/remove_table.md @@ -3,6 +3,7 @@ title: 'Removing specific tables from a ClickPipe' description: 'Removing specific tables from a ClickPipe' sidebar_label: 'Remove Table' slug: /integrations/clickpipes/postgres/removing_tables +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/resync.md b/docs/integrations/data-ingestion/clickpipes/postgres/resync.md index fe3d558a9b8..467cdd1a90c 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/resync.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/resync.md @@ -3,6 +3,7 @@ title: 'Resyncing a Database ClickPipe' description: 'Doc for resyncing a database ClickPipe' slug: /integrations/clickpipes/postgres/resync sidebar_label: 'Resync ClickPipe' +doc_type: 'guide' --- import resync_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/resync_button.png' diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/scaling.md b/docs/integrations/data-ingestion/clickpipes/postgres/scaling.md index 2d5e3019dc4..e49cd1bdc1a 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/scaling.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/scaling.md @@ -3,6 +3,7 @@ title: 'Scaling DB ClickPipes via OpenAPI' description: 'Doc for scaling DB ClickPipes via OpenAPI' slug: /integrations/clickpipes/postgres/scaling sidebar_label: 'Scaling' +doc_type: 'guide' --- :::caution Most users won't need this API diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/schema-changes.md b/docs/integrations/data-ingestion/clickpipes/postgres/schema-changes.md index 96903ac3e45..385989337a4 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/schema-changes.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/schema-changes.md @@ -2,6 +2,7 @@ title: 'Schema Changes Propagation Support' slug: /integrations/clickpipes/postgres/schema-changes description: 'Page describing schema change types detectable by ClickPipes in the source tables' +doc_type: 'reference' --- ClickPipes for Postgres can detect schema changes in the source tables and, in some cases, automatically propagate the changes to the destination tables. The way each DDL operation is handled is documented below: diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/aurora.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/aurora.md index 2101871b31c..a1239c5f25c 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/aurora.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/aurora.md @@ -3,6 +3,7 @@ sidebar_label: 'Amazon Aurora Postgres' description: 'Set up Amazon Aurora Postgres as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/aurora title: 'Aurora Postgres Source Setup Guide' +doc_type: 'guide' --- import parameter_group_in_blade from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/rds/parameter_group_in_blade.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/azure-flexible-server-postgres.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/azure-flexible-server-postgres.md index 0704d7ed828..d31d1918cd2 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/azure-flexible-server-postgres.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/azure-flexible-server-postgres.md @@ -3,6 +3,7 @@ sidebar_label: 'Azure Flexible Server for Postgres' description: 'Set up Azure Flexible Server for Postgres as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/azure-flexible-server-postgres title: 'Azure Flexible Server for Postgres Source Setup Guide' +doc_type: 'guide' --- import server_parameters from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/azure-flexible-server-postgres/server_parameters.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/crunchy-postgres.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/crunchy-postgres.md index aa5cbf6e155..f6257840826 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/crunchy-postgres.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/crunchy-postgres.md @@ -3,6 +3,7 @@ sidebar_label: 'Crunchy Bridge Postgres' description: 'Set up Crunchy Bridge Postgres as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/crunchy-postgres title: 'Crunchy Bridge Postgres Source Setup Guide' +doc_type: 'guide' --- import firewall_rules_crunchy_bridge from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/setup/crunchy-postgres/firewall_rules_crunchy_bridge.png' diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/generic.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/generic.md index 3cc69865841..012be5b41ed 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/generic.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/generic.md @@ -3,6 +3,7 @@ sidebar_label: 'Generic Postgres' description: 'Set up any Postgres instance as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/generic title: 'Generic Postgres Source Setup Guide' +doc_type: 'guide' --- # Generic Postgres source setup guide diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/google-cloudsql.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/google-cloudsql.md index bc535d6e9d1..b6b2f24e236 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/google-cloudsql.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/google-cloudsql.md @@ -3,6 +3,7 @@ sidebar_label: 'Google Cloud SQL' description: 'Set up Google Cloud SQL Postgres instance as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/google-cloudsql title: 'Google Cloud SQL Postgres Source Setup Guide' +doc_type: 'guide' --- import edit_button from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/google-cloudsql/edit.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/neon-postgres.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/neon-postgres.md index 8d332071e7f..e53919c06c0 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/neon-postgres.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/neon-postgres.md @@ -3,6 +3,7 @@ sidebar_label: 'Neon Postgres' description: 'Set up Neon Postgres instance as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/neon-postgres title: 'Neon Postgres Source Setup Guide' +doc_type: 'guide' --- import neon_commands from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/setup/neon-postgres/neon-commands.png' diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/planetscale.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/planetscale.md index ad71ea71b63..4bd4ffa4503 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/planetscale.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/planetscale.md @@ -3,6 +3,7 @@ sidebar_label: 'Planetscale for Postgres' description: 'Set up Planetscale for Postgres as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/planetscale title: 'PlanetScale for Postgres Source Setup Guide' +doc_type: 'guide' --- import planetscale_wal_level_logical from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/planetscale/planetscale_wal_level_logical.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/rds.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/rds.md index 8ced731ee65..5adab8fb5a6 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/rds.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/rds.md @@ -3,6 +3,7 @@ sidebar_label: 'Amazon RDS Postgres' description: 'Set up Amazon RDS Postgres as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/rds title: 'RDS Postgres Source Setup Guide' +doc_type: 'guide' --- import parameter_group_in_blade from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/rds/parameter_group_in_blade.png'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/supabase.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/supabase.md index cb750c42544..4148f2ea6c0 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/supabase.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/supabase.md @@ -3,6 +3,7 @@ sidebar_label: 'Supabase Postgres' description: 'Set up Supabase instance as a source for ClickPipes' slug: /integrations/clickpipes/postgres/source/supabase title: 'Supabase Source Setup Guide' +doc_type: 'guide' --- import supabase_commands from '@site/static/images/integrations/data-ingestion/clickpipes/postgres/source/setup/supabase/supabase-commands.jpg' diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/source/timescale.md b/docs/integrations/data-ingestion/clickpipes/postgres/source/timescale.md index f2f48eaa9b5..bd8309176b6 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/source/timescale.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/source/timescale.md @@ -4,6 +4,7 @@ description: 'Set up Postgres with the TimescaleDB extension as a source for Cli slug: /integrations/clickpipes/postgres/source/timescale title: 'Postgres with TimescaleDB source setup guide' keywords: ['TimescaleDB'] +doc_type: 'guide' --- import BetaBadge from '@theme/badges/BetaBadge'; diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/table_resync.md b/docs/integrations/data-ingestion/clickpipes/postgres/table_resync.md index 11288c5290c..74e777a3c0d 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/table_resync.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/table_resync.md @@ -3,6 +3,7 @@ title: 'Resyncing Specific Tables' description: 'Resyncing specific tables in a Postgres ClickPipe' slug: /integrations/clickpipes/postgres/table_resync sidebar_label: 'Resync Table' +doc_type: 'guide' --- # Resyncing specific tables {#resync-tables} diff --git a/docs/integrations/data-ingestion/clickpipes/postgres/toast.md b/docs/integrations/data-ingestion/clickpipes/postgres/toast.md index bf3fd659f2e..49860298a40 100644 --- a/docs/integrations/data-ingestion/clickpipes/postgres/toast.md +++ b/docs/integrations/data-ingestion/clickpipes/postgres/toast.md @@ -2,6 +2,7 @@ title: 'Handling TOAST Columns' description: 'Learn how to handle TOAST columns when replicating data from PostgreSQL to ClickHouse.' slug: /integrations/clickpipes/postgres/toast +doc_type: 'guide' --- When replicating data from PostgreSQL to ClickHouse, it's important to understand the limitations and special considerations for TOAST (The Oversized-Attribute Storage Technique) columns. This guide will help you identify and properly handle TOAST columns in your replication process. diff --git a/docs/integrations/data-ingestion/clickpipes/secure-kinesis.md b/docs/integrations/data-ingestion/clickpipes/secure-kinesis.md index 7b6044bd43c..2e6426e2cd5 100644 --- a/docs/integrations/data-ingestion/clickpipes/secure-kinesis.md +++ b/docs/integrations/data-ingestion/clickpipes/secure-kinesis.md @@ -3,6 +3,7 @@ slug: /integrations/clickpipes/secure-kinesis sidebar_label: 'Kinesis Role-Based Access' title: 'Kinesis Role-Based Access' description: 'This article demonstrates how ClickPipes customers can leverage role-based access to authenticate with Amazon Kinesis and access their data streams securely.' +doc_type: 'guide' --- import secure_kinesis from '@site/static/images/integrations/data-ingestion/clickpipes/securekinesis.jpg'; diff --git a/docs/integrations/data-ingestion/clickpipes/secure-rds.md b/docs/integrations/data-ingestion/clickpipes/secure-rds.md index e3e90e0bb10..5d11f64571f 100644 --- a/docs/integrations/data-ingestion/clickpipes/secure-rds.md +++ b/docs/integrations/data-ingestion/clickpipes/secure-rds.md @@ -3,6 +3,7 @@ slug: /integrations/clickpipes/secure-rds sidebar_label: 'AWS IAM DB Authentication (RDS/Aurora)' title: 'AWS IAM DB Authentication (RDS/Aurora)' description: 'This article demonstrates how ClickPipes customers can leverage role-based access to authenticate with Amazon RDS/Aurora and access their database securely.' +doc_type: 'guide' --- import secures3_arn from '@site/static/images/cloud/security/secures3_arn.png'; diff --git a/docs/integrations/data-ingestion/data-formats/arrow-avro-orc.md b/docs/integrations/data-ingestion/data-formats/arrow-avro-orc.md index 58968b30633..86c333d4d83 100644 --- a/docs/integrations/data-ingestion/data-formats/arrow-avro-orc.md +++ b/docs/integrations/data-ingestion/data-formats/arrow-avro-orc.md @@ -4,6 +4,7 @@ sidebar_position: 5 slug: /integrations/data-formats/arrow-avro-orc title: 'Working with Avro, Arrow, and ORC data in ClickHouse' description: 'Page describing how to work with Avro, Arrow and ORC data in ClickHouse' +doc_type: 'guide' --- # Working with Avro, Arrow, and ORC data in ClickHouse diff --git a/docs/integrations/data-ingestion/data-formats/binary.md b/docs/integrations/data-ingestion/data-formats/binary.md index 254948a18fd..e720dbce392 100644 --- a/docs/integrations/data-ingestion/data-formats/binary.md +++ b/docs/integrations/data-ingestion/data-formats/binary.md @@ -3,6 +3,7 @@ sidebar_label: 'Binary and Native' slug: /integrations/data-formats/binary-native title: 'Using native and binary formats in ClickHouse' description: 'Page describing how to use native and binary formats in ClickHouse' +doc_type: 'guide' --- import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; diff --git a/docs/integrations/data-ingestion/data-formats/csv-tsv.md b/docs/integrations/data-ingestion/data-formats/csv-tsv.md index 253993d1148..c7b49429ee3 100644 --- a/docs/integrations/data-ingestion/data-formats/csv-tsv.md +++ b/docs/integrations/data-ingestion/data-formats/csv-tsv.md @@ -3,6 +3,7 @@ sidebar_label: 'CSV and TSV' slug: /integrations/data-formats/csv-tsv title: 'Working with CSV and TSV data in ClickHouse' description: 'Page describing how to work with CSV and TSV data in ClickHouse' +doc_type: 'guide' --- # Working with CSV and TSV data in ClickHouse diff --git a/docs/integrations/data-ingestion/data-formats/intro.md b/docs/integrations/data-ingestion/data-formats/intro.md index 54f5b5f41bc..cc1ce5472d0 100644 --- a/docs/integrations/data-ingestion/data-formats/intro.md +++ b/docs/integrations/data-ingestion/data-formats/intro.md @@ -6,6 +6,7 @@ keywords: ['clickhouse', 'CSV', 'TSV', 'Parquet', 'clickhouse-client', 'clickhou title: 'Importing from various data formats to ClickHouse' description: 'Page describing how to import various data formats into ClickHouse' show_related_blogs: true +doc_type: 'guide' --- # Importing from various data formats to ClickHouse diff --git a/docs/integrations/data-ingestion/data-formats/json/exporting.md b/docs/integrations/data-ingestion/data-formats/json/exporting.md index 7a39c46c360..a1e1627f5be 100644 --- a/docs/integrations/data-ingestion/data-formats/json/exporting.md +++ b/docs/integrations/data-ingestion/data-formats/json/exporting.md @@ -3,6 +3,7 @@ title: 'Exporting JSON' slug: /integrations/data-formats/json/exporting description: 'How to export JSON data from ClickHouse' keywords: ['json', 'clickhouse', 'formats', 'exporting'] +doc_type: 'guide' --- # Exporting JSON diff --git a/docs/integrations/data-ingestion/data-formats/json/formats.md b/docs/integrations/data-ingestion/data-formats/json/formats.md index efd8112dbbb..b92c64c5365 100644 --- a/docs/integrations/data-ingestion/data-formats/json/formats.md +++ b/docs/integrations/data-ingestion/data-formats/json/formats.md @@ -4,6 +4,7 @@ slug: /integrations/data-formats/json/other-formats description: 'Handling other JSON formats' sidebar_label: 'Handling other formats' keywords: ['json', 'formats', 'json formats'] +doc_type: 'guide' --- # Handling other JSON formats diff --git a/docs/integrations/data-ingestion/data-formats/json/inference.md b/docs/integrations/data-ingestion/data-formats/json/inference.md index a6c6eecb754..4a5dbe6e5a9 100644 --- a/docs/integrations/data-ingestion/data-formats/json/inference.md +++ b/docs/integrations/data-ingestion/data-formats/json/inference.md @@ -3,6 +3,7 @@ title: 'JSON schema inference' slug: /integrations/data-formats/json/inference description: 'How to use JSON schema inference' keywords: ['json', 'schema', 'inference', 'schema inference'] +doc_type: 'guide' --- ClickHouse can automatically determine the structure of JSON data. This can be used to query JSON data directly e.g. on disk with `clickhouse-local` or S3 buckets, and/or automatically create schemas prior to loading the data into ClickHouse. diff --git a/docs/integrations/data-ingestion/data-formats/json/intro.md b/docs/integrations/data-ingestion/data-formats/json/intro.md index ff7fe692bfb..0e1e4ece5fa 100644 --- a/docs/integrations/data-ingestion/data-formats/json/intro.md +++ b/docs/integrations/data-ingestion/data-formats/json/intro.md @@ -6,6 +6,7 @@ slug: /integrations/data-formats/json/overview description: 'Working with JSON in ClickHouse' keywords: ['json', 'clickhouse'] score: 10 +doc_type: 'guide' --- # JSON Overview diff --git a/docs/integrations/data-ingestion/data-formats/json/loading.md b/docs/integrations/data-ingestion/data-formats/json/loading.md index 5ec169066f3..25aa01cf6a2 100644 --- a/docs/integrations/data-ingestion/data-formats/json/loading.md +++ b/docs/integrations/data-ingestion/data-formats/json/loading.md @@ -6,6 +6,7 @@ slug: /integrations/data-formats/json/loading description: 'Loading JSON' keywords: ['json', 'clickhouse', 'inserting', 'loading', 'inserting'] score: 15 +doc_type: 'guide' --- # Loading JSON {#loading-json} diff --git a/docs/integrations/data-ingestion/data-formats/json/other.md b/docs/integrations/data-ingestion/data-formats/json/other.md index 95411202514..54c8f661857 100644 --- a/docs/integrations/data-ingestion/data-formats/json/other.md +++ b/docs/integrations/data-ingestion/data-formats/json/other.md @@ -3,6 +3,7 @@ title: 'Other JSON approaches' slug: /integrations/data-formats/json/other-approaches description: 'Other approaches to modeling JSON' keywords: ['json', 'formats'] +doc_type: 'reference' --- # Other approaches to modeling JSON diff --git a/docs/integrations/data-ingestion/data-formats/json/schema.md b/docs/integrations/data-ingestion/data-formats/json/schema.md index af0ca123b67..d2737daf9b2 100644 --- a/docs/integrations/data-ingestion/data-formats/json/schema.md +++ b/docs/integrations/data-ingestion/data-formats/json/schema.md @@ -4,6 +4,7 @@ slug: /integrations/data-formats/json/schema description: 'How to optimally design JSON schemas' keywords: ['json', 'clickhouse', 'inserting', 'loading', 'formats', 'schema', 'structured', 'semi-structured'] score: 20 +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/data-formats/parquet.md b/docs/integrations/data-ingestion/data-formats/parquet.md index 01afd4efdd3..b4fdc91b32f 100644 --- a/docs/integrations/data-ingestion/data-formats/parquet.md +++ b/docs/integrations/data-ingestion/data-formats/parquet.md @@ -4,6 +4,7 @@ sidebar_position: 3 slug: /integrations/data-formats/parquet title: 'Working with Parquet in ClickHouse' description: 'Page describing how to work with Parquet in ClickHouse' +doc_type: 'guide' --- # Working with Parquet in ClickHouse diff --git a/docs/integrations/data-ingestion/data-formats/sql.md b/docs/integrations/data-ingestion/data-formats/sql.md index e3ec019c4d6..038196ea3bb 100644 --- a/docs/integrations/data-ingestion/data-formats/sql.md +++ b/docs/integrations/data-ingestion/data-formats/sql.md @@ -3,6 +3,7 @@ sidebar_label: 'SQL Dumps' slug: /integrations/data-formats/sql title: 'Inserting and dumping SQL data in ClickHouse' description: 'Page describing how to transfer data between other databases and ClickHouse using SQL dumps.' +doc_type: 'guide' --- # Inserting and dumping SQL data in ClickHouse diff --git a/docs/integrations/data-ingestion/data-formats/templates-regex.md b/docs/integrations/data-ingestion/data-formats/templates-regex.md index c3f4fc18f4b..4a9a6a8d522 100644 --- a/docs/integrations/data-ingestion/data-formats/templates-regex.md +++ b/docs/integrations/data-ingestion/data-formats/templates-regex.md @@ -4,6 +4,7 @@ sidebar_position: 3 slug: /integrations/data-formats/templates-regexp title: 'Importing and exporting custom text data using Templates and Regex in ClickHouse' description: 'Page describing how to import and export custom text using templates and regex in ClickHouse' +doc_type: 'guide' --- # Importing and exporting custom text data using Templates and Regex in ClickHouse diff --git a/docs/integrations/data-ingestion/data-ingestion-index.md b/docs/integrations/data-ingestion/data-ingestion-index.md index 0f88aa8e1a4..fbdfeaf6bc1 100644 --- a/docs/integrations/data-ingestion/data-ingestion-index.md +++ b/docs/integrations/data-ingestion/data-ingestion-index.md @@ -3,6 +3,7 @@ slug: /integrations/data-ingestion-overview keywords: [ 'Airbyte', 'Apache Spark', 'Spark', 'Azure Synapse', 'Amazon Glue', 'Apache Beam', 'dbt', 'Fivetran', 'NiFi', 'dlt', 'Vector' ] title: 'Data Ingestion' description: 'Landing page for the data ingestion section' +doc_type: 'landing-page' --- # Data Ingestion diff --git a/docs/integrations/data-ingestion/data-sources-index.md b/docs/integrations/data-ingestion/data-sources-index.md index 9344185da62..b7cd897f61f 100644 --- a/docs/integrations/data-ingestion/data-sources-index.md +++ b/docs/integrations/data-ingestion/data-sources-index.md @@ -3,6 +3,7 @@ slug: /integrations/data-sources/index keywords: ['AWS S3', 'Azure Data Factory', 'PostgreSQL', 'Kafka', 'MySQL', 'Cassandra', 'Data Factory', 'Redis', 'RabbitMQ', 'MongoDB', 'Google Cloud Storage', 'Hive', 'Hudi', 'Iceberg', 'MinIO', 'Delta Lake', 'RocksDB', 'Splunk', 'SQLite', 'NATS', 'EMQX', 'local files', 'JDBC', 'ODBC'] description: 'Datasources overview page' title: 'Data Sources' +doc_type: 'landing-page' --- # Data sources diff --git a/docs/integrations/data-ingestion/dbms/dynamodb/index.md b/docs/integrations/data-ingestion/dbms/dynamodb/index.md index 144b95daca7..13baeda5b54 100644 --- a/docs/integrations/data-ingestion/dbms/dynamodb/index.md +++ b/docs/integrations/data-ingestion/dbms/dynamodb/index.md @@ -6,6 +6,7 @@ description: 'ClickPipes allows you to connect ClickHouse to DynamoDB.' keywords: ['DynamoDB'] title: 'CDC from DynamoDB to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; diff --git a/docs/integrations/data-ingestion/dbms/jdbc-with-clickhouse.md b/docs/integrations/data-ingestion/dbms/jdbc-with-clickhouse.md index 8ac322ecd5d..45eabb69fbb 100644 --- a/docs/integrations/data-ingestion/dbms/jdbc-with-clickhouse.md +++ b/docs/integrations/data-ingestion/dbms/jdbc-with-clickhouse.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'jdbc', 'connect', 'integrate'] slug: /integrations/jdbc/jdbc-with-clickhouse description: 'The ClickHouse JDBC Bridge allows ClickHouse to access data from any external data source for which a JDBC driver is available' title: 'Connecting ClickHouse to external data sources with JDBC' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/dbms/odbc-with-clickhouse.md b/docs/integrations/data-ingestion/dbms/odbc-with-clickhouse.md index 73aae819a8e..1e5be9d9bec 100644 --- a/docs/integrations/data-ingestion/dbms/odbc-with-clickhouse.md +++ b/docs/integrations/data-ingestion/dbms/odbc-with-clickhouse.md @@ -4,6 +4,7 @@ sidebar_position: 1 title: 'ODBC' slug: /integrations/data-ingestion/dbms/odbc-with-clickhouse description: 'Page describing the ODBC integration' +doc_type: 'reference' --- import Content from '@site/docs/engines/table-engines/integrations/odbc.md'; diff --git a/docs/integrations/data-ingestion/dbms/postgresql/connecting-to-postgresql.md b/docs/integrations/data-ingestion/dbms/postgresql/connecting-to-postgresql.md index da2f81cc9f6..c89664195bb 100644 --- a/docs/integrations/data-ingestion/dbms/postgresql/connecting-to-postgresql.md +++ b/docs/integrations/data-ingestion/dbms/postgresql/connecting-to-postgresql.md @@ -4,6 +4,7 @@ title: 'Connecting to PostgreSQL' keywords: ['clickhouse', 'postgres', 'postgresql', 'connect', 'integrate', 'table', 'engine'] description: 'Page describing the various ways to connect PostgreSQL to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; diff --git a/docs/integrations/data-ingestion/dbms/postgresql/inserting-data.md b/docs/integrations/data-ingestion/dbms/postgresql/inserting-data.md index 9b51f0c4461..2348f729917 100644 --- a/docs/integrations/data-ingestion/dbms/postgresql/inserting-data.md +++ b/docs/integrations/data-ingestion/dbms/postgresql/inserting-data.md @@ -3,6 +3,7 @@ slug: /integrations/postgresql/inserting-data title: 'How to insert data from PostgreSQL' keywords: ['postgres', 'postgresql', 'inserts'] description: 'Page describing how to insert data from PostgresSQL using ClickPipes, PeerDB or the Postgres table function' +doc_type: 'guide' --- We recommend reading [this guide](/guides/inserting-data) to learn best practices on inserting data to ClickHouse to optimize for insert performance. diff --git a/docs/integrations/data-ingestion/emqx/index.md b/docs/integrations/data-ingestion/emqx/index.md index 09e93ac070c..288fa1f4b3d 100644 --- a/docs/integrations/data-ingestion/emqx/index.md +++ b/docs/integrations/data-ingestion/emqx/index.md @@ -4,6 +4,7 @@ sidebar_position: 1 slug: /integrations/emqx description: 'Introduction to EMQX with ClickHouse' title: 'Integrating EMQX with ClickHouse' +doc_type: 'guide' --- import emqx_cloud_artitecture from '@site/static/images/integrations/data-ingestion/emqx/emqx-cloud-artitecture.png'; diff --git a/docs/integrations/data-ingestion/etl-tools/airbyte-and-clickhouse.md b/docs/integrations/data-ingestion/etl-tools/airbyte-and-clickhouse.md index d4ff6c85bd0..1a6c82db2e4 100644 --- a/docs/integrations/data-ingestion/etl-tools/airbyte-and-clickhouse.md +++ b/docs/integrations/data-ingestion/etl-tools/airbyte-and-clickhouse.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'Airbyte', 'connect', 'integrate', 'etl', 'data integra slug: /integrations/airbyte description: 'Stream data into ClickHouse using Airbyte data pipelines' title: 'Connect Airbyte to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/etl-tools/apache-beam.md b/docs/integrations/data-ingestion/etl-tools/apache-beam.md index 04662198f65..5139529cb01 100644 --- a/docs/integrations/data-ingestion/etl-tools/apache-beam.md +++ b/docs/integrations/data-ingestion/etl-tools/apache-beam.md @@ -3,6 +3,7 @@ sidebar_label: 'Apache Beam' slug: /integrations/apache-beam description: 'Users can ingest data into ClickHouse using Apache Beam' title: 'Integrating Apache Beam and ClickHouse' +doc_type: 'guide' --- import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported'; diff --git a/docs/integrations/data-ingestion/etl-tools/bladepipe-and-clickhouse.md b/docs/integrations/data-ingestion/etl-tools/bladepipe-and-clickhouse.md index f7594deb7df..d552e50561b 100644 --- a/docs/integrations/data-ingestion/etl-tools/bladepipe-and-clickhouse.md +++ b/docs/integrations/data-ingestion/etl-tools/bladepipe-and-clickhouse.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'BladePipe', 'connect', 'integrate', 'cdc', 'etl', 'dat slug: /integrations/bladepipe description: 'Stream data into ClickHouse using BladePipe data pipelines' title: 'Connect BladePipe to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/etl-tools/dbt/index.md b/docs/integrations/data-ingestion/etl-tools/dbt/index.md index a7e52bcef32..9d9ac698341 100644 --- a/docs/integrations/data-ingestion/etl-tools/dbt/index.md +++ b/docs/integrations/data-ingestion/etl-tools/dbt/index.md @@ -4,6 +4,7 @@ slug: /integrations/dbt sidebar_position: 1 description: 'Users can transform and model their data in ClickHouse using dbt' title: 'Integrating dbt and ClickHouse' +doc_type: 'guide' --- import TOCInline from '@theme/TOCInline'; diff --git a/docs/integrations/data-ingestion/etl-tools/dlt-and-clickhouse.md b/docs/integrations/data-ingestion/etl-tools/dlt-and-clickhouse.md index 02aa71ca10a..566c36bd5ef 100644 --- a/docs/integrations/data-ingestion/etl-tools/dlt-and-clickhouse.md +++ b/docs/integrations/data-ingestion/etl-tools/dlt-and-clickhouse.md @@ -4,6 +4,7 @@ keywords: ['clickhouse', 'dlt', 'connect', 'integrate', 'etl', 'data integration description: 'Load data into Clickhouse using dlt integration' title: 'Connect dlt to ClickHouse' slug: /integrations/data-ingestion/etl-tools/dlt-and-clickhouse +doc_type: 'guide' --- import CommunityMaintainedBadge from '@theme/badges/CommunityMaintained'; diff --git a/docs/integrations/data-ingestion/etl-tools/fivetran/index.md b/docs/integrations/data-ingestion/etl-tools/fivetran/index.md index b8d127e3b7b..400ea3a9fd1 100644 --- a/docs/integrations/data-ingestion/etl-tools/fivetran/index.md +++ b/docs/integrations/data-ingestion/etl-tools/fivetran/index.md @@ -4,6 +4,7 @@ slug: /integrations/fivetran sidebar_position: 2 description: 'Users can transform and model their data in ClickHouse using dbt' title: 'Fivetran and ClickHouse Cloud' +doc_type: 'guide' --- import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported'; diff --git a/docs/integrations/data-ingestion/etl-tools/nifi-and-clickhouse.md b/docs/integrations/data-ingestion/etl-tools/nifi-and-clickhouse.md index b7249a06d11..6678c164539 100644 --- a/docs/integrations/data-ingestion/etl-tools/nifi-and-clickhouse.md +++ b/docs/integrations/data-ingestion/etl-tools/nifi-and-clickhouse.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'NiFi', 'connect', 'integrate', 'etl', 'data integratio slug: /integrations/nifi description: 'Stream data into ClickHouse using NiFi data pipelines' title: 'Connect Apache NiFi to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/etl-tools/vector-to-clickhouse.md b/docs/integrations/data-ingestion/etl-tools/vector-to-clickhouse.md index 5dd69834249..dc5c36aef08 100644 --- a/docs/integrations/data-ingestion/etl-tools/vector-to-clickhouse.md +++ b/docs/integrations/data-ingestion/etl-tools/vector-to-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/vector description: 'How to tail a log file into ClickHouse using Vector' title: 'Integrating Vector with ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/gcs/index.md b/docs/integrations/data-ingestion/gcs/index.md index dc4659a77a0..ee640dc9a6e 100644 --- a/docs/integrations/data-ingestion/gcs/index.md +++ b/docs/integrations/data-ingestion/gcs/index.md @@ -4,6 +4,7 @@ sidebar_position: 4 slug: /integrations/gcs description: 'Google Cloud Storage (GCS) Backed MergeTree' title: 'Integrate Google Cloud Storage with ClickHouse' +doc_type: 'guide' --- import BucketDetails from '@site/docs/_snippets/_GCS_authentication_and_bucket.md'; diff --git a/docs/integrations/data-ingestion/google-dataflow/dataflow.md b/docs/integrations/data-ingestion/google-dataflow/dataflow.md index f982e6c1618..d0560a44a85 100644 --- a/docs/integrations/data-ingestion/google-dataflow/dataflow.md +++ b/docs/integrations/data-ingestion/google-dataflow/dataflow.md @@ -4,6 +4,7 @@ slug: /integrations/google-dataflow/dataflow sidebar_position: 1 description: 'Users can ingest data into ClickHouse using Google Dataflow' title: 'Integrating Google Dataflow with ClickHouse' +doc_type: 'guide' --- import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported'; diff --git a/docs/integrations/data-ingestion/google-dataflow/java-runner.md b/docs/integrations/data-ingestion/google-dataflow/java-runner.md index fe6abe1e201..4f4384c8bd2 100644 --- a/docs/integrations/data-ingestion/google-dataflow/java-runner.md +++ b/docs/integrations/data-ingestion/google-dataflow/java-runner.md @@ -4,6 +4,7 @@ slug: /integrations/google-dataflow/java-runner sidebar_position: 2 description: 'Users can ingest data into ClickHouse using Google Dataflow Java Runner' title: 'Dataflow Java Runner' +doc_type: 'guide' --- import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported'; diff --git a/docs/integrations/data-ingestion/google-dataflow/templates.md b/docs/integrations/data-ingestion/google-dataflow/templates.md index a7bcfb0b87e..7577e81793f 100644 --- a/docs/integrations/data-ingestion/google-dataflow/templates.md +++ b/docs/integrations/data-ingestion/google-dataflow/templates.md @@ -4,6 +4,7 @@ slug: /integrations/google-dataflow/templates sidebar_position: 3 description: 'Users can ingest data into ClickHouse using Google Dataflow Templates' title: 'Google Dataflow Templates' +doc_type: 'guide' --- import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported'; diff --git a/docs/integrations/data-ingestion/google-dataflow/templates/bigquery-to-clickhouse.md b/docs/integrations/data-ingestion/google-dataflow/templates/bigquery-to-clickhouse.md index 860980af59c..f425206de0d 100644 --- a/docs/integrations/data-ingestion/google-dataflow/templates/bigquery-to-clickhouse.md +++ b/docs/integrations/data-ingestion/google-dataflow/templates/bigquery-to-clickhouse.md @@ -4,6 +4,7 @@ sidebar_position: 1 slug: /integrations/google-dataflow/templates/bigquery-to-clickhouse description: 'Users can ingest data from BigQuery into ClickHouse using Google Dataflow Template' title: 'Dataflow BigQuery to ClickHouse template' +doc_type: 'guide' --- import TOCInline from '@theme/TOCInline'; diff --git a/docs/integrations/data-ingestion/insert-local-files.md b/docs/integrations/data-ingestion/insert-local-files.md index bf584f4e5aa..2c75929d32c 100644 --- a/docs/integrations/data-ingestion/insert-local-files.md +++ b/docs/integrations/data-ingestion/insert-local-files.md @@ -5,6 +5,7 @@ title: 'Insert Local Files' slug: /integrations/data-ingestion/insert-local-files description: 'Learn about Insert Local Files' show_related_blogs: true +doc_type: 'guide' --- # Insert local files diff --git a/docs/integrations/data-ingestion/kafka/confluent/confluent-cloud.md b/docs/integrations/data-ingestion/kafka/confluent/confluent-cloud.md index a395202e7c2..8855215ceba 100644 --- a/docs/integrations/data-ingestion/kafka/confluent/confluent-cloud.md +++ b/docs/integrations/data-ingestion/kafka/confluent/confluent-cloud.md @@ -5,6 +5,7 @@ slug: /integrations/kafka/cloud/confluent/sink-connector description: 'Guide to using the fully managed ClickHouse Connector Sinkon Confluent Cloud' title: 'Integrating Confluent Cloud with ClickHouse' keywords: ['Kafka', 'Confluent Cloud'] +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/kafka/confluent/custom-connector.md b/docs/integrations/data-ingestion/kafka/confluent/custom-connector.md index f2651bfc0f0..9225c8e16e9 100644 --- a/docs/integrations/data-ingestion/kafka/confluent/custom-connector.md +++ b/docs/integrations/data-ingestion/kafka/confluent/custom-connector.md @@ -4,6 +4,7 @@ sidebar_position: 3 slug: /integrations/kafka/cloud/confluent/custom-connector description: 'Using ClickHouse Connector Sink with Kafka Connect and ClickHouse' title: 'Integrating Confluent Cloud with ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/kafka/confluent/index.md b/docs/integrations/data-ingestion/kafka/confluent/index.md index be62342cb6b..55aa538e451 100644 --- a/docs/integrations/data-ingestion/kafka/confluent/index.md +++ b/docs/integrations/data-ingestion/kafka/confluent/index.md @@ -4,6 +4,7 @@ sidebar_position: 1 slug: /integrations/kafka/cloud/confluent description: 'Kafka Connectivity with Confluent Cloud' title: 'Integrating Confluent Cloud with ClickHouse' +doc_type: 'guide' --- # Integrating Confluent Cloud with ClickHouse diff --git a/docs/integrations/data-ingestion/kafka/confluent/kafka-connect-http.md b/docs/integrations/data-ingestion/kafka/confluent/kafka-connect-http.md index 8ebeb2d3358..27b9fe6a745 100644 --- a/docs/integrations/data-ingestion/kafka/confluent/kafka-connect-http.md +++ b/docs/integrations/data-ingestion/kafka/confluent/kafka-connect-http.md @@ -4,6 +4,7 @@ sidebar_position: 4 slug: /integrations/kafka/cloud/confluent/http description: 'Using HTTP Connector Sink with Kafka Connect and ClickHouse' title: 'Confluent HTTP Sink Connector' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/kafka/index.md b/docs/integrations/data-ingestion/kafka/index.md index ef85ea20227..f460d47ef88 100644 --- a/docs/integrations/data-ingestion/kafka/index.md +++ b/docs/integrations/data-ingestion/kafka/index.md @@ -4,6 +4,7 @@ sidebar_position: 1 slug: /integrations/kafka description: 'Introduction to Kafka with ClickHouse' title: 'Integrating Kafka with ClickHouse' +doc_type: 'guide' --- # Integrating Kafka with ClickHouse diff --git a/docs/integrations/data-ingestion/kafka/kafka-clickhouse-connect-sink.md b/docs/integrations/data-ingestion/kafka/kafka-clickhouse-connect-sink.md index d8dcb3f4969..cd2b3399f61 100644 --- a/docs/integrations/data-ingestion/kafka/kafka-clickhouse-connect-sink.md +++ b/docs/integrations/data-ingestion/kafka/kafka-clickhouse-connect-sink.md @@ -4,6 +4,7 @@ sidebar_position: 2 slug: /integrations/kafka/clickhouse-kafka-connect-sink description: 'The official Kafka connector from ClickHouse.' title: 'ClickHouse Kafka Connect Sink' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/kafka/kafka-connect-jdbc.md b/docs/integrations/data-ingestion/kafka/kafka-connect-jdbc.md index 3d637f4d561..194375d2289 100644 --- a/docs/integrations/data-ingestion/kafka/kafka-connect-jdbc.md +++ b/docs/integrations/data-ingestion/kafka/kafka-connect-jdbc.md @@ -4,6 +4,7 @@ sidebar_position: 4 slug: /integrations/kafka/kafka-connect-jdbc description: 'Using JDBC Connector Sink with Kafka Connect and ClickHouse' title: 'JDBC Connector' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/kafka/kafka-table-engine-named-collections.md b/docs/integrations/data-ingestion/kafka/kafka-table-engine-named-collections.md index 81edf388e47..6b25bb2f135 100644 --- a/docs/integrations/data-ingestion/kafka/kafka-table-engine-named-collections.md +++ b/docs/integrations/data-ingestion/kafka/kafka-table-engine-named-collections.md @@ -3,6 +3,7 @@ title: 'Integrating ClickHouse with Kafka using Named Collections' description: 'How to use named collections to connect clickhouse to kafka' keywords: ['named collection', 'how to', 'kafka'] slug: /integrations/data-ingestion/kafka/kafka-table-engine-named-collections +doc_type: 'guide' --- # Integrating ClickHouse with Kafka using named collections diff --git a/docs/integrations/data-ingestion/kafka/kafka-table-engine.md b/docs/integrations/data-ingestion/kafka/kafka-table-engine.md index 4081e24f4bc..b27b4191ee4 100644 --- a/docs/integrations/data-ingestion/kafka/kafka-table-engine.md +++ b/docs/integrations/data-ingestion/kafka/kafka-table-engine.md @@ -4,6 +4,7 @@ sidebar_position: 5 slug: /integrations/kafka/kafka-table-engine description: 'Using the Kafka Table Engine' title: 'Using the Kafka table engine' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-ingestion/kafka/kafka-vector.md b/docs/integrations/data-ingestion/kafka/kafka-vector.md index f326bf4b0a5..32ec1cf2a97 100644 --- a/docs/integrations/data-ingestion/kafka/kafka-vector.md +++ b/docs/integrations/data-ingestion/kafka/kafka-vector.md @@ -4,6 +4,7 @@ sidebar_position: 3 slug: /integrations/kafka/kafka-vector description: 'Using Vector with Kafka and ClickHouse' title: 'Using Vector with Kafka and ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/kafka/msk/index.md b/docs/integrations/data-ingestion/kafka/msk/index.md index 547b2b9c30a..825e974a213 100644 --- a/docs/integrations/data-ingestion/kafka/msk/index.md +++ b/docs/integrations/data-ingestion/kafka/msk/index.md @@ -5,6 +5,7 @@ slug: /integrations/kafka/cloud/amazon-msk/ description: 'The official Kafka connector from ClickHouse with Amazon MSK' keywords: ['integration', 'kafka', 'amazon msk', 'sink', 'connector'] title: 'Integrating Amazon MSK with ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-ingestion/s3-minio.md b/docs/integrations/data-ingestion/s3-minio.md index c40e23dbac2..ee1e05bfe89 100644 --- a/docs/integrations/data-ingestion/s3-minio.md +++ b/docs/integrations/data-ingestion/s3-minio.md @@ -4,6 +4,7 @@ sidebar_position: 6 slug: /integrations/minio description: 'Page describing how to use MinIO with ClickHouse' title: 'Using MinIO' +doc_type: 'guide' --- # Using MinIO diff --git a/docs/integrations/data-ingestion/s3/index.md b/docs/integrations/data-ingestion/s3/index.md index c2195918426..9a7cd275da8 100644 --- a/docs/integrations/data-ingestion/s3/index.md +++ b/docs/integrations/data-ingestion/s3/index.md @@ -4,6 +4,7 @@ sidebar_position: 1 sidebar_label: 'Integrating S3 with ClickHouse' title: 'Integrating S3 with ClickHouse' description: 'Page describing how to integrate S3 with ClickHouse' +doc_type: 'guide' --- import BucketDetails from '@site/docs/_snippets/_S3_authentication_and_bucket.md'; diff --git a/docs/integrations/data-ingestion/s3/performance.md b/docs/integrations/data-ingestion/s3/performance.md index e9cabe29d6f..eaf9ea3bcef 100644 --- a/docs/integrations/data-ingestion/s3/performance.md +++ b/docs/integrations/data-ingestion/s3/performance.md @@ -4,6 +4,7 @@ sidebar_position: 2 sidebar_label: 'Optimizing for Performance' title: 'Optimizing for S3 Insert and Read Performance' description: 'Optimizing the performance of S3 read and insert' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-sources/cassandra.md b/docs/integrations/data-sources/cassandra.md index 983ab3967e6..943a5d9e1df 100644 --- a/docs/integrations/data-sources/cassandra.md +++ b/docs/integrations/data-sources/cassandra.md @@ -3,6 +3,7 @@ slug: /integrations/cassandra sidebar_label: 'Cassandra' title: 'Cassandra' description: 'Page describing how users can integrate with Cassandra via a dictionary.' +doc_type: 'reference' --- # Cassandra integration diff --git a/docs/integrations/data-sources/deltalake.md b/docs/integrations/data-sources/deltalake.md index 7e0efee394b..87956ae8009 100644 --- a/docs/integrations/data-sources/deltalake.md +++ b/docs/integrations/data-sources/deltalake.md @@ -3,6 +3,7 @@ slug: /integrations/deltalake sidebar_label: 'Delta Lake' title: 'Delta Lake' description: 'Page describing how users can integrate with the Delta lake table format via the table function.' +doc_type: 'reference' --- import DeltaLakeFunction from '@site/docs/sql-reference/table-functions/deltalake.md'; diff --git a/docs/integrations/data-sources/hive.md b/docs/integrations/data-sources/hive.md index 82f88e1250a..a841a252aef 100644 --- a/docs/integrations/data-sources/hive.md +++ b/docs/integrations/data-sources/hive.md @@ -4,6 +4,7 @@ sidebar_label: 'Hive' title: 'Hive' hide_title: true description: 'Page describing the Hive table engine' +doc_type: 'reference' --- import HiveTableEngine from '@site/docs/engines/table-engines/integrations/hive.md'; diff --git a/docs/integrations/data-sources/hudi.md b/docs/integrations/data-sources/hudi.md index ef7b220f0a8..7365c6b1bca 100644 --- a/docs/integrations/data-sources/hudi.md +++ b/docs/integrations/data-sources/hudi.md @@ -4,6 +4,7 @@ sidebar_label: 'Hudi' title: 'Hudi' hide_title: true description: 'Page describing the Hudi table engine' +doc_type: 'reference' --- import HudiTableEngine from '@site/docs/engines/table-engines/integrations/hudi.md'; diff --git a/docs/integrations/data-sources/iceberg.md b/docs/integrations/data-sources/iceberg.md index cb6db487847..3debb02cf81 100644 --- a/docs/integrations/data-sources/iceberg.md +++ b/docs/integrations/data-sources/iceberg.md @@ -3,6 +3,7 @@ slug: /integrations/iceberg sidebar_label: 'Iceberg' title: 'Iceberg' description: 'Page describing the IcebergFunction which can be used to integrate ClickHouse with the Iceberg table format' +doc_type: 'guide' --- import IcebergFunction from '@site/docs/sql-reference/table-functions/iceberg.md'; diff --git a/docs/integrations/data-sources/mongodb.md b/docs/integrations/data-sources/mongodb.md index 8750366c870..83ff9e661c3 100644 --- a/docs/integrations/data-sources/mongodb.md +++ b/docs/integrations/data-sources/mongodb.md @@ -4,6 +4,7 @@ sidebar_label: 'MongoDB' title: 'MongoDB' hide_title: true description: 'Page describing integration using the MongoDB engine' +doc_type: 'reference' --- import MongoDBEngine from '@site/docs/engines/table-engines/integrations/mongodb.md'; diff --git a/docs/integrations/data-sources/mysql.md b/docs/integrations/data-sources/mysql.md index 56eebe31735..bddd8278030 100644 --- a/docs/integrations/data-sources/mysql.md +++ b/docs/integrations/data-sources/mysql.md @@ -4,6 +4,7 @@ sidebar_label: 'MySQL' title: 'MySQL' hide_title: true description: 'Page describing MySQL integration' +doc_type: 'reference' --- import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; diff --git a/docs/integrations/data-sources/nats.md b/docs/integrations/data-sources/nats.md index afc17e6c816..be9eeb6a75a 100644 --- a/docs/integrations/data-sources/nats.md +++ b/docs/integrations/data-sources/nats.md @@ -4,6 +4,7 @@ sidebar_label: 'NATS' title: 'NATS' hide_title: true description: 'Page describing integration with the NATS engine' +doc_type: 'reference' --- import NatsEngine from '@site/docs/engines/table-engines/integrations/nats.md'; diff --git a/docs/integrations/data-sources/postgres.md b/docs/integrations/data-sources/postgres.md index 4d21b4728cb..6acb1d4a5fc 100644 --- a/docs/integrations/data-sources/postgres.md +++ b/docs/integrations/data-sources/postgres.md @@ -4,6 +4,7 @@ sidebar_label: 'PostgreSQL' title: 'PostgreSQL' hide_title: false description: 'Page describing how to integrate Postgres with ClickHouse' +doc_type: 'guide' --- import PostgreSQL from '@site/docs/integrations/data-ingestion/dbms/postgresql/connecting-to-postgresql.md'; diff --git a/docs/integrations/data-sources/rabbitmq.md b/docs/integrations/data-sources/rabbitmq.md index 893541f9aac..a8e66cea6e7 100644 --- a/docs/integrations/data-sources/rabbitmq.md +++ b/docs/integrations/data-sources/rabbitmq.md @@ -4,6 +4,7 @@ sidebar_label: 'RabbitMQ' title: 'RabbitMQ' hide_title: true description: 'Page describing the RabbitMQEngine integration' +doc_type: 'reference' --- import RabbitMQEngine from '@site/docs/engines/table-engines/integrations/rabbitmq.md'; diff --git a/docs/integrations/data-sources/redis.md b/docs/integrations/data-sources/redis.md index b47d08ccb1d..761e8278699 100644 --- a/docs/integrations/data-sources/redis.md +++ b/docs/integrations/data-sources/redis.md @@ -3,6 +3,7 @@ slug: /integrations/redis sidebar_label: 'Redis' title: 'Redis' description: 'Page describing the Redis table function' +doc_type: 'reference' --- import RedisFunction from '@site/docs/sql-reference/table-functions/redis.md'; diff --git a/docs/integrations/data-sources/rocksdb.md b/docs/integrations/data-sources/rocksdb.md index 0fbf91f611a..5be85cc2a07 100644 --- a/docs/integrations/data-sources/rocksdb.md +++ b/docs/integrations/data-sources/rocksdb.md @@ -4,6 +4,7 @@ sidebar_label: 'RocksDB' title: 'RocksDB' hide_title: true description: 'Page describing the RocksDBTableEngine' +doc_type: 'reference' --- import RocksDBTableEngine from '@site/docs/engines/table-engines/integrations/embedded-rocksdb.md'; diff --git a/docs/integrations/data-sources/sqlite.md b/docs/integrations/data-sources/sqlite.md index 7bb019c60fe..3b9fd71435b 100644 --- a/docs/integrations/data-sources/sqlite.md +++ b/docs/integrations/data-sources/sqlite.md @@ -4,6 +4,7 @@ sidebar_label: 'SQLite' title: 'SQLite' hide_title: true description: 'Page describing integration using the SQLite engine' +doc_type: 'reference' --- import SQLiteEngine from '@site/docs/engines/table-engines/integrations/sqlite.md'; diff --git a/docs/integrations/data-visualization/astrato-and-clickhouse.md b/docs/integrations/data-visualization/astrato-and-clickhouse.md index f47b6856129..2900a48daad 100644 --- a/docs/integrations/data-visualization/astrato-and-clickhouse.md +++ b/docs/integrations/data-visualization/astrato-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/astrato keywords: ['clickhouse', 'Power BI', 'connect', 'integrate', 'ui', 'data apps', 'data viz', 'embedded analytics', 'Astrato'] description: 'Astrato brings true Self-Service BI to Enterprises & Data Businesses by putting analytics in the hands of every user, enabling them to build their own dashboards, reports and data apps, enabling the answering of data questions without IT help. Astrato accelerates adoption, speeds up decision-making, and unifies analytics, embedded analytics, data input, and data apps in one platform. Astrato unites action and analytics in one, introduce live write-back, interact with ML models, accelerate your analytics with AI – go beyond dashboarding, thanks to pushdown SQL support in Astrato.' title: 'Connecting Astrato to ClickHouse' +doc_type: 'guide' --- import astrato_1_dataconnection from '@site/static/images/integrations/data-visualization/astrato_1_dataconnection.png'; diff --git a/docs/integrations/data-visualization/chartbrew-and-clickhouse.md b/docs/integrations/data-visualization/chartbrew-and-clickhouse.md index 21a6c30fbb5..27cc5e8bfc6 100644 --- a/docs/integrations/data-visualization/chartbrew-and-clickhouse.md +++ b/docs/integrations/data-visualization/chartbrew-and-clickhouse.md @@ -5,6 +5,7 @@ sidebar_position: 131 slug: /integrations/chartbrew-and-clickhouse keywords: ['ClickHouse', 'Chartbrew', 'connect', 'integrate', 'visualization'] description: 'Connect Chartbrew to ClickHouse to create real-time dashboards and client reports.' +doc_type: 'guide' --- import chartbrew_01 from '@site/static/images/integrations/data-visualization/chartbrew_01.png'; diff --git a/docs/integrations/data-visualization/deepnote.md b/docs/integrations/data-visualization/deepnote.md index 55a3d803e61..936c384ea62 100644 --- a/docs/integrations/data-visualization/deepnote.md +++ b/docs/integrations/data-visualization/deepnote.md @@ -5,6 +5,7 @@ slug: /integrations/deepnote keywords: ['clickhouse', 'Deepnote', 'connect', 'integrate', 'notebook'] description: 'Efficiently query very large datasets, analyzing and modeling in the comfort of known notebook environment.' title: 'Connect ClickHouse to Deepnote' +doc_type: 'guide' --- import deepnote_01 from '@site/static/images/integrations/data-visualization/deepnote_01.png'; diff --git a/docs/integrations/data-visualization/draxlr-and-clickhouse.md b/docs/integrations/data-visualization/draxlr-and-clickhouse.md index 1ded9c2f56e..b010bd07703 100644 --- a/docs/integrations/data-visualization/draxlr-and-clickhouse.md +++ b/docs/integrations/data-visualization/draxlr-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/draxlr keywords: ['clickhouse', 'Draxlr', 'connect', 'integrate', 'ui'] description: 'Draxlr is a Business intelligence tool with data visualization and analytics.' title: 'Connecting Draxlr to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/embeddable-and-clickhouse.md b/docs/integrations/data-visualization/embeddable-and-clickhouse.md index 2534cf523c5..9fb83005510 100644 --- a/docs/integrations/data-visualization/embeddable-and-clickhouse.md +++ b/docs/integrations/data-visualization/embeddable-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/embeddable keywords: ['clickhouse', 'Embeddable', 'connect', 'integrate', 'ui'] description: 'Embeddable is a developer toolkit for building fast, interactive, fully-custom analytics experiences directly into your app.' title: 'Connecting Embeddable to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/explo-and-clickhouse.md b/docs/integrations/data-visualization/explo-and-clickhouse.md index 2173ec92192..071a3b3a275 100644 --- a/docs/integrations/data-visualization/explo-and-clickhouse.md +++ b/docs/integrations/data-visualization/explo-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/explo keywords: ['clickhouse', 'Explo', 'connect', 'integrate', 'ui'] description: 'Explo is an easy-to-use, open source UI tool for asking questions about your data.' title: 'Connecting Explo to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/fabi-and-clickhouse.md b/docs/integrations/data-visualization/fabi-and-clickhouse.md index a22236a0018..878b66a3208 100644 --- a/docs/integrations/data-visualization/fabi-and-clickhouse.md +++ b/docs/integrations/data-visualization/fabi-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/fabi.ai keywords: ['clickhouse', 'Fabi.ai', 'connect', 'integrate', 'notebook', 'ui', 'analytics'] description: 'Fabi.ai is an all-in-one collaborate data analysis platform. You can leverage SQL, Python, AI, and no-code to build dashboard and data workflows faster than ever before' title: 'Connect ClickHouse to Fabi.ai' +doc_type: 'guide' --- import fabi_01 from '@site/static/images/integrations/data-visualization/fabi_01.png'; diff --git a/docs/integrations/data-visualization/grafana/config.md b/docs/integrations/data-visualization/grafana/config.md index fd2186d62f2..8acc6fd0d0b 100644 --- a/docs/integrations/data-visualization/grafana/config.md +++ b/docs/integrations/data-visualization/grafana/config.md @@ -4,6 +4,7 @@ sidebar_position: 3 slug: /integrations/grafana/config description: 'Configuration options for the ClickHouse data source plugin in Grafana' title: 'Configuring ClickHouse data source in Grafana' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/grafana/index.md b/docs/integrations/data-visualization/grafana/index.md index e0112629062..1f4ee182e47 100644 --- a/docs/integrations/data-visualization/grafana/index.md +++ b/docs/integrations/data-visualization/grafana/index.md @@ -5,6 +5,7 @@ slug: /integrations/grafana description: 'Introduction to using ClickHouse with Grafana' title: 'ClickHouse data source plugin for Grafana' show_related_blogs: true +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_native.md'; diff --git a/docs/integrations/data-visualization/grafana/query-builder.md b/docs/integrations/data-visualization/grafana/query-builder.md index be4d321a13c..8b934c57adf 100644 --- a/docs/integrations/data-visualization/grafana/query-builder.md +++ b/docs/integrations/data-visualization/grafana/query-builder.md @@ -4,6 +4,7 @@ sidebar_position: 2 slug: /integrations/grafana/query-builder description: 'Using the Query Builder in the ClickHouse Grafana plugin' title: 'Query Builder' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/hashboard-and-clickhouse.md b/docs/integrations/data-visualization/hashboard-and-clickhouse.md index 67af29908e8..429511071c0 100644 --- a/docs/integrations/data-visualization/hashboard-and-clickhouse.md +++ b/docs/integrations/data-visualization/hashboard-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/hashboard keywords: ['clickhouse', 'Hashboard', 'connect', 'integrate', 'ui', 'analytics'] description: 'Hashboard is a robust analytics platform that can be easily integrated with ClickHouse for real-time data analysis.' title: 'Connecting ClickHouse to Hashboard' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_native.md'; diff --git a/docs/integrations/data-visualization/index.md b/docs/integrations/data-visualization/index.md index 0e32a3ed2bd..7f18ec5c05d 100644 --- a/docs/integrations/data-visualization/index.md +++ b/docs/integrations/data-visualization/index.md @@ -5,6 +5,7 @@ keywords: ['ClickHouse', 'connect', 'Luzmo', 'Explo', 'Fabi.ai', 'Tableau', 'Gra title: 'Visualizing Data in ClickHouse' slug: /integrations/data-visualization description: 'Learn about Visualizing Data in ClickHouse' +doc_type: 'guide' --- # Visualizing data in ClickHouse diff --git a/docs/integrations/data-visualization/looker-and-clickhouse.md b/docs/integrations/data-visualization/looker-and-clickhouse.md index acee94b3457..cc3be8c1055 100644 --- a/docs/integrations/data-visualization/looker-and-clickhouse.md +++ b/docs/integrations/data-visualization/looker-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/looker keywords: ['clickhouse', 'looker', 'connect', 'integrate', 'ui'] description: 'Looker is an enterprise platform for BI, data applications, and embedded analytics that helps you explore and share insights in real time.' title: 'Looker' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/looker-studio-and-clickhouse.md b/docs/integrations/data-visualization/looker-studio-and-clickhouse.md index b9ec7d7c97a..07590cf70d6 100644 --- a/docs/integrations/data-visualization/looker-studio-and-clickhouse.md +++ b/docs/integrations/data-visualization/looker-studio-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/lookerstudio keywords: ['clickhouse', 'looker', 'studio', 'connect', 'mysql', 'integrate', 'ui'] description: 'Looker Studio, formerly Google Data Studio, is an online tool for converting data into customizable informative reports and dashboards.' title: 'Looker Studio' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/luzmo-and-clickhouse.md b/docs/integrations/data-visualization/luzmo-and-clickhouse.md index 2e3fff028a5..93b5b8fd4ce 100644 --- a/docs/integrations/data-visualization/luzmo-and-clickhouse.md +++ b/docs/integrations/data-visualization/luzmo-and-clickhouse.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'Luzmo', 'connect', 'integrate', 'ui', 'embedded'] description: 'Luzmo is an embedded analytics platform with a native ClickHouse integration, purpose-built for Software and SaaS applications.' title: 'Integrating Luzmo with ClickHouse' sidebar: 'integrations' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/metabase-and-clickhouse.md b/docs/integrations/data-visualization/metabase-and-clickhouse.md index d621c11cb9d..93cde69c5d3 100644 --- a/docs/integrations/data-visualization/metabase-and-clickhouse.md +++ b/docs/integrations/data-visualization/metabase-and-clickhouse.md @@ -6,6 +6,7 @@ keywords: ['Metabase'] description: 'Metabase is an easy-to-use, open source UI tool for asking questions about your data.' title: 'Connecting Metabase to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/mitzu-and-clickhouse.md b/docs/integrations/data-visualization/mitzu-and-clickhouse.md index 6dc80d9a9f7..97e83b62594 100644 --- a/docs/integrations/data-visualization/mitzu-and-clickhouse.md +++ b/docs/integrations/data-visualization/mitzu-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/mitzu keywords: ['clickhouse', 'Mitzu', 'connect', 'integrate', 'ui'] description: 'Mitzu is a no-code warehouse-native product analytics application.' title: 'Connecting Mitzu to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/omni-and-clickhouse.md b/docs/integrations/data-visualization/omni-and-clickhouse.md index d3ddcaa9789..267e8f5a514 100644 --- a/docs/integrations/data-visualization/omni-and-clickhouse.md +++ b/docs/integrations/data-visualization/omni-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/omni keywords: ['clickhouse', 'Omni', 'connect', 'integrate', 'ui'] description: 'Omni is an enterprise platform for BI, data applications, and embedded analytics that helps you explore and share insights in real time.' title: 'Omni' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/powerbi-and-clickhouse.md b/docs/integrations/data-visualization/powerbi-and-clickhouse.md index ea93ada5b08..82a5f578a32 100644 --- a/docs/integrations/data-visualization/powerbi-and-clickhouse.md +++ b/docs/integrations/data-visualization/powerbi-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/powerbi keywords: ['clickhouse', 'Power BI', 'connect', 'integrate', 'ui'] description: 'Microsoft Power BI is an interactive data visualization software product developed by Microsoft with a primary focus on business intelligence.' title: 'Power BI' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/quicksight-and-clickhouse.md b/docs/integrations/data-visualization/quicksight-and-clickhouse.md index 303c3c60279..47cbf7806ff 100644 --- a/docs/integrations/data-visualization/quicksight-and-clickhouse.md +++ b/docs/integrations/data-visualization/quicksight-and-clickhouse.md @@ -4,6 +4,7 @@ slug: /integrations/quicksight keywords: ['clickhouse', 'aws', 'amazon', 'QuickSight', 'mysql', 'connect', 'integrate', 'ui'] description: 'Amazon QuickSight powers data-driven organizations with unified business intelligence (BI).' title: 'QuickSight' +doc_type: 'guide' --- import MySQLOnPremiseSetup from '@site/docs/_snippets/_clickhouse_mysql_on_premise_setup.mdx'; diff --git a/docs/integrations/data-visualization/rocketbi-and-clickhouse.md b/docs/integrations/data-visualization/rocketbi-and-clickhouse.md index cacdc3acc3b..cf43ecea971 100644 --- a/docs/integrations/data-visualization/rocketbi-and-clickhouse.md +++ b/docs/integrations/data-visualization/rocketbi-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/rocketbi keywords: ['clickhouse', 'RocketBI', 'connect', 'integrate', 'ui'] description: 'RocketBI is a self-service business intelligence platform that helps you quickly analyze data, build drag-n-drop visualizations and collaborate with colleagues right on your web browser.' title: 'GOAL: BUILD YOUR 1ST DASHBOARD' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/splunk-and-clickhouse.md b/docs/integrations/data-visualization/splunk-and-clickhouse.md index 9da898cfcb7..a8c65cf8626 100644 --- a/docs/integrations/data-visualization/splunk-and-clickhouse.md +++ b/docs/integrations/data-visualization/splunk-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/splunk keywords: ['Splunk', 'integration', 'data visualization'] description: 'Connect Splunk dashboards to ClickHouse' title: 'Connecting Splunk to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/superset-and-clickhouse.md b/docs/integrations/data-visualization/superset-and-clickhouse.md index 8753506afda..e842b9214da 100644 --- a/docs/integrations/data-visualization/superset-and-clickhouse.md +++ b/docs/integrations/data-visualization/superset-and-clickhouse.md @@ -6,6 +6,7 @@ keywords: ['superset'] description: 'Apache Superset is an open-source data exploration and visualization platform.' title: 'Connect Superset to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/data-visualization/tableau/tableau-analysis-tips.md b/docs/integrations/data-visualization/tableau/tableau-analysis-tips.md index 0dfa9535dc3..dd08d3cbded 100644 --- a/docs/integrations/data-visualization/tableau/tableau-analysis-tips.md +++ b/docs/integrations/data-visualization/tableau/tableau-analysis-tips.md @@ -5,6 +5,7 @@ slug: /integrations/tableau/analysis-tips keywords: ['clickhouse', 'tableau', 'online', 'mysql', 'connect', 'integrate', 'ui'] description: 'Tableau analysis tips when using ClickHouse official connector.' title: 'Analysis tips' +doc_type: 'guide' --- # Analysis tips diff --git a/docs/integrations/data-visualization/tableau/tableau-and-clickhouse.md b/docs/integrations/data-visualization/tableau/tableau-and-clickhouse.md index b931b7eb189..99adb55708d 100644 --- a/docs/integrations/data-visualization/tableau/tableau-and-clickhouse.md +++ b/docs/integrations/data-visualization/tableau/tableau-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/tableau keywords: ['clickhouse', 'tableau', 'connect', 'integrate', 'ui'] description: 'Tableau can use ClickHouse databases and tables as a data source.' title: 'Connecting Tableau to ClickHouse' +doc_type: 'guide' --- import TOCInline from '@theme/TOCInline'; diff --git a/docs/integrations/data-visualization/tableau/tableau-connection-tips.md b/docs/integrations/data-visualization/tableau/tableau-connection-tips.md index 3392c21dc1c..71df9e5f76b 100644 --- a/docs/integrations/data-visualization/tableau/tableau-connection-tips.md +++ b/docs/integrations/data-visualization/tableau/tableau-connection-tips.md @@ -5,6 +5,7 @@ slug: /integrations/tableau/connection-tips keywords: ['clickhouse', 'tableau', 'online', 'mysql', 'connect', 'integrate', 'ui'] description: 'Tableau connection tips when using ClickHouse official connector.' title: 'Connection tips' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/data-visualization/tableau/tableau-online-and-clickhouse.md b/docs/integrations/data-visualization/tableau/tableau-online-and-clickhouse.md index 3f722896b8a..7d3dcdd5636 100644 --- a/docs/integrations/data-visualization/tableau/tableau-online-and-clickhouse.md +++ b/docs/integrations/data-visualization/tableau/tableau-online-and-clickhouse.md @@ -5,6 +5,7 @@ slug: /integrations/tableau-online keywords: ['clickhouse', 'tableau', 'online', 'mysql', 'connect', 'integrate', 'ui'] description: 'Tableau Online streamlines the power of data to make people faster and more confident decision makers from anywhere.' title: 'Tableau Online' +doc_type: 'guide' --- import MySQLCloudSetup from '@site/docs/_snippets/_clickhouse_mysql_cloud_setup.mdx'; diff --git a/docs/integrations/data-visualization/zingdata-and-clickhouse.md b/docs/integrations/data-visualization/zingdata-and-clickhouse.md index 431509786c1..33011e68f42 100644 --- a/docs/integrations/data-visualization/zingdata-and-clickhouse.md +++ b/docs/integrations/data-visualization/zingdata-and-clickhouse.md @@ -6,6 +6,7 @@ keywords: ['Zing Data'] description: 'Zing Data is simple social business intelligence for ClickHouse, made for iOS, Android and the web.' title: 'Connect Zing Data to ClickHouse' show_related_blogs: true +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/language-clients/csharp.md b/docs/integrations/language-clients/csharp.md index 97c11abc56c..cc7fd3274ea 100644 --- a/docs/integrations/language-clients/csharp.md +++ b/docs/integrations/language-clients/csharp.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'cs', 'c#', '.net', 'dotnet', 'csharp', 'client', 'driv slug: /integrations/csharp description: 'The official C# client for connecting to ClickHouse.' title: 'ClickHouse C# Driver' +doc_type: 'guide' --- # ClickHouse C# Client diff --git a/docs/integrations/language-clients/go/index.md b/docs/integrations/language-clients/go/index.md index 614ce309363..624dbb35650 100644 --- a/docs/integrations/language-clients/go/index.md +++ b/docs/integrations/language-clients/go/index.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'go', 'client', 'golang'] slug: /integrations/go description: 'The Go clients for ClickHouse allows users to connect to ClickHouse using either the Go standard database/sql interface or an optimized native interface.' title: 'ClickHouse Go' +doc_type: 'reference' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_native.md'; diff --git a/docs/integrations/language-clients/index.md b/docs/integrations/language-clients/index.md index 3f3db2e10cc..239f498fd1a 100644 --- a/docs/integrations/language-clients/index.md +++ b/docs/integrations/language-clients/index.md @@ -3,6 +3,7 @@ slug: /integrations/language-clients title: 'Language Clients' description: 'Table of contents page for Language Clients.' keywords: ['Language Clients', 'C++', 'Go', 'JavaScript', 'Java', 'Python', 'Rust'] +doc_type: 'landing-page' --- In this section of the documentation, you can learn more about the many language client integrations diff --git a/docs/integrations/language-clients/java/index.md b/docs/integrations/language-clients/java/index.md index 216af1f7585..b816ab32529 100644 --- a/docs/integrations/language-clients/java/index.md +++ b/docs/integrations/language-clients/java/index.md @@ -3,6 +3,7 @@ title: 'Java' keywords: ['clickhouse', 'java', 'jdbc', 'client', 'integrate', 'r2dbc'] description: 'Options for connecting to ClickHouse from Java' slug: /integrations/java +doc_type: 'reference' --- import Tabs from '@theme/Tabs'; diff --git a/docs/integrations/language-clients/java/r2dbc.md b/docs/integrations/language-clients/java/r2dbc.md index c420f26484a..6ad36d9f3bc 100644 --- a/docs/integrations/language-clients/java/r2dbc.md +++ b/docs/integrations/language-clients/java/r2dbc.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'java', 'driver', 'integrate', 'r2dbc'] description: 'ClickHouse R2DBC Driver' slug: /integrations/java/r2dbc title: 'R2DBC driver' +doc_type: 'reference' --- import Tabs from '@theme/Tabs'; diff --git a/docs/integrations/language-clients/js.md b/docs/integrations/language-clients/js.md index a1a8172092f..aa5ba02650c 100644 --- a/docs/integrations/language-clients/js.md +++ b/docs/integrations/language-clients/js.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'js', 'JavaScript', 'NodeJS', 'web', 'browser', 'Cloudf slug: /integrations/javascript description: 'The official JS client for connecting to ClickHouse.' title: 'ClickHouse JS' +doc_type: 'reference' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/language-clients/moose-olap.md b/docs/integrations/language-clients/moose-olap.md index 987418e76f6..6d6458e0ca9 100644 --- a/docs/integrations/language-clients/moose-olap.md +++ b/docs/integrations/language-clients/moose-olap.md @@ -5,6 +5,7 @@ sidebar_position: 25 slug: /interfaces/third-party/moose-olap title: 'Developing on ClickHouse with Moose OLAP' keywords: ['Moose'] +doc_type: 'guide' --- import CommunityMaintainedBadge from '@theme/badges/CommunityMaintained'; diff --git a/docs/integrations/language-clients/python/index.md b/docs/integrations/language-clients/python/index.md index edeae79d993..c26b5698978 100644 --- a/docs/integrations/language-clients/python/index.md +++ b/docs/integrations/language-clients/python/index.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'python', 'client', 'connect', 'integrate'] slug: /integrations/python description: 'The ClickHouse Connect project suite for connecting Python to ClickHouse' title: 'Python Integration with ClickHouse Connect' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/language-clients/rust.md b/docs/integrations/language-clients/rust.md index 9c57ed8c567..09592eab3f2 100644 --- a/docs/integrations/language-clients/rust.md +++ b/docs/integrations/language-clients/rust.md @@ -5,6 +5,7 @@ keywords: ['clickhouse', 'rs', 'rust', 'cargo', 'crate', 'http', 'client', 'conn slug: /integrations/rust description: 'The official Rust client for connecting to ClickHouse.' title: 'ClickHouse Rust Client' +doc_type: 'reference' --- # ClickHouse Rust client diff --git a/docs/integrations/misc/index.md b/docs/integrations/misc/index.md index cf0c7a6c583..a05f2d55af1 100644 --- a/docs/integrations/misc/index.md +++ b/docs/integrations/misc/index.md @@ -3,6 +3,7 @@ slug: /integrations/misc keywords: ['Retool', 'Easypanel', 'Splunk'] title: 'Tools' description: 'Landing page for the Tools section' +doc_type: 'landing-page' --- # Tools diff --git a/docs/integrations/sql-clients/datagrip.md b/docs/integrations/sql-clients/datagrip.md index 11f33769bff..6cfe1bb4039 100644 --- a/docs/integrations/sql-clients/datagrip.md +++ b/docs/integrations/sql-clients/datagrip.md @@ -3,6 +3,7 @@ sidebar_label: 'DataGrip' slug: /integrations/datagrip description: 'DataGrip is a database IDE that supports ClickHouse out of the box.' title: 'Connecting DataGrip to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/sql-clients/dbeaver.md b/docs/integrations/sql-clients/dbeaver.md index 8e5b5bfee6e..e8cbe7337ef 100644 --- a/docs/integrations/sql-clients/dbeaver.md +++ b/docs/integrations/sql-clients/dbeaver.md @@ -3,6 +3,7 @@ slug: /integrations/dbeaver sidebar_label: 'DBeaver' description: 'DBeaver is a multi-platform database tool.' title: 'Connect DBeaver to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/sql-clients/dbvisualizer.md b/docs/integrations/sql-clients/dbvisualizer.md index 78901286134..35478e8b0b5 100644 --- a/docs/integrations/sql-clients/dbvisualizer.md +++ b/docs/integrations/sql-clients/dbvisualizer.md @@ -3,6 +3,7 @@ sidebar_label: 'DbVisualizer' slug: /integrations/dbvisualizer description: 'DbVisualizer is a database tool with extended support for ClickHouse.' title: 'Connecting DbVisualizer to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/sql-clients/index.md b/docs/integrations/sql-clients/index.md index 46f9c26296b..1724ffe050c 100644 --- a/docs/integrations/sql-clients/index.md +++ b/docs/integrations/sql-clients/index.md @@ -3,6 +3,7 @@ slug: /integrations/sql-clients/ description: 'Overview page for ClickHouse SQL clients.' keywords: ['integrations', 'DataGrip', 'DBeaver', 'DbVisualizer', 'Jupyter Notebooks', 'QStudio', 'TABLUM.IO', 'marimo'] title: 'SQL Client Integrations' +doc_type: 'landing-page' --- # SQL client integrations diff --git a/docs/integrations/sql-clients/jupysql.md b/docs/integrations/sql-clients/jupysql.md index ee2eea15c05..b1663e76575 100644 --- a/docs/integrations/sql-clients/jupysql.md +++ b/docs/integrations/sql-clients/jupysql.md @@ -3,6 +3,7 @@ slug: /integrations/jupysql sidebar_label: 'Jupyter notebooks' description: 'JupySQL is a multi-platform database tool for Jupyter.' title: 'Using JupySQL with ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/sql-clients/marimo.md b/docs/integrations/sql-clients/marimo.md index cff3817d3a8..ed12d9085de 100644 --- a/docs/integrations/sql-clients/marimo.md +++ b/docs/integrations/sql-clients/marimo.md @@ -3,6 +3,7 @@ slug: /integrations/marimo sidebar_label: 'marimo' description: 'marimo is a next-generation Python notebook for interacting with data' title: 'Using marimo with ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/sql-clients/qstudio.md b/docs/integrations/sql-clients/qstudio.md index 4f0faa45fe1..f1edc42ec82 100644 --- a/docs/integrations/sql-clients/qstudio.md +++ b/docs/integrations/sql-clients/qstudio.md @@ -3,6 +3,7 @@ slug: /integrations/qstudio sidebar_label: 'QStudio' description: 'QStudio is a free SQL tool.' title: 'Connect QStudio to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/sql-clients/sql-console.md b/docs/integrations/sql-clients/sql-console.md index f2a9f4825eb..92576f98007 100644 --- a/docs/integrations/sql-clients/sql-console.md +++ b/docs/integrations/sql-clients/sql-console.md @@ -4,6 +4,7 @@ sidebar_position: 1 title: 'SQL Console' slug: /integrations/sql-clients/sql-console description: 'Learn about SQL Console' +doc_type: 'guide' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/integrations/sql-clients/tablum.md b/docs/integrations/sql-clients/tablum.md index 60f671ea7f6..3dcd100d2dc 100644 --- a/docs/integrations/sql-clients/tablum.md +++ b/docs/integrations/sql-clients/tablum.md @@ -3,6 +3,7 @@ sidebar_label: 'TABLUM.IO' slug: /integrations/tablumio description: 'TABLUM.IO is a data management SaaS that supports ClickHouse out of the box.' title: 'Connecting TABLUM.IO to ClickHouse' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/tools/data-integration/easypanel/index.md b/docs/integrations/tools/data-integration/easypanel/index.md index 14f97a28899..f0ac1717b67 100644 --- a/docs/integrations/tools/data-integration/easypanel/index.md +++ b/docs/integrations/tools/data-integration/easypanel/index.md @@ -4,6 +4,7 @@ slug: /integrations/easypanel keywords: ['clickhouse', 'Easypanel', 'deployment', 'integrate', 'install'] description: 'You can use it to deploy ClickHouse on your own server.' title: 'Deploying ClickHouse on Easypanel' +doc_type: 'guide' --- import CommunityMaintainedBadge from '@theme/badges/CommunityMaintained'; diff --git a/docs/integrations/tools/data-integration/index.md b/docs/integrations/tools/data-integration/index.md index c62c99f45e2..0b42e03cd7a 100644 --- a/docs/integrations/tools/data-integration/index.md +++ b/docs/integrations/tools/data-integration/index.md @@ -3,6 +3,7 @@ slug: /integrations/tools/data-integrations keywords: ['Retool', 'Easypanel', 'Splunk'] title: 'Data Integrations' description: 'Landing page for the data integrations section' +doc_type: 'landing-page' --- # Data Integrations diff --git a/docs/integrations/tools/data-integration/retool/index.md b/docs/integrations/tools/data-integration/retool/index.md index dc7bfba9642..a33567b4111 100644 --- a/docs/integrations/tools/data-integration/retool/index.md +++ b/docs/integrations/tools/data-integration/retool/index.md @@ -4,6 +4,7 @@ slug: /integrations/retool keywords: ['clickhouse', 'retool', 'connect', 'integrate', 'ui', 'admin', 'panel', 'dashboard', 'nocode', 'no-code'] description: 'Quickly build web and mobile apps with rich user interfaces, automate complex tasks, and integrate AI—all powered by your data.' title: 'Connecting Retool to ClickHouse' +doc_type: 'guide' --- import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; diff --git a/docs/integrations/tools/data-integration/splunk/index.md b/docs/integrations/tools/data-integration/splunk/index.md index 8b840ccbda7..f57228f0fa7 100644 --- a/docs/integrations/tools/data-integration/splunk/index.md +++ b/docs/integrations/tools/data-integration/splunk/index.md @@ -4,6 +4,7 @@ slug: /integrations/audit-splunk keywords: ['clickhouse', 'Splunk', 'audit', 'cloud'] description: 'Store ClickHouse Cloud audit logs into Splunk.' title: 'Storing ClickHouse Cloud Audit logs into Splunk' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/integrations/tools/index.md b/docs/integrations/tools/index.md index 890fc562879..b100e363480 100644 --- a/docs/integrations/tools/index.md +++ b/docs/integrations/tools/index.md @@ -3,6 +3,7 @@ slug: /integrations/tools keywords: ['Retool', 'Easypanel', 'Splunk'] title: 'Tools' description: 'Landing page for the tools section' +doc_type: 'landing-page' --- # Tools diff --git a/docs/intro.md b/docs/intro.md index fa8a1703a4e..908954e6dc5 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -3,6 +3,7 @@ slug: /intro sidebar_label: 'What is ClickHouse?' description: 'ClickHouse® is a column-oriented SQL database management system (DBMS) for online analytical processing (OLAP). It is available as both an open-source software and a cloud offering.' title: 'What is ClickHouse?' +doc_type: 'guide' --- import column_example from '@site/static/images/column-oriented-example-query.png'; diff --git a/docs/introduction-index.md b/docs/introduction-index.md index 5dabdd96f96..64d1e4ffdd7 100644 --- a/docs/introduction-index.md +++ b/docs/introduction-index.md @@ -3,6 +3,7 @@ slug: /introduction-clickhouse title: 'Introduction' description: 'Landing page for Introduction' pagination_next: null +doc_type: 'landing-page' --- Welcome to ClickHouse! Check out the pages below to learn how to get up and running with ClickHouse - the fastest and most resource efficient real-time data warehouse and open-source database. diff --git a/docs/managing-data/core-concepts/index.md b/docs/managing-data/core-concepts/index.md index 5401c0d261d..0746062a97f 100644 --- a/docs/managing-data/core-concepts/index.md +++ b/docs/managing-data/core-concepts/index.md @@ -3,6 +3,7 @@ slug: /managing-data/core-concepts title: 'Core Concepts' description: 'Learn Core Concepts of how ClickHouse works' keywords: ['concepts', 'part', 'partition', 'primary index'] +doc_type: 'guide' --- In this section of the documentation, diff --git a/docs/managing-data/core-concepts/parts.md b/docs/managing-data/core-concepts/parts.md index 6cb42df5874..22860ea4265 100644 --- a/docs/managing-data/core-concepts/parts.md +++ b/docs/managing-data/core-concepts/parts.md @@ -3,6 +3,7 @@ slug: /parts title: 'Table parts' description: 'What are data parts in ClickHouse' keywords: ['part'] +doc_type: 'reference' --- import merges from '@site/static/images/managing-data/core-concepts/merges.png'; diff --git a/docs/managing-data/deleting-data/index.md b/docs/managing-data/deleting-data/index.md index a02d3dae796..2584070683d 100644 --- a/docs/managing-data/deleting-data/index.md +++ b/docs/managing-data/deleting-data/index.md @@ -3,6 +3,7 @@ slug: /managing-data/deleting-data/overview title: 'Deleting Data' description: 'How to delete data in ClickHouse Table Of Contents' keywords: ['delete', 'truncate', 'drop', 'lightweight delete'] +doc_type: 'guide' --- In this section of the documentation, diff --git a/docs/managing-data/truncate.md b/docs/managing-data/truncate.md index d3a2a0409d3..6f8f89408c8 100644 --- a/docs/managing-data/truncate.md +++ b/docs/managing-data/truncate.md @@ -4,6 +4,7 @@ sidebar_label: 'Truncate Table' title: 'Truncate Table' hide_title: false description: 'Truncate allows the data in a table or database to be removed, while preserving their existence.' +doc_type: 'reference' --- Truncate allows the data in a table or database to be removed, while preserving their existence. This is a lightweight operation which cannot be reversed. diff --git a/docs/managing-data/updating-data/index.md b/docs/managing-data/updating-data/index.md index fc1f07c6af2..7ee4b24f241 100644 --- a/docs/managing-data/updating-data/index.md +++ b/docs/managing-data/updating-data/index.md @@ -3,6 +3,7 @@ slug: /updating-data title: 'Updating Data' description: 'Updating Data Table Of Contents' keywords: ['update', 'updating data'] +doc_type: 'landing-page' --- In this section of the documentation, you will learn how you can update your data. diff --git a/docs/materialized-view/incremental-materialized-view.md b/docs/materialized-view/incremental-materialized-view.md index 18e3f8871aa..947c4434acf 100644 --- a/docs/materialized-view/incremental-materialized-view.md +++ b/docs/materialized-view/incremental-materialized-view.md @@ -4,6 +4,7 @@ title: 'Incremental materialized view' description: 'How to use incremental materialized views to speed up queries' keywords: ['incremental materialized views', 'speed up queries', 'query optimization'] score: 10000 +doc_type: 'guide' --- import materializedViewDiagram from '@site/static/images/materialized-view/materialized-view-diagram.png'; diff --git a/docs/materialized-view/index.md b/docs/materialized-view/index.md index 6976401a192..1dd82f8a319 100644 --- a/docs/materialized-view/index.md +++ b/docs/materialized-view/index.md @@ -3,6 +3,7 @@ slug: /materialized-views title: 'Materialized Views' description: 'Index page for materialized views' keywords: ['materialized views', 'speed up queries', 'query optimization', 'refreshable', 'incremental'] +doc_type: 'landing-page' --- | Page | Description | diff --git a/docs/materialized-view/refreshable-materialized-view.md b/docs/materialized-view/refreshable-materialized-view.md index 36d7a0b8f2c..cd7bc990192 100644 --- a/docs/materialized-view/refreshable-materialized-view.md +++ b/docs/materialized-view/refreshable-materialized-view.md @@ -3,6 +3,7 @@ slug: /materialized-view/refreshable-materialized-view title: 'Refreshable materialized view' description: 'How to use materialized views to speed up queries' keywords: ['refreshable materialized view', 'refresh', 'materialized views', 'speed up queries', 'query optimization'] +doc_type: 'guide' --- import refreshableMaterializedViewDiagram from '@site/static/images/materialized-view/refreshable-materialized-view-diagram.png'; diff --git a/docs/native-protocol/basics.md b/docs/native-protocol/basics.md index 7f77395a518..0c36c53b86a 100644 --- a/docs/native-protocol/basics.md +++ b/docs/native-protocol/basics.md @@ -3,6 +3,7 @@ slug: /native-protocol/basics sidebar_position: 1 title: 'Basics' description: 'Native protocol basics' +doc_type: 'guide' --- # Basics diff --git a/docs/native-protocol/client.md b/docs/native-protocol/client.md index 5fe29e134f4..d8734c2da86 100644 --- a/docs/native-protocol/client.md +++ b/docs/native-protocol/client.md @@ -3,6 +3,7 @@ slug: /native-protocol/client sidebar_position: 2 title: 'Native client packets' description: 'Native protocol client' +doc_type: 'reference' --- # Client packets diff --git a/docs/native-protocol/columns.md b/docs/native-protocol/columns.md index e0b65368ac0..ffb36c9c414 100644 --- a/docs/native-protocol/columns.md +++ b/docs/native-protocol/columns.md @@ -3,6 +3,7 @@ slug: /native-protocol/columns sidebar_position: 4 title: 'Column types' description: 'Column types for the native protocol' +doc_type: 'reference' --- # Column types diff --git a/docs/native-protocol/hash.md b/docs/native-protocol/hash.md index 3de9ac70315..55d14907cb1 100644 --- a/docs/native-protocol/hash.md +++ b/docs/native-protocol/hash.md @@ -3,6 +3,7 @@ slug: /native-protocol/hash sidebar_position: 5 title: 'CityHash' description: 'Native protocol hash' +doc_type: 'reference' --- # CityHash diff --git a/docs/native-protocol/server.md b/docs/native-protocol/server.md index f3503a425b0..560be1e9695 100644 --- a/docs/native-protocol/server.md +++ b/docs/native-protocol/server.md @@ -3,6 +3,7 @@ slug: /native-protocol/server sidebar_position: 3 title: 'Server packets' description: 'Native protocol server' +doc_type: 'reference' --- # Server packets diff --git a/docs/starter-guides/index.md b/docs/starter-guides/index.md index feb98f67f63..995fad09b37 100644 --- a/docs/starter-guides/index.md +++ b/docs/starter-guides/index.md @@ -4,6 +4,7 @@ title: 'Starter Guides' description: 'Landing page for starter guides' pagination_prev: null pagination_next: null +doc_type: 'landing-page' --- In this section of the docs you'll find starter guides for common SQL queries: `CREATE`, `INSERT`, `SELECT`, and mutations `UPDATE` and `DELETE`. diff --git a/docs/tips-and-tricks/community-wisdom.md b/docs/tips-and-tricks/community-wisdom.md index ce41c2efd49..e6191cbba2c 100644 --- a/docs/tips-and-tricks/community-wisdom.md +++ b/docs/tips-and-tricks/community-wisdom.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /tips-and-tricks/community-wisdom sidebar_label: 'Community Wisdom' -doc_type: 'overview' +doc_type: 'landing-page' keywords: [ 'database tips', 'community wisdom', diff --git a/docs/tips-and-tricks/cost-optimization.md b/docs/tips-and-tricks/cost-optimization.md index a302275e4a5..4e35e77bee5 100644 --- a/docs/tips-and-tricks/cost-optimization.md +++ b/docs/tips-and-tricks/cost-optimization.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /community-wisdom/cost-optimization sidebar_label: 'Cost Optimization' -doc_type: 'how-to-guide' +doc_type: 'guide' keywords: [ 'cost optimization', 'storage costs', diff --git a/docs/tips-and-tricks/debugging-insights.md b/docs/tips-and-tricks/debugging-insights.md index 4dc45937519..3c0e4ac0b85 100644 --- a/docs/tips-and-tricks/debugging-insights.md +++ b/docs/tips-and-tricks/debugging-insights.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /community-wisdom/debugging-insights sidebar_label: 'Debugging Insights' -doc_type: 'how-to-guide' +doc_type: 'guide' keywords: [ 'clickhouse troubleshooting', 'clickhouse errors', diff --git a/docs/tips-and-tricks/materialized-views.md b/docs/tips-and-tricks/materialized-views.md index 38bc0d32d5b..7a5338cc79e 100644 --- a/docs/tips-and-tricks/materialized-views.md +++ b/docs/tips-and-tricks/materialized-views.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /tips-and-tricks/materialized-views sidebar_label: 'Materialized Views' -doc_type: 'how-to' +doc_type: 'guide' keywords: [ 'clickhouse materialized views', 'materialized view optimization', diff --git a/docs/tips-and-tricks/performance-optimization.md b/docs/tips-and-tricks/performance-optimization.md index d0e39924ba0..d2b39a83a38 100644 --- a/docs/tips-and-tricks/performance-optimization.md +++ b/docs/tips-and-tricks/performance-optimization.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /community-wisdom/performance-optimization sidebar_label: 'Performance Optimization' -doc_type: 'how-to-guide' +doc_type: 'guide' keywords: [ 'performance optimization', 'query performance', diff --git a/docs/tips-and-tricks/success-stories.md b/docs/tips-and-tricks/success-stories.md index c8104a136d6..f474f2b249e 100644 --- a/docs/tips-and-tricks/success-stories.md +++ b/docs/tips-and-tricks/success-stories.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /community-wisdom/creative-use-cases sidebar_label: 'Success Stories' -doc_type: 'how-to-guide' +doc_type: 'guide' keywords: [ 'clickhouse creative use cases', 'clickhouse success stories', diff --git a/docs/tips-and-tricks/too-many-parts.md b/docs/tips-and-tricks/too-many-parts.md index e721e0733d3..6b805dd6bdb 100644 --- a/docs/tips-and-tricks/too-many-parts.md +++ b/docs/tips-and-tricks/too-many-parts.md @@ -2,7 +2,7 @@ sidebar_position: 1 slug: /tips-and-tricks/too-many-parts sidebar_label: 'Too Many Parts' -doc_type: 'how-to' +doc_type: 'guide' keywords: [ 'clickhouse too many parts', 'too many parts error', diff --git a/docs/tools-and-utilities/static-files-disk-uploader.md b/docs/tools-and-utilities/static-files-disk-uploader.md index 3de2afe1cd1..c78b8ecaa9d 100644 --- a/docs/tools-and-utilities/static-files-disk-uploader.md +++ b/docs/tools-and-utilities/static-files-disk-uploader.md @@ -3,6 +3,7 @@ slug: /operations/utilities/static-files-disk-uploader title: 'clickhouse-static-files-disk-uploader' keywords: ['clickhouse-static-files-disk-uploader', 'utility', 'disk', 'uploader'] description: 'Provides a description of the clickhouse-static-files-disk-uploader utility' +doc_type: 'guide' --- # clickhouse-static-files-disk-uploader diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/index.md index a85f66cdf8b..ba06869b670 100644 --- a/docs/troubleshooting/index.md +++ b/docs/troubleshooting/index.md @@ -1,7 +1,7 @@ --- slug: /troubleshooting sidebar_label: 'Troubleshooting' -doc_type: 'reference' +doc_type: 'guide' keywords: [ 'clickhouse troubleshooting', 'clickhouse errors', diff --git a/docs/tutorial.md b/docs/tutorial.md index 73c0b627f8d..98cfc8224eb 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -6,6 +6,7 @@ description: 'Learn how to ingest and query data in ClickHouse using a New York sidebar_position: 0.5 keywords: ['clickhouse', 'install', 'tutorial', 'dictionary', 'dictionaries', 'example', 'advanced', 'taxi', 'new york', 'nyc'] show_related_blogs: true +doc_type: 'guide' --- # Advanced Tutorial diff --git a/docs/use-cases/AI_ML/MCP/01_remote_mcp.md b/docs/use-cases/AI_ML/MCP/01_remote_mcp.md index 96fb158aa7d..a8599a8f179 100644 --- a/docs/use-cases/AI_ML/MCP/01_remote_mcp.md +++ b/docs/use-cases/AI_ML/MCP/01_remote_mcp.md @@ -8,6 +8,7 @@ description: 'This guide explains how to enable and use the ClickHouse Cloud Rem keywords: ['AI', 'ClickHouse Cloud', 'MCP'] show_related_blogs: true sidebar_position: 1 +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/02_claude-desktop.md b/docs/use-cases/AI_ML/MCP/02_claude-desktop.md index dc822b5615f..664900e0b36 100644 --- a/docs/use-cases/AI_ML/MCP/02_claude-desktop.md +++ b/docs/use-cases/AI_ML/MCP/02_claude-desktop.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to set up Claude Desktop with a ClickHouse MCP server.' keywords: ['AI', 'Librechat', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/03_librechat.md b/docs/use-cases/AI_ML/MCP/03_librechat.md index f2c88b8a5e9..90ec522f813 100644 --- a/docs/use-cases/AI_ML/MCP/03_librechat.md +++ b/docs/use-cases/AI_ML/MCP/03_librechat.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to set up LibreChat with a ClickHouse MCP server using Docker.' keywords: ['AI', 'Librechat', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/04_anythingllm.md b/docs/use-cases/AI_ML/MCP/04_anythingllm.md index bb3370069f7..bdc8894fd5a 100644 --- a/docs/use-cases/AI_ML/MCP/04_anythingllm.md +++ b/docs/use-cases/AI_ML/MCP/04_anythingllm.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to set up AnythingLLM with a ClickHouse MCP server using Docker.' keywords: ['AI', 'AnythingLLM', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/05_open-webui.md b/docs/use-cases/AI_ML/MCP/05_open-webui.md index 996c185e792..f11dbe535c5 100644 --- a/docs/use-cases/AI_ML/MCP/05_open-webui.md +++ b/docs/use-cases/AI_ML/MCP/05_open-webui.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to set up Open WebUI with a ClickHouse MCP server using Docker.' keywords: ['AI', 'Open WebUI', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/06_ollama.md b/docs/use-cases/AI_ML/MCP/06_ollama.md index 02e38cef3c0..8b286158b11 100644 --- a/docs/use-cases/AI_ML/MCP/06_ollama.md +++ b/docs/use-cases/AI_ML/MCP/06_ollama.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to set up Ollama with a ClickHouse MCP server.' keywords: ['AI', 'Ollama', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/07_janai.md b/docs/use-cases/AI_ML/MCP/07_janai.md index 64b2d909bde..5c6e2685fde 100644 --- a/docs/use-cases/AI_ML/MCP/07_janai.md +++ b/docs/use-cases/AI_ML/MCP/07_janai.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to set up Jan.ai with a ClickHouse MCP server.' keywords: ['AI', 'Jan.ai', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import {CardHorizontal} from '@clickhouse/click-ui/bundled' diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/agno.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/agno.md index 8eda3c5aac2..c480ea7519a 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/agno.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/agno.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how build an AI Agent with Agno and the ClickHouse MCP Server' keywords: ['ClickHouse', 'MCP', 'Agno'] show_related_blogs: true +doc_type: 'guide' --- # How to build an AI Agent with Agno and the ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/chainlit.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/chainlit.md index 09238237422..63ae9e20930 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/chainlit.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/chainlit.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to use Chainlit to build LLM-based chat apps together with the ClickHouse MCP Server' keywords: ['ClickHouse', 'MCP', 'Chainlit'] show_related_blogs: true +doc_type: 'guide' --- # How to build an AI agent with Chainlit and the ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/copilotkit.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/copilotkit.md index ece4180d2ff..bca912a4f28 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/copilotkit.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/copilotkit.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build an agentic application using data stored in ClickHouse with ClickHouse MCP and CopilotKit' keywords: ['ClickHouse', 'MCP', 'copilotkit'] show_related_blogs: true +doc_type: 'guide' --- # How to build an AI agent with CopilotKit and the ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/dspy.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/dspy.md index 777dae48937..2acbaa30302 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/dspy.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/dspy.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build an AI agent with DSPy and the ClickHouse MCP Server' keywords: ['ClickHouse', 'MCP', 'DSPy'] show_related_blogs: true +doc_type: 'guide' --- # How to build an AI Agent with DSPy and the ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/index.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/index.md index ff5c7f8f3e6..832a73952b3 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/index.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/index.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null description: 'Learn how to build an AI agent with DSPy and the ClickHouse MCP Server' keywords: ['ClickHouse', 'Agno', 'Chainlit', 'MCP', 'DSPy', 'LangChain', 'LlamaIndex', 'OpenAI agents', 'PydanticAI', 'SlackBot', 'StreamLit'] +doc_type: 'guide' --- # Guides for integrating AI agent libraries with ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/langchain.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/langchain.md index 9f99f668978..3c58b2d8e69 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/langchain.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/langchain.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build a LangChain/LangGraph AI agent that can interact with ClickHouse''s SQL playground using ClickHouse''s MCP Server.' keywords: ['ClickHouse', 'MCP', 'LangChain', 'LangGraph'] show_related_blogs: true +doc_type: 'guide' --- # How to build a LangChain/LangGraph AI agent using ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/llamaindex.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/llamaindex.md index af6bd90534c..c09bae9ba41 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/llamaindex.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/llamaindex.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build a LlamaIndex AI agent that can interact with ClickHouse MCP Server.' keywords: ['ClickHouse', 'MCP', 'LlamaIndex'] show_related_blogs: true +doc_type: 'guide' --- # How to build a LlamaIndex AI agent using ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/openai-agents.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/openai-agents.md index 1c44d780c39..cbd2cbda855 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/openai-agents.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/openai-agents.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build an OpenAI agent that can interact with ClickHouse MCP Server.' keywords: ['ClickHouse', 'MCP', 'OpenAI'] show_related_blogs: true +doc_type: 'guide' --- # How to build an OpenAI agent using ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/pydantic-ai.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/pydantic-ai.md index 71efc7d1a78..86bd69314c3 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/pydantic-ai.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/pydantic-ai.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build a PydanticAI agent that can interact with ClickHouse MCP Server.' keywords: ['ClickHouse', 'MCP', 'PydanticAI'] show_related_blogs: true +doc_type: 'guide' --- # How to build a PydanticAI agent using ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/slackbot.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/slackbot.md index e7cc096ceb8..5144129aba5 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/slackbot.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/slackbot.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build a SlackBot agent that can interact with ClickHouse MCP Server.' keywords: ['ClickHouse', 'MCP', 'Slack', 'SlackBot', 'PydanticAI'] show_related_blogs: true +doc_type: 'guide' --- # How to build a SlackBot agent using ClickHouse MCP Server diff --git a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/streamlit.md b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/streamlit.md index 964d6f7f9bc..a2441bf3598 100644 --- a/docs/use-cases/AI_ML/MCP/ai_agent_libraries/streamlit.md +++ b/docs/use-cases/AI_ML/MCP/ai_agent_libraries/streamlit.md @@ -7,6 +7,7 @@ pagination_next: null description: 'Learn how to build a web-based AI Agent with Streamlit and the ClickHouse MCP Server' keywords: ['ClickHouse', 'MCP', 'Streamlit', 'Agno', 'AI Agent'] show_related_blogs: true +doc_type: 'guide' --- # How to build a ClickHouse-backed AI Agent with Streamlit diff --git a/docs/use-cases/AI_ML/MCP/index.md b/docs/use-cases/AI_ML/MCP/index.md index 4e98d9531e6..a6ac4ba5dc4 100644 --- a/docs/use-cases/AI_ML/MCP/index.md +++ b/docs/use-cases/AI_ML/MCP/index.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This page provides an intro to Model Context Protocol (MCP) and has a table of contents for MCP guides.' keywords: ['ClickHouse', 'MCP'] show_related_blogs: true +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/AI_ML/ai-powered-sql-generation.md b/docs/use-cases/AI_ML/ai-powered-sql-generation.md index 3c8ee0010e4..3862d124931 100644 --- a/docs/use-cases/AI_ML/ai-powered-sql-generation.md +++ b/docs/use-cases/AI_ML/ai-powered-sql-generation.md @@ -7,6 +7,7 @@ pagination_next: null description: 'This guide explains how to use AI to generate SQL queries in ClickHouse Client or clickhouse-local.' keywords: ['AI', 'SQL generation'] show_related_blogs: true +doc_type: 'guide' --- Starting from ClickHouse 25.7, [ClickHouse Client](https://clickhouse.com/docs/interfaces/cli) and [clickhouse-local](https://clickhouse.com/docs/operations/utilities/clickhouse-local) include [AI-powered functionality](https://clickhouse.com/docs/interfaces/cli#ai-sql-generation) that converts natural language descriptions into SQL queries. This feature allows users to describe their data requirements in plain text, which the system then translates into corresponding SQL statements. diff --git a/docs/use-cases/AI_ML/index.md b/docs/use-cases/AI_ML/index.md index 3b4a877f7fe..3ee09343b31 100644 --- a/docs/use-cases/AI_ML/index.md +++ b/docs/use-cases/AI_ML/index.md @@ -5,6 +5,7 @@ pagination_next: null slug: /use-cases/AI title: 'Machine learning and GenAI' keywords: ['machine learning', 'genAI', 'AI'] +doc_type: 'landing-page' --- # Machine Learning and GenAI diff --git a/docs/use-cases/data_lake/glue_catalog.md b/docs/use-cases/data_lake/glue_catalog.md index 472683bfeb6..6106c9aa225 100644 --- a/docs/use-cases/data_lake/glue_catalog.md +++ b/docs/use-cases/data_lake/glue_catalog.md @@ -8,6 +8,7 @@ description: 'In this guide, we will walk you through the steps to query your data in S3 buckets using ClickHouse and the AWS Glue Data Catalog.' keywords: ['Glue', 'Data Lake'] show_related_blogs: true +doc_type: 'guide' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/use-cases/data_lake/index.md b/docs/use-cases/data_lake/index.md index 1149c918ec7..1243d345581 100644 --- a/docs/use-cases/data_lake/index.md +++ b/docs/use-cases/data_lake/index.md @@ -5,6 +5,7 @@ pagination_next: null slug: /use-cases/data-lake title: 'Data Lake' keywords: ['data lake', 'glue', 'unity', 'rest'] +doc_type: 'landing-page' --- ClickHouse supports integration with multiple catalogs (Unity, Glue, REST, Polaris, etc.). diff --git a/docs/use-cases/data_lake/lakekeeper_catalog.md b/docs/use-cases/data_lake/lakekeeper_catalog.md index 6c0eb373497..74164354a5a 100644 --- a/docs/use-cases/data_lake/lakekeeper_catalog.md +++ b/docs/use-cases/data_lake/lakekeeper_catalog.md @@ -8,6 +8,7 @@ description: 'In this guide, we will walk you through the steps to query your data using ClickHouse and the Lakekeeper Catalog.' keywords: ['Lakekeeper', 'REST', 'Tabular', 'Data Lake', 'Iceberg'] show_related_blogs: true +doc_type: 'guide' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/use-cases/data_lake/nessie_catalog.md b/docs/use-cases/data_lake/nessie_catalog.md index 98a4ec9b9a7..aa79e4cff74 100644 --- a/docs/use-cases/data_lake/nessie_catalog.md +++ b/docs/use-cases/data_lake/nessie_catalog.md @@ -8,6 +8,7 @@ description: 'In this guide, we will walk you through the steps to query your data using ClickHouse and the Nessie Catalog.' keywords: ['Nessie', 'REST', 'Transactional', 'Data Lake', 'Iceberg', 'Git-like'] show_related_blogs: true +doc_type: 'guide' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/use-cases/data_lake/rest_catalog.md b/docs/use-cases/data_lake/rest_catalog.md index 33d97f23dda..1c35ac8fd5b 100644 --- a/docs/use-cases/data_lake/rest_catalog.md +++ b/docs/use-cases/data_lake/rest_catalog.md @@ -8,6 +8,7 @@ description: 'In this guide, we will walk you through the steps to query your data using ClickHouse and the REST Catalog.' keywords: ['REST', 'Tabular', 'Data Lake', 'Iceberg'] show_related_blogs: true +doc_type: 'guide' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/use-cases/data_lake/unity_catalog.md b/docs/use-cases/data_lake/unity_catalog.md index 83cfe9bae62..46194da84c7 100644 --- a/docs/use-cases/data_lake/unity_catalog.md +++ b/docs/use-cases/data_lake/unity_catalog.md @@ -8,6 +8,7 @@ description: 'In this guide, we will walk you through the steps to query your data in S3 buckets using ClickHouse and the Unity Catalog.' keywords: ['Unity', 'Data Lake'] show_related_blogs: true +doc_type: 'guide' --- import ExperimentalBadge from '@theme/badges/ExperimentalBadge'; diff --git a/docs/use-cases/index.md b/docs/use-cases/index.md index 69341937ce1..60d105eb612 100644 --- a/docs/use-cases/index.md +++ b/docs/use-cases/index.md @@ -4,6 +4,7 @@ title: 'Use Case Guides' pagination_prev: null pagination_next: null description: 'Landing page for use case guides' +doc_type: 'landing-page' --- In this section of the docs you can find our use case guides. diff --git a/docs/use-cases/observability/build-your-own/demo-application.md b/docs/use-cases/observability/build-your-own/demo-application.md index acf870ef5de..050a4fc4218 100644 --- a/docs/use-cases/observability/build-your-own/demo-application.md +++ b/docs/use-cases/observability/build-your-own/demo-application.md @@ -3,6 +3,7 @@ title: 'Demo Application' description: 'Demo application for observability' slug: /observability/demo-application keywords: ['observability', 'logs', 'traces', 'metrics', 'OpenTelemetry', 'Grafana', 'OTel'] +doc_type: 'guide' --- The OpenTelemetry project includes a [demo application](https://opentelemetry.io/docs/demo/). A maintained fork of this application with ClickHouse as a data source for logs and traces can be found [here](https://github.com/ClickHouse/opentelemetry-demo). The [official demo instructions](https://opentelemetry.io/docs/demo/docker-deployment/) can be followed to deploy this demo with docker. In addition to the [existing components](https://opentelemetry.io/docs/demo/collector-data-flow-dashboard/), an instance of ClickHouse will be deployed and used for the storage of logs and traces. diff --git a/docs/use-cases/observability/build-your-own/grafana.md b/docs/use-cases/observability/build-your-own/grafana.md index b44c5fb27b5..70b0488b2bb 100644 --- a/docs/use-cases/observability/build-your-own/grafana.md +++ b/docs/use-cases/observability/build-your-own/grafana.md @@ -4,6 +4,7 @@ description: 'Using Grafana and ClickHouse for observability' slug: /observability/grafana keywords: ['Observability', 'logs', 'traces', 'metrics', 'OpenTelemetry', 'Grafana', 'OTel'] show_related_blogs: true +doc_type: 'guide' --- import observability_15 from '@site/static/images/use-cases/observability/observability-15.png'; diff --git a/docs/use-cases/observability/build-your-own/index.md b/docs/use-cases/observability/build-your-own/index.md index 1ec79f79ba7..5159ab1d4a4 100644 --- a/docs/use-cases/observability/build-your-own/index.md +++ b/docs/use-cases/observability/build-your-own/index.md @@ -4,6 +4,7 @@ title: 'Build Your Own Observability Stack' pagination_prev: null pagination_next: null description: 'Landing page building your own observability stack' +doc_type: 'landing-page' --- This guide helps you build a custom observability stack using ClickHouse as the foundation. Learn how to design, implement, and optimize your observability solution for logs, metrics, and traces, with practical examples and best practices. diff --git a/docs/use-cases/observability/build-your-own/integrating-opentelemetry.md b/docs/use-cases/observability/build-your-own/integrating-opentelemetry.md index 0c81c84bb85..6f87bccd860 100644 --- a/docs/use-cases/observability/build-your-own/integrating-opentelemetry.md +++ b/docs/use-cases/observability/build-your-own/integrating-opentelemetry.md @@ -4,6 +4,7 @@ description: 'Integrating OpenTelemetry and ClickHouse for observability' slug: /observability/integrating-opentelemetry keywords: ['Observability', 'OpenTelemetry'] show_related_blogs: true +doc_type: 'guide' --- import observability_3 from '@site/static/images/use-cases/observability/observability-3.png'; diff --git a/docs/use-cases/observability/build-your-own/introduction.md b/docs/use-cases/observability/build-your-own/introduction.md index ef2cacbcb33..073298371ff 100644 --- a/docs/use-cases/observability/build-your-own/introduction.md +++ b/docs/use-cases/observability/build-your-own/introduction.md @@ -4,6 +4,7 @@ description: 'Using ClickHouse as an observability solution' slug: /use-cases/observability/introduction keywords: ['observability', 'logs', 'traces', 'metrics', 'OpenTelemetry', 'Grafana', 'OTel'] show_related_blogs: true +doc_type: 'guide' --- import observability_1 from '@site/static/images/use-cases/observability/observability-1.png'; diff --git a/docs/use-cases/observability/build-your-own/managing-data.md b/docs/use-cases/observability/build-your-own/managing-data.md index 02cab46abb8..1413800ea1b 100644 --- a/docs/use-cases/observability/build-your-own/managing-data.md +++ b/docs/use-cases/observability/build-your-own/managing-data.md @@ -4,6 +4,7 @@ description: 'Managing Data for Observability' slug: /observability/managing-data keywords: ['observability', 'logs', 'traces', 'metrics', 'OpenTelemetry', 'Grafana', 'OTel'] show_related_blogs: true +doc_type: 'guide' --- import observability_14 from '@site/static/images/use-cases/observability/observability-14.png'; diff --git a/docs/use-cases/observability/build-your-own/schema-design.md b/docs/use-cases/observability/build-your-own/schema-design.md index 1869d83ba4f..770421d0bef 100644 --- a/docs/use-cases/observability/build-your-own/schema-design.md +++ b/docs/use-cases/observability/build-your-own/schema-design.md @@ -4,6 +4,7 @@ description: 'Designing a schema design for observability' keywords: ['observability', 'logs', 'traces', 'metrics', 'OpenTelemetry', 'Grafana', 'OTel'] slug: /use-cases/observability/schema-design show_related_blogs: true +doc_type: 'guide' --- import observability_10 from '@site/static/images/use-cases/observability/observability-10.png'; diff --git a/docs/use-cases/observability/clickstack/alerts.md b/docs/use-cases/observability/clickstack/alerts.md index 11c5cfe9c17..b228f222d4b 100644 --- a/docs/use-cases/observability/clickstack/alerts.md +++ b/docs/use-cases/observability/clickstack/alerts.md @@ -5,6 +5,7 @@ sidebar_label: 'Alerts' pagination_prev: null pagination_next: null description: 'Alerts with ClickStack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/architecture.md b/docs/use-cases/observability/clickstack/architecture.md index 57cffd93514..f767586ae2a 100644 --- a/docs/use-cases/observability/clickstack/architecture.md +++ b/docs/use-cases/observability/clickstack/architecture.md @@ -4,6 +4,7 @@ pagination_prev: null pagination_next: null description: 'Architecture of ClickStack - The ClickHouse Observability Stack' title: 'Architecture' +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/config.md b/docs/use-cases/observability/clickstack/config.md index 788a7e68b4c..05c5e013dfe 100644 --- a/docs/use-cases/observability/clickstack/config.md +++ b/docs/use-cases/observability/clickstack/config.md @@ -4,6 +4,7 @@ title: 'Configuration Options' pagination_prev: null pagination_next: null description: 'Configuration options for ClickStack - The ClickHouse Observability Stack' +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/dashboards.md b/docs/use-cases/observability/clickstack/dashboards.md index 84809ebd83c..0284027d730 100644 --- a/docs/use-cases/observability/clickstack/dashboards.md +++ b/docs/use-cases/observability/clickstack/dashboards.md @@ -5,6 +5,7 @@ sidebar_label: 'Dashboards' pagination_prev: null pagination_next: null description: 'Visualizations and Dashboards with ClickStack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/deployment/all-in-one.md b/docs/use-cases/observability/clickstack/deployment/all-in-one.md index 2aeab9f4c7a..db134182aeb 100644 --- a/docs/use-cases/observability/clickstack/deployment/all-in-one.md +++ b/docs/use-cases/observability/clickstack/deployment/all-in-one.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_position: 0 description: 'Deploying ClickStack with All In One - The ClickHouse Observability Stack' +doc_type: 'guide' --- import JSONSupport from '@site/docs/use-cases/observability/clickstack/deployment/_snippets/_json_support.md'; diff --git a/docs/use-cases/observability/clickstack/deployment/docker-compose.md b/docs/use-cases/observability/clickstack/deployment/docker-compose.md index 807cfb1acc4..f8c2be3b4ae 100644 --- a/docs/use-cases/observability/clickstack/deployment/docker-compose.md +++ b/docs/use-cases/observability/clickstack/deployment/docker-compose.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_position: 3 description: 'Deploying ClickStack with Docker Compose - The ClickHouse Observability Stack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/deployment/helm.md b/docs/use-cases/observability/clickstack/deployment/helm.md index ed4ad898300..9119cd6bd85 100644 --- a/docs/use-cases/observability/clickstack/deployment/helm.md +++ b/docs/use-cases/observability/clickstack/deployment/helm.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_position: 2 description: 'Deploying ClickStack with Helm - The ClickHouse Observability Stack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md b/docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md index 4be56035ff6..ddb4bd14336 100644 --- a/docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md +++ b/docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_position: 1 description: 'Deploying ClickStack with ClickHouse Cloud' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/deployment/hyperdx-only.md b/docs/use-cases/observability/clickstack/deployment/hyperdx-only.md index aaf2b71cd35..75fbc0b37e3 100644 --- a/docs/use-cases/observability/clickstack/deployment/hyperdx-only.md +++ b/docs/use-cases/observability/clickstack/deployment/hyperdx-only.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_position: 4 description: 'Deploying HyperDX only' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/deployment/index.md b/docs/use-cases/observability/clickstack/deployment/index.md index 85b40c90475..7c93f6ea6b3 100644 --- a/docs/use-cases/observability/clickstack/deployment/index.md +++ b/docs/use-cases/observability/clickstack/deployment/index.md @@ -4,6 +4,7 @@ title: 'Deployment Options' pagination_prev: null pagination_next: null description: 'Deploying ClickStack - The ClickHouse Observability Stack' +doc_type: 'reference' --- ClickStack provides multiple deployment options to suit various use cases. diff --git a/docs/use-cases/observability/clickstack/deployment/local-mode-only.md b/docs/use-cases/observability/clickstack/deployment/local-mode-only.md index 3f9f8c7323f..46264da2766 100644 --- a/docs/use-cases/observability/clickstack/deployment/local-mode-only.md +++ b/docs/use-cases/observability/clickstack/deployment/local-mode-only.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_position: 5 description: 'Deploying ClickStack with Local Mode Only - The ClickHouse Observability Stack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/example-datasets/index.md b/docs/use-cases/observability/clickstack/example-datasets/index.md index 0cd8cb18670..acfacdf3485 100644 --- a/docs/use-cases/observability/clickstack/example-datasets/index.md +++ b/docs/use-cases/observability/clickstack/example-datasets/index.md @@ -4,6 +4,7 @@ title: 'Sample Datasets' pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and sample datasets' +doc_type: 'landing-page' --- This section provides various sample datasets and examples to help you get started with ClickStack. These examples demonstrate different ways to work with observability data in ClickStack, from local development to production scenarios. diff --git a/docs/use-cases/observability/clickstack/example-datasets/kubernetes.md b/docs/use-cases/observability/clickstack/example-datasets/kubernetes.md index e2059a51a4c..a2d23520514 100644 --- a/docs/use-cases/observability/clickstack/example-datasets/kubernetes.md +++ b/docs/use-cases/observability/clickstack/example-datasets/kubernetes.md @@ -5,6 +5,7 @@ sidebar_position: 1 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and monitoring Kubernetes' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/example-datasets/local-data.md b/docs/use-cases/observability/clickstack/example-datasets/local-data.md index f0ccdddeae3..4c3eef0c2b3 100644 --- a/docs/use-cases/observability/clickstack/example-datasets/local-data.md +++ b/docs/use-cases/observability/clickstack/example-datasets/local-data.md @@ -5,6 +5,7 @@ sidebar_position: 1 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack local and system data and metrics' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/example-datasets/remote-demo-data.md b/docs/use-cases/observability/clickstack/example-datasets/remote-demo-data.md index d7a97c6f32f..ee4af85dcc2 100644 --- a/docs/use-cases/observability/clickstack/example-datasets/remote-demo-data.md +++ b/docs/use-cases/observability/clickstack/example-datasets/remote-demo-data.md @@ -5,6 +5,7 @@ sidebar_position: 2 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and a remote demo dataset' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/example-datasets/sample-data.md b/docs/use-cases/observability/clickstack/example-datasets/sample-data.md index b6b3c860417..e9add75accf 100644 --- a/docs/use-cases/observability/clickstack/example-datasets/sample-data.md +++ b/docs/use-cases/observability/clickstack/example-datasets/sample-data.md @@ -5,6 +5,7 @@ sidebar_position: 0 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and a sample dataset with logs, sessions, traces and metrics' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/getting-started.md b/docs/use-cases/observability/clickstack/getting-started.md index 4ab5bae0e19..c4785781d81 100644 --- a/docs/use-cases/observability/clickstack/getting-started.md +++ b/docs/use-cases/observability/clickstack/getting-started.md @@ -5,6 +5,7 @@ sidebar_label: 'Getting Started' pagination_prev: null pagination_next: use-cases/observability/clickstack/example-datasets/index description: 'Getting started with ClickStack - The ClickHouse Observability Stack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/index.md b/docs/use-cases/observability/clickstack/index.md index 300779be624..e1bbcf01c9d 100644 --- a/docs/use-cases/observability/clickstack/index.md +++ b/docs/use-cases/observability/clickstack/index.md @@ -4,6 +4,7 @@ title: 'ClickStack - The ClickHouse Observability Stack' pagination_prev: null pagination_next: null description: 'Landing page for the ClickHouse Observability Stack' +doc_type: 'landing-page' --- **ClickStack** is a production-grade observability platform built on ClickHouse and OpenTelemetry (OTel), unifying logs, traces, metrics and session in a single high-performance solution. Designed for monitoring and debugging complex systems, ClickStack enables developers and SREs to trace issues end-to-end without switching between tools or manually stitching together data using timestamps or correlation IDs. diff --git a/docs/use-cases/observability/clickstack/ingesting-data/collector.md b/docs/use-cases/observability/clickstack/ingesting-data/collector.md index 26cb7c14a85..db083ffd57b 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/collector.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/collector.md @@ -5,6 +5,7 @@ pagination_next: null description: 'OpenTelemetry collector for ClickStack - The ClickHouse Observability Stack' sidebar_label: 'OpenTelemetry Collector' title: 'ClickStack OpenTelemetry Collector' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/index.md b/docs/use-cases/observability/clickstack/ingesting-data/index.md index 20196403bf7..b7371556a50 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/index.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/index.md @@ -4,6 +4,7 @@ pagination_prev: null pagination_next: null description: 'Data ingestion for ClickStack - The ClickHouse Observability Stack' title: 'Ingesting data' +doc_type: 'landing-page' --- ClickStack provides multiple ways to ingest observability data into your ClickHouse instance. Whether you're collecting logs, metrics, traces, or session data, you can use the OpenTelemetry (OTel) collector as a unified ingestion point or leverage platform-specific integrations for specialized use cases. diff --git a/docs/use-cases/observability/clickstack/ingesting-data/kubernetes.md b/docs/use-cases/observability/clickstack/ingesting-data/kubernetes.md index be89ba52f81..4a9382df317 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/kubernetes.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/kubernetes.md @@ -4,6 +4,7 @@ pagination_prev: null pagination_next: null description: 'Kubernetes integration for ClickStack - The ClickHouse Observability Stack' title: 'Kubernetes' +doc_type: 'guide' --- ClickStack uses the OpenTelemetry (OTel) collector to collect logs, metrics, and Kubernetes events from Kubernetes clusters and forward them to ClickStack. We support the native OTel log format and require no additional vendor-specific configuration. diff --git a/docs/use-cases/observability/clickstack/ingesting-data/opentelemetry.md b/docs/use-cases/observability/clickstack/ingesting-data/opentelemetry.md index 721889d75dd..087026e7c17 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/opentelemetry.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/opentelemetry.md @@ -4,6 +4,7 @@ pagination_prev: null pagination_next: null description: 'Data ingestion with OpenTelemetry for ClickStack - The ClickHouse Observability Stack' title: 'Ingesting with OpenTelemetry' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/overview.md b/docs/use-cases/observability/clickstack/ingesting-data/overview.md index 39a2de304e5..d41285a9b79 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/overview.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/overview.md @@ -6,6 +6,7 @@ sidebar_position: 0 pagination_prev: null pagination_next: use-cases/observability/clickstack/ingesting-data/opentelemetry description: 'Overview for ingesting data to ClickStack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/schemas.md b/docs/use-cases/observability/clickstack/ingesting-data/schemas.md index 473aba54acd..19e694a248d 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/schemas.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/schemas.md @@ -5,6 +5,7 @@ pagination_next: null description: 'Tables and schemas used by ClickStack - The ClickHouse Observability Stack' sidebar_label: 'Tables and Schemas' title: 'Tables and schemas used by ClickStack' +doc_type: 'reference' --- The ClickStack OpenTelemetry (OTel) collector uses the [ClickHouse exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/clickhouseexporter/README.md) to create tables in ClickHouse and insert data. diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/aws-lambda.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/aws-lambda.md index 3128056d834..c30b6658f0c 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/aws-lambda.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/aws-lambda.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 6 description: 'AWS Lambda for ClickStack - The ClickHouse Observability Stack' title: 'AWS Lambda' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/browser.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/browser.md index 20854a37e08..93b291d425c 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/browser.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/browser.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 0 description: 'Browser SDK for ClickStack - The ClickHouse Observability Stack' title: 'Browser JS' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/deno.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/deno.md index e82b48a4f36..b3adedd347f 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/deno.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/deno.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 6 description: 'Deno SDK for ClickStack - The ClickHouse Observability Stack' title: 'Deno' +doc_type: 'guide' --- This guide Integrates the following: diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/elixir.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/elixir.md index ad65b2937aa..d54832800e6 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/elixir.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/elixir.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 1 description: 'Elixir SDK for ClickStack - The ClickHouse Observability Stack' title: 'Elixir' +doc_type: 'guide' --- diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/golang.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/golang.md index f2ca0833ef5..835fd056092 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/golang.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/golang.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 2 description: 'Golang SDK for ClickStack - The ClickHouse Observability Stack' title: 'Golang' +doc_type: 'guide' --- ClickStack uses the OpenTelemetry standard for collecting telemetry data (logs and diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/index.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/index.md index 0bb78e93527..c56f9e8c08a 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/index.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/index.md @@ -4,6 +4,7 @@ pagination_prev: null pagination_next: null description: 'Language SDKs for ClickStack - The ClickHouse Observability Stack' title: 'Language SDKs' +doc_type: 'guide' --- Data is typically sent to ClickStack via the **OpenTelemetry (OTel) collector**, either directly from language SDKs or through intermediate OpenTelemetry collector acting as agents e.g. collecting infrastructure metrics and logs. diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/java.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/java.md index 50e77dbf7ef..1eacb038a4b 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/java.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/java.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 3 description: 'Java SDK for ClickStack - The ClickHouse Observability Stack' title: 'Java' +doc_type: 'guide' --- ClickStack uses the OpenTelemetry standard for collecting telemetry data (logs and diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/nestjs.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/nestjs.md index 42964cde1dc..9e0414bf592 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/nestjs.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/nestjs.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 4 description: 'NestJS SDK for ClickStack - The ClickHouse Observability Stack' title: 'NestJS' +doc_type: 'guide' --- The ClickStack NestJS integration allows you to create a logger or use the default diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/nextjs.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/nextjs.md index be9f5dd8e0a..1de85c02ba4 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/nextjs.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/nextjs.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 4 description: 'Next.js SDK for ClickStack - The ClickHouse Observability Stack' title: 'Next.js' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/nodejs.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/nodejs.md index 1e8a4c8411a..f4cf384497c 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/nodejs.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/nodejs.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 5 description: 'Node.js SDK for ClickStack - The ClickHouse Observability Stack' title: 'Node.js' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/python.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/python.md index 89b725aff72..90e26a514ef 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/python.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/python.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 7 description: 'Python for ClickStack - The ClickHouse Observability Stack' title: 'Python' +doc_type: 'guide' --- import Tabs from '@theme/Tabs'; diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/react-native.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/react-native.md index da822eedbb2..4549941ed31 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/react-native.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/react-native.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 7 description: 'React Native SDK for ClickStack - The ClickHouse Observability Stack' title: 'React Native' +doc_type: 'guide' --- The ClickStack React Native SDK allows you to instrument your React Native diff --git a/docs/use-cases/observability/clickstack/ingesting-data/sdks/ruby.md b/docs/use-cases/observability/clickstack/ingesting-data/sdks/ruby.md index 1bd4fa7cc37..4ff6f6f93ce 100644 --- a/docs/use-cases/observability/clickstack/ingesting-data/sdks/ruby.md +++ b/docs/use-cases/observability/clickstack/ingesting-data/sdks/ruby.md @@ -5,6 +5,7 @@ pagination_next: null sidebar_position: 7 description: 'Ruby on Rails SDK for ClickStack - The ClickHouse Observability Stack' title: 'Ruby on Rails' +doc_type: 'guide' --- This guide integrates: diff --git a/docs/use-cases/observability/clickstack/migration/elastic/concepts.md b/docs/use-cases/observability/clickstack/migration/elastic/concepts.md index b63560bef62..db96a4fba48 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/concepts.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/concepts.md @@ -8,6 +8,7 @@ sidebar_position: 1 description: 'Equivalent concepts - ClickStack and Elastic' show_related_blogs: true keywords: ['Elasticsearch'] +doc_type: 'reference' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/migration/elastic/index.md b/docs/use-cases/observability/clickstack/migration/elastic/index.md index e304d41f34d..217c16e534f 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/index.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/index.md @@ -6,6 +6,7 @@ pagination_next: null description: 'Landing page migrating to the ClickHouse Observability Stack from Elastic' show_related_blogs: true keywords: ['Elasticsearch'] +doc_type: 'landing-page' --- This guide provides a comprehensive approach to migrating from Elastic Stack to ClickStack. We focus on a parallel operation strategy that minimizes risk while leveraging ClickHouse's strengths in observability workloads. diff --git a/docs/use-cases/observability/clickstack/migration/elastic/intro.md b/docs/use-cases/observability/clickstack/migration/elastic/intro.md index 66bed39785f..ea874d54f85 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/intro.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/intro.md @@ -8,6 +8,7 @@ sidebar_position: 0 description: 'Overview for migrating to the ClickHouse Observability Stack from Elastic' show_related_blogs: true keywords: ['Elasticsearch'] +doc_type: 'guide' --- ## Migrating to ClickStack from Elastic {#migrating-to-clickstack-from-elastic} diff --git a/docs/use-cases/observability/clickstack/migration/elastic/migrating-agents.md b/docs/use-cases/observability/clickstack/migration/elastic/migrating-agents.md index da4072283c0..0effc78a1f4 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/migrating-agents.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/migrating-agents.md @@ -8,6 +8,7 @@ sidebar_position: 5 description: 'Migrating agents from Elastic' show_related_blogs: true keywords: ['ClickStack'] +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/migration/elastic/migrating-data.md b/docs/use-cases/observability/clickstack/migration/elastic/migrating-data.md index c4bd8ce828b..04439bbe8be 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/migrating-data.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/migrating-data.md @@ -8,6 +8,7 @@ sidebar_position: 4 description: 'Migrating data to ClickHouse Observability Stack from Elastic' show_related_blogs: true keywords: ['ClickStack'] +doc_type: 'guide' --- ## Parallel operation strategy {#parallel-operation-strategy} diff --git a/docs/use-cases/observability/clickstack/migration/elastic/migrating-sdks.md b/docs/use-cases/observability/clickstack/migration/elastic/migrating-sdks.md index 9b3e8d5c166..f83c6bfc770 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/migrating-sdks.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/migrating-sdks.md @@ -8,6 +8,7 @@ sidebar_position: 6 description: 'Migrating SDKs from Elastic' show_related_blogs: true keywords: ['ClickStack'] +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/migration/elastic/search.md b/docs/use-cases/observability/clickstack/migration/elastic/search.md index 16478273a63..15be70e22de 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/search.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/search.md @@ -6,6 +6,7 @@ pagination_next: null sidebar_label: 'Search' sidebar_position: 3 description: 'Searching in ClickStack and Elastic' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/migration/elastic/types.md b/docs/use-cases/observability/clickstack/migration/elastic/types.md index 57c2670c955..fbe1cbc1e92 100644 --- a/docs/use-cases/observability/clickstack/migration/elastic/types.md +++ b/docs/use-cases/observability/clickstack/migration/elastic/types.md @@ -8,6 +8,7 @@ sidebar_position: 2 description: 'Mapping types in ClickHouse and Elasticsearch' show_related_blogs: true keywords: ['JSON', 'Codecs'] +doc_type: 'reference' --- Elasticsearch and ClickHouse support a wide variety of data types, but their underlying storage and query models are fundamentally different. This section maps commonly used Elasticsearch field types to their ClickHouse equivalents, where available, and provides context to help guide migrations. Where no equivalent exists, alternatives or notes are provided in the comments. diff --git a/docs/use-cases/observability/clickstack/migration/index.md b/docs/use-cases/observability/clickstack/migration/index.md index eea17c4238b..a8875f6af5c 100644 --- a/docs/use-cases/observability/clickstack/migration/index.md +++ b/docs/use-cases/observability/clickstack/migration/index.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null sidebar_label: 'Migration guides' description: 'Migrating to ClickStack from other Observability solutions' +doc_type: 'guide' --- This section provides comprehensive guides for migrating from various observability solutions to ClickStack. Each guide includes detailed instructions for transitioning your data, agents, and workflows while maintaining operational continuity. diff --git a/docs/use-cases/observability/clickstack/overview.md b/docs/use-cases/observability/clickstack/overview.md index 504f525e78b..54c1f0f3a74 100644 --- a/docs/use-cases/observability/clickstack/overview.md +++ b/docs/use-cases/observability/clickstack/overview.md @@ -5,6 +5,7 @@ sidebar_label: 'Overview' pagination_prev: null pagination_next: use-cases/observability/clickstack/getting-started description: 'Overview for ClickStack - The ClickHouse Observability Stack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/production.md b/docs/use-cases/observability/clickstack/production.md index 3fa9c0fe0b8..a340da5da0e 100644 --- a/docs/use-cases/observability/clickstack/production.md +++ b/docs/use-cases/observability/clickstack/production.md @@ -5,6 +5,7 @@ sidebar_label: 'Production' pagination_prev: null pagination_next: null description: 'Going to production with ClickStack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/search.md b/docs/use-cases/observability/clickstack/search.md index 4099ac8abd3..67d3fecd284 100644 --- a/docs/use-cases/observability/clickstack/search.md +++ b/docs/use-cases/observability/clickstack/search.md @@ -5,6 +5,7 @@ sidebar_label: 'Search' pagination_prev: null pagination_next: null description: 'Search with ClickStack' +doc_type: 'guide' --- import Image from '@theme/IdealImage'; diff --git a/docs/use-cases/observability/clickstack/ttl.md b/docs/use-cases/observability/clickstack/ttl.md index a11ba3eef2e..5abfc587ad8 100644 --- a/docs/use-cases/observability/clickstack/ttl.md +++ b/docs/use-cases/observability/clickstack/ttl.md @@ -5,6 +5,7 @@ sidebar_label: 'Managing TTL' pagination_prev: null pagination_next: null description: 'Managing TTL with ClickStack' +doc_type: 'guide' --- import observability_14 from '@site/static/images/use-cases/observability/observability-14.png'; diff --git a/docs/use-cases/observability/index.md b/docs/use-cases/observability/index.md index 3845ba84e8c..67948a5a0cd 100644 --- a/docs/use-cases/observability/index.md +++ b/docs/use-cases/observability/index.md @@ -5,6 +5,7 @@ pagination_prev: null pagination_next: null description: 'Landing page for the Observability use case guide' keywords: ['observability', 'logs', 'traces', 'metrics', 'OpenTelemetry', 'Grafana', 'OTel'] +doc_type: 'guide' --- ClickHouse offers unmatched speed, scale, and cost-efficiency for observability. This guide provides two paths depending on your needs: diff --git a/docs/use-cases/time-series/analysis-functions.md b/docs/use-cases/time-series/analysis-functions.md index cdcdb3d2c2e..5c901ab82d2 100644 --- a/docs/use-cases/time-series/analysis-functions.md +++ b/docs/use-cases/time-series/analysis-functions.md @@ -5,6 +5,7 @@ description: 'Functions for analyzing time-series data in ClickHouse.' slug: /use-cases/time-series/analysis-functions keywords: ['time-series'] show_related_blogs: true +doc_type: 'reference' --- # Time-series analysis functions diff --git a/docs/use-cases/time-series/basic-operations.md b/docs/use-cases/time-series/basic-operations.md index 541f828a6fc..0a4d2d7037f 100644 --- a/docs/use-cases/time-series/basic-operations.md +++ b/docs/use-cases/time-series/basic-operations.md @@ -5,6 +5,7 @@ description: 'Basic time-series operations in ClickHouse.' slug: /use-cases/time-series/basic-operations keywords: ['time-series'] show_related_blogs: true +doc_type: 'guide' --- # Basic time-series operations diff --git a/docs/use-cases/time-series/date-time-data-types.md b/docs/use-cases/time-series/date-time-data-types.md index 73959386808..657bb318f8e 100644 --- a/docs/use-cases/time-series/date-time-data-types.md +++ b/docs/use-cases/time-series/date-time-data-types.md @@ -5,6 +5,7 @@ description: 'Time-series data types in ClickHouse.' slug: /use-cases/time-series/date-time-data-types keywords: ['Time Series', 'DateTime'] show_related_blogs: true +doc_type: 'reference' --- # Date and time data types diff --git a/docs/use-cases/time-series/index.md b/docs/use-cases/time-series/index.md index d1a37acd28e..050c1fcfc13 100644 --- a/docs/use-cases/time-series/index.md +++ b/docs/use-cases/time-series/index.md @@ -4,6 +4,7 @@ slug: /use-cases/time-series title: 'Time-Series' pagination_prev: null pagination_next: null +doc_type: 'guide' --- Welcome to our time-series use case guide. In this guide you'll learn how you can get setup and use ClickHouse for time-series. diff --git a/docs/use-cases/time-series/query-performance.md b/docs/use-cases/time-series/query-performance.md index 8b181e2b2a7..11de0077bf2 100644 --- a/docs/use-cases/time-series/query-performance.md +++ b/docs/use-cases/time-series/query-performance.md @@ -5,6 +5,7 @@ description: 'Improving time-series query performance' slug: /use-cases/time-series/query-performance keywords: ['time-series'] show_related_blogs: true +doc_type: 'guide' --- # Time-series query performance diff --git a/docs/use-cases/time-series/storage-efficiency.md b/docs/use-cases/time-series/storage-efficiency.md index b093726da13..1a908b791cb 100644 --- a/docs/use-cases/time-series/storage-efficiency.md +++ b/docs/use-cases/time-series/storage-efficiency.md @@ -5,6 +5,7 @@ description: 'Improving time-series storage efficiency' slug: /use-cases/time-series/storage-efficiency keywords: ['time-series'] show_related_blogs: true +doc_type: 'guide' --- # Time-series storage efficiency diff --git a/docs/whats-new/changelog/2017.md b/docs/whats-new/changelog/2017.md index 65fbd254699..b4062c984cf 100644 --- a/docs/whats-new/changelog/2017.md +++ b/docs/whats-new/changelog/2017.md @@ -4,6 +4,7 @@ sidebar_position: 10 sidebar_label: '2017' title: '2017 Changelog' description: 'Changelog for 2017' +doc_type: 'changelog' --- ### ClickHouse Release 1.1.54327, 2017-12-21 {#clickhouse-release-1-1-54327-2017-12-21} diff --git a/docs/whats-new/changelog/2018.md b/docs/whats-new/changelog/2018.md index 8f730d6baf7..ed37477fde9 100644 --- a/docs/whats-new/changelog/2018.md +++ b/docs/whats-new/changelog/2018.md @@ -4,6 +4,7 @@ sidebar_position: 9 sidebar_label: '2018' title: '2018 Changelog' description: 'Changelog for 2018' +doc_type: 'changelog' --- ## ClickHouse Release 18.16 {#clickhouse-release-18-16} diff --git a/docs/whats-new/changelog/2019.md b/docs/whats-new/changelog/2019.md index 21de463a3e5..95e699e6604 100644 --- a/docs/whats-new/changelog/2019.md +++ b/docs/whats-new/changelog/2019.md @@ -4,6 +4,7 @@ sidebar_position: 8 sidebar_label: '2019' title: '2019 Changelog' description: 'Changelog for 2019' +doc_type: 'changelog' --- ## ClickHouse Release 19.17 {#clickhouse-release-v19-17} diff --git a/docs/whats-new/changelog/2020.md b/docs/whats-new/changelog/2020.md index ff5154fc130..c4be50ead1f 100644 --- a/docs/whats-new/changelog/2020.md +++ b/docs/whats-new/changelog/2020.md @@ -4,6 +4,7 @@ sidebar_position: 7 sidebar_label: '2020' title: '2020 Changelog' description: 'Changelog for 2020' +doc_type: 'changelog' --- ### ClickHouse release 20.12 {#clickhouse-release-2012} diff --git a/docs/whats-new/changelog/2021.md b/docs/whats-new/changelog/2021.md index 853d1b88c9e..092f4749451 100644 --- a/docs/whats-new/changelog/2021.md +++ b/docs/whats-new/changelog/2021.md @@ -4,6 +4,7 @@ sidebar_position: 6 sidebar_label: '2021' title: '2021 Changelog' description: 'Changelog for 2021' +doc_type: 'changelog' --- ### ClickHouse release v21.12, 2021-12-15 {#clickhouse-release-v2112-2021-12-15} diff --git a/docs/whats-new/changelog/2022.md b/docs/whats-new/changelog/2022.md index 96820bf05cc..adeae8e0200 100644 --- a/docs/whats-new/changelog/2022.md +++ b/docs/whats-new/changelog/2022.md @@ -4,6 +4,7 @@ sidebar_position: 5 sidebar_label: '2022' title: '2022 Changelog' description: 'Changelog for 2022' +doc_type: 'changelog' --- ### ClickHouse release 22.12, 2022-12-15 {#a-id2212a-clickhouse-release-2212-2022-12-15} diff --git a/docs/whats-new/changelog/2023.md b/docs/whats-new/changelog/2023.md index d321f74fdd6..11058c59dce 100644 --- a/docs/whats-new/changelog/2023.md +++ b/docs/whats-new/changelog/2023.md @@ -4,6 +4,7 @@ sidebar_position: 4 sidebar_label: '2023' title: '2023 Changelog' description: 'Changelog for 2023' +doc_type: 'changelog' --- ### Table of Contents {#table-of-contents} diff --git a/docs/whats-new/changelog/2024.md b/docs/whats-new/changelog/2024.md index e3b57784dc1..6c28c3cab7b 100644 --- a/docs/whats-new/changelog/2024.md +++ b/docs/whats-new/changelog/2024.md @@ -4,6 +4,7 @@ sidebar_position: 3 sidebar_label: '2024' title: '2024 Changelog' description: 'Changelog for 2024' +doc_type: 'changelog' --- ### Table of Contents {#table-of-contents} diff --git a/docs/whats-new/changelog/cloud.md b/docs/whats-new/changelog/cloud.md index dd3faf69c73..89a9fd594fa 100644 --- a/docs/whats-new/changelog/cloud.md +++ b/docs/whats-new/changelog/cloud.md @@ -4,6 +4,7 @@ sidebar_label: 'Cloud' title: 'Cloud Changelog' slug: /whats-new/changelog/cloud description: 'Learn about Cloud Changelog' +doc_type: 'changelog' --- # Cloud Changelog diff --git a/docs/whats-new/changelog/index.md b/docs/whats-new/changelog/index.md index 4a14fcb7dbf..c5c638730ba 100644 --- a/docs/whats-new/changelog/index.md +++ b/docs/whats-new/changelog/index.md @@ -5,5 +5,6 @@ slug: /whats-new/changelog/ sidebar_position: 2 sidebar_label: '2025' title: '2025 Changelog' +doc_type: 'changelog' --- diff --git a/docs/whats-new/roadmap.md b/docs/whats-new/roadmap.md index 93f7d5313dd..bd96443545e 100644 --- a/docs/whats-new/roadmap.md +++ b/docs/whats-new/roadmap.md @@ -3,6 +3,7 @@ title: 'Roadmap' slug: /whats-new/roadmap sidebar_position: 50 description: 'Present and past ClickHouse road maps' +doc_type: 'landing-page' --- ## Current roadmap {#current-roadmap} diff --git a/docs/whats-new/security-changelog.md b/docs/whats-new/security-changelog.md index 2f02469a7e5..20e9e44e0ff 100644 --- a/docs/whats-new/security-changelog.md +++ b/docs/whats-new/security-changelog.md @@ -4,6 +4,7 @@ sidebar_position: 20 sidebar_label: 'Security changelog' title: 'Security changelog' description: 'Security changelog detailing security related updates and changes' +doc_type: 'changelog' --- # Security changelog diff --git a/i18n/jp/docusaurus-plugin-content-docs/current/about-us/beta-and-experimental-features.md b/i18n/jp/docusaurus-plugin-content-docs/current/about-us/beta-and-experimental-features.md index 4949a706f0b..acf78abdcf1 100644 --- a/i18n/jp/docusaurus-plugin-content-docs/current/about-us/beta-and-experimental-features.md +++ b/i18n/jp/docusaurus-plugin-content-docs/current/about-us/beta-and-experimental-features.md @@ -44,110 +44,4 @@ The sections below explicitly describe the properties of **Beta** and **Experime --> -## Beta settings {#beta-settings} - -| Name | Default | -|------|--------| -| [geotoh3_argument_order](/operations/settings/settings#geotoh3_argument_order) | `lat_lon` | -| [allow_experimental_parallel_reading_from_replicas](/operations/settings/settings#allow_experimental_parallel_reading_from_replicas) | `0` | -| [parallel_replicas_mode](/operations/settings/settings#parallel_replicas_mode) | `read_tasks` | -| [parallel_replicas_count](/operations/settings/settings#parallel_replicas_count) | `0` | -| [parallel_replica_offset](/operations/settings/settings#parallel_replica_offset) | `0` | -| [parallel_replicas_custom_key](/operations/settings/settings#parallel_replicas_custom_key) | `` | -| [parallel_replicas_custom_key_range_lower](/operations/settings/settings#parallel_replicas_custom_key_range_lower) | `0` | -| [parallel_replicas_custom_key_range_upper](/operations/settings/settings#parallel_replicas_custom_key_range_upper) | `0` | -| [cluster_for_parallel_replicas](/operations/settings/settings#cluster_for_parallel_replicas) | `` | -| [parallel_replicas_allow_in_with_subquery](/operations/settings/settings#parallel_replicas_allow_in_with_subquery) | `1` | -| [parallel_replicas_for_non_replicated_merge_tree](/operations/settings/settings#parallel_replicas_for_non_replicated_merge_tree) | `0` | -| [parallel_replicas_min_number_of_rows_per_replica](/operations/settings/settings#parallel_replicas_min_number_of_rows_per_replica) | `0` | -| [parallel_replicas_prefer_local_join](/operations/settings/settings#parallel_replicas_prefer_local_join) | `1` | -| [parallel_replicas_mark_segment_size](/operations/settings/settings#parallel_replicas_mark_segment_size) | `0` | -| [parallel_replicas_local_plan](/operations/settings/settings#parallel_replicas_local_plan) | `1` | -| [parallel_replicas_index_analysis_only_on_coordinator](/operations/settings/settings#parallel_replicas_index_analysis_only_on_coordinator) | `1` | -| [parallel_replicas_only_with_analyzer](/operations/settings/settings#parallel_replicas_only_with_analyzer) | `1` | -| [parallel_replicas_insert_select_local_pipeline](/operations/settings/settings#parallel_replicas_insert_select_local_pipeline) | `1` | -| [parallel_replicas_connect_timeout_ms](/operations/settings/settings#parallel_replicas_connect_timeout_ms) | `300` | -| [session_timezone](/operations/settings/settings#session_timezone) | `` | -| [low_priority_query_wait_time_ms](/operations/settings/settings#low_priority_query_wait_time_ms) | `1000` | -| [max_limit_for_vector_search_queries](/operations/settings/settings#max_limit_for_vector_search_queries) | `1000` | -| [hnsw_candidate_list_size_for_search](/operations/settings/settings#hnsw_candidate_list_size_for_search) | `256` | -| [vector_search_filter_strategy](/operations/settings/settings#vector_search_filter_strategy) | `auto` | -| [vector_search_postfilter_multiplier](/operations/settings/settings#vector_search_postfilter_multiplier) | `1` | -| [allow_experimental_delta_kernel_rs](/operations/settings/settings#allow_experimental_delta_kernel_rs) | `1` | -| [allow_remote_fs_zero_copy_replication](/operations/settings/merge-tree-settings#allow_remote_fs_zero_copy_replication) | `0` | - - -## Experimental settings {#experimental-settings} - -| Name | Default | -|------|--------| -| [allow_experimental_kafka_offsets_storage_in_keeper](/operations/settings/settings#allow_experimental_kafka_offsets_storage_in_keeper) | `0` | -| [allow_experimental_correlated_subqueries](/operations/settings/settings#allow_experimental_correlated_subqueries) | `0` | -| [allow_experimental_materialized_postgresql_table](/operations/settings/settings#allow_experimental_materialized_postgresql_table) | `0` | -| [allow_experimental_funnel_functions](/operations/settings/settings#allow_experimental_funnel_functions) | `0` | -| [allow_experimental_nlp_functions](/operations/settings/settings#allow_experimental_nlp_functions) | `0` | -| [allow_experimental_hash_functions](/operations/settings/settings#allow_experimental_hash_functions) | `0` | -| [allow_experimental_object_type](/operations/settings/settings#allow_experimental_object_type) | `0` | -| [allow_experimental_time_series_table](/operations/settings/settings#allow_experimental_time_series_table) | `0` | -| [allow_experimental_vector_similarity_index](/operations/settings/settings#allow_experimental_vector_similarity_index) | `0` | -| [allow_experimental_codecs](/operations/settings/settings#allow_experimental_codecs) | `0` | -| [throw_on_unsupported_query_inside_transaction](/operations/settings/settings#throw_on_unsupported_query_inside_transaction) | `1` | -| [wait_changes_become_visible_after_commit_mode](/operations/settings/settings#wait_changes_become_visible_after_commit_mode) | `wait_unknown` | -| [implicit_transaction](/operations/settings/settings#implicit_transaction) | `0` | -| [grace_hash_join_initial_buckets](/operations/settings/settings#grace_hash_join_initial_buckets) | `1` | -| [grace_hash_join_max_buckets](/operations/settings/settings#grace_hash_join_max_buckets) | `1024` | -| [join_to_sort_minimum_perkey_rows](/operations/settings/settings#join_to_sort_minimum_perkey_rows) | `40` | -| [join_to_sort_maximum_table_rows](/operations/settings/settings#join_to_sort_maximum_table_rows) | `10000` | -| [allow_experimental_join_right_table_sorting](/operations/settings/settings#allow_experimental_join_right_table_sorting) | `0` | -| [allow_statistics_optimize](/operations/settings/settings#allow_statistics_optimize) | `0` | -| [allow_experimental_statistics](/operations/settings/settings#allow_experimental_statistics) | `0` | -| [allow_experimental_inverted_index](/operations/settings/settings#allow_experimental_inverted_index) | `0` | -| [allow_experimental_full_text_index](/operations/settings/settings#allow_experimental_full_text_index) | `0` | -| [allow_experimental_lightweight_update](/operations/settings/settings#allow_experimental_lightweight_update) | `0` | -| [allow_experimental_join_condition](/operations/settings/settings#allow_experimental_join_condition) | `0` | -| [allow_experimental_live_view](/operations/settings/settings#allow_experimental_live_view) | `0` | -| [live_view_heartbeat_interval](/operations/settings/settings#live_view_heartbeat_interval) | `15` | -| [max_live_view_insert_blocks_before_refresh](/operations/settings/settings#max_live_view_insert_blocks_before_refresh) | `64` | -| [allow_experimental_window_view](/operations/settings/settings#allow_experimental_window_view) | `0` | -| [window_view_clean_interval](/operations/settings/settings#window_view_clean_interval) | `60` | -| [window_view_heartbeat_interval](/operations/settings/settings#window_view_heartbeat_interval) | `15` | -| [wait_for_window_view_fire_signal_timeout](/operations/settings/settings#wait_for_window_view_fire_signal_timeout) | `10` | -| [stop_refreshable_materialized_views_on_startup](/operations/settings/settings#stop_refreshable_materialized_views_on_startup) | `0` | -| [allow_experimental_database_materialized_postgresql](/operations/settings/settings#allow_experimental_database_materialized_postgresql) | `0` | -| [allow_experimental_query_deduplication](/operations/settings/settings#allow_experimental_query_deduplication) | `0` | -| [allow_experimental_database_iceberg](/operations/settings/settings#allow_experimental_database_iceberg) | `0` | -| [allow_experimental_database_unity_catalog](/operations/settings/settings#allow_experimental_database_unity_catalog) | `0` | -| [allow_experimental_database_glue_catalog](/operations/settings/settings#allow_experimental_database_glue_catalog) | `0` | -| [allow_experimental_database_hms_catalog](/operations/settings/settings#allow_experimental_database_hms_catalog) | `0` | -| [allow_experimental_kusto_dialect](/operations/settings/settings#allow_experimental_kusto_dialect) | `0` | -| [allow_experimental_prql_dialect](/operations/settings/settings#allow_experimental_prql_dialect) | `0` | -| [enable_adaptive_memory_spill_scheduler](/operations/settings/settings#enable_adaptive_memory_spill_scheduler) | `0` | -| [make_distributed_plan](/operations/settings/settings#make_distributed_plan) | `0` | -| [distributed_plan_execute_locally](/operations/settings/settings#distributed_plan_execute_locally) | `0` | -| [distributed_plan_default_shuffle_join_bucket_count](/operations/settings/settings#distributed_plan_default_shuffle_join_bucket_count) | `8` | -| [distributed_plan_default_reader_bucket_count](/operations/settings/settings#distributed_plan_default_reader_bucket_count) | `8` | -| [distributed_plan_force_exchange_kind](/operations/settings/settings#distributed_plan_force_exchange_kind) | `` | -| [allow_experimental_ts_to_grid_aggregate_function](/operations/settings/settings#allow_experimental_ts_to_grid_aggregate_function) | `0` | -| [allow_experimental_replacing_merge_with_cleanup](/operations/settings/merge-tree-settings#allow_experimental_replacing_merge_with_cleanup) | `0` | -| [allow_experimental_reverse_key](/operations/settings/merge-tree-settings#allow_experimental_reverse_key) | `0` | -| [enable_replacing_merge_with_cleanup_for_min_age_to_force_merge](/operations/settings/merge-tree-settings#enable_replacing_merge_with_cleanup_for_min_age_to_force_merge) | `0` | -| [force_read_through_cache_for_merges](/operations/settings/merge-tree-settings#force_read_through_cache_for_merges) | `0` | -| [merge_selector_algorithm](/operations/settings/merge-tree-settings#merge_selector_algorithm) | `Simple` | -| [notify_newest_block_number](/operations/settings/merge-tree-settings#notify_newest_block_number) | `0` | -| [part_moves_between_shards_delay_seconds](/operations/settings/merge-tree-settings#part_moves_between_shards_delay_seconds) | `30` | -| [part_moves_between_shards_enable](/operations/settings/merge-tree-settings#part_moves_between_shards_enable) | `0` | -| [remote_fs_zero_copy_path_compatible_mode](/operations/settings/merge-tree-settings#remote_fs_zero_copy_path_compatible_mode) | `0` | -| [remote_fs_zero_copy_zookeeper_path](/operations/settings/merge-tree-settings#remote_fs_zero_copy_zookeeper_path) | `/clickhouse/zero_copy` | -| [remove_rolled_back_parts_immediately](/operations/settings/merge-tree-settings#remove_rolled_back_parts_immediately) | `1` | -| [shared_merge_tree_enable_coordinated_merges](/operations/settings/merge-tree-settings#shared_merge_tree_enable_coordinated_merges) | `0` | -| [shared_merge_tree_enable_keeper_parts_extra_data](/operations/settings/merge-tree-settings#shared_merge_tree_enable_keeper_parts_extra_data) | `0` | -| [shared_merge_tree_merge_coordinator_election_check_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_election_check_period_ms) | `30000` | -| [shared_merge_tree_merge_coordinator_factor](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_factor) | `2` | -| [shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms) | `10000` | -| [shared_merge_tree_merge_coordinator_max_merge_request_size](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_merge_request_size) | `20` | -| [shared_merge_tree_merge_coordinator_max_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_period_ms) | `10000` | -| [shared_merge_tree_merge_coordinator_merges_prepare_count](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_merges_prepare_count) | `100` | -| [shared_merge_tree_merge_coordinator_min_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_min_period_ms) | `1` | -| [shared_merge_tree_merge_worker_fast_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_fast_timeout_ms) | `100` | -| [shared_merge_tree_merge_worker_regular_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_regular_timeout_ms) | `10000` | diff --git a/knowledgebase/unable-to-access-cloud-service.mdx b/knowledgebase/unable-to-access-cloud-service.mdx index 46fc174e860..f5ea5d28bc9 100644 --- a/knowledgebase/unable-to-access-cloud-service.mdx +++ b/knowledgebase/unable-to-access-cloud-service.mdx @@ -4,6 +4,7 @@ description: "Tips and tricks on optimizing basic data types in ClickHouse" date: 2024-07-02 tags: ['Errors and Exceptions'] keywords: ['accessing cloud service'] +doc_type: 'guide' --- {frontMatter.description} diff --git a/plugins/frontmatter-validation/customParseFrontMatter.js b/plugins/frontmatter-validation/customParseFrontMatter.js index ac64a9a8b2c..5919a0329f1 100644 --- a/plugins/frontmatter-validation/customParseFrontMatter.js +++ b/plugins/frontmatter-validation/customParseFrontMatter.js @@ -141,7 +141,7 @@ async function customParseFrontMatter(params) { // Use Docusaurus's default parser to get the frontmatter data const parsedData = await defaultParseFrontMatter(params); // Check for required fields - const requiredFields = ['title', 'slug', 'description']; + const requiredFields = ['title', 'slug', 'description', 'doc_type']; for (const field of requiredFields) { if (!parsedData.frontMatter[field]) { issues.push(`missing required field: ${field}`); diff --git a/scripts/aspell-ignore/en/aspell-dict.txt b/scripts/aspell-ignore/en/aspell-dict.txt index 3b48b7ded2f..31a1b383b4f 100644 --- a/scripts/aspell-ignore/en/aspell-dict.txt +++ b/scripts/aspell-ignore/en/aspell-dict.txt @@ -1,4 +1,4 @@ -personal_ws-1.1 en 3638 +personal_ws-1.1 en 3646 AArch ACLs Accepter @@ -652,10 +652,10 @@ LOCALTIMESTAMP LONGLONG LOONGARCH LaGuardia +Lakekeeper LangChain LangGraph Langchain -Lakekeeper Lemire Levenshtein Lhotsky @@ -800,7 +800,6 @@ NDJSON NEKUDOTAYIM NEWDATE NEWDECIMAL -Nessie NFKC NFKD NIST @@ -815,6 +814,7 @@ Nambiar Namenode NamesAndTypesList Nano +Nessie NestJS Nesterov NetFlow @@ -974,8 +974,8 @@ PendingAsyncInsert Percona PerfEventInfo PhpStorm -PlantUML PlanetScale +PlantUML Poess PointDistKm PointDistM @@ -1025,10 +1025,10 @@ ProxySQL Punycode PyArrow PyCharm -Pydantic PyPI PyReader PySpark +Pydantic PydanticAI QATlib QEMU @@ -1299,7 +1299,6 @@ ThreadPoolRemoteFSReaderThreads ThreadPoolRemoteFSReaderThreadsActive ThreadsActive ThreadsInOvercommitTracker -Trino TiDB TimeSeries TimescaleDB @@ -1331,6 +1330,7 @@ TotalsMode Tradeoff Transactional TransactionsWaitCSNMode +Trino Tsai Tukey TwoColumnList @@ -2869,6 +2869,7 @@ profiler programmatically proleptic prometheus +promql proportionsZTest proto protobuf @@ -3650,6 +3651,7 @@ xz yaml yandex youtube +ytsaurus zLib zLinux zabbix diff --git a/scripts/categorizer.py b/scripts/categorizer.py new file mode 100644 index 00000000000..41642a783b8 --- /dev/null +++ b/scripts/categorizer.py @@ -0,0 +1,386 @@ +#!/usr/bin/env python3 +""" +Document Categorizer using Custom Framework +Automatically categorizes markdown documents and updates frontmatter with doc_type. +""" + +import os +import re +import asyncio +import aiohttp +import yaml +from pathlib import Path +from typing import Dict, List, Optional, Tuple +import argparse +import json +from datetime import datetime + +# Configuration +ANTHROPIC_API_KEY = os.getenv('ANTHROPIC_API_KEY', '') +API_URL = 'https://api.anthropic.com/v1/messages' +MODEL = 'claude-3-haiku-20240307' +MAX_CONTENT_LENGTH = 8000 +BATCH_SIZE = 5 +RATE_LIMIT_DELAY = 2 + +# Categorization prompt +CATEGORIZATION_PROMPT = """ +Categorize this markdown document using the following framework. + +Categories: +- guide: Task-oriented content with actionable steps, procedures, or learning paths that users follow to accomplish something +- reference: Information-oriented material that users look up for specific facts, including technical specifications and lookup data +- landing-page: Navigation pages that primarily link to other documents (index pages, TOCs, directory listings with minimal content per item) +- changelog: Version history, release notes, change logs, what's new pages + +Key distinctions: + +GUIDE vs REFERENCE: +- Guide: "How to do X" - Users follow steps to accomplish a task or learn a skill + * Installation instructions, tutorials, walkthroughs, setup procedures + * Configuration guides with specific steps and code examples + * Decision-making frameworks ("How to choose the right engine") + * Learning paths with exercises or examples to follow along + * Step-by-step processes, workflows, procedures + * Migration guides, troubleshooting procedures + * Case studies and success stories that demonstrate implementation approaches + * Documents that show "how to configure/implement/set up/use" something + * Examples: "Getting Started Tutorial", "How to Create Tables", "Setting Up Replication", "Migrating from PostgreSQL", "Defining Ordering Keys", "Creative Use Cases" + +- Reference: Pure lookup material users consult for technical information + * API documentation, function definitions, configuration parameter lists + * Engine specifications, data type references, SQL syntax documentation + * Pure technical specifications without implementation guidance + * Adopters lists, error code references, parameter tables + * Architecture overviews that explain concepts without showing implementation steps + * Function syntax, data type definitions, specification documents + * Examples: "SQL Functions Reference", "MergeTree Engine Specification", "Configuration Parameters List", "Data Types Documentation", "ClickHouse Adopters" + +REFERENCE vs LANDING-PAGE: +- Reference: Contains substantial technical information that users look up +- Landing-page: Primarily navigation with minimal content per item (lists of links, table of contents, directory pages) + +Decision framework: +1. Does it document version changes, release notes, or what's new? → changelog +2. Is it primarily navigation with minimal content per item? → landing-page +3. Does it provide step-by-step instructions, procedures, or implementation guidance (including case studies)? → guide +4. Does it contain technical specifications or information users look up? → reference + +Examples by category: +- Guide: "Installing ClickHouse", "Creating Your First Dashboard", "Migration from MySQL Tutorial", "Setting Up Authentication", "Creative Use Cases" +- Reference: "SQL Functions", "MergeTree Engine Documentation", "Configuration Parameters", "Data Types", "ClickHouse Architecture", "Adopters List" +- Landing-page: "Documentation Home", "Table of Contents", "Available Integrations", "Function Categories" +- Changelog: "Release Notes v22.8", "What's New", "Version History", "Breaking Changes" + +Filename: {filename} +Title: {title} +Description: {description} + +Content: {content} + +IMPORTANT: Respond with ONLY one word: guide, reference, landing-page, or changelog +""" + +class DocumentCategorizer: + def __init__(self, api_key: str, dry_run: bool = False, force: bool = False): + self.api_key = api_key + self.dry_run = dry_run + self.force = force + self.session = None + self.results = [] + + async def __aenter__(self): + self.session = aiohttp.ClientSession() + return self + + async def __aexit__(self, exc_type, exc_val, exc_tb): + if self.session: + await self.session.close() + + def extract_frontmatter_info(self, content: str) -> Tuple[Optional[Dict], str, bool]: + """Extract frontmatter info without full parsing.""" + frontmatter_pattern = r'^---\s*\n(.*?)\n---\s*\n(.*)$' + match = re.match(frontmatter_pattern, content, re.DOTALL) + + if not match: + return None, content, False + + try: + yaml_content = match.group(1) + body_content = match.group(2) + frontmatter_dict = yaml.safe_load(yaml_content) + has_doc_type = frontmatter_dict and 'doc_type' in frontmatter_dict + return frontmatter_dict or {}, body_content, has_doc_type + except yaml.YAMLError as e: + print(f"YAML parsing error: {e}") + return None, content, False + + async def categorize_document(self, content: str, filename: str, frontmatter: Dict) -> str: + """Send document to Claude API for categorization.""" + if not self.api_key: + raise ValueError("ANTHROPIC_API_KEY environment variable not set") + + # Prepare content for API + truncated_content = content[:MAX_CONTENT_LENGTH] + if len(content) > MAX_CONTENT_LENGTH: + truncated_content += "\n... (truncated)" + + # Build prompt + prompt = CATEGORIZATION_PROMPT.format( + filename=filename, + title=frontmatter.get('title', ''), + description=frontmatter.get('description', ''), + content=truncated_content + ) + + # API request + headers = { + 'x-api-key': self.api_key, + 'Content-Type': 'application/json', + 'anthropic-version': '2023-06-01' + } + + data = { + 'model': MODEL, + 'max_tokens': 20, + 'messages': [{'role': 'user', 'content': prompt}] + } + + async with self.session.post(API_URL, headers=headers, json=data) as response: + if response.status != 200: + error_text = await response.text() + raise Exception(f"API request failed: {response.status} - {error_text}") + + result = await response.json() + raw_response = result['content'][0]['text'].strip().lower() + + # Extract category from response + valid_categories = {'guide', 'reference', 'landing-page', 'changelog'} + + # Look for exact matches first + for category in valid_categories: + if category in raw_response: + return category + + # Fallback patterns with updated logic + if any(term in raw_response for term in ['changelog', 'change log', 'release notes', 'version history', 'what\'s new']): + return 'changelog' + elif any(term in raw_response for term in ['tutorial', 'how-to', 'how to', 'step-by-step', 'learning', 'guide', 'installation', 'setup']): + return 'guide' + elif any(term in raw_response for term in ['index', 'toc', 'table of contents', 'navigation', 'directory', 'links to']): + return 'landing-page' + else: + return 'reference' + + def add_doc_type_to_frontmatter(self, file_path: Path, category: str) -> bool: + """Add or update doc_type to existing frontmatter without reformatting.""" + try: + with open(file_path, 'r', encoding='utf-8') as f: + content = f.read() + + # Find the frontmatter sections + match = re.match(r'^(---\s*\n)(.*?)(\n---\s*\n)(.*)$', content, re.DOTALL) + if not match: + return False + + frontmatter_start = match.group(1) # "---\n" + frontmatter_content = match.group(2) # The YAML content + frontmatter_end = match.group(3) # "\n---\n" + body = match.group(4) # Rest of document + + # Check if doc_type already exists and update it, otherwise add it + doc_type_pattern = r'^doc_type:\s*.*$' + lines = frontmatter_content.split('\n') + + doc_type_updated = False + for i, line in enumerate(lines): + if re.match(doc_type_pattern, line.strip()): + lines[i] = f"doc_type: '{category}'" + doc_type_updated = True + break + + if not doc_type_updated: + # Add doc_type as the last line in frontmatter + new_frontmatter_content = frontmatter_content + f"\ndoc_type: '{category}'" + else: + new_frontmatter_content = '\n'.join(lines) + + new_content = f"{frontmatter_start}{new_frontmatter_content}{frontmatter_end}{body}" + + if not self.dry_run: + with open(file_path, 'w', encoding='utf-8') as f: + f.write(new_content) + + return True + except Exception as e: + print(f"Error updating {file_path}: {e}") + return False + + async def process_document(self, file_path: Path) -> Dict: + """Process a single document.""" + try: + with open(file_path, 'r', encoding='utf-8') as f: + content = f.read() + + frontmatter_dict, body, has_doc_type = self.extract_frontmatter_info(content) + + # Skip files without frontmatter + if frontmatter_dict is None: + return { + 'file': str(file_path), + 'status': 'skipped', + 'reason': 'no_frontmatter' + } + + # Skip if already categorized (unless force is enabled) + if has_doc_type and not self.force: + return { + 'file': str(file_path), + 'status': 'skipped', + 'reason': 'already_categorized', + 'existing_category': frontmatter_dict['doc_type'] + } + + # Categorize using API + category = await self.categorize_document(body, file_path.name, frontmatter_dict) + + # Update file + if self.add_doc_type_to_frontmatter(file_path, category): + return { + 'file': str(file_path), + 'status': 'success', + 'category': category + } + else: + return { + 'file': str(file_path), + 'status': 'error', + 'reason': 'failed_to_update' + } + + except Exception as e: + return { + 'file': str(file_path), + 'status': 'error', + 'reason': str(e) + } + + async def process_batch(self, files: List[Path]) -> List[Dict]: + """Process a batch of files.""" + tasks = [self.process_document(file_path) for file_path in files] + return await asyncio.gather(*tasks, return_exceptions=True) + + async def process_directory(self, directory: Path, pattern: str = "*.md") -> None: + """Process all matching files in directory.""" + files = list(directory.rglob(pattern)) + total_files = len(files) + + print(f"Found {total_files} markdown files") + if self.dry_run: + print("DRY RUN MODE - No files will be modified") + if self.force: + print("FORCE MODE - Re-categorizing documents that already have doc_type") + + processed = 0 + + # Process in batches + for i in range(0, total_files, BATCH_SIZE): + batch = files[i:i + BATCH_SIZE] + print(f"Processing batch {i // BATCH_SIZE + 1} ({len(batch)} files)...") + + try: + results = await self.process_batch(batch) + self.results.extend(results) + processed += len(batch) + + # Rate limiting + if i + BATCH_SIZE < total_files: + await asyncio.sleep(RATE_LIMIT_DELAY) + + # Progress update + print(f"Progress: {processed}/{total_files} files processed") + + except Exception as e: + print(f"Error processing batch: {e}") + continue + + def print_summary(self) -> None: + """Print processing summary.""" + success = sum(1 for r in self.results if r.get('status') == 'success') + skipped = sum(1 for r in self.results if r.get('status') == 'skipped') + errors = sum(1 for r in self.results if r.get('status') == 'error') + + print(f"\n=== Summary ===") + print(f"Successfully categorized: {success}") + print(f"Skipped (already categorized or no frontmatter): {skipped}") + print(f"Errors: {errors}") + + # Show category breakdown + categories = {} + for r in self.results: + if r.get('status') == 'success': + cat = r.get('category') + categories[cat] = categories.get(cat, 0) + 1 + + if categories: + print(f"\nCategory breakdown:") + for cat, count in sorted(categories.items()): + print(f" {cat}: {count}") + + # Show errors + error_results = [r for r in self.results if r.get('status') == 'error'] + if error_results: + print(f"\nErrors:") + for r in error_results[:10]: + print(f" {r['file']}: {r.get('reason', 'Unknown error')}") + if len(error_results) > 10: + print(f" ... and {len(error_results) - 10} more") + +async def main(): + parser = argparse.ArgumentParser(description='Categorize markdown documents using custom framework') + parser.add_argument('directory', help='Directory containing markdown files') + parser.add_argument('--pattern', default='*.md', help='File pattern to match (default: *.md)') + parser.add_argument('--force', action='store_true', help='Re-categorize documents that already have doc_type') + parser.add_argument('--dry-run', action='store_true', help='Show what would be done without making changes') + parser.add_argument('--output-log', help='Save results to JSON file') + + args = parser.parse_args() + + directory = Path(args.directory) + if not directory.exists(): + print(f"Error: Directory {directory} does not exist") + return 1 + + if not ANTHROPIC_API_KEY: + print("Error: ANTHROPIC_API_KEY environment variable not set") + print("Get your API key from: https://console.anthropic.com/") + return 1 + + async with DocumentCategorizer(ANTHROPIC_API_KEY, args.dry_run, args.force) as categorizer: + try: + await categorizer.process_directory(directory, args.pattern) + categorizer.print_summary() + + if args.output_log: + with open(args.output_log, 'w') as f: + json.dump({ + 'timestamp': datetime.now().isoformat(), + 'directory': str(directory), + 'pattern': args.pattern, + 'dry_run': args.dry_run, + 'force': args.force, + 'results': categorizer.results + }, f, indent=2) + print(f"Results saved to {args.output_log}") + + except KeyboardInterrupt: + print("\nInterrupted by user") + return 1 + except Exception as e: + print(f"Error: {e}") + return 1 + + return 0 + +if __name__ == '__main__': + exit(asyncio.run(main())) \ No newline at end of file