@clickhouse/client 0.1.0 → 0.2.0-beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/README.md +10 -6
  2. package/dist/client.d.ts +26 -128
  3. package/dist/client.js +39 -225
  4. package/dist/client.js.map +1 -1
  5. package/dist/connection/index.d.ts +3 -1
  6. package/dist/connection/index.js +3 -1
  7. package/dist/connection/index.js.map +1 -1
  8. package/dist/connection/node_base_connection.d.ts +50 -0
  9. package/dist/connection/node_base_connection.js +350 -0
  10. package/dist/connection/node_base_connection.js.map +1 -0
  11. package/dist/connection/node_http_connection.d.ts +11 -0
  12. package/dist/connection/node_http_connection.js +32 -0
  13. package/dist/connection/node_http_connection.js.map +1 -0
  14. package/dist/connection/node_https_connection.d.ts +12 -0
  15. package/dist/connection/node_https_connection.js +53 -0
  16. package/dist/connection/node_https_connection.js.map +1 -0
  17. package/dist/index.d.ts +4 -15
  18. package/dist/index.js +11 -9
  19. package/dist/index.js.map +1 -1
  20. package/dist/result_set.d.ts +13 -0
  21. package/dist/{result.js → result_set.js} +5 -32
  22. package/dist/result_set.js.map +1 -0
  23. package/dist/utils/encoder.d.ts +7 -0
  24. package/dist/utils/encoder.js +55 -0
  25. package/dist/utils/encoder.js.map +1 -0
  26. package/dist/utils/index.d.ts +3 -1
  27. package/dist/utils/index.js +3 -1
  28. package/dist/utils/index.js.map +1 -1
  29. package/dist/utils/process.js.map +1 -1
  30. package/dist/utils/stream.d.ts +1 -1
  31. package/dist/utils/stream.js.map +1 -1
  32. package/dist/utils/user_agent.js +1 -2
  33. package/dist/utils/user_agent.js.map +1 -1
  34. package/dist/version.d.ts +2 -2
  35. package/dist/version.js +2 -1
  36. package/dist/version.js.map +1 -1
  37. package/package.json +7 -48
  38. package/dist/clickhouse_types.d.ts +0 -24
  39. package/dist/clickhouse_types.js +0 -3
  40. package/dist/clickhouse_types.js.map +0 -1
  41. package/dist/connection/adapter/base_http_adapter.d.ts +0 -35
  42. package/dist/connection/adapter/base_http_adapter.js +0 -302
  43. package/dist/connection/adapter/base_http_adapter.js.map +0 -1
  44. package/dist/connection/adapter/http_adapter.d.ts +0 -10
  45. package/dist/connection/adapter/http_adapter.js +0 -27
  46. package/dist/connection/adapter/http_adapter.js.map +0 -1
  47. package/dist/connection/adapter/http_search_params.d.ts +0 -11
  48. package/dist/connection/adapter/http_search_params.js +0 -42
  49. package/dist/connection/adapter/http_search_params.js.map +0 -1
  50. package/dist/connection/adapter/https_adapter.d.ts +0 -11
  51. package/dist/connection/adapter/https_adapter.js +0 -48
  52. package/dist/connection/adapter/https_adapter.js.map +0 -1
  53. package/dist/connection/adapter/index.d.ts +0 -2
  54. package/dist/connection/adapter/index.js +0 -8
  55. package/dist/connection/adapter/index.js.map +0 -1
  56. package/dist/connection/adapter/transform_url.d.ts +0 -5
  57. package/dist/connection/adapter/transform_url.js +0 -15
  58. package/dist/connection/adapter/transform_url.js.map +0 -1
  59. package/dist/connection/connection.d.ts +0 -58
  60. package/dist/connection/connection.js +0 -17
  61. package/dist/connection/connection.js.map +0 -1
  62. package/dist/data_formatter/format_query_params.d.ts +0 -1
  63. package/dist/data_formatter/format_query_params.js +0 -61
  64. package/dist/data_formatter/format_query_params.js.map +0 -1
  65. package/dist/data_formatter/format_query_settings.d.ts +0 -2
  66. package/dist/data_formatter/format_query_settings.js +0 -21
  67. package/dist/data_formatter/format_query_settings.js.map +0 -1
  68. package/dist/data_formatter/formatter.d.ts +0 -23
  69. package/dist/data_formatter/formatter.js +0 -96
  70. package/dist/data_formatter/formatter.js.map +0 -1
  71. package/dist/data_formatter/index.d.ts +0 -3
  72. package/dist/data_formatter/index.js +0 -23
  73. package/dist/data_formatter/index.js.map +0 -1
  74. package/dist/error/index.d.ts +0 -1
  75. package/dist/error/index.js +0 -18
  76. package/dist/error/index.js.map +0 -1
  77. package/dist/error/parse_error.d.ts +0 -12
  78. package/dist/error/parse_error.js +0 -39
  79. package/dist/error/parse_error.js.map +0 -1
  80. package/dist/logger.d.ts +0 -30
  81. package/dist/logger.js +0 -100
  82. package/dist/logger.js.map +0 -1
  83. package/dist/result.d.ts +0 -52
  84. package/dist/result.js.map +0 -1
  85. package/dist/schema/common.d.ts +0 -8
  86. package/dist/schema/common.js +0 -3
  87. package/dist/schema/common.js.map +0 -1
  88. package/dist/schema/engines.d.ts +0 -40
  89. package/dist/schema/engines.js +0 -61
  90. package/dist/schema/engines.js.map +0 -1
  91. package/dist/schema/index.d.ts +0 -7
  92. package/dist/schema/index.js +0 -24
  93. package/dist/schema/index.js.map +0 -1
  94. package/dist/schema/query_formatter.d.ts +0 -9
  95. package/dist/schema/query_formatter.js +0 -48
  96. package/dist/schema/query_formatter.js.map +0 -1
  97. package/dist/schema/result.d.ts +0 -13
  98. package/dist/schema/result.js +0 -3
  99. package/dist/schema/result.js.map +0 -1
  100. package/dist/schema/schema.d.ts +0 -6
  101. package/dist/schema/schema.js +0 -20
  102. package/dist/schema/schema.js.map +0 -1
  103. package/dist/schema/stream.d.ts +0 -11
  104. package/dist/schema/stream.js +0 -25
  105. package/dist/schema/stream.js.map +0 -1
  106. package/dist/schema/table.d.ts +0 -44
  107. package/dist/schema/table.js +0 -73
  108. package/dist/schema/table.js.map +0 -1
  109. package/dist/schema/types.d.ts +0 -201
  110. package/dist/schema/types.js +0 -268
  111. package/dist/schema/types.js.map +0 -1
  112. package/dist/schema/where.d.ts +0 -8
  113. package/dist/schema/where.js +0 -43
  114. package/dist/schema/where.js.map +0 -1
  115. package/dist/settings.d.ts +0 -1453
  116. package/dist/settings.js +0 -28
  117. package/dist/settings.js.map +0 -1
  118. package/dist/utils/string.d.ts +0 -1
  119. package/dist/utils/string.js +0 -9
  120. package/dist/utils/string.js.map +0 -1
@@ -1,1453 +0,0 @@
1
- /**
2
- * @see {@link https://github.com/ClickHouse/ClickHouse/blob/46ed4f6cdf68fbbdc59fbe0f0bfa9a361cc0dec1/src/Core/Settings.h}
3
- * @see {@link https://github.com/ClickHouse/ClickHouse/blob/5f84f06d6d26672da3d97d0b236ebb46b5080989/src/Core/Defines.h}
4
- * @see {@link https://github.com/ClickHouse/ClickHouse/blob/eae2667a1c29565c801be0ffd465f8bfcffe77ef/src/Storages/MergeTree/MergeTreeSettings.h}
5
- */
6
- interface ClickHouseServerSettings {
7
- /** The actual size of the block to compress (default: 65536) */
8
- min_compress_block_size?: UInt64;
9
- /** The maximum size of blocks of uncompressed data before compressing for writing to a table. (default: 1048576) */
10
- max_compress_block_size?: UInt64;
11
- /** Maximum block size for reading (default: 65505) */
12
- max_block_size?: UInt64;
13
- /** The maximum block size for insertion (default: 1048545) */
14
- max_insert_block_size?: UInt64;
15
- /** Squash blocks passed to INSERT query to specified size in rows (default: 1048545) */
16
- min_insert_block_size_rows?: UInt64;
17
- /** Squash blocks passed to INSERT query to specified size in bytes (default: (1048545 * 256)) */
18
- min_insert_block_size_bytes?: UInt64;
19
- /** Like min_insert_block_size_rows (default: 0) */
20
- min_insert_block_size_rows_for_materialized_views?: UInt64;
21
- /** Like min_insert_block_size_bytes (default: 0) */
22
- min_insert_block_size_bytes_for_materialized_views?: UInt64;
23
- /** Maximum block size for JOIN result (if join algorithm supports it). 0 means unlimited. (default: 65505) */
24
- max_joined_block_size_rows?: UInt64;
25
- /** The maximum number of threads to execute the INSERT SELECT query. Values 0 or 1 means that INSERT SELECT is not run in parallel. Higher values will lead to higher memory usage. Parallel INSERT SELECT has effect only if the SELECT part is run on parallel (default: 0) */
26
- max_insert_threads?: UInt64;
27
- /** The maximum number of streams (columns) to delay final part flush. Default - auto (1000 in case of underlying storage supports parallel write (default: 0) */
28
- max_insert_delayed_streams_for_parallel_write?: UInt64;
29
- /** The maximum number of threads to read from table with FINAL. (default: 16) */
30
- max_final_threads?: UInt64;
31
- /** The maximum number of threads to execute the request. By default (default: 0) */
32
- max_threads?: MaxThreads;
33
- /** The maximum number of threads to download data (e.g. for URL engine). (default: 4) */
34
- max_download_threads?: MaxThreads;
35
- /** The maximal size of buffer for parallel downloading (e.g. for URL engine) per each thread. (default: 10*1024*1024) */
36
- max_download_buffer_size?: UInt64;
37
- /** The maximum size of the buffer to read from the filesystem. (default: 1048576) */
38
- max_read_buffer_size?: UInt64;
39
- /** The maximum number of connections for distributed processing of one query (should be greater than max_threads). (default: 1024) */
40
- max_distributed_connections?: UInt64;
41
- /** Which part of the query can be read into RAM for parsing (the remaining data for INSERT (default: 262144) */
42
- max_query_size?: UInt64;
43
- /** The interval in microseconds to check if the request is cancelled (default: 100000) */
44
- interactive_delay?: UInt64;
45
- /** Connection timeout if there are no replicas. (default: 10) */
46
- connect_timeout?: Seconds;
47
- /** Connection timeout for selecting first healthy replica. (default: 50) */
48
- connect_timeout_with_failover_ms?: Milliseconds;
49
- /** Connection timeout for selecting first healthy replica (for secure connections). (default: 100) */
50
- connect_timeout_with_failover_secure_ms?: Milliseconds;
51
- /** (default: 300) */
52
- receive_timeout?: Seconds;
53
- /** (default: 300) */
54
- send_timeout?: Seconds;
55
- /** Timeout for draining remote connections (default: 3) */
56
- drain_timeout?: Seconds;
57
- /** The time in seconds the connection needs to remain idle before TCP starts sending keepalive probes (default: 290 (less than 300)) */
58
- tcp_keep_alive_timeout?: Seconds;
59
- /** Connection timeout for establishing connection with replica for Hedged requests (default: 100) */
60
- hedged_connection_timeout_ms?: Milliseconds;
61
- /** Connection timeout for receiving first packet of data or packet with positive progress from replica (default: 2000) */
62
- receive_data_timeout_ms?: Milliseconds;
63
- /** Use hedged requests for distributed queries (default: true) */
64
- use_hedged_requests?: Bool;
65
- /** Allow HedgedConnections to change replica until receiving first data packet (default: false) */
66
- allow_changing_replica_until_first_data_packet?: Bool;
67
- /** The wait time in the request queue (default: 0) */
68
- queue_max_wait_ms?: Milliseconds;
69
- /** The wait time when the connection pool is full. (default: 0) */
70
- connection_pool_max_wait_ms?: Milliseconds;
71
- /** The wait time for running query with the same query_id to finish when setting 'replace_running_query' is active. (default: 5000) */
72
- replace_running_query_max_wait_ms?: Milliseconds;
73
- /** The wait time for reading from Kafka before retry. (default: 5000) */
74
- kafka_max_wait_ms?: Milliseconds;
75
- /** The wait time for reading from RabbitMQ before retry. (default: 5000) */
76
- rabbitmq_max_wait_ms?: Milliseconds;
77
- /** Block at the query wait loop on the server for the specified number of seconds. (default: 10) */
78
- poll_interval?: UInt64;
79
- /** Close idle TCP connections after specified number of seconds. (default: 3600) */
80
- idle_connection_timeout?: UInt64;
81
- /** Maximum number of connections with one remote server in the pool. (default: 1024) */
82
- distributed_connections_pool_size?: UInt64;
83
- /** The maximum number of attempts to connect to replicas. (default: 3) */
84
- connections_with_failover_max_tries?: UInt64;
85
- /** The minimum size of part to upload during multipart upload to S3. (default: 16*1024*1024) */
86
- s3_min_upload_part_size?: UInt64;
87
- /** Multiply s3_min_upload_part_size by this factor each time s3_multiply_parts_count_threshold parts were uploaded from a single write to S3. (default: 2) */
88
- s3_upload_part_size_multiply_factor?: UInt64;
89
- /** Each time this number of parts was uploaded to S3 s3_min_upload_part_size multiplied by s3_upload_part_size_multiply_factor. (default: 1000) */
90
- s3_upload_part_size_multiply_parts_count_threshold?: UInt64;
91
- /** The maximum size of object to upload using singlepart upload to S3. (default: 32*1024*1024) */
92
- s3_max_single_part_upload_size?: UInt64;
93
- /** The maximum number of retries during single S3 read. (default: 4) */
94
- s3_max_single_read_retries?: UInt64;
95
- /** Max number of S3 redirects hops allowed. (default: 10) */
96
- s3_max_redirects?: UInt64;
97
- /** The maximum number of connections per server. (default: 1024) */
98
- s3_max_connections?: UInt64;
99
- /** Enables or disables truncate before insert in s3 engine tables. (default: false) */
100
- s3_truncate_on_insert?: Bool;
101
- /** Enables or disables creating a new file on each insert in s3 engine tables (default: false) */
102
- s3_create_new_file_on_insert?: Bool;
103
- /** Enable very explicit logging of S3 requests. Makes sense for debug only. (default: false) */
104
- enable_s3_requests_logging?: Bool;
105
- /** The actual number of replications can be specified when the hdfs file is created. (default: 0) */
106
- hdfs_replication?: UInt64;
107
- /** Enables or disables truncate before insert in s3 engine tables (default: false) */
108
- hdfs_truncate_on_insert?: Bool;
109
- /** Enables or disables creating a new file on each insert in hdfs engine tables (default: false) */
110
- hdfs_create_new_file_on_insert?: Bool;
111
- /** Expired time for hsts. 0 means disable HSTS. (default: 0) */
112
- hsts_max_age?: UInt64;
113
- /** Calculate minimums and maximums of the result columns. They can be output in JSON-formats. (default: false) */
114
- extremes?: Bool;
115
- /** Whether to use the cache of uncompressed blocks. (default: false) */
116
- use_uncompressed_cache?: Bool;
117
- /** Whether the running request should be canceled with the same id as the new one. (default: false) */
118
- replace_running_query?: Bool;
119
- /** The maximum speed of data exchange over the network in bytes per second for replicated fetches. Zero means unlimited. Only has meaning at server startup. (default: 0) */
120
- max_replicated_fetches_network_bandwidth_for_server?: UInt64;
121
- /** The maximum speed of data exchange over the network in bytes per second for replicated sends. Zero means unlimited. Only has meaning at server startup. (default: 0) */
122
- max_replicated_sends_network_bandwidth_for_server?: UInt64;
123
- /** The maximum speed of data exchange over the network in bytes per second for read. Zero means unlimited. Only has meaning at server startup. (default: 0) */
124
- max_remote_read_network_bandwidth_for_server?: UInt64;
125
- /** The maximum speed of data exchange over the network in bytes per second for write. Zero means unlimited. Only has meaning at server startup. (default: 0) */
126
- max_remote_write_network_bandwidth_for_server?: UInt64;
127
- /** Allow direct SELECT query for Kafka (default: false) */
128
- stream_like_engine_allow_direct_select?: Bool;
129
- /** When stream like engine reads from multiple queues (default: "") */
130
- stream_like_engine_insert_queue?: string;
131
- /** Sleep time for StorageDistributed DirectoryMonitors (default: 100) */
132
- distributed_directory_monitor_sleep_time_ms?: Milliseconds;
133
- /** Maximum sleep time for StorageDistributed DirectoryMonitors (default: 30000) */
134
- distributed_directory_monitor_max_sleep_time_ms?: Milliseconds;
135
- /** Should StorageDistributed DirectoryMonitors try to batch individual inserts into bigger ones. (default: false) */
136
- distributed_directory_monitor_batch_inserts?: Bool;
137
- /** Should StorageDistributed DirectoryMonitors try to split batch into smaller in case of failures. (default: false) */
138
- distributed_directory_monitor_split_batch_on_failure?: Bool;
139
- /** Allows disabling WHERE to PREWHERE optimization in SELECT queries from MergeTree. (default: true) */
140
- optimize_move_to_prewhere?: Bool;
141
- /** If query has `FINAL` (default: false) */
142
- optimize_move_to_prewhere_if_final?: Bool;
143
- /** Wait for actions to manipulate the partitions. 0 - do not wait (default: 1) */
144
- replication_alter_partitions_sync?: UInt64;
145
- /** Wait for inactive replica to execute ALTER/OPTIMIZE. Time in seconds (default: 120) */
146
- replication_wait_for_inactive_replica_timeout?: Int64;
147
- /** Which replicas (among healthy replicas) to preferably send a query to (on the first attempt) for distributed processing. (default: 'random') */
148
- load_balancing?: LoadBalancing;
149
- /** Which replica to preferably send a query when FIRST_OR_RANDOM load balancing strategy is used. (default: 0) */
150
- load_balancing_first_offset?: UInt64;
151
- /** How to calculate TOTALS when HAVING is present (default: 'after_having_exclusive') */
152
- totals_mode?: TotalsMode;
153
- /** The threshold for totals_mode = 'auto'. (default: 0.5) */
154
- totals_auto_threshold?: Float;
155
- /** In CREATE TABLE statement allows specifying LowCardinality modifier for types of small fixed size (8 or less). Enabling this may increase merge times and memory consumption. (default: false) */
156
- allow_suspicious_low_cardinality_types?: Bool;
157
- /** Compile some scalar functions and operators to native code. (default: true) */
158
- compile_expressions?: Bool;
159
- /** The number of identical expressions before they are JIT-compiled (default: 3) */
160
- min_count_to_compile_expression?: UInt64;
161
- /** Compile aggregate functions to native code. (default: true) */
162
- compile_aggregate_expressions?: Bool;
163
- /** The number of identical aggregate expressions before they are JIT-compiled (default: 3) */
164
- min_count_to_compile_aggregate_expression?: UInt64;
165
- /** Compile sort description to native code. (default: true) */
166
- compile_sort_description?: Bool;
167
- /** The number of identical sort descriptions before they are JIT-compiled (default: 3) */
168
- min_count_to_compile_sort_description?: UInt64;
169
- /** From what number of keys (default: 100000) */
170
- group_by_two_level_threshold?: UInt64;
171
- /** From what size of the aggregation state in bytes (default: 50000000) */
172
- group_by_two_level_threshold_bytes?: UInt64;
173
- /** Is the memory-saving mode of distributed aggregation enabled. (default: true) */
174
- distributed_aggregation_memory_efficient?: Bool;
175
- /** Number of threads to use for merge intermediate aggregation results in memory efficient mode. When bigger (default: 0) */
176
- aggregation_memory_efficient_merge_threads?: UInt64;
177
- /** Enable positional arguments in ORDER BY (default: true) */
178
- enable_positional_arguments?: Bool;
179
- /** Treat columns mentioned in ROLLUP (default: false) */
180
- group_by_use_nulls?: Bool;
181
- /** The maximum number of replicas of each shard used when the query is executed. For consistency (to get different parts of the same partition) (default: 1) */
182
- max_parallel_replicas?: UInt64;
183
- /** " (default: 0) */
184
- parallel_replicas_count?: UInt64;
185
- /** " (default: 0) */
186
- parallel_replica_offset?: UInt64;
187
- /** If true (default: false) */
188
- allow_experimental_parallel_reading_from_replicas?: Bool;
189
- /** If true (default: false) */
190
- skip_unavailable_shards?: Bool;
191
- /** Process distributed INSERT SELECT query in the same cluster on local tables on every shard; if set to 1 - SELECT is executed on each shard; if set to 2 - SELECT and INSERT are executed on each shard (default: 0) */
192
- parallel_distributed_insert_select?: UInt64;
193
- /** If 1 (default: 0) */
194
- distributed_group_by_no_merge?: UInt64;
195
- /** If 1 (default: 1) */
196
- distributed_push_down_limit?: UInt64;
197
- /** Optimize GROUP BY sharding_key queries (by avoiding costly aggregation on the initiator server). (default: true) */
198
- optimize_distributed_group_by_sharding_key?: Bool;
199
- /** Limit for number of sharding key values (default: 1000) */
200
- optimize_skip_unused_shards_limit?: UInt64;
201
- /** Assumes that data is distributed by sharding_key. Optimization to skip unused shards if SELECT query filters by sharding_key. (default: false) */
202
- optimize_skip_unused_shards?: Bool;
203
- /** Rewrite IN in query for remote shards to exclude values that does not belong to the shard (requires optimize_skip_unused_shards) (default: true) */
204
- optimize_skip_unused_shards_rewrite_in?: Bool;
205
- /** Allow non-deterministic functions (includes dictGet) in sharding_key for optimize_skip_unused_shards (default: false) */
206
- allow_nondeterministic_optimize_skip_unused_shards?: Bool;
207
- /** Throw an exception if unused shards cannot be skipped (1 - throw only if the table has the sharding key (default: 0) */
208
- force_optimize_skip_unused_shards?: UInt64;
209
- /** Same as optimize_skip_unused_shards (default: 0) */
210
- optimize_skip_unused_shards_nesting?: UInt64;
211
- /** Same as force_optimize_skip_unused_shards (default: 0) */
212
- force_optimize_skip_unused_shards_nesting?: UInt64;
213
- /** Enable parallel parsing for some data formats. (default: true) */
214
- input_format_parallel_parsing?: Bool;
215
- /** The minimum chunk size in bytes (default: (10 * 1024 * 1024)) */
216
- min_chunk_bytes_for_parallel_parsing?: UInt64;
217
- /** Enable parallel formatting for some data formats. (default: true) */
218
- output_format_parallel_formatting?: Bool;
219
- /** If at least as many lines are read from one file (default: (20 * 8192)) */
220
- merge_tree_min_rows_for_concurrent_read?: UInt64;
221
- /** If at least as many bytes are read from one file (default: (24 * 10 * 1024 * 1024)) */
222
- merge_tree_min_bytes_for_concurrent_read?: UInt64;
223
- /** You can skip reading more than that number of rows at the price of one seek per file. (default: 0) */
224
- merge_tree_min_rows_for_seek?: UInt64;
225
- /** You can skip reading more than that number of bytes at the price of one seek per file. (default: 0) */
226
- merge_tree_min_bytes_for_seek?: UInt64;
227
- /** If the index segment can contain the required keys (default: 8) */
228
- merge_tree_coarse_index_granularity?: UInt64;
229
- /** The maximum number of rows per request (default: (128 * 8192)) */
230
- merge_tree_max_rows_to_use_cache?: UInt64;
231
- /** The maximum number of bytes per request (default: (192 * 10 * 1024 * 1024)) */
232
- merge_tree_max_bytes_to_use_cache?: UInt64;
233
- /** Merge parts only in one partition in select final (default: false) */
234
- do_not_merge_across_partitions_select_final?: Bool;
235
- /** The maximum number of rows in MySQL batch insertion of the MySQL storage engine (default: 65536) */
236
- mysql_max_rows_to_insert?: UInt64;
237
- /** The minimum length of the expression `expr = x1 OR ... expr = xN` for optimization (default: 3) */
238
- optimize_min_equality_disjunction_chain_length?: UInt64;
239
- /** The minimum number of bytes for reading the data with O_DIRECT option during SELECT queries execution. 0 - disabled. (default: 0) */
240
- min_bytes_to_use_direct_io?: UInt64;
241
- /** The minimum number of bytes for reading the data with mmap option during SELECT queries execution. 0 - disabled. (default: 0) */
242
- min_bytes_to_use_mmap_io?: UInt64;
243
- /** Validate checksums on reading. It is enabled by default and should be always enabled in production. Please do not expect any benefits in disabling this setting. It may only be used for experiments and benchmarks. The setting only applicable for tables of MergeTree family. Checksums are always validated for other table engines and when receiving data over network. (default: true) */
244
- checksum_on_read?: Bool;
245
- /** Throw an exception if there is a partition key in a table (default: false) */
246
- force_index_by_date?: Bool;
247
- /** Throw an exception if there is primary key in a table (default: false) */
248
- force_primary_key?: Bool;
249
- /** Use data skipping indexes during query execution. (default: true) */
250
- use_skip_indexes?: Bool;
251
- /** If query has FINAL (default: false) */
252
- use_skip_indexes_if_final?: Bool;
253
- /** Comma separated list of strings or literals with the name of the data skipping indices that should be used during query execution (default: "") */
254
- force_data_skipping_indices?: string;
255
- /** Allows you to use more sources than the number of threads - to more evenly distribute work across threads. It is assumed that this is a temporary solution (default: 1) */
256
- max_streams_to_max_threads_ratio?: Float;
257
- /** Ask more streams when reading from Merge table. Streams will be spread across tables that Merge table will use. This allows more even distribution of work across threads and especially helpful when merged tables differ in size. (default: 5) */
258
- max_streams_multiplier_for_merge_tables?: Float;
259
- /** Allows you to select the method of data compression when writing. (default: "LZ4") */
260
- network_compression_method?: string;
261
- /** Allows you to select the level of ZSTD compression. (default: 1) */
262
- network_zstd_compression_level?: Int64;
263
- /** Allows you to select the max window log of ZSTD (it will not be used for MergeTree family) (default: 0) */
264
- zstd_window_log_max?: Int64;
265
- /** Priority of the query. 1 - the highest (default: 0) */
266
- priority?: UInt64;
267
- /** If non zero - set corresponding 'nice' value for query processing threads. Can be used to adjust query priority for OS scheduler. (default: 0) */
268
- os_thread_priority?: Int64;
269
- /** Log requests and write the log to the system table. (default: true) */
270
- log_queries?: Bool;
271
- /** Log formatted queries and write the log to the system table. (default: false) */
272
- log_formatted_queries?: Bool;
273
- /** Minimal type in query_log to log (default: 'QUERY_START') */
274
- log_queries_min_type?: LogQueriesType;
275
- /** Minimal time for the query to run (default: 0) */
276
- log_queries_min_query_duration_ms?: Milliseconds;
277
- /** If query length is greater than specified threshold (in bytes) (default: 100000) */
278
- log_queries_cut_to_length?: UInt64;
279
- /** Log queries with the specified probabality. (default: 1.) */
280
- log_queries_probability?: Float;
281
- /** Log Processors profile events. (default: false) */
282
- log_processors_profiles?: Bool;
283
- /** How are distributed subqueries performed inside IN or JOIN sections? (default: 'deny') */
284
- distributed_product_mode?: DistributedProductMode;
285
- /** The maximum number of concurrent requests for all users. (default: 0) */
286
- max_concurrent_queries_for_all_users?: UInt64;
287
- /** The maximum number of concurrent requests per user. (default: 0) */
288
- max_concurrent_queries_for_user?: UInt64;
289
- /** For INSERT queries in the replicated table (default: true) */
290
- insert_deduplicate?: Bool;
291
- /** For INSERT queries in the replicated table (default: 0) */
292
- insert_quorum?: UInt64Auto;
293
- /** " (default: 600000) */
294
- insert_quorum_timeout?: Milliseconds;
295
- /** For quorum INSERT queries - enable to make parallel inserts without linearizability (default: true) */
296
- insert_quorum_parallel?: Bool;
297
- /** For SELECT queries from the replicated table (default: 0) */
298
- select_sequential_consistency?: UInt64;
299
- /** The maximum number of different shards and the maximum number of replicas of one shard in the `remote` function. (default: 1000) */
300
- table_function_remote_max_addresses?: UInt64;
301
- /** Setting to reduce the number of threads in case of slow reads. Pay attention only to reads that took at least that much time. (default: 1000) */
302
- read_backoff_min_latency_ms?: Milliseconds;
303
- /** Settings to reduce the number of threads in case of slow reads. Count events when the read bandwidth is less than that many bytes per second. (default: 1048576) */
304
- read_backoff_max_throughput?: UInt64;
305
- /** Settings to reduce the number of threads in case of slow reads. Do not pay attention to the event (default: 1000) */
306
- read_backoff_min_interval_between_events_ms?: Milliseconds;
307
- /** Settings to reduce the number of threads in case of slow reads. The number of events after which the number of threads will be reduced. (default: 2) */
308
- read_backoff_min_events?: UInt64;
309
- /** Settings to try keeping the minimal number of threads in case of slow reads. (default: 1) */
310
- read_backoff_min_concurrency?: UInt64;
311
- /** For testing of `exception safety` - throw an exception every time you allocate memory with the specified probability. (default: 0.) */
312
- memory_tracker_fault_probability?: Float;
313
- /** Compress the result if the client over HTTP said that it understands data compressed by gzip or deflate. (default: false) */
314
- enable_http_compression?: Bool;
315
- /** Compression level - used if the client on HTTP said that it understands data compressed by gzip or deflate. (default: 3) */
316
- http_zlib_compression_level?: Int64;
317
- /** If you uncompress the POST data from the client compressed by the native format (default: false) */
318
- http_native_compression_disable_checksumming_on_decompress?: Bool;
319
- /** What aggregate function to use for implementation of count(DISTINCT ...) (default: "uniqExact") */
320
- count_distinct_implementation?: string;
321
- /** Write add http CORS header. (default: false) */
322
- add_http_cors_header?: Bool;
323
- /** Max number of http GET redirects hops allowed. Make sure additional security measures are in place to prevent a malicious server to redirect your requests to unexpected services. (default: 0) */
324
- max_http_get_redirects?: UInt64;
325
- /** Use client timezone for interpreting DateTime string values (default: false) */
326
- use_client_time_zone?: Bool;
327
- /** Send progress notifications using X-ClickHouse-Progress headers. Some clients do not support high amount of HTTP headers (Python requests in particular) (default: false) */
328
- send_progress_in_http_headers?: Bool;
329
- /** Do not send HTTP headers X-ClickHouse-Progress more frequently than at each specified interval. (default: 100) */
330
- http_headers_progress_interval_ms?: UInt64;
331
- /** Do fsync after changing metadata for tables and databases (.sql files). Could be disabled in case of poor latency on server with high load of DDL queries and high load of disk subsystem. (default: true) */
332
- fsync_metadata?: Bool;
333
- /** Use NULLs for non-joined rows of outer JOINs for types that can be inside Nullable. If false (default: false) */
334
- join_use_nulls?: Bool;
335
- /** Set default strictness in JOIN query (default: 'ALL') */
336
- join_default_strictness?: JoinStrictness;
337
- /** Enable old ANY JOIN logic with many-to-one left-to-right table keys mapping for all ANY JOINs. It leads to confusing not equal results for 't1 ANY LEFT JOIN t2' and 't2 ANY RIGHT JOIN t1'. ANY RIGHT JOIN needs one-to-many keys mapping to be consistent with LEFT one. (default: false) */
338
- any_join_distinct_right_table_keys?: Bool;
339
- /** " (default: 1000000) */
340
- preferred_block_size_bytes?: UInt64;
341
- /** If set (default: 300) */
342
- max_replica_delay_for_distributed_queries?: UInt64;
343
- /** Suppose max_replica_delay_for_distributed_queries is set and all replicas for the queried table are stale. If this setting is enabled (default: true) */
344
- fallback_to_stale_replicas_for_distributed_queries?: Bool;
345
- /** Limit on max column size in block while reading. Helps to decrease cache misses count. Should be close to L2 cache size. (default: 0) */
346
- preferred_max_column_in_block_size_bytes?: UInt64;
347
- /** If the destination table contains at least that many active parts in a single partition (default: 150) */
348
- parts_to_delay_insert?: UInt64;
349
- /** If more than this number active parts in a single partition of the destination table (default: 300) */
350
- parts_to_throw_insert?: UInt64;
351
- /** If setting is enabled (default: false) */
352
- insert_distributed_sync?: Bool;
353
- /** Timeout for insert query into distributed. Setting is used only with insert_distributed_sync enabled. Zero value means no timeout. (default: 0) */
354
- insert_distributed_timeout?: UInt64;
355
- /** Timeout for DDL query responses from all hosts in cluster. If a ddl request has not been performed on all hosts (default: 180) */
356
- distributed_ddl_task_timeout?: Int64;
357
- /** Timeout for flushing data from streaming storages. (default: 7500) */
358
- stream_flush_interval_ms?: Milliseconds;
359
- /** Timeout for polling data from/to streaming storages. (default: 500) */
360
- stream_poll_timeout_ms?: Milliseconds;
361
- /** Time to sleep in sending tables status response in TCPHandler (default: 0) */
362
- sleep_in_send_tables_status_ms?: Milliseconds;
363
- /** Time to sleep in sending data in TCPHandler (default: 0) */
364
- sleep_in_send_data_ms?: Milliseconds;
365
- /** Time to sleep after receiving query in TCPHandler (default: 0) */
366
- sleep_after_receiving_query_ms?: Milliseconds;
367
- /** Send unknown packet instead of data Nth data packet (default: 0) */
368
- unknown_packet_in_send_data?: UInt64;
369
- /** Time to sleep in receiving cancel in TCPHandler (default: 0) */
370
- sleep_in_receive_cancel_ms?: Milliseconds;
371
- /** If setting is enabled (default: false) */
372
- insert_allow_materialized_columns?: Bool;
373
- /** HTTP connection timeout. (default: 1) */
374
- http_connection_timeout?: Seconds;
375
- /** HTTP send timeout (default: 180) */
376
- http_send_timeout?: Seconds;
377
- /** HTTP receive timeout (default: 180) */
378
- http_receive_timeout?: Seconds;
379
- /** Maximum URI length of HTTP request (default: 1048576) */
380
- http_max_uri_size?: UInt64;
381
- /** Maximum number of fields in HTTP header (default: 1000000) */
382
- http_max_fields?: UInt64;
383
- /** Maximum length of field name in HTTP header (default: 1048576) */
384
- http_max_field_name_size?: UInt64;
385
- /** Maximum length of field value in HTTP header (default: 1048576) */
386
- http_max_field_value_size?: UInt64;
387
- /** Skip url's for globs with HTTP_NOT_FOUND error (default: true) */
388
- http_skip_not_found_url_for_globs?: Bool;
389
- /** If setting is enabled and OPTIMIZE query didn't actually assign a merge then an explanatory exception is thrown (default: false) */
390
- optimize_throw_if_noop?: Bool;
391
- /** Try using an index if there is a subquery or a table expression on the right side of the IN operator. (default: true) */
392
- use_index_for_in_with_subqueries?: Bool;
393
- /** Force joined subqueries and table functions to have aliases for correct name qualification. (default: true) */
394
- joined_subquery_requires_alias?: Bool;
395
- /** Return empty result when aggregating without keys on empty set. (default: false) */
396
- empty_result_for_aggregation_by_empty_set?: Bool;
397
- /** Return empty result when aggregating by constant keys on empty set. (default: true) */
398
- empty_result_for_aggregation_by_constant_keys_on_empty_set?: Bool;
399
- /** If it is set to true (default: true) */
400
- allow_distributed_ddl?: Bool;
401
- /** If it is set to true (default: false) */
402
- allow_suspicious_codecs?: Bool;
403
- /** If it is set to true (default: false) */
404
- allow_experimental_codecs?: Bool;
405
- /** Period for real clock timer of query profiler (in nanoseconds). Set 0 value to turn off the real clock query profiler. Recommended value is at least 10000000 (100 times a second) for single queries or 1000000000 (once a second) for cluster-wide profiling. (default: QUERY_PROFILER_DEFAULT_SAMPLE_RATE_NS) */
406
- query_profiler_real_time_period_ns?: UInt64;
407
- /** Period for CPU clock timer of query profiler (in nanoseconds). Set 0 value to turn off the CPU clock query profiler. Recommended value is at least 10000000 (100 times a second) for single queries or 1000000000 (once a second) for cluster-wide profiling. (default: QUERY_PROFILER_DEFAULT_SAMPLE_RATE_NS) */
408
- query_profiler_cpu_time_period_ns?: UInt64;
409
- /** If enabled (default: false) */
410
- metrics_perf_events_enabled?: Bool;
411
- /** Comma separated list of perf metrics that will be measured throughout queries' execution. Empty means all events. See PerfEventInfo in sources for the available events. (default: "") */
412
- metrics_perf_events_list?: string;
413
- /** Probability to start an OpenTelemetry trace for an incoming query. (default: 0.) */
414
- opentelemetry_start_trace_probability?: Float;
415
- /** Collect OpenTelemetry spans for processors. (default: false) */
416
- opentelemetry_trace_processors?: Bool;
417
- /** Prefer using column names instead of aliases if possible. (default: false) */
418
- prefer_column_name_to_alias?: Bool;
419
- /** If enabled (default: false) */
420
- prefer_global_in_and_join?: Bool;
421
- /** Limit on read rows from the most 'deep' sources. That is (default: 0) */
422
- max_rows_to_read?: UInt64;
423
- /** Limit on read bytes (after decompression) from the most 'deep' sources. That is (default: 0) */
424
- max_bytes_to_read?: UInt64;
425
- /** What to do when the limit is exceeded. (default: 'throw') */
426
- read_overflow_mode?: OverflowMode;
427
- /** Limit on read rows on the leaf nodes for distributed queries. Limit is applied for local reads only excluding the final merge stage on the root node. (default: 0) */
428
- max_rows_to_read_leaf?: UInt64;
429
- /** Limit on read bytes (after decompression) on the leaf nodes for distributed queries. Limit is applied for local reads only excluding the final merge stage on the root node. (default: 0) */
430
- max_bytes_to_read_leaf?: UInt64;
431
- /** What to do when the leaf limit is exceeded. (default: 'throw') */
432
- read_overflow_mode_leaf?: OverflowMode;
433
- /** " (default: 0) */
434
- max_rows_to_group_by?: UInt64;
435
- /** What to do when the limit is exceeded. (default: 'throw') */
436
- group_by_overflow_mode?: OverflowModeGroupBy;
437
- /** " (default: 0) */
438
- max_bytes_before_external_group_by?: UInt64;
439
- /** " (default: 0) */
440
- max_rows_to_sort?: UInt64;
441
- /** " (default: 0) */
442
- max_bytes_to_sort?: UInt64;
443
- /** What to do when the limit is exceeded. (default: 'throw') */
444
- sort_overflow_mode?: OverflowMode;
445
- /** " (default: 0) */
446
- max_bytes_before_external_sort?: UInt64;
447
- /** In case of ORDER BY with LIMIT (default: 1000000000) */
448
- max_bytes_before_remerge_sort?: UInt64;
449
- /** If memory usage after remerge does not reduced by this ratio (default: 2.) */
450
- remerge_sort_lowered_memory_bytes_ratio?: Float;
451
- /** Limit on result size in rows. Also checked for intermediate data sent from remote servers. (default: 0) */
452
- max_result_rows?: UInt64;
453
- /** Limit on result size in bytes (uncompressed). Also checked for intermediate data sent from remote servers. (default: 0) */
454
- max_result_bytes?: UInt64;
455
- /** What to do when the limit is exceeded. (default: 'throw') */
456
- result_overflow_mode?: OverflowMode;
457
- /** " (default: 0) */
458
- max_execution_time?: Seconds;
459
- /** What to do when the limit is exceeded. (default: 'throw') */
460
- timeout_overflow_mode?: OverflowMode;
461
- /** Minimum number of execution rows per second. (default: 0) */
462
- min_execution_speed?: UInt64;
463
- /** Maximum number of execution rows per second. (default: 0) */
464
- max_execution_speed?: UInt64;
465
- /** Minimum number of execution bytes per second. (default: 0) */
466
- min_execution_speed_bytes?: UInt64;
467
- /** Maximum number of execution bytes per second. (default: 0) */
468
- max_execution_speed_bytes?: UInt64;
469
- /** Check that the speed is not too low after the specified time has elapsed. (default: 10) */
470
- timeout_before_checking_execution_speed?: Seconds;
471
- /** " (default: 0) */
472
- max_columns_to_read?: UInt64;
473
- /** " (default: 0) */
474
- max_temporary_columns?: UInt64;
475
- /** " (default: 0) */
476
- max_temporary_non_const_columns?: UInt64;
477
- /** " (default: 100) */
478
- max_subquery_depth?: UInt64;
479
- /** " (default: 1000) */
480
- max_pipeline_depth?: UInt64;
481
- /** Maximum depth of query syntax tree. Checked after parsing. (default: 1000) */
482
- max_ast_depth?: UInt64;
483
- /** Maximum size of query syntax tree in number of nodes. Checked after parsing. (default: 50000) */
484
- max_ast_elements?: UInt64;
485
- /** Maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. (default: 500000) */
486
- max_expanded_ast_elements?: UInt64;
487
- /** 0 - everything is allowed. 1 - only read requests. 2 - only read requests (default: 0) */
488
- readonly?: UInt64;
489
- /** Maximum size of the set (in number of elements) resulting from the execution of the IN section. (default: 0) */
490
- max_rows_in_set?: UInt64;
491
- /** Maximum size of the set (in bytes in memory) resulting from the execution of the IN section. (default: 0) */
492
- max_bytes_in_set?: UInt64;
493
- /** What to do when the limit is exceeded. (default: 'throw') */
494
- set_overflow_mode?: OverflowMode;
495
- /** Maximum size of the hash table for JOIN (in number of rows). (default: 0) */
496
- max_rows_in_join?: UInt64;
497
- /** Maximum size of the hash table for JOIN (in number of bytes in memory). (default: 0) */
498
- max_bytes_in_join?: UInt64;
499
- /** What to do when the limit is exceeded. (default: 'throw') */
500
- join_overflow_mode?: OverflowMode;
501
- /** When disabled (default) ANY JOIN will take the first found row for a key. When enabled, it will take the last row seen if there are multiple rows for the same key. (default: false) */
502
- join_any_take_last_row?: Bool;
503
- /** Specify join algorithm */
504
- join_algorithm?: JoinAlgorithm;
505
- /** Maximum size of right-side table if limit is required but max_bytes_in_join is not set. (default: 1000000000) */
506
- default_max_bytes_in_join?: UInt64;
507
- /** If not 0 group left table blocks in bigger ones for left-side table in partial merge join. It uses up to 2x of specified memory per joining thread. (default: 0) */
508
- partial_merge_join_left_table_buffer_bytes?: UInt64;
509
- /** Split right-hand joining data in blocks of specified size. It's a portion of data indexed by min-max values and possibly unloaded on disk. (default: 65536) */
510
- partial_merge_join_rows_in_right_blocks?: UInt64;
511
- /** For MergeJoin on disk set how much files it's allowed to sort simultaneously. Then this value bigger then more memory used and then less disk I/O needed. Minimum is 2. (default: 64) */
512
- join_on_disk_max_files_to_merge?: UInt64;
513
- /** Compatibility ignore collation in create table (default: true) */
514
- compatibility_ignore_collation_in_create_table?: Bool;
515
- /** Set compression codec for temporary files (sort and join on disk). I.e. LZ4 (default: "LZ4") */
516
- temporary_files_codec?: string;
517
- /** Maximum size (in rows) of the transmitted external table obtained when the GLOBAL IN/JOIN section is executed. (default: 0) */
518
- max_rows_to_transfer?: UInt64;
519
- /** Maximum size (in uncompressed bytes) of the transmitted external table obtained when the GLOBAL IN/JOIN section is executed. (default: 0) */
520
- max_bytes_to_transfer?: UInt64;
521
- /** What to do when the limit is exceeded. (default: 'throw') */
522
- transfer_overflow_mode?: OverflowMode;
523
- /** Maximum number of elements during execution of DISTINCT. (default: 0) */
524
- max_rows_in_distinct?: UInt64;
525
- /** Maximum total size of state (in uncompressed bytes) in memory for the execution of DISTINCT. (default: 0) */
526
- max_bytes_in_distinct?: UInt64;
527
- /** What to do when the limit is exceeded. (default: 'throw') */
528
- distinct_overflow_mode?: OverflowMode;
529
- /** Maximum memory usage for processing of single query. Zero means unlimited. (default: 0) */
530
- max_memory_usage?: UInt64;
531
- /** It represents soft memory limit on the user level. This value is used to compute query overcommit ratio. (default: 1_GiB) */
532
- memory_overcommit_ratio_denominator?: UInt64;
533
- /** Maximum memory usage for processing all concurrently running queries for the user. Zero means unlimited. (default: 0) */
534
- max_memory_usage_for_user?: UInt64;
535
- /** It represents soft memory limit on the global level. This value is used to compute query overcommit ratio. (default: 1_GiB) */
536
- memory_overcommit_ratio_denominator_for_user?: UInt64;
537
- /** Small allocations and deallocations are grouped in thread local variable and tracked or profiled only when amount (in absolute value) becomes larger than specified value. If the value is higher than 'memory_profiler_step' it will be effectively lowered to 'memory_profiler_step'. (default: (4 * 1024 * 1024)) */
538
- max_untracked_memory?: UInt64;
539
- /** Whenever query memory usage becomes larger than every next step in number of bytes the memory profiler will collect the allocating stack trace. Zero means disabled memory profiler. Values lower than a few megabytes will slow down query processing. (default: (4 * 1024 * 1024)) */
540
- memory_profiler_step?: UInt64;
541
- /** Collect random allocations and deallocations and write them into system.trace_log with 'MemorySample' trace_type. The probability is for every alloc/free regardless to the size of the allocation. Note that sampling happens only when the amount of untracked memory exceeds 'max_untracked_memory'. You may want to set 'max_untracked_memory' to 0 for extra fine grained sampling. (default: 0.) */
542
- memory_profiler_sample_probability?: Float;
543
- /** Maximum time thread will wait for memory to be freed in the case of memory overcommit. If timeout is reached and memory is not freed (default: 5'000'000) */
544
- memory_usage_overcommit_max_wait_microseconds?: UInt64;
545
- /** The maximum speed of data exchange over the network in bytes per second for a query. Zero means unlimited. (default: 0) */
546
- max_network_bandwidth?: UInt64;
547
- /** The maximum number of bytes (compressed) to receive or transmit over the network for execution of the query. (default: 0) */
548
- max_network_bytes?: UInt64;
549
- /** The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Zero means unlimited. (default: 0) */
550
- max_network_bandwidth_for_user?: UInt64;
551
- /** The maximum speed of data exchange over the network in bytes per second for all concurrently running queries. Zero means unlimited. (default: 0) */
552
- max_network_bandwidth_for_all_users?: UInt64;
553
- /** The maximum number of threads to execute BACKUP requests. (default: 16) */
554
- backup_threads?: UInt64;
555
- /** The maximum number of threads to execute RESTORE requests. (default: 16) */
556
- restore_threads?: UInt64;
557
- /** Log query performance statistics into the query_log (default: true) */
558
- log_profile_events?: Bool;
559
- /** Log query settings into the query_log. (default: true) */
560
- log_query_settings?: Bool;
561
- /** Log query threads into system.query_thread_log table. This setting have effect only when 'log_queries' is true. (default: false) */
562
- log_query_threads?: Bool;
563
- /** Log query dependent views into system.query_views_log table. This setting have effect only when 'log_queries' is true. (default: true) */
564
- log_query_views?: Bool;
565
- /** Log comment into system.query_log table and server log. It can be set to arbitrary string no longer than max_query_size. (default: "") */
566
- log_comment?: string;
567
- /** Send server text logs with specified minimum level to client (default: 'fatal') */
568
- send_logs_level?: LogsLevel;
569
- /** Send server text logs with specified regexp to match log source name. Empty means all sources. (default: "") */
570
- send_logs_source_regexp?: string;
571
- /** If it is set to true (default: true) */
572
- enable_optimize_predicate_expression?: Bool;
573
- /** Allow push predicate to final subquery. (default: true) */
574
- enable_optimize_predicate_expression_to_final_subquery?: Bool;
575
- /** Allows push predicate when subquery contains WITH clause (default: true) */
576
- allow_push_predicate_when_subquery_contains_with?: Bool;
577
- /** Maximum size (in rows) of shared global dictionary for LowCardinality type. (default: 8192) */
578
- low_cardinality_max_dictionary_size?: UInt64;
579
- /** LowCardinality type serialization setting. If is true (default: false) */
580
- low_cardinality_use_single_dictionary_for_part?: Bool;
581
- /** Check overflow of decimal arithmetic/comparison operations (default: true) */
582
- decimal_check_overflow?: Bool;
583
- /** If it's true then queries will be always sent to local replica (if it exists). If it's false then replica to send a query will be chosen between local and remote ones according to load_balancing (default: true) */
584
- prefer_localhost_replica?: Bool;
585
- /** Amount of retries while fetching partition from another host. (default: 5) */
586
- max_fetch_partition_retries_count?: UInt64;
587
- /** Limit on size of multipart/form-data content. This setting cannot be parsed from URL parameters and should be set in user profile. Note that content is parsed and external tables are created in memory before start of query execution. And this is the only limit that has effect on that stage (limits on max memory usage and max execution time have no effect while reading HTTP form data). (default: 1024 * 1024 * 1024) */
588
- http_max_multipart_form_data_size?: UInt64;
589
- /** Calculate text stack trace in case of exceptions during query execution. This is the default. It requires symbol lookups that may slow down fuzzing tests when huge amount of wrong queries are executed. In normal cases you should not disable this option. (default: true) */
590
- calculate_text_stack_trace?: Bool;
591
- /** If it is set to true (default: true) */
592
- allow_ddl?: Bool;
593
- /** Enables pushing to attached views concurrently instead of sequentially. (default: false) */
594
- parallel_view_processing?: Bool;
595
- /** Allow ARRAY JOIN with multiple arrays that have different sizes. When this settings is enabled (default: false) */
596
- enable_unaligned_array_join?: Bool;
597
- /** Enable ORDER BY optimization for reading data in corresponding order in MergeTree tables. (default: true) */
598
- optimize_read_in_order?: Bool;
599
- /** Enable ORDER BY optimization in window clause for reading data in corresponding order in MergeTree tables. (default: true) */
600
- optimize_read_in_window_order?: Bool;
601
- /** Enable GROUP BY optimization for aggregating data in corresponding order in MergeTree tables. (default: false) */
602
- optimize_aggregation_in_order?: Bool;
603
- /** Maximal size of block in bytes accumulated during aggregation in order of primary key. Lower block size allows to parallelize more final merge stage of aggregation. (default: 50000000) */
604
- aggregation_in_order_max_block_bytes?: UInt64;
605
- /** Minimal number of parts to read to run preliminary merge step during multithread reading in order of primary key. (default: 100) */
606
- read_in_order_two_level_merge_threshold?: UInt64;
607
- /** Use LowCardinality type in Native format. Otherwise (default: true) */
608
- low_cardinality_allow_in_native_format?: Bool;
609
- /** Cancel HTTP readonly queries when a client closes the connection without waiting for response. (default: false) */
610
- cancel_http_readonly_queries_on_client_close?: Bool;
611
- /** If it is set to true (default: true) */
612
- external_table_functions_use_nulls?: Bool;
613
- /** If it is set to true (default: false) */
614
- external_table_strict_query?: Bool;
615
- /** Allow functions that use Hyperscan library. Disable to avoid potentially long compilation times and excessive resource usage. (default: true) */
616
- allow_hyperscan?: Bool;
617
- /** Max length of regexp than can be used in hyperscan multi-match functions. Zero means unlimited. (default: 0) */
618
- max_hyperscan_regexp_length?: UInt64;
619
- /** Max total length of all regexps than can be used in hyperscan multi-match functions (per every function). Zero means unlimited. (default: 0) */
620
- max_hyperscan_regexp_total_length?: UInt64;
621
- /** Allow using simdjson library in 'JSON*' functions if AVX2 instructions are available. If disabled rapidjson will be used. (default: true) */
622
- allow_simdjson?: Bool;
623
- /** Allow functions for introspection of ELF and DWARF for query profiling. These functions are slow and may impose security considerations. (default: false) */
624
- allow_introspection_functions?: Bool;
625
- /** Limit maximum number of partitions in single INSERTed block. Zero means unlimited. Throw exception if the block contains too many partitions. This setting is a safety threshold (default: 100) */
626
- max_partitions_per_insert_block?: UInt64;
627
- /** Limit the max number of partitions that can be accessed in one query. <= 0 means unlimited. (default: -1) */
628
- max_partitions_to_read?: Int64;
629
- /** Return check query result as single 1/0 value (default: true) */
630
- check_query_single_value_result?: Bool;
631
- /** Allow ALTER TABLE ... DROP DETACHED PART[ITION] ... queries (default: false) */
632
- allow_drop_detached?: Bool;
633
- /** Connection pool size for PostgreSQL table engine and database engine. (default: 16) */
634
- postgresql_connection_pool_size?: UInt64;
635
- /** Connection pool push/pop timeout on empty pool for PostgreSQL table engine and database engine. By default it will block on empty pool. (default: 5000) */
636
- postgresql_connection_pool_wait_timeout?: UInt64;
637
- /** Close connection before returning connection to the pool. (default: false) */
638
- postgresql_connection_pool_auto_close_connection?: Bool;
639
- /** Maximum number of allowed addresses (For external storages (default: 1000) */
640
- glob_expansion_max_elements?: UInt64;
641
- /** Connection pool size for each connection settings string in ODBC bridge. (default: 16) */
642
- odbc_bridge_connection_pool_size?: UInt64;
643
- /** Use connection pooling in ODBC bridge. If set to false (default: true) */
644
- odbc_bridge_use_connection_pooling?: Bool;
645
- /** Time period reduces replica error counter by 2 times. (default: 60) */
646
- distributed_replica_error_half_life?: Seconds;
647
- /** Max number of errors per replica (default: 1000) */
648
- distributed_replica_error_cap?: UInt64;
649
- /** Number of errors that will be ignored while choosing replicas (default: 0) */
650
- distributed_replica_max_ignored_errors?: UInt64;
651
- /** Enable LIVE VIEW. Not mature enough. (default: false) */
652
- allow_experimental_live_view?: Bool;
653
- /** The heartbeat interval in seconds to indicate live query is alive. (default: 15) */
654
- live_view_heartbeat_interval?: Seconds;
655
- /** Limit maximum number of inserted blocks after which mergeable blocks are dropped and query is re-executed. (default: 64) */
656
- max_live_view_insert_blocks_before_refresh?: UInt64;
657
- /** Enable WINDOW VIEW. Not mature enough. (default: false) */
658
- allow_experimental_window_view?: Bool;
659
- /** The clean interval of window view in seconds to free outdated data. (default: 60) */
660
- window_view_clean_interval?: Seconds;
661
- /** The heartbeat interval in seconds to indicate watch query is alive. (default: 15) */
662
- window_view_heartbeat_interval?: Seconds;
663
- /** Timeout for waiting for window view fire signal in event time processing (default: 10) */
664
- wait_for_window_view_fire_signal_timeout?: Seconds;
665
- /** The minimum disk space to keep while writing temporary data used in external sorting and aggregation. (default: 0) */
666
- min_free_disk_space_for_temporary_data?: UInt64;
667
- /** Default table engine used when ENGINE is not set in CREATE statement. (default: 'None') */
668
- default_table_engine?: DefaultTableEngine;
669
- /** For tables in databases with Engine=Atomic show UUID of the table in its CREATE query. (default: false) */
670
- show_table_uuid_in_table_create_query_if_not_nil?: Bool;
671
- /** When executing DROP or DETACH TABLE in Atomic database (default: false) */
672
- database_atomic_wait_for_drop_and_detach_synchronously?: Bool;
673
- /** If it is set to true (default: true) */
674
- enable_scalar_subquery_optimization?: Bool;
675
- /** Process trivial 'SELECT count() FROM table' query from metadata. (default: true) */
676
- optimize_trivial_count_query?: Bool;
677
- /** If it is set to true (default: true) */
678
- optimize_respect_aliases?: Bool;
679
- /** Wait for synchronous execution of ALTER TABLE UPDATE/DELETE queries (mutations). 0 - execute asynchronously. 1 - wait current server. 2 - wait all replicas if they exist. (default: 0) */
680
- mutations_sync?: UInt64;
681
- /** Enable lightweight DELETE mutations for mergetree tables. Work in progress (default: false) */
682
- allow_experimental_lightweight_delete?: Bool;
683
- /** Move functions out of aggregate functions 'any' (default: false) */
684
- optimize_move_functions_out_of_any?: Bool;
685
- /** Rewrite aggregate functions that semantically equals to count() as count(). (default: true) */
686
- optimize_normalize_count_variants?: Bool;
687
- /** Delete injective functions of one argument inside uniq*() functions. (default: true) */
688
- optimize_injective_functions_inside_uniq?: Bool;
689
- /** Convert SELECT query to CNF (default: false) */
690
- convert_query_to_cnf?: Bool;
691
- /** Optimize multiple OR LIKE into multiMatchAny. This optimization should not be enabled by default (default: false) */
692
- optimize_or_like_chain?: Bool;
693
- /** Move arithmetic operations out of aggregation functions (default: true) */
694
- optimize_arithmetic_operations_in_aggregate_functions?: Bool;
695
- /** Remove duplicate ORDER BY and DISTINCT if it's possible (default: true) */
696
- optimize_duplicate_order_by_and_distinct?: Bool;
697
- /** Remove functions from ORDER BY if its argument is also in ORDER BY (default: true) */
698
- optimize_redundant_functions_in_order_by?: Bool;
699
- /** Replace if(cond1 (default: false) */
700
- optimize_if_chain_to_multiif?: Bool;
701
- /** Replace 'multiIf' with only one condition to 'if'. (default: true) */
702
- optimize_multiif_to_if?: Bool;
703
- /** Replaces string-type arguments in If and Transform to enum. Disabled by default cause it could make inconsistent change in distributed query that would lead to its fail. (default: false) */
704
- optimize_if_transform_strings_to_enum?: Bool;
705
- /** Replace monotonous function with its argument in ORDER BY (default: true) */
706
- optimize_monotonous_functions_in_order_by?: Bool;
707
- /** Transform functions to subcolumns (default: false) */
708
- optimize_functions_to_subcolumns?: Bool;
709
- /** Use constraints for query optimization (default: false) */
710
- optimize_using_constraints?: Bool;
711
- /** Use constraints for column substitution (default: false) */
712
- optimize_substitute_columns?: Bool;
713
- /** Use constraints in order to append index condition (indexHint) (default: false) */
714
- optimize_append_index?: Bool;
715
- /** Normalize function names to their canonical names (default: true) */
716
- normalize_function_names?: Bool;
717
- /** Allow atomic alter on Materialized views. Work in progress. (default: false) */
718
- allow_experimental_alter_materialized_view_structure?: Bool;
719
- /** Enable query optimization where we analyze function and subqueries results and rewrite query if there're constants there (default: true) */
720
- enable_early_constant_folding?: Bool;
721
- /** Should deduplicate blocks for materialized views if the block is not a duplicate for the table. Use true to always deduplicate in dependent tables. (default: false) */
722
- deduplicate_blocks_in_dependent_materialized_views?: Bool;
723
- /** Changes format of directories names for distributed table insert parts. (default: true) */
724
- use_compact_format_in_distributed_parts_names?: Bool;
725
- /** Throw exception if polygon is invalid in function pointInPolygon (e.g. self-tangent (default: true) */
726
- validate_polygons?: Bool;
727
- /** Maximum parser depth (recursion depth of recursive descend parser). (default: 1000) */
728
- max_parser_depth?: UInt64;
729
- /** Allow SETTINGS after FORMAT (default: false) */
730
- allow_settings_after_format_in_insert?: Bool;
731
- /** Timeout after which temporary live view is deleted. (default: 5) */
732
- temporary_live_view_timeout?: Seconds;
733
- /** Interval after which periodically refreshed live view is forced to refresh. (default: 60) */
734
- periodic_live_view_refresh?: Seconds;
735
- /** If enabled (default: false) */
736
- transform_null_in?: Bool;
737
- /** Allow non-deterministic functions in ALTER UPDATE/ALTER DELETE statements (default: false) */
738
- allow_nondeterministic_mutations?: Bool;
739
- /** How long locking request should wait before failing (default: 120) */
740
- lock_acquire_timeout?: Seconds;
741
- /** Apply TTL for old data (default: true) */
742
- materialize_ttl_after_modify?: Bool;
743
- /** Choose function implementation for specific target or variant (experimental). If empty enable all of them. (default: "") */
744
- function_implementation?: string;
745
- /** Allow geo data types such as Point (default: true) */
746
- allow_experimental_geo_types?: Bool;
747
- /** Data types without NULL or NOT NULL will make Nullable (default: false) */
748
- data_type_default_nullable?: Bool;
749
- /** CAST operator keep Nullable for result data type (default: false) */
750
- cast_keep_nullable?: Bool;
751
- /** CAST operator into IPv4 (default: false) */
752
- cast_ipv4_ipv6_default_on_conversion_error?: Bool;
753
- /** Output information about affected parts. Currently works only for FREEZE and ATTACH commands. (default: false) */
754
- alter_partition_verbose_result?: Bool;
755
- /** Allow to create database with Engine=MaterializedMySQL(...). (default: false) */
756
- allow_experimental_database_materialized_mysql?: Bool;
757
- /** Allow to create database with Engine=MaterializedPostgreSQL(...). (default: false) */
758
- allow_experimental_database_materialized_postgresql?: Bool;
759
- /** Include all metrics (default: false) */
760
- system_events_show_zero_values?: Bool;
761
- /** Which MySQL types should be converted to corresponding ClickHouse types (rather than being represented as String). Can be empty or any combination of 'decimal' (default: '') */
762
- mysql_datatypes_support_level?: MySQLDataTypesSupport;
763
- /** Optimize trivial 'INSERT INTO table SELECT ... FROM TABLES' query (default: true) */
764
- optimize_trivial_insert_select?: Bool;
765
- /** Allow to execute alters which affects not only tables metadata (default: true) */
766
- allow_non_metadata_alters?: Bool;
767
- /** Propagate WITH statements to UNION queries and all subqueries (default: true) */
768
- enable_global_with_statement?: Bool;
769
- /** Rewrite all aggregate functions in a query (default: false) */
770
- aggregate_functions_null_for_empty?: Bool;
771
- /** Not ready for production (default: false) */
772
- optimize_syntax_fuse_functions?: Bool;
773
- /** Not ready for production (default: false) */
774
- optimize_fuse_sum_count_avg?: Bool;
775
- /** If true (default: true) */
776
- flatten_nested?: Bool;
777
- /** Include MATERIALIZED columns for wildcard query (default: false) */
778
- asterisk_include_materialized_columns?: Bool;
779
- /** Include ALIAS columns for wildcard query (default: false) */
780
- asterisk_include_alias_columns?: Bool;
781
- /** Skip partitions with one part with level > 0 in optimize final (default: false) */
782
- optimize_skip_merged_partitions?: Bool;
783
- /** Do the same transformation for inserted block of data as if merge was done on this block. (default: true) */
784
- optimize_on_insert?: Bool;
785
- /** If projection optimization is enabled (default: false) */
786
- force_optimize_projection?: Bool;
787
- /** Asynchronously read from socket executing remote query (default: true) */
788
- async_socket_for_remote?: Bool;
789
- /** Insert DEFAULT values instead of NULL in INSERT SELECT (UNION ALL) (default: true) */
790
- insert_null_as_default?: Bool;
791
- /** Deduce concrete type of columns of type Object in DESCRIBE query (default: false) */
792
- describe_extend_object_types?: Bool;
793
- /** If true (default: false) */
794
- describe_include_subcolumns?: Bool;
795
- /** Rewrite sumIf() and sum(if()) function countIf() function when logically equivalent (default: true) */
796
- optimize_rewrite_sum_if_to_count_if?: Bool;
797
- /** If non zero (default: 0) */
798
- insert_shard_id?: UInt64;
799
- /** Enable collecting hash table statistics to optimize memory allocation (default: true) */
800
- collect_hash_table_stats_during_aggregation?: Bool;
801
- /** How many entries hash table statistics collected during aggregation is allowed to have (default: 10'000) */
802
- max_entries_for_hash_table_stats?: UInt64;
803
- /** For how many elements it is allowed to preallocate space in all hash tables in total before aggregation (default: 10'000'000) */
804
- max_size_to_preallocate_for_aggregation?: UInt64;
805
- /** Experimental data deduplication for SELECT queries based on part UUIDs (default: false) */
806
- allow_experimental_query_deduplication?: Bool;
807
- /** Allows to select data from a file engine table without file (default: false) */
808
- engine_file_empty_if_not_exists?: Bool;
809
- /** Enables or disables truncate before insert in file engine tables (default: false) */
810
- engine_file_truncate_on_insert?: Bool;
811
- /** Enables or disables creating a new file on each insert in file engine tables if format has suffix. (default: false) */
812
- engine_file_allow_create_multiple_files?: Bool;
813
- /** Allow to create databases with Replicated engine (default: false) */
814
- allow_experimental_database_replicated?: Bool;
815
- /** How long initial DDL query should wait for Replicated database to precess previous DDL queue entries (default: 300) */
816
- database_replicated_initial_query_timeout_sec?: UInt64;
817
- /** Enforces synchronous waiting for some queries (see also database_atomic_wait_for_drop_and_detach_synchronously (default: false) */
818
- database_replicated_enforce_synchronous_settings?: Bool;
819
- /** Maximum distributed query depth (default: 5) */
820
- max_distributed_depth?: UInt64;
821
- /** Execute DETACH TABLE as DETACH TABLE PERMANENTLY if database engine is Replicated (default: false) */
822
- database_replicated_always_detach_permanently?: Bool;
823
- /** Allow to create only Replicated tables in database with engine Replicated (default: false) */
824
- database_replicated_allow_only_replicated_engine?: Bool;
825
- /** Format of distributed DDL query result (default: 'throw') */
826
- distributed_ddl_output_mode?: DistributedDDLOutputMode;
827
- /** Compatibility version of distributed DDL (ON CLUSTER) queries (default: 3) */
828
- distributed_ddl_entry_format_version?: UInt64;
829
- /** Limit maximum number of rows when table with external engine should flush history data. Now supported only for MySQL table engine (default: 0) */
830
- external_storage_max_read_rows?: UInt64;
831
- /** Limit maximum number of bytes when table with external engine should flush history data. Now supported only for MySQL table engine (default: 0) */
832
- external_storage_max_read_bytes?: UInt64;
833
- /** Connect timeout in seconds. Now supported only for MySQL (default: DBMS_DEFAULT_CONNECT_TIMEOUT_SEC) */
834
- external_storage_connect_timeout_sec?: UInt64;
835
- /** Read/write timeout in seconds. Now supported only for MySQL (default: 300) */
836
- external_storage_rw_timeout_sec?: UInt64;
837
- /** Set default Union Mode in SelectWithUnion query (default: '') */
838
- union_default_mode?: UnionMode;
839
- /** Eliminates min/max/any/anyLast aggregators of GROUP BY keys in SELECT section (default: true) */
840
- optimize_aggregators_of_group_by_keys?: Bool;
841
- /** Eliminates functions of other keys in GROUP BY section (default: true) */
842
- optimize_group_by_function_keys?: Bool;
843
- /** List all names of element of large tuple literals in their column names instead of hash. This settings exists only for compatibility reasons. It makes sense to set to 'true' (default: false) */
844
- legacy_column_name_of_tuple_literal?: Bool;
845
- /** Apply optimizations to query plan (default: true) */
846
- query_plan_enable_optimizations?: Bool;
847
- /** Limit the total number of optimizations applied to query plan. If zero (default: 10000) */
848
- query_plan_max_optimizations_to_apply?: UInt64;
849
- /** Allow to push down filter by predicate query plan step (default: true) */
850
- query_plan_filter_push_down?: Bool;
851
- /** Analyze primary key using query plan (instead of AST) (default: true) */
852
- query_plan_optimize_primary_key?: Bool;
853
- /** Max matches of any single regexp per row (default: 1000) */
854
- regexp_max_matches_per_row?: UInt64;
855
- /** Limit on read rows from the most 'end' result for select query (default: 0) */
856
- limit?: UInt64;
857
- /** Offset on read rows from the most 'end' result for select query (default: 0) */
858
- offset?: UInt64;
859
- /** Maximum number of values generated by function 'range' per block of data (sum of array sizes for every row in a block (default: 500000000) */
860
- function_range_max_elements_in_block?: UInt64;
861
- /** Setting for short-circuit function evaluation configuration. Possible values: 'enable' - use short-circuit function evaluation for functions that are suitable for it, 'disable' - disable short-circuit function evaluation, 'force_enable' - use short-circuit function evaluation for all functions. (default: 'enable') */
862
- short_circuit_function_evaluation?: ShortCircuitFunctionEvaluation;
863
- /** Method of reading data from local filesystem (default: "pread_threadpool") */
864
- local_filesystem_read_method?: string;
865
- /** Method of reading data from remote filesystem (default: "threadpool") */
866
- remote_filesystem_read_method?: string;
867
- /** Should use prefetching when reading data from local filesystem. (default: false) */
868
- local_filesystem_read_prefetch?: Bool;
869
- /** Should use prefetching when reading data from remote filesystem. (default: true) */
870
- remote_filesystem_read_prefetch?: Bool;
871
- /** Priority to read data from local filesystem. Only supported for 'pread_threadpool' method. (default: 0) */
872
- read_priority?: Int64;
873
- /** If at least as many lines are read from one file (default: (20 * 8192)) */
874
- merge_tree_min_rows_for_concurrent_read_for_remote_filesystem?: UInt64;
875
- /** If at least as many bytes are read from one file (default: (24 * 10 * 1024 * 1024)) */
876
- merge_tree_min_bytes_for_concurrent_read_for_remote_filesystem?: UInt64;
877
- /** Min bytes required for remote read (url (default: 4 * 1048576) */
878
- remote_read_min_bytes_for_seek?: UInt64;
879
- /** Maximum number of threads to actually parse and insert data in background. Zero means asynchronous mode is disabled (default: 16) */
880
- async_insert_threads?: UInt64;
881
- /** If true (default: false) */
882
- async_insert?: Bool;
883
- /** If true wait for processing of asynchronous insertion (default: true) */
884
- wait_for_async_insert?: Bool;
885
- /** Timeout for waiting for processing asynchronous insertion (default: 120) */
886
- wait_for_async_insert_timeout?: Seconds;
887
- /** Maximum size in bytes of unparsed data collected per query before being inserted (default: 100000) */
888
- async_insert_max_data_size?: UInt64;
889
- /** Maximum time to wait before dumping collected data per query since the first data appeared (default: 200) */
890
- async_insert_busy_timeout_ms?: Milliseconds;
891
- /** Maximum time to wait before dumping collected data per query since the last data appeared. Zero means no timeout at all (default: 0) */
892
- async_insert_stale_timeout_ms?: Milliseconds;
893
- /** Max wait time when trying to read data for remote disk (default: 10000) */
894
- remote_fs_read_max_backoff_ms?: UInt64;
895
- /** Max attempts to read with backoff (default: 5) */
896
- remote_fs_read_backoff_max_tries?: UInt64;
897
- /** Use cache for remote filesystem. This setting does not turn on/off cache for disks (must be done via disk config) (default: true) */
898
- enable_filesystem_cache?: Bool;
899
- /** Allow to wait at most this number of seconds for download of current remote_fs_buffer_size bytes (default: 5) */
900
- filesystem_cache_max_wait_sec?: UInt64;
901
- /** Write into cache on write operations. To actually work this setting requires be added to disk config too (default: false) */
902
- enable_filesystem_cache_on_write_operations?: Bool;
903
- /** Allows to record the filesystem caching log for each query (default: false) */
904
- enable_filesystem_cache_log?: Bool;
905
- /** " (default: false) */
906
- read_from_filesystem_cache_if_exists_otherwise_bypass_cache?: Bool;
907
- /** Skip download from remote filesystem if exceeds query cache size (default: true) */
908
- skip_download_if_exceeds_query_cache?: Bool;
909
- /** Max remote filesystem cache size that can be used by a single query (default: (128UL * 1024 * 1024 * 1024)) */
910
- max_query_cache_size?: UInt64;
911
- /** Use structure from insertion table instead of schema inference from data (default: false) */
912
- use_structure_from_insertion_table_in_table_functions?: Bool;
913
- /** Max attempts to read via http. (default: 10) */
914
- http_max_tries?: UInt64;
915
- /** Min milliseconds for backoff (default: 100) */
916
- http_retry_initial_backoff_ms?: UInt64;
917
- /** Max milliseconds for backoff (default: 10000) */
918
- http_retry_max_backoff_ms?: UInt64;
919
- /** Recursively remove data on DROP query. Avoids 'Directory not empty' error (default: false) */
920
- force_remove_data_recursively_on_drop?: Bool;
921
- /** Check that DDL query (such as DROP TABLE or RENAME) will not break dependencies (default: true) */
922
- check_table_dependencies?: Bool;
923
- /** Use local cache for remote storage like HDFS or S3 (default: true) */
924
- use_local_cache_for_remote_storage?: Bool;
925
- /** Allow unrestricted (without condition on path) reads from system.zookeeper table (default: false) */
926
- allow_unrestricted_reads_from_keeper?: Bool;
927
- /** Allow to create databases with deprecated Ordinary engine (default: false) */
928
- allow_deprecated_database_ordinary?: Bool;
929
- /** Allow to create *MergeTree tables with deprecated engine definition syntax (default: false) */
930
- allow_deprecated_syntax_for_merge_tree?: Bool;
931
- /** Changes other settings according to provided ClickHouse version. If we know that we changed some behaviour in ClickHouse by changing some settings in some version (default: "") */
932
- compatibility?: string;
933
- /** Additional filter expression which would be applied after reading from specified table. Syntax: {'table1': 'expression' (default: "") */
934
- additional_table_filters?: Map;
935
- /** Additional filter expression which would be applied to query result (default: "") */
936
- additional_result_filter?: string;
937
- /** Enable experimental functions for funnel analysis. (default: false) */
938
- allow_experimental_funnel_functions?: Bool;
939
- /** Enable experimental functions for natural language processing. (default: false) */
940
- allow_experimental_nlp_functions?: Bool;
941
- /** Enable experimental hash functions (hashid (default: false) */
942
- allow_experimental_hash_functions?: Bool;
943
- /** Allow Object and JSON data types (default: false) */
944
- allow_experimental_object_type?: Bool;
945
- /** If not empty, used for duplicate detection instead of data digest (default: "") */
946
- insert_deduplication_token?: string;
947
- /** Rewrite count distinct to subquery of group by (default: false) */
948
- count_distinct_optimization?: Bool;
949
- /** Throw exception if unsupported query is used inside transaction (default: true) */
950
- throw_on_unsupported_query_inside_transaction?: Bool;
951
- /** Wait for committed changes to become actually visible in the latest snapshot (default: 'wait_unknown') */
952
- wait_changes_become_visible_after_commit_mode?: TransactionsWaitCSNMode;
953
- /** If enabled and not already inside a transaction (default: false) */
954
- implicit_transaction?: Bool;
955
- /** Enables or disables empty INSERTs (default: true) */
956
- throw_if_no_data_to_insert?: Bool;
957
- /** Ignore AUTO_INCREMENT keyword in column declaration if true (default: false) */
958
- compatibility_ignore_auto_increment_in_create_table?: Bool;
959
- /** Do not add aliases to top level expression list on multiple joins rewrite (default: false) */
960
- multiple_joins_try_to_keep_original_names?: Bool;
961
- /** Enable DISTINCT optimization if some columns in DISTINCT form a prefix of sorting. For example (default: true) */
962
- optimize_distinct_in_order?: Bool;
963
- /** Optimize sorting by sorting properties of input stream (default: true) */
964
- optimize_sorting_by_input_stream_properties?: Bool;
965
- /** ' (default: ') */
966
- format_csv_delimiter?: Char;
967
- /** If it is set to true (default: false) */
968
- format_csv_allow_single_quotes?: Bool;
969
- /** If it is set to true (default: true) */
970
- format_csv_allow_double_quotes?: Bool;
971
- /** If it is set true (default: false) */
972
- output_format_csv_crlf_end_of_line?: Bool;
973
- /** Treat inserted enum values in CSV formats as enum indices (default: false) */
974
- input_format_csv_enum_as_number?: Bool;
975
- /** R"(When reading Array from CSV (default: false) */
976
- input_format_csv_arrays_as_nested_csv?: Bool;
977
- /** Skip columns with unknown names from input data (it works for JSONEachRow (default: true) */
978
- input_format_skip_unknown_fields?: Bool;
979
- /** For -WithNames input formats this controls whether format parser is to assume that column data appear in the input exactly as they are specified in the header. (default: true) */
980
- input_format_with_names_use_header?: Bool;
981
- /** For -WithNamesAndTypes input formats this controls whether format parser should check if data types from the input match data types from the header. (default: true) */
982
- input_format_with_types_use_header?: Bool;
983
- /** Map nested JSON data to nested tables (it works for JSONEachRow format). (default: false) */
984
- input_format_import_nested_json?: Bool;
985
- /** For input data calculate default expressions for omitted fields (it works for JSONEachRow (default: true) */
986
- input_format_defaults_for_omitted_fields?: Bool;
987
- /** Treat empty fields in CSV input as default values. (default: true) */
988
- input_format_csv_empty_as_default?: Bool;
989
- /** Treat empty fields in TSV input as default values. (default: false) */
990
- input_format_tsv_empty_as_default?: Bool;
991
- /** Treat inserted enum values in TSV formats as enum indices. (default: false) */
992
- input_format_tsv_enum_as_number?: Bool;
993
- /** For text input formats initialize null fields with default values if data type of this field is not nullable (default: true) */
994
- input_format_null_as_default?: Bool;
995
- /** Allow to insert array of structs into Nested table in Arrow input format. (default: false) */
996
- input_format_arrow_import_nested?: Bool;
997
- /** Ignore case when matching Arrow columns with CH columns. (default: false) */
998
- input_format_arrow_case_insensitive_column_matching?: Bool;
999
- /** Allow to insert array of structs into Nested table in ORC input format. (default: false) */
1000
- input_format_orc_import_nested?: Bool;
1001
- /** Batch size when reading ORC stripes. (default: 100'000) */
1002
- input_format_orc_row_batch_size?: Int64;
1003
- /** Ignore case when matching ORC columns with CH columns. (default: false) */
1004
- input_format_orc_case_insensitive_column_matching?: Bool;
1005
- /** Allow to insert array of structs into Nested table in Parquet input format. (default: false) */
1006
- input_format_parquet_import_nested?: Bool;
1007
- /** Ignore case when matching Parquet columns with CH columns. (default: false) */
1008
- input_format_parquet_case_insensitive_column_matching?: Bool;
1009
- /** Allow seeks while reading in ORC/Parquet/Arrow input formats (default: true) */
1010
- input_format_allow_seeks?: Bool;
1011
- /** Allow missing columns while reading ORC input formats (default: false) */
1012
- input_format_orc_allow_missing_columns?: Bool;
1013
- /** Allow missing columns while reading Parquet input formats (default: false) */
1014
- input_format_parquet_allow_missing_columns?: Bool;
1015
- /** Allow missing columns while reading Arrow input formats (default: false) */
1016
- input_format_arrow_allow_missing_columns?: Bool;
1017
- /** Delimiter between fields in Hive Text File (default: '\x01') */
1018
- input_format_hive_text_fields_delimiter?: Char;
1019
- /** Delimiter between collection(array or map) items in Hive Text File (default: '\x02') */
1020
- input_format_hive_text_collection_items_delimiter?: Char;
1021
- /** Delimiter between a pair of map key/values in Hive Text File (default: '\x03') */
1022
- input_format_hive_text_map_keys_delimiter?: Char;
1023
- /** The number of columns in inserted MsgPack data. Used for automatic schema inference from data. (default: 0) */
1024
- input_format_msgpack_number_of_columns?: UInt64;
1025
- /** The way how to output UUID in MsgPack format. (default: 'ext') */
1026
- output_format_msgpack_uuid_representation?: MsgPackUUIDRepresentation;
1027
- /** The maximum rows of data to read for automatic schema inference (default: 25000) */
1028
- input_format_max_rows_to_read_for_schema_inference?: UInt64;
1029
- /** Use some tweaks and heuristics to infer schema in CSV format (default: true) */
1030
- input_format_csv_use_best_effort_in_schema_inference?: Bool;
1031
- /** Use some tweaks and heuristics to infer schema in TSV format (default: true) */
1032
- input_format_tsv_use_best_effort_in_schema_inference?: Bool;
1033
- /** Skip columns with unsupported types while schema inference for format Parquet (default: false) */
1034
- input_format_parquet_skip_columns_with_unsupported_types_in_schema_inference?: Bool;
1035
- /** Skip fields with unsupported types while schema inference for format Protobuf (default: false) */
1036
- input_format_protobuf_skip_fields_with_unsupported_types_in_schema_inference?: Bool;
1037
- /** Skip columns with unsupported types while schema inference for format CapnProto (default: false) */
1038
- input_format_capn_proto_skip_fields_with_unsupported_types_in_schema_inference?: Bool;
1039
- /** Skip columns with unsupported types while schema inference for format ORC (default: false) */
1040
- input_format_orc_skip_columns_with_unsupported_types_in_schema_inference?: Bool;
1041
- /** Skip columns with unsupported types while schema inference for format Arrow (default: false) */
1042
- input_format_arrow_skip_columns_with_unsupported_types_in_schema_inference?: Bool;
1043
- /** The list of column names to use in schema inference for formats without column names. The format: 'column1 (default: "") */
1044
- column_names_for_schema_inference?: string;
1045
- /** Allow to parse bools as numbers in JSON input formats (default: true) */
1046
- input_format_json_read_bools_as_numbers?: Bool;
1047
- /** Try to infer numbers from string fields while schema inference (default: true) */
1048
- input_format_json_try_infer_numbers_from_strings?: Bool;
1049
- /** Try to infer numbers from string fields while schema inference in text formats (default: true) */
1050
- input_format_try_infer_integers?: Bool;
1051
- /** Try to infer dates from string fields while schema inference in text formats (default: true) */
1052
- input_format_try_infer_dates?: Bool;
1053
- /** Try to infer datetimes from string fields while schema inference in text formats (default: true) */
1054
- input_format_try_infer_datetimes?: Bool;
1055
- /** Enable Google wrappers for regular non-nested columns (default: false) */
1056
- input_format_protobuf_flatten_google_wrappers?: Bool;
1057
- /** When serializing Nullable columns with Google wrappers (default: false) */
1058
- output_format_protobuf_nullables_with_google_wrappers?: Bool;
1059
- /** Skip specified number of lines at the beginning of data in CSV format (default: 0) */
1060
- input_format_csv_skip_first_lines?: UInt64;
1061
- /** Skip specified number of lines at the beginning of data in TSV format (default: 0) */
1062
- input_format_tsv_skip_first_lines?: UInt64;
1063
- /** Method to read DateTime from text input formats (default: 'basic') */
1064
- date_time_input_format?: DateTimeInputFormat;
1065
- /** Method to write DateTime to text output (default: 'simple') */
1066
- date_time_output_format?: DateTimeOutputFormat;
1067
- /** Deserialization of IPv4 will use default values instead of throwing exception on conversion error. (default: false) */
1068
- input_format_ipv4_default_on_conversion_error?: Bool;
1069
- /** Deserialization of IPV6 will use default values instead of throwing exception on conversion error. (default: false) */
1070
- input_format_ipv6_default_on_conversion_error?: Bool;
1071
- /** Text to represent bool value in TSV/CSV formats. (default: "true") */
1072
- bool_true_representation?: string;
1073
- /** Text to represent bool value in TSV/CSV formats. (default: "false") */
1074
- bool_false_representation?: string;
1075
- /** For Values format: if the field could not be parsed by streaming parser (default: true) */
1076
- input_format_values_interpret_expressions?: Bool;
1077
- /** For Values format: if the field could not be parsed by streaming parser (default: true) */
1078
- input_format_values_deduce_templates_of_expressions?: Bool;
1079
- /** For Values format: when parsing and interpreting expressions using template (default: true) */
1080
- input_format_values_accurate_types_of_literals?: Bool;
1081
- /** For Avro/AvroConfluent format: when field is not found in schema use default value instead of error (default: false) */
1082
- input_format_avro_allow_missing_fields?: Bool;
1083
- /** For Avro/AvroConfluent format: insert default in case of null and non Nullable column (default: false) */
1084
- input_format_avro_null_as_default?: Bool;
1085
- /** For AvroConfluent format: Confluent Schema Registry URL. (default: "") */
1086
- format_avro_schema_registry_url?: URI;
1087
- /** Controls quoting of 64-bit integers in JSON output format. (default: true) */
1088
- output_format_json_quote_64bit_integers?: Bool;
1089
- /** Enables '+nan' (default: false) */
1090
- output_format_json_quote_denormals?: Bool;
1091
- /** Controls escaping forward slashes for string outputs in JSON output format. This is intended for compatibility with JavaScript. Don't confuse with backslashes that are always escaped. (default: true) */
1092
- output_format_json_escape_forward_slashes?: Bool;
1093
- /** Serialize named tuple columns as JSON objects. (default: true) */
1094
- output_format_json_named_tuples_as_objects?: Bool;
1095
- /** Output a JSON array of all rows in JSONEachRow(Compact) format. (default: false) */
1096
- output_format_json_array_of_rows?: Bool;
1097
- /** Rows limit for Pretty formats. (default: 10000) */
1098
- output_format_pretty_max_rows?: UInt64;
1099
- /** Maximum width to pad all values in a column in Pretty formats. (default: 250) */
1100
- output_format_pretty_max_column_pad_width?: UInt64;
1101
- /** Maximum width of value to display in Pretty formats. If greater - it will be cut. (default: 10000) */
1102
- output_format_pretty_max_value_width?: UInt64;
1103
- /** Use ANSI escape sequences to paint colors in Pretty formats (default: true) */
1104
- output_format_pretty_color?: Bool;
1105
- /** Charset for printing grid borders. Available charsets: ASCII (default: "UTF-8") */
1106
- output_format_pretty_grid_charset?: string;
1107
- /** Row group size in rows. (default: 1000000) */
1108
- output_format_parquet_row_group_size?: UInt64;
1109
- /** Use Parquet String type instead of Binary for String columns. (default: false) */
1110
- output_format_parquet_string_as_string?: Bool;
1111
- /** Compression codec used for output (default: "") */
1112
- output_format_avro_codec?: string;
1113
- /** Sync interval in bytes. (default: 16 * 1024) */
1114
- output_format_avro_sync_interval?: UInt64;
1115
- /** For Avro format: regexp of String columns to select as AVRO string. (default: "") */
1116
- output_format_avro_string_column_pattern?: string;
1117
- /** Max rows in a file (if permitted by storage) (default: 1) */
1118
- output_format_avro_rows_in_file?: UInt64;
1119
- /** If it is set true (default: false) */
1120
- output_format_tsv_crlf_end_of_line?: Bool;
1121
- /** Custom NULL representation in CSV format (default: "\\N") */
1122
- format_csv_null_representation?: string;
1123
- /** Custom NULL representation in TSV format (default: "\\N") */
1124
- format_tsv_null_representation?: string;
1125
- /** Output trailing zeros when printing Decimal values. E.g. 1.230000 instead of 1.23. (default: false) */
1126
- output_format_decimal_trailing_zeros?: Bool;
1127
- /** Maximum absolute amount of errors while reading text formats (like CSV (default: 0) */
1128
- input_format_allow_errors_num?: UInt64;
1129
- /** Maximum relative amount of errors while reading text formats (like CSV (default: 0) */
1130
- input_format_allow_errors_ratio?: Float;
1131
- /** Schema identifier (used by schema-based formats) (default: "") */
1132
- format_schema?: string;
1133
- /** Path to file which contains format string for result set (for Template format) (default: "") */
1134
- format_template_resultset?: string;
1135
- /** Path to file which contains format string for rows (for Template format) (default: "") */
1136
- format_template_row?: string;
1137
- /** Delimiter between rows (for Template format) (default: "\n") */
1138
- format_template_rows_between_delimiter?: string;
1139
- /** Field escaping rule (for CustomSeparated format) (default: "Escaped") */
1140
- format_custom_escaping_rule?: EscapingRule;
1141
- /** Delimiter between fields (for CustomSeparated format) (default: "\t") */
1142
- format_custom_field_delimiter?: string;
1143
- /** Delimiter before field of the first column (for CustomSeparated format) (default: "") */
1144
- format_custom_row_before_delimiter?: string;
1145
- /** Delimiter after field of the last column (for CustomSeparated format) (default: "\n") */
1146
- format_custom_row_after_delimiter?: string;
1147
- /** Delimiter between rows (for CustomSeparated format) (default: "") */
1148
- format_custom_row_between_delimiter?: string;
1149
- /** Prefix before result set (for CustomSeparated format) (default: "") */
1150
- format_custom_result_before_delimiter?: string;
1151
- /** Suffix after result set (for CustomSeparated format) (default: "") */
1152
- format_custom_result_after_delimiter?: string;
1153
- /** Regular expression (for Regexp format) (default: "") */
1154
- format_regexp?: string;
1155
- /** Field escaping rule (for Regexp format) (default: "Raw") */
1156
- format_regexp_escaping_rule?: EscapingRule;
1157
- /** Skip lines unmatched by regular expression (for Regexp format) (default: false) */
1158
- format_regexp_skip_unmatched?: Bool;
1159
- /** Enable streaming in output formats that support it. (default: false) */
1160
- output_format_enable_streaming?: Bool;
1161
- /** Write statistics about read rows (default: true) */
1162
- output_format_write_statistics?: Bool;
1163
- /** Add row numbers before each row for pretty output format (default: false) */
1164
- output_format_pretty_row_numbers?: Bool;
1165
- /** If setting is enabled (default: false) */
1166
- insert_distributed_one_random_shard?: Bool;
1167
- /** When enabled (default: false) */
1168
- exact_rows_before_limit?: Bool;
1169
- /** Use inner join instead of comma/cross join if there're joining expressions in the WHERE section. Values: 0 - no rewrite (default: 1) */
1170
- cross_to_inner_join_rewrite?: UInt64;
1171
- /** Enable output LowCardinality type as Dictionary Arrow type (default: false) */
1172
- output_format_arrow_low_cardinality_as_dictionary?: Bool;
1173
- /** Use Arrow String type instead of Binary for String columns (default: false) */
1174
- output_format_arrow_string_as_string?: Bool;
1175
- /** Use ORC String type instead of Binary for String columns (default: false) */
1176
- output_format_orc_string_as_string?: Bool;
1177
- /** How to map ClickHouse Enum and CapnProto Enum (default: 'by_values') */
1178
- format_capn_proto_enum_comparising_mode?: EnumComparingMode;
1179
- /** Name of the table in MySQL dump from which to read data (default: "") */
1180
- input_format_mysql_dump_table_name?: string;
1181
- /** Match columns from table in MySQL dump and columns from ClickHouse table by names (default: true) */
1182
- input_format_mysql_dump_map_column_names?: Bool;
1183
- /** The maximum number of rows in one INSERT statement. (default: 65505) */
1184
- output_format_sql_insert_max_batch_size?: UInt64;
1185
- /** The name of table in the output INSERT query (default: "table") */
1186
- output_format_sql_insert_table_name?: string;
1187
- /** Include column names in INSERT query (default: true) */
1188
- output_format_sql_insert_include_column_names?: Bool;
1189
- /** Use REPLACE statement instead of INSERT (default: false) */
1190
- output_format_sql_insert_use_replace?: Bool;
1191
- /** Quote column names with '`' characters (default: true) */
1192
- output_format_sql_insert_quote_names?: Bool;
1193
- }
1194
- interface ClickHouseHTTPSettings {
1195
- wait_end_of_query?: Bool;
1196
- }
1197
- export type ClickHouseSettings = ClickHouseServerSettings & ClickHouseHTTPSettings;
1198
- export interface MergeTreeSettings {
1199
- /** When granule is written (default: 0) */
1200
- min_compress_block_size?: UInt64;
1201
- /** Compress the pending uncompressed data in buffer if its size is larger or equal than the specified threshold. Block of data will be compressed even if the current granule is not finished. If this setting is not set (default: 0) */
1202
- max_compress_block_size?: UInt64;
1203
- /** How many rows correspond to one primary key value. (default: 8192) */
1204
- index_granularity?: UInt64;
1205
- /** Minimal uncompressed size in bytes to create part in wide format instead of compact (default: 10485760) */
1206
- min_bytes_for_wide_part?: UInt64;
1207
- /** Minimal number of rows to create part in wide format instead of compact (default: 0) */
1208
- min_rows_for_wide_part?: UInt64;
1209
- /** Experimental. Minimal uncompressed size in bytes to create part in compact format instead of saving it in RAM (default: 0) */
1210
- min_bytes_for_compact_part?: UInt64;
1211
- /** Experimental. Minimal number of rows to create part in compact format instead of saving it in RAM (default: 0) */
1212
- min_rows_for_compact_part?: UInt64;
1213
- /** Whether to write blocks in Native format to write-ahead-log before creation in-memory part (default: true) */
1214
- in_memory_parts_enable_wal?: Bool;
1215
- /** Rotate WAL (default: 1024 * 1024 * 1024) */
1216
- write_ahead_log_max_bytes?: UInt64;
1217
- /** Minimal ratio of number of default values to number of all values in column to store it in sparse serializations. If >= 1 (default: 1.0) */
1218
- ratio_of_defaults_for_sparse_serialization?: Float;
1219
- /** How many rows in blocks should be formed for merge operations. (default: DEFAULT_MERGE_BLOCK_SIZE) */
1220
- merge_max_block_size?: UInt64;
1221
- /** Maximum in total size of parts to merge (default: 150ULL * 1024 * 1024 * 1024) */
1222
- max_bytes_to_merge_at_max_space_in_pool?: UInt64;
1223
- /** Maximum in total size of parts to merge (default: 1024 * 1024) */
1224
- max_bytes_to_merge_at_min_space_in_pool?: UInt64;
1225
- /** How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. (default: 16) */
1226
- max_replicated_merges_in_queue?: UInt64;
1227
- /** How many tasks of mutating parts are allowed simultaneously in ReplicatedMergeTree queue. (default: 8) */
1228
- max_replicated_mutations_in_queue?: UInt64;
1229
- /** How many tasks of merging parts with TTL are allowed simultaneously in ReplicatedMergeTree queue. (default: 1) */
1230
- max_replicated_merges_with_ttl_in_queue?: UInt64;
1231
- /** When there is less than specified number of free entries in pool (or replicated queue) (default: 8) */
1232
- number_of_free_entries_in_pool_to_lower_max_size_of_merge?: UInt64;
1233
- /** When there is less than specified number of free entries in pool (default: 20) */
1234
- number_of_free_entries_in_pool_to_execute_mutation?: UInt64;
1235
- /** When there is more than specified number of merges with TTL entries in pool (default: 2) */
1236
- max_number_of_merges_with_ttl_in_pool?: UInt64;
1237
- /** How many seconds to keep obsolete parts. (default: 8 * 60) */
1238
- old_parts_lifetime?: Seconds;
1239
- /** How many seconds to keep tmp_-directories. You should not lower this value because merges and mutations may not be able to work with low value of this setting. (default: 86400) */
1240
- temporary_directories_lifetime?: Seconds;
1241
- /** For background operations like merges (default: DBMS_DEFAULT_LOCK_ACQUIRE_TIMEOUT_SEC) */
1242
- lock_acquire_timeout_for_background_operations?: Seconds;
1243
- /** Minimal number of rows to do fsync for part after merge (0 - disabled) (default: 0) */
1244
- min_rows_to_fsync_after_merge?: UInt64;
1245
- /** Minimal number of compressed bytes to do fsync for part after merge (0 - disabled) (default: 0) */
1246
- min_compressed_bytes_to_fsync_after_merge?: UInt64;
1247
- /** Minimal number of compressed bytes to do fsync for part after fetch (0 - disabled) (default: 0) */
1248
- min_compressed_bytes_to_fsync_after_fetch?: UInt64;
1249
- /** Do fsync for every inserted part. Significantly decreases performance of inserts (default: false) */
1250
- fsync_after_insert?: Bool;
1251
- /** Do fsync for part directory after all part operations (writes (default: false) */
1252
- fsync_part_directory?: Bool;
1253
- /** Amount of bytes (default: 100ULL * 1024 * 1024) */
1254
- write_ahead_log_bytes_to_fsync?: UInt64;
1255
- /** Interval in milliseconds after which fsync for WAL is being done. (default: 100) */
1256
- write_ahead_log_interval_ms_to_fsync?: UInt64;
1257
- /** If true insert of part with in-memory format will wait for fsync of WAL (default: false) */
1258
- in_memory_parts_insert_sync?: Bool;
1259
- /** How many last blocks of hashes should be kept on disk (0 - disabled). (default: 0) */
1260
- non_replicated_deduplication_window?: UInt64;
1261
- /** Max amount of parts which can be merged at once (0 - disabled). Doesn't affect OPTIMIZE FINAL query. (default: 100) */
1262
- max_parts_to_merge_at_once?: UInt64;
1263
- /** Sleep time for merge selecting when no part selected (default: 5000) */
1264
- merge_selecting_sleep_ms?: UInt64;
1265
- /** The period of executing the clear old temporary directories operation in background. (default: 60) */
1266
- merge_tree_clear_old_temporary_directories_interval_seconds?: UInt64;
1267
- /** The period of executing the clear old parts operation in background. (default: 1) */
1268
- merge_tree_clear_old_parts_interval_seconds?: UInt64;
1269
- /** Remove old broken detached parts in the background if they remained untouched for a specified by this setting period of time. (default: 1ULL * 3600 * 24 * 30) */
1270
- merge_tree_clear_old_broken_detached_parts_ttl_timeout_seconds?: UInt64;
1271
- /** Enable clearing old broken detached parts operation in background. (default: false) */
1272
- merge_tree_enable_clear_old_broken_detached?: UInt64;
1273
- /** Setting for an incomplete experimental feature. (default: 1) */
1274
- remove_rolled_back_parts_immediately?: Bool;
1275
- /** If table contains at least that many active parts in single partition (default: 150) */
1276
- parts_to_delay_insert?: UInt64;
1277
- /** If table contains at least that many inactive parts in single partition (default: 0) */
1278
- inactive_parts_to_delay_insert?: UInt64;
1279
- /** If more than this number active parts in single partition (default: 300) */
1280
- parts_to_throw_insert?: UInt64;
1281
- /** If more than this number inactive parts in single partition (default: 0) */
1282
- inactive_parts_to_throw_insert?: UInt64;
1283
- /** Max delay of inserting data into MergeTree table in seconds (default: 1) */
1284
- max_delay_to_insert?: UInt64;
1285
- /** If more than this number active parts in all partitions in total (default: 100000) */
1286
- max_parts_in_total?: UInt64;
1287
- /** How many last blocks of hashes should be kept in ZooKeeper (old blocks will be deleted). (default: 100) */
1288
- replicated_deduplication_window?: UInt64;
1289
- /** Similar to "replicated_deduplication_window" (default: 7 * 24 * 60 * 60 // one week) */
1290
- replicated_deduplication_window_seconds?: UInt64;
1291
- /** How many records may be in log (default: 1000) */
1292
- max_replicated_logs_to_keep?: UInt64;
1293
- /** Keep about this number of last records in ZooKeeper log (default: 10) */
1294
- min_replicated_logs_to_keep?: UInt64;
1295
- /** If time passed after replication log entry creation exceeds this threshold and sum size of parts is greater than \"prefer_fetch_merged_part_size_threshold\ (default: 3600) */
1296
- prefer_fetch_merged_part_time_threshold?: Seconds;
1297
- /** If sum size of parts exceeds this threshold and time passed after replication log entry creation is greater than \"prefer_fetch_merged_part_time_threshold\ (default: 10ULL * 1024 * 1024 * 1024) */
1298
- prefer_fetch_merged_part_size_threshold?: UInt64;
1299
- /** When greater than zero only a single replica starts the merge immediately (default: 0) */
1300
- execute_merges_on_single_replica_time_threshold?: Seconds;
1301
- /** When greater than zero only a single replica starts the merge immediately if merged part on shared storage and 'allow_remote_fs_zero_copy_replication' is enabled. (default: 3 * 60 * 60) */
1302
- remote_fs_execute_merges_on_single_replica_time_threshold?: Seconds;
1303
- /** Recompression works slow in most cases (default: 7200) */
1304
- try_fetch_recompressed_part_timeout?: Seconds;
1305
- /** If true (default: false) */
1306
- always_fetch_merged_part?: Bool;
1307
- /** Max broken parts (default: 10) */
1308
- max_suspicious_broken_parts?: UInt64;
1309
- /** Max size of all broken parts (default: 1ULL * 1024 * 1024 * 1024) */
1310
- max_suspicious_broken_parts_bytes?: UInt64;
1311
- /** Not apply ALTER if number of files for modification(deletion (default: 75) */
1312
- max_files_to_modify_in_alter_columns?: UInt64;
1313
- /** Not apply ALTER (default: 50) */
1314
- max_files_to_remove_in_alter_columns?: UInt64;
1315
- /** If ratio of wrong parts to total number of parts is less than this - allow to start. (default: 0.5) */
1316
- replicated_max_ratio_of_wrong_parts?: Float;
1317
- /** Limit parallel fetches from endpoint (actually pool size). (default: DEFAULT_COUNT_OF_HTTP_CONNECTIONS_PER_ENDPOINT) */
1318
- replicated_max_parallel_fetches_for_host?: UInt64;
1319
- /** HTTP connection timeout for part fetch requests. Inherited from default profile `http_connection_timeout` if not set explicitly. (default: 0) */
1320
- replicated_fetches_http_connection_timeout?: Seconds;
1321
- /** HTTP send timeout for part fetch requests. Inherited from default profile `http_send_timeout` if not set explicitly. (default: 0) */
1322
- replicated_fetches_http_send_timeout?: Seconds;
1323
- /** HTTP receive timeout for fetch part requests. Inherited from default profile `http_receive_timeout` if not set explicitly. (default: 0) */
1324
- replicated_fetches_http_receive_timeout?: Seconds;
1325
- /** If true (default: true) */
1326
- replicated_can_become_leader?: Bool;
1327
- /** ZooKeeper session expiration check period (default: 60) */
1328
- zookeeper_session_expiration_check_period?: Seconds;
1329
- /** Retry period for table initialization (default: 60) */
1330
- initialization_retry_period?: Seconds;
1331
- /** Do not remove old local parts when repairing lost replica. (default: true) */
1332
- detach_old_local_parts_when_cloning_replica?: Bool;
1333
- /** Do not remove non byte-identical parts for ReplicatedMergeTree (default: false) */
1334
- detach_not_byte_identical_parts?: Bool;
1335
- /** The maximum speed of data exchange over the network in bytes per second for replicated fetches. Zero means unlimited. (default: 0) */
1336
- max_replicated_fetches_network_bandwidth?: UInt64;
1337
- /** The maximum speed of data exchange over the network in bytes per second for replicated sends. Zero means unlimited. (default: 0) */
1338
- max_replicated_sends_network_bandwidth?: UInt64;
1339
- /** Calculate relative replica delay only if absolute delay is not less that this value. (default: 120) */
1340
- min_relative_delay_to_measure?: UInt64;
1341
- /** Period to clean old queue logs (default: 30) */
1342
- cleanup_delay_period?: UInt64;
1343
- /** Add uniformly distributed value from 0 to x seconds to cleanup_delay_period to avoid thundering herd effect and subsequent DoS of ZooKeeper in case of very large number of tables. (default: 10) */
1344
- cleanup_delay_period_random_add?: UInt64;
1345
- /** Minimal delay from other replicas to close (default: 300) */
1346
- min_relative_delay_to_close?: UInt64;
1347
- /** Minimal absolute delay to close (default: 0) */
1348
- min_absolute_delay_to_close?: UInt64;
1349
- /** Enable usage of Vertical merge algorithm. (default: 1) */
1350
- enable_vertical_merge_algorithm?: UInt64;
1351
- /** Minimal (approximate) sum of rows in merging parts to activate Vertical merge algorithm. (default: 16 * DEFAULT_MERGE_BLOCK_SIZE) */
1352
- vertical_merge_algorithm_min_rows_to_activate?: UInt64;
1353
- /** Minimal amount of non-PK columns to activate Vertical merge algorithm. (default: 11) */
1354
- vertical_merge_algorithm_min_columns_to_activate?: UInt64;
1355
- /** Allow to create a table with sampling expression not in primary key. This is needed only to temporarily allow to run the server with wrong tables for backward compatibility. (default: false) */
1356
- compatibility_allow_sampling_expression_not_in_primary_key?: Bool;
1357
- /** Use small format (dozens bytes) for part checksums in ZooKeeper instead of ordinary ones (dozens KB). Before enabling check that all replicas support new format. (default: true) */
1358
- use_minimalistic_checksums_in_zookeeper?: Bool;
1359
- /** Store part header (checksums and columns) in a compact format and a single part znode instead of separate znodes (<part>/columns and <part>/checksums). This can dramatically reduce snapshot size in ZooKeeper. Before enabling check that all replicas support new format. (default: true) */
1360
- use_minimalistic_part_header_in_zookeeper?: Bool;
1361
- /** How many records about mutations that are done to keep. If zero (default: 100) */
1362
- finished_mutations_to_keep?: UInt64;
1363
- /** Minimal amount of bytes to enable O_DIRECT in merge (0 - disabled). (default: 10ULL * 1024 * 1024 * 1024) */
1364
- min_merge_bytes_to_use_direct_io?: UInt64;
1365
- /** Approximate amount of bytes in single granule (0 - disabled). (default: 10 * 1024 * 1024) */
1366
- index_granularity_bytes?: UInt64;
1367
- /** Minimum amount of bytes in single granule. (default: 1024) */
1368
- min_index_granularity_bytes?: UInt64;
1369
- /** Minimal time in seconds (default: 3600 * 4) */
1370
- merge_with_ttl_timeout?: Int64;
1371
- /** Minimal time in seconds (default: 3600 * 4) */
1372
- merge_with_recompression_ttl_timeout?: Int64;
1373
- /** Only drop altogether the expired parts and not partially prune them. (default: false) */
1374
- ttl_only_drop_parts?: Bool;
1375
- /** Only recalculate ttl info when MATERIALIZE TTL (default: false) */
1376
- materialize_ttl_recalculate_only?: Bool;
1377
- /** Enable parts with adaptive and non-adaptive granularity (default: true) */
1378
- enable_mixed_granularity_parts?: Bool;
1379
- /** The number of threads to load data parts at startup. (default: 0) */
1380
- max_part_loading_threads?: MaxThreads;
1381
- /** The number of threads for concurrent removal of inactive data parts. One is usually enough (default: 0) */
1382
- max_part_removal_threads?: MaxThreads;
1383
- /** Activate concurrent part removal (see 'max_part_removal_threads') only if the number of inactive data parts is at least this. (default: 100) */
1384
- concurrent_part_removal_threshold?: UInt64;
1385
- /** Name of storage disk policy (default: "default") */
1386
- storage_policy?: string;
1387
- /** Allow Nullable types as primary keys. (default: false) */
1388
- allow_nullable_key?: Bool;
1389
- /** Remove empty parts after they were pruned by TTL (default: true) */
1390
- remove_empty_parts?: Bool;
1391
- /** Generate UUIDs for parts. Before enabling check that all replicas support new format. (default: false) */
1392
- assign_part_uuids?: Bool;
1393
- /** Limit the max number of partitions that can be accessed in one query. <= 0 means unlimited. This setting is the default that can be overridden by the query-level setting with the same name. (default: -1) */
1394
- max_partitions_to_read?: Int64;
1395
- /** Max number of concurrently executed queries related to the MergeTree table (0 - disabled). Queries will still be limited by other max_concurrent_queries settings. (default: 0) */
1396
- max_concurrent_queries?: UInt64;
1397
- /** Minimal number of marks to honor the MergeTree-level's max_concurrent_queries (0 - disabled). Queries will still be limited by other max_concurrent_queries settings. (default: 0) */
1398
- min_marks_to_honor_max_concurrent_queries?: UInt64;
1399
- /** Minimal amount of bytes to enable part rebalance over JBOD array (0 - disabled). (default: 0) */
1400
- min_bytes_to_rebalance_partition_over_jbod?: UInt64;
1401
- /** Check columns or columns by hash for sampling are unsigned integer. (default: true) */
1402
- check_sample_column_is_correct?: Bool;
1403
- /** Experimental/Incomplete feature to move parts between shards. Does not take into account sharding expressions. (default: 0) */
1404
- part_moves_between_shards_enable?: UInt64;
1405
- /** Time to wait before/after moving parts between shards. (default: 30) */
1406
- part_moves_between_shards_delay_seconds?: UInt64;
1407
- /** Experimental feature to speed up parts loading process by using MergeTree metadata cache (default: false) */
1408
- use_metadata_cache?: Bool;
1409
- /** Don't use this setting in production (default: false) */
1410
- allow_remote_fs_zero_copy_replication?: Bool;
1411
- /** ZooKeeper path for Zero-copy table-independent info. (default: "/clickhouse/zero_copy") */
1412
- remote_fs_zero_copy_zookeeper_path?: string;
1413
- /** Run zero-copy in compatible mode during conversion process. (default: false) */
1414
- remote_fs_zero_copy_path_compatible_mode?: Bool;
1415
- }
1416
- type Bool = 0 | 1;
1417
- type Int64 = string;
1418
- type UInt64 = string;
1419
- type UInt64Auto = string;
1420
- type Float = number;
1421
- type MaxThreads = number;
1422
- type Seconds = number;
1423
- type Milliseconds = number;
1424
- type Char = string;
1425
- type URI = string;
1426
- type Map = SettingsMap;
1427
- export declare class SettingsMap {
1428
- private readonly record;
1429
- private constructor();
1430
- toString(): string;
1431
- static from(record: Record<string, string>): SettingsMap;
1432
- }
1433
- export type LoadBalancing = 'random' | 'nearest_hostname' | 'in_order' | 'first_or_random' | 'round_robin';
1434
- export type TotalsMode = 'before_having' | 'after_having_inclusive' | 'after_having_exclusive' | 'after_having_auto';
1435
- export type DistributedProductMode = 'deny' | 'local' | 'global' | 'allow';
1436
- export type LogsLevel = 'none' | 'fatal' | 'error' | 'warning' | 'information' | 'debug' | 'trace' | 'test';
1437
- export type LogQueriesType = 'QUERY_START' | 'QUERY_FINISH' | 'EXCEPTION_BEFORE_START' | 'EXCEPTION_WHILE_PROCESSING';
1438
- export type DefaultTableEngine = 'Memory' | 'ReplicatedMergeTree' | 'ReplacingMergeTree' | 'MergeTree' | 'StripeLog' | 'ReplicatedReplacingMergeTree' | 'Log' | 'None';
1439
- export type MySQLDataTypesSupport = '' | 'date2String' | 'date2Date32' | 'datetime64' | 'decimal';
1440
- export type UnionMode = '' | 'ALL' | 'DISTINCT';
1441
- export type DistributedDDLOutputMode = 'never_throw' | 'null_status_on_timeout' | 'throw' | 'none';
1442
- export type ShortCircuitFunctionEvaluation = 'force_enable' | 'disable' | 'enable';
1443
- export type TransactionsWaitCSNMode = 'wait_unknown' | 'wait' | 'async';
1444
- export type EscapingRule = 'CSV' | 'JSON' | 'Quoted' | 'Raw' | 'XML' | 'Escaped' | 'None';
1445
- export type DateTimeOutputFormat = 'simple' | 'iso' | 'unix_timestamp';
1446
- export type EnumComparingMode = 'by_names_case_insensitive' | 'by_values' | 'by_names';
1447
- export type DateTimeInputFormat = 'best_effort_us' | 'best_effort' | 'basic';
1448
- export type MsgPackUUIDRepresentation = 'ext' | 'str' | 'bin';
1449
- export type OverflowMode = 'break' | 'throw';
1450
- export type OverflowModeGroupBy = OverflowMode | 'any';
1451
- export type JoinStrictness = 'ANY' | 'ALL' | '';
1452
- export type JoinAlgorithm = 'prefer_partial_merge' | 'hash' | 'parallel_hash' | 'partial_merge' | 'auto';
1453
- export {};