yandexcloud 0.354.0__py3-none-any.whl → 0.356.0__py3-none-any.whl
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.
Potentially problematic release.
This version of yandexcloud might be problematic. Click here for more details.
- yandex/cloud/ai/assistants/v1/common_pb2.py +58 -30
- yandex/cloud/ai/assistants/v1/common_pb2.pyi +178 -3
- yandex/cloud/airflow/v1/cluster_pb2.py +12 -8
- yandex/cloud/airflow/v1/cluster_pb2.pyi +4 -0
- yandex/cloud/apploadbalancer/v1/virtual_host_pb2.py +32 -32
- yandex/cloud/apploadbalancer/v1/virtual_host_pb2.pyi +5 -1
- yandex/cloud/apploadbalancer/v1/virtual_host_service_pb2.py +6 -6
- yandex/cloud/apploadbalancer/v1/virtual_host_service_pb2.pyi +5 -1
- yandex/cloud/backup/v1/backup_service_pb2.py +46 -40
- yandex/cloud/backup/v1/backup_service_pb2.pyi +26 -4
- yandex/cloud/backup/v1/resource_pb2.py +2 -2
- yandex/cloud/backup/v1/resource_pb2.pyi +8 -0
- yandex/cloud/baremetal/v1alpha/configuration_service_pb2.py +18 -9
- yandex/cloud/baremetal/v1alpha/configuration_service_pb2.pyi +16 -2
- yandex/cloud/baremetal/v1alpha/hardware_pool_service_pb2.py +14 -9
- yandex/cloud/baremetal/v1alpha/image_service_pb2.py +39 -32
- yandex/cloud/baremetal/v1alpha/private_cloud_connection_service_pb2.py +29 -24
- yandex/cloud/baremetal/v1alpha/private_subnet_service_pb2.py +43 -36
- yandex/cloud/baremetal/v1alpha/public_subnet_service_pb2.py +39 -32
- yandex/cloud/baremetal/v1alpha/public_subnet_service_pb2.pyi +3 -2
- yandex/cloud/baremetal/v1alpha/server_service_pb2.py +83 -76
- yandex/cloud/baremetal/v1alpha/storage_service_pb2.py +16 -11
- yandex/cloud/baremetal/v1alpha/vrf_service_pb2.py +39 -32
- yandex/cloud/baremetal/v1alpha/zone_service_pb2.py +14 -9
- yandex/cloud/compute/v1/maintenance_service_pb2.py +47 -0
- yandex/cloud/compute/v1/maintenance_service_pb2.pyi +8 -0
- yandex/cloud/compute/v1/maintenance_service_pb2_grpc.py +190 -0
- yandex/cloud/compute/v1/maintenance_service_pb2_grpc.pyi +91 -0
- yandex/cloud/compute/v1/reserved_instance_pool_pb2.py +8 -4
- yandex/cloud/compute/v1/reserved_instance_pool_pb2.pyi +69 -2
- yandex/cloud/compute/v1/reserved_instance_pool_service_pb2.py +44 -20
- yandex/cloud/compute/v1/reserved_instance_pool_service_pb2.pyi +138 -2
- yandex/cloud/compute/v1/reserved_instance_pool_service_pb2_grpc.py +88 -0
- yandex/cloud/compute/v1/reserved_instance_pool_service_pb2_grpc.pyi +40 -0
- yandex/cloud/datatransfer/v1/transfer_pb2.py +50 -48
- yandex/cloud/datatransfer/v1/transfer_pb2.pyi +23 -4
- yandex/cloud/datatransfer/v1/transfer_service_pb2.py +32 -32
- yandex/cloud/datatransfer/v1/transfer_service_pb2.pyi +12 -4
- yandex/cloud/iam/v1/oauth_client_pb2.py +39 -0
- yandex/cloud/iam/v1/oauth_client_pb2.pyi +85 -0
- yandex/cloud/iam/v1/oauth_client_pb2_grpc.py +24 -0
- yandex/cloud/iam/v1/oauth_client_pb2_grpc.pyi +17 -0
- yandex/cloud/iam/v1/oauth_client_secret_pb2.py +38 -0
- yandex/cloud/iam/v1/oauth_client_secret_pb2.pyi +49 -0
- yandex/cloud/iam/v1/oauth_client_secret_pb2_grpc.py +24 -0
- yandex/cloud/iam/v1/oauth_client_secret_pb2_grpc.pyi +17 -0
- yandex/cloud/iam/v1/oauth_client_secret_service_pb2.py +80 -0
- yandex/cloud/iam/v1/oauth_client_secret_service_pb2.pyi +188 -0
- yandex/cloud/iam/v1/oauth_client_secret_service_pb2_grpc.py +237 -0
- yandex/cloud/iam/v1/oauth_client_secret_service_pb2_grpc.pyi +121 -0
- yandex/cloud/iam/v1/oauth_client_service_pb2.py +99 -0
- yandex/cloud/iam/v1/oauth_client_service_pb2.pyi +257 -0
- yandex/cloud/iam/v1/oauth_client_service_pb2_grpc.py +281 -0
- yandex/cloud/iam/v1/oauth_client_service_pb2_grpc.pyi +141 -0
- yandex/cloud/iot/broker/v1/broker_service_pb2.py +50 -50
- yandex/cloud/iot/devices/v1/device_service_pb2.py +61 -61
- yandex/cloud/iot/devices/v1/registry_service_pb2.py +82 -82
- yandex/cloud/maintenance/__init__.py +0 -0
- yandex/cloud/maintenance/v2/__init__.py +0 -0
- yandex/cloud/maintenance/v2/common_pb2.py +73 -0
- yandex/cloud/maintenance/v2/common_pb2.pyi +324 -0
- yandex/cloud/maintenance/v2/common_pb2_grpc.py +24 -0
- yandex/cloud/maintenance/v2/common_pb2_grpc.pyi +17 -0
- yandex/cloud/mdb/clickhouse/v1/config/clickhouse_pb2.py +196 -152
- yandex/cloud/mdb/clickhouse/v1/config/clickhouse_pb2.pyi +1779 -1066
- yandex/cloud/mdb/clickhouse/v1/user_pb2.py +98 -86
- yandex/cloud/mdb/clickhouse/v1/user_pb2.pyi +1248 -792
- yandex/cloud/mdb/opensearch/v1/backup_pb2.py +14 -14
- yandex/cloud/mdb/opensearch/v1/backup_pb2.pyi +13 -1
- yandex/cloud/mdb/spqr/v1/cluster_service_pb2.py +76 -76
- yandex/cloud/mdb/spqr/v1/cluster_service_pb2.pyi +4 -0
- yandex/cloud/metastore/v1/cluster_pb2.py +18 -16
- yandex/cloud/metastore/v1/cluster_pb2.pyi +31 -1
- yandex/cloud/searchapi/v2/gen_search_service_pb2.py +22 -22
- yandex/cloud/searchapi/v2/gen_search_service_pb2.pyi +12 -2
- yandex/cloud/serverless/containers/v1/container_pb2.py +46 -44
- yandex/cloud/serverless/containers/v1/container_pb2.pyi +25 -3
- yandex/cloud/smartwebsecurity/v1/waf/waf_profile_pb2.py +50 -18
- yandex/cloud/smartwebsecurity/v1/waf/waf_profile_pb2.pyi +241 -2
- yandex/cloud/smartwebsecurity/v1/waf/waf_profile_service_pb2.py +18 -18
- yandex/cloud/smartwebsecurity/v1/waf/waf_profile_service_pb2.pyi +22 -2
- yandex/cloud/storage/v1/presign_service_pb2.py +47 -0
- yandex/cloud/storage/v1/presign_service_pb2.pyi +117 -0
- yandex/cloud/storage/v1/presign_service_pb2_grpc.py +101 -0
- yandex/cloud/storage/v1/presign_service_pb2_grpc.pyi +50 -0
- yandex/cloud/trino/v1/access_control_pb2.py +212 -0
- yandex/cloud/trino/v1/access_control_pb2.pyi +926 -0
- yandex/cloud/trino/v1/access_control_pb2_grpc.py +24 -0
- yandex/cloud/trino/v1/access_control_pb2_grpc.pyi +17 -0
- yandex/cloud/trino/v1/cluster_pb2.py +44 -43
- yandex/cloud/trino/v1/cluster_pb2.pyi +9 -2
- yandex/cloud/trino/v1/cluster_service_pb2.py +50 -49
- yandex/cloud/trino/v1/cluster_service_pb2.pyi +29 -4
- yandex/cloud/ytsaurus/v1/cluster_pb2.py +40 -37
- yandex/cloud/ytsaurus/v1/cluster_pb2.pyi +32 -18
- yandexcloud/__init__.py +1 -1
- {yandexcloud-0.354.0.dist-info → yandexcloud-0.356.0.dist-info}/METADATA +1 -1
- {yandexcloud-0.354.0.dist-info → yandexcloud-0.356.0.dist-info}/RECORD +102 -68
- {yandexcloud-0.354.0.dist-info → yandexcloud-0.356.0.dist-info}/AUTHORS +0 -0
- {yandexcloud-0.354.0.dist-info → yandexcloud-0.356.0.dist-info}/LICENSE +0 -0
- {yandexcloud-0.354.0.dist-info → yandexcloud-0.356.0.dist-info}/WHEEL +0 -0
- {yandexcloud-0.354.0.dist-info → yandexcloud-0.356.0.dist-info}/top_level.txt +0 -0
|
@@ -22,9 +22,7 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
|
|
|
22
22
|
|
|
23
23
|
@typing.final
|
|
24
24
|
class User(google.protobuf.message.Message):
|
|
25
|
-
"""A ClickHouse User resource. For more information, see
|
|
26
|
-
the [Developer's guide](/docs/managed-clickhouse/concepts).
|
|
27
|
-
"""
|
|
25
|
+
"""A ClickHouse User resource. For more information, see the [Developer's guide](/docs/managed-clickhouse/concepts)."""
|
|
28
26
|
|
|
29
27
|
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
30
28
|
|
|
@@ -35,22 +33,24 @@ class User(google.protobuf.message.Message):
|
|
|
35
33
|
QUOTAS_FIELD_NUMBER: builtins.int
|
|
36
34
|
CONNECTION_MANAGER_FIELD_NUMBER: builtins.int
|
|
37
35
|
name: builtins.str
|
|
38
|
-
"""
|
|
36
|
+
"""User name."""
|
|
39
37
|
cluster_id: builtins.str
|
|
40
|
-
"""ID
|
|
38
|
+
"""Cluster ID."""
|
|
41
39
|
@property
|
|
42
40
|
def permissions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Permission]:
|
|
43
|
-
"""
|
|
41
|
+
"""User permissions."""
|
|
44
42
|
|
|
45
43
|
@property
|
|
46
|
-
def settings(self) -> global___UserSettings:
|
|
44
|
+
def settings(self) -> global___UserSettings:
|
|
45
|
+
"""User settings."""
|
|
46
|
+
|
|
47
47
|
@property
|
|
48
48
|
def quotas(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UserQuota]:
|
|
49
|
-
"""
|
|
49
|
+
"""Quotas assigned to the user."""
|
|
50
50
|
|
|
51
51
|
@property
|
|
52
52
|
def connection_manager(self) -> global___ConnectionManager:
|
|
53
|
-
"""Connection Manager connection configuration.
|
|
53
|
+
"""Connection Manager connection configuration."""
|
|
54
54
|
|
|
55
55
|
def __init__(
|
|
56
56
|
self,
|
|
@@ -83,107 +83,14 @@ class Permission(google.protobuf.message.Message):
|
|
|
83
83
|
|
|
84
84
|
global___Permission = Permission
|
|
85
85
|
|
|
86
|
-
@typing.final
|
|
87
|
-
class ConnectionManager(google.protobuf.message.Message):
|
|
88
|
-
"""Connection Manager connection configuration."""
|
|
89
|
-
|
|
90
|
-
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
91
|
-
|
|
92
|
-
CONNECTION_ID_FIELD_NUMBER: builtins.int
|
|
93
|
-
connection_id: builtins.str
|
|
94
|
-
"""ID of Connection Manager connection."""
|
|
95
|
-
def __init__(
|
|
96
|
-
self,
|
|
97
|
-
*,
|
|
98
|
-
connection_id: builtins.str = ...,
|
|
99
|
-
) -> None: ...
|
|
100
|
-
def ClearField(self, field_name: typing.Literal["connection_id", b"connection_id"]) -> None: ...
|
|
101
|
-
|
|
102
|
-
global___ConnectionManager = ConnectionManager
|
|
103
|
-
|
|
104
|
-
@typing.final
|
|
105
|
-
class UserSpec(google.protobuf.message.Message):
|
|
106
|
-
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
107
|
-
|
|
108
|
-
NAME_FIELD_NUMBER: builtins.int
|
|
109
|
-
PASSWORD_FIELD_NUMBER: builtins.int
|
|
110
|
-
PERMISSIONS_FIELD_NUMBER: builtins.int
|
|
111
|
-
SETTINGS_FIELD_NUMBER: builtins.int
|
|
112
|
-
QUOTAS_FIELD_NUMBER: builtins.int
|
|
113
|
-
GENERATE_PASSWORD_FIELD_NUMBER: builtins.int
|
|
114
|
-
name: builtins.str
|
|
115
|
-
"""Name of the ClickHouse user."""
|
|
116
|
-
password: builtins.str
|
|
117
|
-
"""Password of the ClickHouse user."""
|
|
118
|
-
@property
|
|
119
|
-
def permissions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Permission]:
|
|
120
|
-
"""Set of permissions to grant to the user. If not set, it's granted permissions to access all databases."""
|
|
121
|
-
|
|
122
|
-
@property
|
|
123
|
-
def settings(self) -> global___UserSettings: ...
|
|
124
|
-
@property
|
|
125
|
-
def quotas(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UserQuota]:
|
|
126
|
-
"""Set of quotas assigned to the user."""
|
|
127
|
-
|
|
128
|
-
@property
|
|
129
|
-
def generate_password(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
130
|
-
"""Generate password using Connection Manager."""
|
|
131
|
-
|
|
132
|
-
def __init__(
|
|
133
|
-
self,
|
|
134
|
-
*,
|
|
135
|
-
name: builtins.str = ...,
|
|
136
|
-
password: builtins.str = ...,
|
|
137
|
-
permissions: collections.abc.Iterable[global___Permission] | None = ...,
|
|
138
|
-
settings: global___UserSettings | None = ...,
|
|
139
|
-
quotas: collections.abc.Iterable[global___UserQuota] | None = ...,
|
|
140
|
-
generate_password: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
141
|
-
) -> None: ...
|
|
142
|
-
def HasField(self, field_name: typing.Literal["generate_password", b"generate_password", "settings", b"settings"]) -> builtins.bool: ...
|
|
143
|
-
def ClearField(self, field_name: typing.Literal["generate_password", b"generate_password", "name", b"name", "password", b"password", "permissions", b"permissions", "quotas", b"quotas", "settings", b"settings"]) -> None: ...
|
|
144
|
-
|
|
145
|
-
global___UserSpec = UserSpec
|
|
146
|
-
|
|
147
86
|
@typing.final
|
|
148
87
|
class UserSettings(google.protobuf.message.Message):
|
|
149
|
-
"""ClickHouse user settings. Supported settings are a
|
|
150
|
-
|
|
88
|
+
"""ClickHouse user settings. Supported settings are a subset of settings described
|
|
89
|
+
in [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/).
|
|
151
90
|
"""
|
|
152
91
|
|
|
153
92
|
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
154
93
|
|
|
155
|
-
class _OverflowMode:
|
|
156
|
-
ValueType = typing.NewType("ValueType", builtins.int)
|
|
157
|
-
V: typing_extensions.TypeAlias = ValueType
|
|
158
|
-
|
|
159
|
-
class _OverflowModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._OverflowMode.ValueType], builtins.type):
|
|
160
|
-
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
161
|
-
OVERFLOW_MODE_UNSPECIFIED: UserSettings._OverflowMode.ValueType # 0
|
|
162
|
-
OVERFLOW_MODE_THROW: UserSettings._OverflowMode.ValueType # 1
|
|
163
|
-
OVERFLOW_MODE_BREAK: UserSettings._OverflowMode.ValueType # 2
|
|
164
|
-
|
|
165
|
-
class OverflowMode(_OverflowMode, metaclass=_OverflowModeEnumTypeWrapper): ...
|
|
166
|
-
OVERFLOW_MODE_UNSPECIFIED: UserSettings.OverflowMode.ValueType # 0
|
|
167
|
-
OVERFLOW_MODE_THROW: UserSettings.OverflowMode.ValueType # 1
|
|
168
|
-
OVERFLOW_MODE_BREAK: UserSettings.OverflowMode.ValueType # 2
|
|
169
|
-
|
|
170
|
-
class _GroupByOverflowMode:
|
|
171
|
-
ValueType = typing.NewType("ValueType", builtins.int)
|
|
172
|
-
V: typing_extensions.TypeAlias = ValueType
|
|
173
|
-
|
|
174
|
-
class _GroupByOverflowModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._GroupByOverflowMode.ValueType], builtins.type):
|
|
175
|
-
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
176
|
-
GROUP_BY_OVERFLOW_MODE_UNSPECIFIED: UserSettings._GroupByOverflowMode.ValueType # 0
|
|
177
|
-
GROUP_BY_OVERFLOW_MODE_THROW: UserSettings._GroupByOverflowMode.ValueType # 1
|
|
178
|
-
GROUP_BY_OVERFLOW_MODE_BREAK: UserSettings._GroupByOverflowMode.ValueType # 2
|
|
179
|
-
GROUP_BY_OVERFLOW_MODE_ANY: UserSettings._GroupByOverflowMode.ValueType # 3
|
|
180
|
-
|
|
181
|
-
class GroupByOverflowMode(_GroupByOverflowMode, metaclass=_GroupByOverflowModeEnumTypeWrapper): ...
|
|
182
|
-
GROUP_BY_OVERFLOW_MODE_UNSPECIFIED: UserSettings.GroupByOverflowMode.ValueType # 0
|
|
183
|
-
GROUP_BY_OVERFLOW_MODE_THROW: UserSettings.GroupByOverflowMode.ValueType # 1
|
|
184
|
-
GROUP_BY_OVERFLOW_MODE_BREAK: UserSettings.GroupByOverflowMode.ValueType # 2
|
|
185
|
-
GROUP_BY_OVERFLOW_MODE_ANY: UserSettings.GroupByOverflowMode.ValueType # 3
|
|
186
|
-
|
|
187
94
|
class _DistributedProductMode:
|
|
188
95
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
189
96
|
V: typing_extensions.TypeAlias = ValueType
|
|
@@ -192,7 +99,7 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
192
99
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
193
100
|
DISTRIBUTED_PRODUCT_MODE_UNSPECIFIED: UserSettings._DistributedProductMode.ValueType # 0
|
|
194
101
|
DISTRIBUTED_PRODUCT_MODE_DENY: UserSettings._DistributedProductMode.ValueType # 1
|
|
195
|
-
"""
|
|
102
|
+
"""Prohibits using these types of subqueries (returns the "Double-distributed in/JOIN subqueries is denied" exception)."""
|
|
196
103
|
DISTRIBUTED_PRODUCT_MODE_LOCAL: UserSettings._DistributedProductMode.ValueType # 2
|
|
197
104
|
"""Replaces the database and table in the subquery with local ones for the destination server (shard), leaving the normal IN/JOIN."""
|
|
198
105
|
DISTRIBUTED_PRODUCT_MODE_GLOBAL: UserSettings._DistributedProductMode.ValueType # 3
|
|
@@ -200,10 +107,12 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
200
107
|
DISTRIBUTED_PRODUCT_MODE_ALLOW: UserSettings._DistributedProductMode.ValueType # 4
|
|
201
108
|
"""Allows the use of these types of subqueries."""
|
|
202
109
|
|
|
203
|
-
class DistributedProductMode(_DistributedProductMode, metaclass=_DistributedProductModeEnumTypeWrapper):
|
|
110
|
+
class DistributedProductMode(_DistributedProductMode, metaclass=_DistributedProductModeEnumTypeWrapper):
|
|
111
|
+
"""Determines the behavior of distributed subqueries."""
|
|
112
|
+
|
|
204
113
|
DISTRIBUTED_PRODUCT_MODE_UNSPECIFIED: UserSettings.DistributedProductMode.ValueType # 0
|
|
205
114
|
DISTRIBUTED_PRODUCT_MODE_DENY: UserSettings.DistributedProductMode.ValueType # 1
|
|
206
|
-
"""
|
|
115
|
+
"""Prohibits using these types of subqueries (returns the "Double-distributed in/JOIN subqueries is denied" exception)."""
|
|
207
116
|
DISTRIBUTED_PRODUCT_MODE_LOCAL: UserSettings.DistributedProductMode.ValueType # 2
|
|
208
117
|
"""Replaces the database and table in the subquery with local ones for the destination server (shard), leaving the normal IN/JOIN."""
|
|
209
118
|
DISTRIBUTED_PRODUCT_MODE_GLOBAL: UserSettings.DistributedProductMode.ValueType # 3
|
|
@@ -211,91 +120,159 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
211
120
|
DISTRIBUTED_PRODUCT_MODE_ALLOW: UserSettings.DistributedProductMode.ValueType # 4
|
|
212
121
|
"""Allows the use of these types of subqueries."""
|
|
213
122
|
|
|
214
|
-
class
|
|
123
|
+
class _DistributedDdlOutputMode:
|
|
215
124
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
216
125
|
V: typing_extensions.TypeAlias = ValueType
|
|
217
126
|
|
|
218
|
-
class
|
|
127
|
+
class _DistributedDdlOutputModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._DistributedDdlOutputMode.ValueType], builtins.type):
|
|
219
128
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
129
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_UNSPECIFIED: UserSettings._DistributedDdlOutputMode.ValueType # 0
|
|
130
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_THROW: UserSettings._DistributedDdlOutputMode.ValueType # 1
|
|
131
|
+
"""Returns result set with query execution status for all hosts where query is finished. If query has failed on some hosts, then it will rethrow the first exception.
|
|
132
|
+
If query is not finished yet on some hosts and **distributed_ddl_task_timeout** exceeded, then it throws **TIMEOUT_EXCEEDED** exception.
|
|
133
|
+
"""
|
|
134
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NONE: UserSettings._DistributedDdlOutputMode.ValueType # 2
|
|
135
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_THROW**, but distributed DDL query returns no result set."""
|
|
136
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT: UserSettings._DistributedDdlOutputMode.ValueType # 3
|
|
137
|
+
"""Returns **NULL** as execution status in some rows of result set instead of throwing **TIMEOUT_EXCEEDED** if query is not finished on the corresponding hosts."""
|
|
138
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NEVER_THROW: UserSettings._DistributedDdlOutputMode.ValueType # 4
|
|
139
|
+
"""Do not throw **TIMEOUT_EXCEEDED** and do not rethrow exceptions if query has failed on some hosts."""
|
|
140
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NONE_ONLY_ACTIVE: UserSettings._DistributedDdlOutputMode.ValueType # 5
|
|
141
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_NONE**, but doesn't wait for inactive replicas of the **Replicated** database.
|
|
142
|
+
With this mode it's impossible to figure out that the query was not executed on some replica and will be executed in background.
|
|
143
|
+
"""
|
|
144
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT_ONLY_ACTIVE: UserSettings._DistributedDdlOutputMode.ValueType # 6
|
|
145
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT**, but doesn't wait for inactive replicas of the **Replicated** database."""
|
|
146
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_THROW_ONLY_ACTIVE: UserSettings._DistributedDdlOutputMode.ValueType # 7
|
|
147
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_THROW**, but doesn't wait for inactive replicas of the **Replicated** database."""
|
|
148
|
+
|
|
149
|
+
class DistributedDdlOutputMode(_DistributedDdlOutputMode, metaclass=_DistributedDdlOutputModeEnumTypeWrapper):
|
|
150
|
+
"""Determines the format of distributed DDL query result.
|
|
151
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#distributed_ddl_output_mode).
|
|
152
|
+
"""
|
|
153
|
+
|
|
154
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_UNSPECIFIED: UserSettings.DistributedDdlOutputMode.ValueType # 0
|
|
155
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_THROW: UserSettings.DistributedDdlOutputMode.ValueType # 1
|
|
156
|
+
"""Returns result set with query execution status for all hosts where query is finished. If query has failed on some hosts, then it will rethrow the first exception.
|
|
157
|
+
If query is not finished yet on some hosts and **distributed_ddl_task_timeout** exceeded, then it throws **TIMEOUT_EXCEEDED** exception.
|
|
158
|
+
"""
|
|
159
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NONE: UserSettings.DistributedDdlOutputMode.ValueType # 2
|
|
160
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_THROW**, but distributed DDL query returns no result set."""
|
|
161
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT: UserSettings.DistributedDdlOutputMode.ValueType # 3
|
|
162
|
+
"""Returns **NULL** as execution status in some rows of result set instead of throwing **TIMEOUT_EXCEEDED** if query is not finished on the corresponding hosts."""
|
|
163
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NEVER_THROW: UserSettings.DistributedDdlOutputMode.ValueType # 4
|
|
164
|
+
"""Do not throw **TIMEOUT_EXCEEDED** and do not rethrow exceptions if query has failed on some hosts."""
|
|
165
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NONE_ONLY_ACTIVE: UserSettings.DistributedDdlOutputMode.ValueType # 5
|
|
166
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_NONE**, but doesn't wait for inactive replicas of the **Replicated** database.
|
|
167
|
+
With this mode it's impossible to figure out that the query was not executed on some replica and will be executed in background.
|
|
168
|
+
"""
|
|
169
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT_ONLY_ACTIVE: UserSettings.DistributedDdlOutputMode.ValueType # 6
|
|
170
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT**, but doesn't wait for inactive replicas of the **Replicated** database."""
|
|
171
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_THROW_ONLY_ACTIVE: UserSettings.DistributedDdlOutputMode.ValueType # 7
|
|
172
|
+
"""Like **DISTRIBUTED_DDL_OUTPUT_MODE_THROW**, but doesn't wait for inactive replicas of the **Replicated** database."""
|
|
224
173
|
|
|
225
|
-
class
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
QUOTA_MODE_KEYED: UserSettings.QuotaMode.ValueType # 2
|
|
229
|
-
QUOTA_MODE_KEYED_BY_IP: UserSettings.QuotaMode.ValueType # 3
|
|
174
|
+
class _LoadBalancing:
|
|
175
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
176
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
230
177
|
|
|
231
|
-
class
|
|
178
|
+
class _LoadBalancingEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._LoadBalancing.ValueType], builtins.type):
|
|
179
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
180
|
+
LOAD_BALANCING_UNSPECIFIED: UserSettings._LoadBalancing.ValueType # 0
|
|
181
|
+
LOAD_BALANCING_RANDOM: UserSettings._LoadBalancing.ValueType # 1
|
|
182
|
+
LOAD_BALANCING_NEAREST_HOSTNAME: UserSettings._LoadBalancing.ValueType # 2
|
|
183
|
+
LOAD_BALANCING_IN_ORDER: UserSettings._LoadBalancing.ValueType # 3
|
|
184
|
+
LOAD_BALANCING_FIRST_OR_RANDOM: UserSettings._LoadBalancing.ValueType # 4
|
|
185
|
+
LOAD_BALANCING_ROUND_ROBIN: UserSettings._LoadBalancing.ValueType # 5
|
|
186
|
+
|
|
187
|
+
class LoadBalancing(_LoadBalancing, metaclass=_LoadBalancingEnumTypeWrapper): ...
|
|
188
|
+
LOAD_BALANCING_UNSPECIFIED: UserSettings.LoadBalancing.ValueType # 0
|
|
189
|
+
LOAD_BALANCING_RANDOM: UserSettings.LoadBalancing.ValueType # 1
|
|
190
|
+
LOAD_BALANCING_NEAREST_HOSTNAME: UserSettings.LoadBalancing.ValueType # 2
|
|
191
|
+
LOAD_BALANCING_IN_ORDER: UserSettings.LoadBalancing.ValueType # 3
|
|
192
|
+
LOAD_BALANCING_FIRST_OR_RANDOM: UserSettings.LoadBalancing.ValueType # 4
|
|
193
|
+
LOAD_BALANCING_ROUND_ROBIN: UserSettings.LoadBalancing.ValueType # 5
|
|
194
|
+
|
|
195
|
+
class _LocalFilesystemReadMethod:
|
|
232
196
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
233
197
|
V: typing_extensions.TypeAlias = ValueType
|
|
234
198
|
|
|
235
|
-
class
|
|
199
|
+
class _LocalFilesystemReadMethodEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._LocalFilesystemReadMethod.ValueType], builtins.type):
|
|
236
200
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
201
|
+
LOCAL_FILESYSTEM_READ_METHOD_UNSPECIFIED: UserSettings._LocalFilesystemReadMethod.ValueType # 0
|
|
202
|
+
LOCAL_FILESYSTEM_READ_METHOD_READ: UserSettings._LocalFilesystemReadMethod.ValueType # 1
|
|
203
|
+
LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL: UserSettings._LocalFilesystemReadMethod.ValueType # 2
|
|
204
|
+
LOCAL_FILESYSTEM_READ_METHOD_PREAD: UserSettings._LocalFilesystemReadMethod.ValueType # 3
|
|
205
|
+
LOCAL_FILESYSTEM_READ_METHOD_NMAP: UserSettings._LocalFilesystemReadMethod.ValueType # 4
|
|
206
|
+
LOCAL_FILESYSTEM_READ_METHOD_IO_URING: UserSettings._LocalFilesystemReadMethod.ValueType # 5
|
|
243
207
|
|
|
244
|
-
class
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
208
|
+
class LocalFilesystemReadMethod(_LocalFilesystemReadMethod, metaclass=_LocalFilesystemReadMethodEnumTypeWrapper): ...
|
|
209
|
+
LOCAL_FILESYSTEM_READ_METHOD_UNSPECIFIED: UserSettings.LocalFilesystemReadMethod.ValueType # 0
|
|
210
|
+
LOCAL_FILESYSTEM_READ_METHOD_READ: UserSettings.LocalFilesystemReadMethod.ValueType # 1
|
|
211
|
+
LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL: UserSettings.LocalFilesystemReadMethod.ValueType # 2
|
|
212
|
+
LOCAL_FILESYSTEM_READ_METHOD_PREAD: UserSettings.LocalFilesystemReadMethod.ValueType # 3
|
|
213
|
+
LOCAL_FILESYSTEM_READ_METHOD_NMAP: UserSettings.LocalFilesystemReadMethod.ValueType # 4
|
|
214
|
+
LOCAL_FILESYSTEM_READ_METHOD_IO_URING: UserSettings.LocalFilesystemReadMethod.ValueType # 5
|
|
251
215
|
|
|
252
|
-
class
|
|
216
|
+
class _RemoteFilesystemReadMethod:
|
|
253
217
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
254
218
|
V: typing_extensions.TypeAlias = ValueType
|
|
255
219
|
|
|
256
|
-
class
|
|
220
|
+
class _RemoteFilesystemReadMethodEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._RemoteFilesystemReadMethod.ValueType], builtins.type):
|
|
257
221
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
JOIN_ALGORITHM_PARTIAL_MERGE: UserSettings._JoinAlgorithm.ValueType # 3
|
|
262
|
-
JOIN_ALGORITHM_DIRECT: UserSettings._JoinAlgorithm.ValueType # 4
|
|
263
|
-
JOIN_ALGORITHM_AUTO: UserSettings._JoinAlgorithm.ValueType # 5
|
|
264
|
-
JOIN_ALGORITHM_FULL_SORTING_MERGE: UserSettings._JoinAlgorithm.ValueType # 6
|
|
265
|
-
JOIN_ALGORITHM_PREFER_PARTIAL_MERGE: UserSettings._JoinAlgorithm.ValueType # 7
|
|
222
|
+
REMOTE_FILESYSTEM_READ_METHOD_UNSPECIFIED: UserSettings._RemoteFilesystemReadMethod.ValueType # 0
|
|
223
|
+
REMOTE_FILESYSTEM_READ_METHOD_READ: UserSettings._RemoteFilesystemReadMethod.ValueType # 1
|
|
224
|
+
REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL: UserSettings._RemoteFilesystemReadMethod.ValueType # 2
|
|
266
225
|
|
|
267
|
-
class
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
JOIN_ALGORITHM_PARTIAL_MERGE: UserSettings.JoinAlgorithm.ValueType # 3
|
|
272
|
-
JOIN_ALGORITHM_DIRECT: UserSettings.JoinAlgorithm.ValueType # 4
|
|
273
|
-
JOIN_ALGORITHM_AUTO: UserSettings.JoinAlgorithm.ValueType # 5
|
|
274
|
-
JOIN_ALGORITHM_FULL_SORTING_MERGE: UserSettings.JoinAlgorithm.ValueType # 6
|
|
275
|
-
JOIN_ALGORITHM_PREFER_PARTIAL_MERGE: UserSettings.JoinAlgorithm.ValueType # 7
|
|
226
|
+
class RemoteFilesystemReadMethod(_RemoteFilesystemReadMethod, metaclass=_RemoteFilesystemReadMethodEnumTypeWrapper): ...
|
|
227
|
+
REMOTE_FILESYSTEM_READ_METHOD_UNSPECIFIED: UserSettings.RemoteFilesystemReadMethod.ValueType # 0
|
|
228
|
+
REMOTE_FILESYSTEM_READ_METHOD_READ: UserSettings.RemoteFilesystemReadMethod.ValueType # 1
|
|
229
|
+
REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL: UserSettings.RemoteFilesystemReadMethod.ValueType # 2
|
|
276
230
|
|
|
277
|
-
class
|
|
231
|
+
class _OverflowMode:
|
|
278
232
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
279
233
|
V: typing_extensions.TypeAlias = ValueType
|
|
280
234
|
|
|
281
|
-
class
|
|
235
|
+
class _OverflowModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._OverflowMode.ValueType], builtins.type):
|
|
282
236
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
FORMAT_REGEXP_ESCAPING_RULE_XML: UserSettings._FormatRegexpEscapingRule.ValueType # 5
|
|
289
|
-
FORMAT_REGEXP_ESCAPING_RULE_RAW: UserSettings._FormatRegexpEscapingRule.ValueType # 6
|
|
237
|
+
OVERFLOW_MODE_UNSPECIFIED: UserSettings._OverflowMode.ValueType # 0
|
|
238
|
+
OVERFLOW_MODE_THROW: UserSettings._OverflowMode.ValueType # 1
|
|
239
|
+
"""Abort query execution and return an error."""
|
|
240
|
+
OVERFLOW_MODE_BREAK: UserSettings._OverflowMode.ValueType # 2
|
|
241
|
+
"""Return a partial result."""
|
|
290
242
|
|
|
291
|
-
class
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
243
|
+
class OverflowMode(_OverflowMode, metaclass=_OverflowModeEnumTypeWrapper):
|
|
244
|
+
"""Determines the behavior on exceeding of query complexity limits."""
|
|
245
|
+
|
|
246
|
+
OVERFLOW_MODE_UNSPECIFIED: UserSettings.OverflowMode.ValueType # 0
|
|
247
|
+
OVERFLOW_MODE_THROW: UserSettings.OverflowMode.ValueType # 1
|
|
248
|
+
"""Abort query execution and return an error."""
|
|
249
|
+
OVERFLOW_MODE_BREAK: UserSettings.OverflowMode.ValueType # 2
|
|
250
|
+
"""Return a partial result."""
|
|
251
|
+
|
|
252
|
+
class _GroupByOverflowMode:
|
|
253
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
254
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
255
|
+
|
|
256
|
+
class _GroupByOverflowModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._GroupByOverflowMode.ValueType], builtins.type):
|
|
257
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
258
|
+
GROUP_BY_OVERFLOW_MODE_UNSPECIFIED: UserSettings._GroupByOverflowMode.ValueType # 0
|
|
259
|
+
GROUP_BY_OVERFLOW_MODE_THROW: UserSettings._GroupByOverflowMode.ValueType # 1
|
|
260
|
+
"""Abort query execution and return an error."""
|
|
261
|
+
GROUP_BY_OVERFLOW_MODE_BREAK: UserSettings._GroupByOverflowMode.ValueType # 2
|
|
262
|
+
"""Return a partial result."""
|
|
263
|
+
GROUP_BY_OVERFLOW_MODE_ANY: UserSettings._GroupByOverflowMode.ValueType # 3
|
|
264
|
+
"""Continuing aggregation for the keys that got into the set, but do not add new keys to the set."""
|
|
265
|
+
|
|
266
|
+
class GroupByOverflowMode(_GroupByOverflowMode, metaclass=_GroupByOverflowModeEnumTypeWrapper):
|
|
267
|
+
"""Determines behavior on exceeding the limit on the number of unique keys during aggregation."""
|
|
268
|
+
|
|
269
|
+
GROUP_BY_OVERFLOW_MODE_UNSPECIFIED: UserSettings.GroupByOverflowMode.ValueType # 0
|
|
270
|
+
GROUP_BY_OVERFLOW_MODE_THROW: UserSettings.GroupByOverflowMode.ValueType # 1
|
|
271
|
+
"""Abort query execution and return an error."""
|
|
272
|
+
GROUP_BY_OVERFLOW_MODE_BREAK: UserSettings.GroupByOverflowMode.ValueType # 2
|
|
273
|
+
"""Return a partial result."""
|
|
274
|
+
GROUP_BY_OVERFLOW_MODE_ANY: UserSettings.GroupByOverflowMode.ValueType # 3
|
|
275
|
+
"""Continuing aggregation for the keys that got into the set, but do not add new keys to the set."""
|
|
299
276
|
|
|
300
277
|
class _DateTimeInputFormat:
|
|
301
278
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
@@ -331,60 +308,45 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
331
308
|
DATE_TIME_OUTPUT_FORMAT_ISO: UserSettings.DateTimeOutputFormat.ValueType # 2
|
|
332
309
|
DATE_TIME_OUTPUT_FORMAT_UNIX_TIMESTAMP: UserSettings.DateTimeOutputFormat.ValueType # 3
|
|
333
310
|
|
|
334
|
-
class
|
|
335
|
-
ValueType = typing.NewType("ValueType", builtins.int)
|
|
336
|
-
V: typing_extensions.TypeAlias = ValueType
|
|
337
|
-
|
|
338
|
-
class _LocalFilesystemReadMethodEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._LocalFilesystemReadMethod.ValueType], builtins.type):
|
|
339
|
-
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
340
|
-
LOCAL_FILESYSTEM_READ_METHOD_UNSPECIFIED: UserSettings._LocalFilesystemReadMethod.ValueType # 0
|
|
341
|
-
LOCAL_FILESYSTEM_READ_METHOD_READ: UserSettings._LocalFilesystemReadMethod.ValueType # 1
|
|
342
|
-
LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL: UserSettings._LocalFilesystemReadMethod.ValueType # 2
|
|
343
|
-
LOCAL_FILESYSTEM_READ_METHOD_PREAD: UserSettings._LocalFilesystemReadMethod.ValueType # 3
|
|
344
|
-
LOCAL_FILESYSTEM_READ_METHOD_NMAP: UserSettings._LocalFilesystemReadMethod.ValueType # 4
|
|
345
|
-
|
|
346
|
-
class LocalFilesystemReadMethod(_LocalFilesystemReadMethod, metaclass=_LocalFilesystemReadMethodEnumTypeWrapper): ...
|
|
347
|
-
LOCAL_FILESYSTEM_READ_METHOD_UNSPECIFIED: UserSettings.LocalFilesystemReadMethod.ValueType # 0
|
|
348
|
-
LOCAL_FILESYSTEM_READ_METHOD_READ: UserSettings.LocalFilesystemReadMethod.ValueType # 1
|
|
349
|
-
LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL: UserSettings.LocalFilesystemReadMethod.ValueType # 2
|
|
350
|
-
LOCAL_FILESYSTEM_READ_METHOD_PREAD: UserSettings.LocalFilesystemReadMethod.ValueType # 3
|
|
351
|
-
LOCAL_FILESYSTEM_READ_METHOD_NMAP: UserSettings.LocalFilesystemReadMethod.ValueType # 4
|
|
352
|
-
|
|
353
|
-
class _RemoteFilesystemReadMethod:
|
|
311
|
+
class _FormatRegexpEscapingRule:
|
|
354
312
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
355
313
|
V: typing_extensions.TypeAlias = ValueType
|
|
356
314
|
|
|
357
|
-
class
|
|
315
|
+
class _FormatRegexpEscapingRuleEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._FormatRegexpEscapingRule.ValueType], builtins.type):
|
|
358
316
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
317
|
+
FORMAT_REGEXP_ESCAPING_RULE_UNSPECIFIED: UserSettings._FormatRegexpEscapingRule.ValueType # 0
|
|
318
|
+
FORMAT_REGEXP_ESCAPING_RULE_ESCAPED: UserSettings._FormatRegexpEscapingRule.ValueType # 1
|
|
319
|
+
FORMAT_REGEXP_ESCAPING_RULE_QUOTED: UserSettings._FormatRegexpEscapingRule.ValueType # 2
|
|
320
|
+
FORMAT_REGEXP_ESCAPING_RULE_CSV: UserSettings._FormatRegexpEscapingRule.ValueType # 3
|
|
321
|
+
FORMAT_REGEXP_ESCAPING_RULE_JSON: UserSettings._FormatRegexpEscapingRule.ValueType # 4
|
|
322
|
+
FORMAT_REGEXP_ESCAPING_RULE_XML: UserSettings._FormatRegexpEscapingRule.ValueType # 5
|
|
323
|
+
FORMAT_REGEXP_ESCAPING_RULE_RAW: UserSettings._FormatRegexpEscapingRule.ValueType # 6
|
|
362
324
|
|
|
363
|
-
class
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
325
|
+
class FormatRegexpEscapingRule(_FormatRegexpEscapingRule, metaclass=_FormatRegexpEscapingRuleEnumTypeWrapper): ...
|
|
326
|
+
FORMAT_REGEXP_ESCAPING_RULE_UNSPECIFIED: UserSettings.FormatRegexpEscapingRule.ValueType # 0
|
|
327
|
+
FORMAT_REGEXP_ESCAPING_RULE_ESCAPED: UserSettings.FormatRegexpEscapingRule.ValueType # 1
|
|
328
|
+
FORMAT_REGEXP_ESCAPING_RULE_QUOTED: UserSettings.FormatRegexpEscapingRule.ValueType # 2
|
|
329
|
+
FORMAT_REGEXP_ESCAPING_RULE_CSV: UserSettings.FormatRegexpEscapingRule.ValueType # 3
|
|
330
|
+
FORMAT_REGEXP_ESCAPING_RULE_JSON: UserSettings.FormatRegexpEscapingRule.ValueType # 4
|
|
331
|
+
FORMAT_REGEXP_ESCAPING_RULE_XML: UserSettings.FormatRegexpEscapingRule.ValueType # 5
|
|
332
|
+
FORMAT_REGEXP_ESCAPING_RULE_RAW: UserSettings.FormatRegexpEscapingRule.ValueType # 6
|
|
367
333
|
|
|
368
|
-
class
|
|
334
|
+
class _QuotaMode:
|
|
369
335
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
370
336
|
V: typing_extensions.TypeAlias = ValueType
|
|
371
337
|
|
|
372
|
-
class
|
|
338
|
+
class _QuotaModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._QuotaMode.ValueType], builtins.type):
|
|
373
339
|
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
LOAD_BALANCING_FIRST_OR_RANDOM: UserSettings._LoadBalancing.ValueType # 4
|
|
379
|
-
LOAD_BALANCING_ROUND_ROBIN: UserSettings._LoadBalancing.ValueType # 5
|
|
340
|
+
QUOTA_MODE_UNSPECIFIED: UserSettings._QuotaMode.ValueType # 0
|
|
341
|
+
QUOTA_MODE_DEFAULT: UserSettings._QuotaMode.ValueType # 1
|
|
342
|
+
QUOTA_MODE_KEYED: UserSettings._QuotaMode.ValueType # 2
|
|
343
|
+
QUOTA_MODE_KEYED_BY_IP: UserSettings._QuotaMode.ValueType # 3
|
|
380
344
|
|
|
381
|
-
class
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
LOAD_BALANCING_FIRST_OR_RANDOM: UserSettings.LoadBalancing.ValueType # 4
|
|
387
|
-
LOAD_BALANCING_ROUND_ROBIN: UserSettings.LoadBalancing.ValueType # 5
|
|
345
|
+
class QuotaMode(_QuotaMode, metaclass=_QuotaModeEnumTypeWrapper): ...
|
|
346
|
+
QUOTA_MODE_UNSPECIFIED: UserSettings.QuotaMode.ValueType # 0
|
|
347
|
+
QUOTA_MODE_DEFAULT: UserSettings.QuotaMode.ValueType # 1
|
|
348
|
+
QUOTA_MODE_KEYED: UserSettings.QuotaMode.ValueType # 2
|
|
349
|
+
QUOTA_MODE_KEYED_BY_IP: UserSettings.QuotaMode.ValueType # 3
|
|
388
350
|
|
|
389
351
|
class _QueryCacheNondeterministicFunctionHandling:
|
|
390
352
|
ValueType = typing.NewType("ValueType", builtins.int)
|
|
@@ -401,9 +363,7 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
401
363
|
"""Don't cache the query result and don't throw an exception."""
|
|
402
364
|
|
|
403
365
|
class QueryCacheNondeterministicFunctionHandling(_QueryCacheNondeterministicFunctionHandling, metaclass=_QueryCacheNondeterministicFunctionHandlingEnumTypeWrapper):
|
|
404
|
-
"""Controls how the query cache handles SELECT queries with non-deterministic functions like rand() or now().
|
|
405
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#query_cache_nondeterministic_function_handling).
|
|
406
|
-
"""
|
|
366
|
+
"""Controls how the query cache handles SELECT queries with non-deterministic functions like rand() or now()."""
|
|
407
367
|
|
|
408
368
|
QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_UNSPECIFIED: UserSettings.QueryCacheNondeterministicFunctionHandling.ValueType # 0
|
|
409
369
|
QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_THROW: UserSettings.QueryCacheNondeterministicFunctionHandling.ValueType # 1
|
|
@@ -428,9 +388,7 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
428
388
|
"""Don't cache the query result and don't throw an exception."""
|
|
429
389
|
|
|
430
390
|
class QueryCacheSystemTableHandling(_QueryCacheSystemTableHandling, metaclass=_QueryCacheSystemTableHandlingEnumTypeWrapper):
|
|
431
|
-
"""Controls how the query cache handles SELECT queries against system tables.
|
|
432
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_system_table_handling)
|
|
433
|
-
"""
|
|
391
|
+
"""Controls how the query cache handles SELECT queries against system tables."""
|
|
434
392
|
|
|
435
393
|
QUERY_CACHE_SYSTEM_TABLE_HANDLING_UNSPECIFIED: UserSettings.QueryCacheSystemTableHandling.ValueType # 0
|
|
436
394
|
QUERY_CACHE_SYSTEM_TABLE_HANDLING_THROW: UserSettings.QueryCacheSystemTableHandling.ValueType # 1
|
|
@@ -440,6 +398,52 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
440
398
|
QUERY_CACHE_SYSTEM_TABLE_HANDLING_IGNORE: UserSettings.QueryCacheSystemTableHandling.ValueType # 3
|
|
441
399
|
"""Don't cache the query result and don't throw an exception."""
|
|
442
400
|
|
|
401
|
+
class _CountDistinctImplementation:
|
|
402
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
403
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
404
|
+
|
|
405
|
+
class _CountDistinctImplementationEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._CountDistinctImplementation.ValueType], builtins.type):
|
|
406
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
407
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNSPECIFIED: UserSettings._CountDistinctImplementation.ValueType # 0
|
|
408
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ: UserSettings._CountDistinctImplementation.ValueType # 1
|
|
409
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED: UserSettings._CountDistinctImplementation.ValueType # 2
|
|
410
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED_64: UserSettings._CountDistinctImplementation.ValueType # 3
|
|
411
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_HLL_12: UserSettings._CountDistinctImplementation.ValueType # 4
|
|
412
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_EXACT: UserSettings._CountDistinctImplementation.ValueType # 5
|
|
413
|
+
|
|
414
|
+
class CountDistinctImplementation(_CountDistinctImplementation, metaclass=_CountDistinctImplementationEnumTypeWrapper): ...
|
|
415
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNSPECIFIED: UserSettings.CountDistinctImplementation.ValueType # 0
|
|
416
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ: UserSettings.CountDistinctImplementation.ValueType # 1
|
|
417
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED: UserSettings.CountDistinctImplementation.ValueType # 2
|
|
418
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED_64: UserSettings.CountDistinctImplementation.ValueType # 3
|
|
419
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_HLL_12: UserSettings.CountDistinctImplementation.ValueType # 4
|
|
420
|
+
COUNT_DISTINCT_IMPLEMENTATION_UNIQ_EXACT: UserSettings.CountDistinctImplementation.ValueType # 5
|
|
421
|
+
|
|
422
|
+
class _JoinAlgorithm:
|
|
423
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
424
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
425
|
+
|
|
426
|
+
class _JoinAlgorithmEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[UserSettings._JoinAlgorithm.ValueType], builtins.type):
|
|
427
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
428
|
+
JOIN_ALGORITHM_UNSPECIFIED: UserSettings._JoinAlgorithm.ValueType # 0
|
|
429
|
+
JOIN_ALGORITHM_HASH: UserSettings._JoinAlgorithm.ValueType # 1
|
|
430
|
+
JOIN_ALGORITHM_PARALLEL_HASH: UserSettings._JoinAlgorithm.ValueType # 2
|
|
431
|
+
JOIN_ALGORITHM_PARTIAL_MERGE: UserSettings._JoinAlgorithm.ValueType # 3
|
|
432
|
+
JOIN_ALGORITHM_DIRECT: UserSettings._JoinAlgorithm.ValueType # 4
|
|
433
|
+
JOIN_ALGORITHM_AUTO: UserSettings._JoinAlgorithm.ValueType # 5
|
|
434
|
+
JOIN_ALGORITHM_FULL_SORTING_MERGE: UserSettings._JoinAlgorithm.ValueType # 6
|
|
435
|
+
JOIN_ALGORITHM_PREFER_PARTIAL_MERGE: UserSettings._JoinAlgorithm.ValueType # 7
|
|
436
|
+
|
|
437
|
+
class JoinAlgorithm(_JoinAlgorithm, metaclass=_JoinAlgorithmEnumTypeWrapper): ...
|
|
438
|
+
JOIN_ALGORITHM_UNSPECIFIED: UserSettings.JoinAlgorithm.ValueType # 0
|
|
439
|
+
JOIN_ALGORITHM_HASH: UserSettings.JoinAlgorithm.ValueType # 1
|
|
440
|
+
JOIN_ALGORITHM_PARALLEL_HASH: UserSettings.JoinAlgorithm.ValueType # 2
|
|
441
|
+
JOIN_ALGORITHM_PARTIAL_MERGE: UserSettings.JoinAlgorithm.ValueType # 3
|
|
442
|
+
JOIN_ALGORITHM_DIRECT: UserSettings.JoinAlgorithm.ValueType # 4
|
|
443
|
+
JOIN_ALGORITHM_AUTO: UserSettings.JoinAlgorithm.ValueType # 5
|
|
444
|
+
JOIN_ALGORITHM_FULL_SORTING_MERGE: UserSettings.JoinAlgorithm.ValueType # 6
|
|
445
|
+
JOIN_ALGORITHM_PREFER_PARTIAL_MERGE: UserSettings.JoinAlgorithm.ValueType # 7
|
|
446
|
+
|
|
443
447
|
READONLY_FIELD_NUMBER: builtins.int
|
|
444
448
|
ALLOW_DDL_FIELD_NUMBER: builtins.int
|
|
445
449
|
ALLOW_INTROSPECTION_FUNCTIONS_FIELD_NUMBER: builtins.int
|
|
@@ -447,26 +451,31 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
447
451
|
CONNECT_TIMEOUT_WITH_FAILOVER_FIELD_NUMBER: builtins.int
|
|
448
452
|
RECEIVE_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
449
453
|
SEND_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
454
|
+
IDLE_CONNECTION_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
450
455
|
TIMEOUT_BEFORE_CHECKING_EXECUTION_SPEED_FIELD_NUMBER: builtins.int
|
|
451
456
|
INSERT_QUORUM_FIELD_NUMBER: builtins.int
|
|
452
457
|
INSERT_QUORUM_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
453
458
|
INSERT_QUORUM_PARALLEL_FIELD_NUMBER: builtins.int
|
|
454
|
-
INSERT_NULL_AS_DEFAULT_FIELD_NUMBER: builtins.int
|
|
455
459
|
SELECT_SEQUENTIAL_CONSISTENCY_FIELD_NUMBER: builtins.int
|
|
456
|
-
DEDUPLICATE_BLOCKS_IN_DEPENDENT_MATERIALIZED_VIEWS_FIELD_NUMBER: builtins.int
|
|
457
460
|
REPLICATION_ALTER_PARTITIONS_SYNC_FIELD_NUMBER: builtins.int
|
|
458
461
|
MAX_REPLICA_DELAY_FOR_DISTRIBUTED_QUERIES_FIELD_NUMBER: builtins.int
|
|
459
462
|
FALLBACK_TO_STALE_REPLICAS_FOR_DISTRIBUTED_QUERIES_FIELD_NUMBER: builtins.int
|
|
460
463
|
DISTRIBUTED_PRODUCT_MODE_FIELD_NUMBER: builtins.int
|
|
461
464
|
DISTRIBUTED_AGGREGATION_MEMORY_EFFICIENT_FIELD_NUMBER: builtins.int
|
|
462
465
|
DISTRIBUTED_DDL_TASK_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
466
|
+
DISTRIBUTED_DDL_OUTPUT_MODE_FIELD_NUMBER: builtins.int
|
|
463
467
|
SKIP_UNAVAILABLE_SHARDS_FIELD_NUMBER: builtins.int
|
|
468
|
+
USE_HEDGED_REQUESTS_FIELD_NUMBER: builtins.int
|
|
469
|
+
HEDGED_CONNECTION_TIMEOUT_MS_FIELD_NUMBER: builtins.int
|
|
470
|
+
LOAD_BALANCING_FIELD_NUMBER: builtins.int
|
|
471
|
+
PREFER_LOCALHOST_REPLICA_FIELD_NUMBER: builtins.int
|
|
464
472
|
COMPILE_EXPRESSIONS_FIELD_NUMBER: builtins.int
|
|
465
473
|
MIN_COUNT_TO_COMPILE_EXPRESSION_FIELD_NUMBER: builtins.int
|
|
466
474
|
MAX_BLOCK_SIZE_FIELD_NUMBER: builtins.int
|
|
467
475
|
MIN_INSERT_BLOCK_SIZE_ROWS_FIELD_NUMBER: builtins.int
|
|
468
476
|
MIN_INSERT_BLOCK_SIZE_BYTES_FIELD_NUMBER: builtins.int
|
|
469
477
|
MAX_INSERT_BLOCK_SIZE_FIELD_NUMBER: builtins.int
|
|
478
|
+
MAX_PARTITIONS_PER_INSERT_BLOCK_FIELD_NUMBER: builtins.int
|
|
470
479
|
MIN_BYTES_TO_USE_DIRECT_IO_FIELD_NUMBER: builtins.int
|
|
471
480
|
USE_UNCOMPRESSED_CACHE_FIELD_NUMBER: builtins.int
|
|
472
481
|
MERGE_TREE_MAX_ROWS_TO_USE_CACHE_FIELD_NUMBER: builtins.int
|
|
@@ -477,13 +486,21 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
477
486
|
MAX_BYTES_BEFORE_EXTERNAL_SORT_FIELD_NUMBER: builtins.int
|
|
478
487
|
GROUP_BY_TWO_LEVEL_THRESHOLD_FIELD_NUMBER: builtins.int
|
|
479
488
|
GROUP_BY_TWO_LEVEL_THRESHOLD_BYTES_FIELD_NUMBER: builtins.int
|
|
489
|
+
DEDUPLICATE_BLOCKS_IN_DEPENDENT_MATERIALIZED_VIEWS_FIELD_NUMBER: builtins.int
|
|
490
|
+
LOCAL_FILESYSTEM_READ_METHOD_FIELD_NUMBER: builtins.int
|
|
491
|
+
REMOTE_FILESYSTEM_READ_METHOD_FIELD_NUMBER: builtins.int
|
|
480
492
|
PRIORITY_FIELD_NUMBER: builtins.int
|
|
481
493
|
MAX_THREADS_FIELD_NUMBER: builtins.int
|
|
494
|
+
MAX_INSERT_THREADS_FIELD_NUMBER: builtins.int
|
|
482
495
|
MAX_MEMORY_USAGE_FIELD_NUMBER: builtins.int
|
|
483
496
|
MAX_MEMORY_USAGE_FOR_USER_FIELD_NUMBER: builtins.int
|
|
497
|
+
MEMORY_OVERCOMMIT_RATIO_DENOMINATOR_FIELD_NUMBER: builtins.int
|
|
498
|
+
MEMORY_OVERCOMMIT_RATIO_DENOMINATOR_FOR_USER_FIELD_NUMBER: builtins.int
|
|
499
|
+
MEMORY_USAGE_OVERCOMMIT_MAX_WAIT_MICROSECONDS_FIELD_NUMBER: builtins.int
|
|
484
500
|
MAX_NETWORK_BANDWIDTH_FIELD_NUMBER: builtins.int
|
|
485
501
|
MAX_NETWORK_BANDWIDTH_FOR_USER_FIELD_NUMBER: builtins.int
|
|
486
|
-
|
|
502
|
+
MAX_TEMPORARY_DATA_ON_DISK_SIZE_FOR_QUERY_FIELD_NUMBER: builtins.int
|
|
503
|
+
MAX_TEMPORARY_DATA_ON_DISK_SIZE_FOR_USER_FIELD_NUMBER: builtins.int
|
|
487
504
|
MAX_CONCURRENT_QUERIES_FOR_USER_FIELD_NUMBER: builtins.int
|
|
488
505
|
FORCE_INDEX_BY_DATE_FIELD_NUMBER: builtins.int
|
|
489
506
|
FORCE_PRIMARY_KEY_FIELD_NUMBER: builtins.int
|
|
@@ -512,8 +529,6 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
512
529
|
MAX_ROWS_IN_JOIN_FIELD_NUMBER: builtins.int
|
|
513
530
|
MAX_BYTES_IN_JOIN_FIELD_NUMBER: builtins.int
|
|
514
531
|
JOIN_OVERFLOW_MODE_FIELD_NUMBER: builtins.int
|
|
515
|
-
JOIN_ALGORITHM_FIELD_NUMBER: builtins.int
|
|
516
|
-
ANY_JOIN_DISTINCT_RIGHT_TABLE_KEYS_FIELD_NUMBER: builtins.int
|
|
517
532
|
MAX_COLUMNS_TO_READ_FIELD_NUMBER: builtins.int
|
|
518
533
|
MAX_TEMPORARY_COLUMNS_FIELD_NUMBER: builtins.int
|
|
519
534
|
MAX_TEMPORARY_NON_CONST_COLUMNS_FIELD_NUMBER: builtins.int
|
|
@@ -521,20 +536,26 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
521
536
|
MAX_AST_DEPTH_FIELD_NUMBER: builtins.int
|
|
522
537
|
MAX_AST_ELEMENTS_FIELD_NUMBER: builtins.int
|
|
523
538
|
MAX_EXPANDED_AST_ELEMENTS_FIELD_NUMBER: builtins.int
|
|
539
|
+
MAX_PARSER_DEPTH_FIELD_NUMBER: builtins.int
|
|
524
540
|
MIN_EXECUTION_SPEED_FIELD_NUMBER: builtins.int
|
|
525
541
|
MIN_EXECUTION_SPEED_BYTES_FIELD_NUMBER: builtins.int
|
|
526
|
-
COUNT_DISTINCT_IMPLEMENTATION_FIELD_NUMBER: builtins.int
|
|
527
542
|
INPUT_FORMAT_VALUES_INTERPRET_EXPRESSIONS_FIELD_NUMBER: builtins.int
|
|
528
543
|
INPUT_FORMAT_DEFAULTS_FOR_OMITTED_FIELDS_FIELD_NUMBER: builtins.int
|
|
529
544
|
INPUT_FORMAT_NULL_AS_DEFAULT_FIELD_NUMBER: builtins.int
|
|
530
|
-
DATE_TIME_INPUT_FORMAT_FIELD_NUMBER: builtins.int
|
|
531
545
|
INPUT_FORMAT_WITH_NAMES_USE_HEADER_FIELD_NUMBER: builtins.int
|
|
532
546
|
OUTPUT_FORMAT_JSON_QUOTE_64BIT_INTEGERS_FIELD_NUMBER: builtins.int
|
|
533
547
|
OUTPUT_FORMAT_JSON_QUOTE_DENORMALS_FIELD_NUMBER: builtins.int
|
|
548
|
+
DATE_TIME_INPUT_FORMAT_FIELD_NUMBER: builtins.int
|
|
534
549
|
DATE_TIME_OUTPUT_FORMAT_FIELD_NUMBER: builtins.int
|
|
535
550
|
LOW_CARDINALITY_ALLOW_IN_NATIVE_FORMAT_FIELD_NUMBER: builtins.int
|
|
536
|
-
ALLOW_SUSPICIOUS_LOW_CARDINALITY_TYPES_FIELD_NUMBER: builtins.int
|
|
537
551
|
EMPTY_RESULT_FOR_AGGREGATION_BY_EMPTY_SET_FIELD_NUMBER: builtins.int
|
|
552
|
+
FORMAT_REGEXP_FIELD_NUMBER: builtins.int
|
|
553
|
+
FORMAT_REGEXP_ESCAPING_RULE_FIELD_NUMBER: builtins.int
|
|
554
|
+
FORMAT_REGEXP_SKIP_UNMATCHED_FIELD_NUMBER: builtins.int
|
|
555
|
+
INPUT_FORMAT_PARALLEL_PARSING_FIELD_NUMBER: builtins.int
|
|
556
|
+
INPUT_FORMAT_IMPORT_NESTED_JSON_FIELD_NUMBER: builtins.int
|
|
557
|
+
FORMAT_AVRO_SCHEMA_REGISTRY_URL_FIELD_NUMBER: builtins.int
|
|
558
|
+
DATA_TYPE_DEFAULT_NULLABLE_FIELD_NUMBER: builtins.int
|
|
538
559
|
HTTP_CONNECTION_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
539
560
|
HTTP_RECEIVE_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
540
561
|
HTTP_SEND_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
@@ -546,38 +567,13 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
546
567
|
MAX_HTTP_GET_REDIRECTS_FIELD_NUMBER: builtins.int
|
|
547
568
|
HTTP_MAX_FIELD_NAME_SIZE_FIELD_NUMBER: builtins.int
|
|
548
569
|
HTTP_MAX_FIELD_VALUE_SIZE_FIELD_NUMBER: builtins.int
|
|
549
|
-
JOINED_SUBQUERY_REQUIRES_ALIAS_FIELD_NUMBER: builtins.int
|
|
550
|
-
JOIN_USE_NULLS_FIELD_NUMBER: builtins.int
|
|
551
|
-
TRANSFORM_NULL_IN_FIELD_NUMBER: builtins.int
|
|
552
570
|
QUOTA_MODE_FIELD_NUMBER: builtins.int
|
|
553
|
-
FLATTEN_NESTED_FIELD_NUMBER: builtins.int
|
|
554
|
-
FORMAT_REGEXP_FIELD_NUMBER: builtins.int
|
|
555
|
-
FORMAT_REGEXP_ESCAPING_RULE_FIELD_NUMBER: builtins.int
|
|
556
|
-
FORMAT_REGEXP_SKIP_UNMATCHED_FIELD_NUMBER: builtins.int
|
|
557
571
|
ASYNC_INSERT_FIELD_NUMBER: builtins.int
|
|
558
|
-
ASYNC_INSERT_THREADS_FIELD_NUMBER: builtins.int
|
|
559
572
|
WAIT_FOR_ASYNC_INSERT_FIELD_NUMBER: builtins.int
|
|
560
573
|
WAIT_FOR_ASYNC_INSERT_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
561
574
|
ASYNC_INSERT_MAX_DATA_SIZE_FIELD_NUMBER: builtins.int
|
|
562
575
|
ASYNC_INSERT_BUSY_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
563
576
|
ASYNC_INSERT_USE_ADAPTIVE_BUSY_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
564
|
-
MEMORY_PROFILER_STEP_FIELD_NUMBER: builtins.int
|
|
565
|
-
MEMORY_PROFILER_SAMPLE_PROBABILITY_FIELD_NUMBER: builtins.int
|
|
566
|
-
MAX_FINAL_THREADS_FIELD_NUMBER: builtins.int
|
|
567
|
-
INPUT_FORMAT_PARALLEL_PARSING_FIELD_NUMBER: builtins.int
|
|
568
|
-
INPUT_FORMAT_IMPORT_NESTED_JSON_FIELD_NUMBER: builtins.int
|
|
569
|
-
FORMAT_AVRO_SCHEMA_REGISTRY_URL_FIELD_NUMBER: builtins.int
|
|
570
|
-
DATA_TYPE_DEFAULT_NULLABLE_FIELD_NUMBER: builtins.int
|
|
571
|
-
LOCAL_FILESYSTEM_READ_METHOD_FIELD_NUMBER: builtins.int
|
|
572
|
-
MAX_READ_BUFFER_SIZE_FIELD_NUMBER: builtins.int
|
|
573
|
-
INSERT_KEEPER_MAX_RETRIES_FIELD_NUMBER: builtins.int
|
|
574
|
-
MAX_TEMPORARY_DATA_ON_DISK_SIZE_FOR_USER_FIELD_NUMBER: builtins.int
|
|
575
|
-
MAX_TEMPORARY_DATA_ON_DISK_SIZE_FOR_QUERY_FIELD_NUMBER: builtins.int
|
|
576
|
-
MAX_PARSER_DEPTH_FIELD_NUMBER: builtins.int
|
|
577
|
-
REMOTE_FILESYSTEM_READ_METHOD_FIELD_NUMBER: builtins.int
|
|
578
|
-
MEMORY_OVERCOMMIT_RATIO_DENOMINATOR_FIELD_NUMBER: builtins.int
|
|
579
|
-
MEMORY_OVERCOMMIT_RATIO_DENOMINATOR_FOR_USER_FIELD_NUMBER: builtins.int
|
|
580
|
-
MEMORY_USAGE_OVERCOMMIT_MAX_WAIT_MICROSECONDS_FIELD_NUMBER: builtins.int
|
|
581
577
|
LOG_QUERY_THREADS_FIELD_NUMBER: builtins.int
|
|
582
578
|
LOG_QUERY_VIEWS_FIELD_NUMBER: builtins.int
|
|
583
579
|
LOG_QUERIES_PROBABILITY_FIELD_NUMBER: builtins.int
|
|
@@ -594,244 +590,343 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
594
590
|
QUERY_CACHE_SHARE_BETWEEN_USERS_FIELD_NUMBER: builtins.int
|
|
595
591
|
QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_FIELD_NUMBER: builtins.int
|
|
596
592
|
QUERY_CACHE_SYSTEM_TABLE_HANDLING_FIELD_NUMBER: builtins.int
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
593
|
+
COUNT_DISTINCT_IMPLEMENTATION_FIELD_NUMBER: builtins.int
|
|
594
|
+
JOINED_SUBQUERY_REQUIRES_ALIAS_FIELD_NUMBER: builtins.int
|
|
595
|
+
JOIN_USE_NULLS_FIELD_NUMBER: builtins.int
|
|
596
|
+
TRANSFORM_NULL_IN_FIELD_NUMBER: builtins.int
|
|
597
|
+
INSERT_NULL_AS_DEFAULT_FIELD_NUMBER: builtins.int
|
|
598
|
+
JOIN_ALGORITHM_FIELD_NUMBER: builtins.int
|
|
599
|
+
ANY_JOIN_DISTINCT_RIGHT_TABLE_KEYS_FIELD_NUMBER: builtins.int
|
|
600
|
+
ALLOW_SUSPICIOUS_LOW_CARDINALITY_TYPES_FIELD_NUMBER: builtins.int
|
|
601
|
+
FLATTEN_NESTED_FIELD_NUMBER: builtins.int
|
|
602
|
+
MEMORY_PROFILER_STEP_FIELD_NUMBER: builtins.int
|
|
603
|
+
MEMORY_PROFILER_SAMPLE_PROBABILITY_FIELD_NUMBER: builtins.int
|
|
604
|
+
MAX_FINAL_THREADS_FIELD_NUMBER: builtins.int
|
|
605
|
+
MAX_READ_BUFFER_SIZE_FIELD_NUMBER: builtins.int
|
|
606
|
+
INSERT_KEEPER_MAX_RETRIES_FIELD_NUMBER: builtins.int
|
|
603
607
|
DO_NOT_MERGE_ACROSS_PARTITIONS_SELECT_FINAL_FIELD_NUMBER: builtins.int
|
|
604
608
|
IGNORE_MATERIALIZED_VIEWS_WITH_DROPPED_TARGET_TABLE_FIELD_NUMBER: builtins.int
|
|
605
609
|
ENABLE_ANALYZER_FIELD_NUMBER: builtins.int
|
|
610
|
+
S3_USE_ADAPTIVE_TIMEOUTS_FIELD_NUMBER: builtins.int
|
|
606
611
|
COMPILE_FIELD_NUMBER: builtins.int
|
|
607
612
|
MIN_COUNT_TO_COMPILE_FIELD_NUMBER: builtins.int
|
|
613
|
+
ASYNC_INSERT_THREADS_FIELD_NUMBER: builtins.int
|
|
608
614
|
ASYNC_INSERT_STALE_TIMEOUT_FIELD_NUMBER: builtins.int
|
|
609
615
|
distributed_product_mode: global___UserSettings.DistributedProductMode.ValueType
|
|
610
|
-
"""
|
|
616
|
+
"""Determines the behavior of distributed subqueries.
|
|
617
|
+
|
|
618
|
+
Default value: **DISTRIBUTED_PRODUCT_MODE_DENY**.
|
|
619
|
+
|
|
620
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#distributed_product_mode).
|
|
621
|
+
"""
|
|
622
|
+
distributed_ddl_output_mode: global___UserSettings.DistributedDdlOutputMode.ValueType
|
|
623
|
+
"""Determines the format of distributed DDL query result.
|
|
624
|
+
|
|
625
|
+
Default value: **DISTRIBUTED_DDL_OUTPUT_MODE_THROW**.
|
|
626
|
+
|
|
627
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#distributed_ddl_output_mode).
|
|
628
|
+
"""
|
|
629
|
+
load_balancing: global___UserSettings.LoadBalancing.ValueType
|
|
630
|
+
"""Algorithm of replicas selection that is used for distributed query processing.
|
|
631
|
+
|
|
632
|
+
Default value: **LOAD_BALANCING_RANDOM**.
|
|
633
|
+
|
|
634
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#load_balancing).
|
|
635
|
+
"""
|
|
636
|
+
local_filesystem_read_method: global___UserSettings.LocalFilesystemReadMethod.ValueType
|
|
637
|
+
"""Method of reading data from local filesystem.
|
|
638
|
+
|
|
639
|
+
The LOCAL_FILESYSTEM_READ_METHOD_IO_URING is experimental and does not work for Log, TinyLog, StripeLog, File, Set and Join, and
|
|
640
|
+
other tables with append-able files in presence of concurrent reads and writes.
|
|
611
641
|
|
|
612
|
-
|
|
642
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#local_filesystem_read_method).
|
|
643
|
+
"""
|
|
644
|
+
remote_filesystem_read_method: global___UserSettings.RemoteFilesystemReadMethod.ValueType
|
|
645
|
+
"""Method of reading data from remote filesystem.
|
|
646
|
+
|
|
647
|
+
Default value: **REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL**.
|
|
648
|
+
|
|
649
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#remote_filesystem_read_method).
|
|
613
650
|
"""
|
|
614
651
|
read_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
615
|
-
"""Determines the behavior on exceeding
|
|
652
|
+
"""Determines the behavior on exceeding limits while reading the data.
|
|
616
653
|
|
|
617
|
-
|
|
618
|
-
|
|
654
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
655
|
+
|
|
656
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#read_overflow_mode).
|
|
619
657
|
"""
|
|
620
658
|
group_by_overflow_mode: global___UserSettings.GroupByOverflowMode.ValueType
|
|
621
|
-
"""Determines the behavior on exceeding
|
|
659
|
+
"""Determines the behavior on exceeding limits while doing aggregation.
|
|
660
|
+
|
|
661
|
+
Default value: **GROUP_BY_OVERFLOW_MODE_THROW**.
|
|
622
662
|
|
|
623
|
-
|
|
624
|
-
* **break**-stop query execution, return partial result.
|
|
625
|
-
* **any**-perform approximate **GROUP BY** operation by continuing aggregation for the keys that got into the set, but don't add new keys to the set.
|
|
663
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#group_by_overflow_mode).
|
|
626
664
|
"""
|
|
627
665
|
sort_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
628
|
-
"""Determines the behavior on exceeding
|
|
666
|
+
"""Determines the behavior on exceeding limits while sorting.
|
|
629
667
|
|
|
630
|
-
|
|
631
|
-
|
|
668
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
669
|
+
|
|
670
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#sort_overflow_mode).
|
|
632
671
|
"""
|
|
633
672
|
result_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
634
|
-
"""Determines the behavior on exceeding
|
|
673
|
+
"""Determines the behavior on exceeding limits while forming result.
|
|
674
|
+
|
|
675
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
635
676
|
|
|
636
|
-
|
|
637
|
-
* **break**-stop query execution, return partial result.
|
|
677
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#result_overflow_mode).
|
|
638
678
|
"""
|
|
639
679
|
distinct_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
640
|
-
"""Determines the behavior on exceeding
|
|
680
|
+
"""Determines the behavior on exceeding limits while performing **DISTINCT**.
|
|
641
681
|
|
|
642
|
-
|
|
643
|
-
|
|
682
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
683
|
+
|
|
684
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#distinct_overflow_mode).
|
|
644
685
|
"""
|
|
645
686
|
transfer_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
646
|
-
"""Determines the behavior on exceeding
|
|
687
|
+
"""Determines the behavior on exceeding limits while transfering data.
|
|
688
|
+
|
|
689
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
647
690
|
|
|
648
|
-
|
|
649
|
-
* **break**-stop query execution, return partial result.
|
|
691
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#transfer_overflow_mode).
|
|
650
692
|
"""
|
|
651
693
|
timeout_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
652
|
-
"""Determines the behavior on exceeding
|
|
694
|
+
"""Determines the behavior on exceeding limits of execution time.
|
|
653
695
|
|
|
654
|
-
|
|
655
|
-
|
|
696
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
697
|
+
|
|
698
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#timeout_overflow_mode).
|
|
656
699
|
"""
|
|
657
700
|
set_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
658
|
-
"""
|
|
659
|
-
|
|
701
|
+
"""Determines the behavior on exceeding max_rows_in_set or max_bytes_in_set limit.
|
|
702
|
+
|
|
703
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
704
|
+
|
|
705
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#set_overflow_mode).
|
|
660
706
|
"""
|
|
661
707
|
join_overflow_mode: global___UserSettings.OverflowMode.ValueType
|
|
662
|
-
"""
|
|
663
|
-
|
|
708
|
+
"""Determines the behavior on exceeding max_rows_in_join or max_bytes_in_join limit.
|
|
709
|
+
|
|
710
|
+
Default value: **OVERFLOW_MODE_THROW**.
|
|
711
|
+
|
|
712
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#join_overflow_mode).
|
|
664
713
|
"""
|
|
665
|
-
count_distinct_implementation: global___UserSettings.CountDistinctImplementation.ValueType
|
|
666
|
-
"""Aggregate function to use for implementation of count(DISTINCT ...)."""
|
|
667
714
|
date_time_input_format: global___UserSettings.DateTimeInputFormat.ValueType
|
|
668
|
-
"""
|
|
715
|
+
"""Specifies which of date time parsers to use.
|
|
716
|
+
|
|
717
|
+
Default value: **DATE_TIME_INPUT_FORMAT_BASIC**.
|
|
718
|
+
|
|
719
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#date_time_input_format).
|
|
720
|
+
"""
|
|
669
721
|
date_time_output_format: global___UserSettings.DateTimeOutputFormat.ValueType
|
|
670
|
-
"""
|
|
671
|
-
|
|
672
|
-
|
|
722
|
+
"""Specifies which of date time output formats to use.
|
|
723
|
+
|
|
724
|
+
Default value: **DATE_TIME_OUTPUT_FORMAT_SIMPLE**.
|
|
725
|
+
|
|
726
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#date_time_output_format).
|
|
727
|
+
"""
|
|
673
728
|
format_regexp: builtins.str
|
|
674
|
-
"""Regular expression (for Regexp format)
|
|
729
|
+
"""Regular expression (for Regexp format).
|
|
730
|
+
|
|
731
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#format_regexp).
|
|
732
|
+
"""
|
|
675
733
|
format_regexp_escaping_rule: global___UserSettings.FormatRegexpEscapingRule.ValueType
|
|
676
|
-
"""
|
|
734
|
+
"""Field escaping rule (for Regexp format).
|
|
735
|
+
|
|
736
|
+
Default value: **FORMAT_REGEXP_ESCAPING_RULE_RAW**.
|
|
737
|
+
|
|
738
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#format_regexp_escaping_rule).
|
|
739
|
+
"""
|
|
677
740
|
format_avro_schema_registry_url: builtins.str
|
|
678
741
|
"""Avro schema registry URL.
|
|
679
|
-
|
|
742
|
+
|
|
743
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#format_avro_schema_registry_url).
|
|
680
744
|
"""
|
|
681
|
-
|
|
682
|
-
"""
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
Default: read
|
|
686
|
-
Min_version: 21.11
|
|
687
|
-
See in-depth description in [ClickHouse GitHub](https://github.com/ClickHouse/ClickHouse/blob/f9558345e886876b9132d9c018e357f7fa9b22a3/src/Core/Settings.h#L660)
|
|
745
|
+
quota_mode: global___UserSettings.QuotaMode.ValueType
|
|
746
|
+
"""Quota accounting mode.
|
|
747
|
+
|
|
748
|
+
Default value: **QUOTA_MODE_DEFAULT**.
|
|
688
749
|
"""
|
|
689
750
|
query_cache_tag: builtins.str
|
|
690
751
|
"""A string which acts as a label for query cache entries. The same queries with different tags are considered different by the query cache.
|
|
691
|
-
|
|
752
|
+
|
|
753
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_tag).
|
|
692
754
|
"""
|
|
693
755
|
query_cache_nondeterministic_function_handling: global___UserSettings.QueryCacheNondeterministicFunctionHandling.ValueType
|
|
694
|
-
"""Controls how the query cache handles SELECT queries with non-deterministic functions like rand() or now().
|
|
695
|
-
|
|
756
|
+
"""Controls how the query cache handles **SELECT** queries with non-deterministic functions like rand() or now().
|
|
757
|
+
|
|
758
|
+
Default value: **QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_THROW**.
|
|
759
|
+
|
|
760
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_nondeterministic_function_handling).
|
|
696
761
|
"""
|
|
697
762
|
query_cache_system_table_handling: global___UserSettings.QueryCacheSystemTableHandling.ValueType
|
|
698
|
-
"""Controls how the query cache handles SELECT queries against system tables.
|
|
699
|
-
|
|
763
|
+
"""Controls how the query cache handles **SELECT** queries against system tables.
|
|
764
|
+
|
|
765
|
+
Default value: **QUERY_CACHE_SYSTEM_TABLE_HANDLING_THROW**.
|
|
766
|
+
|
|
767
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_system_table_handling).
|
|
700
768
|
"""
|
|
701
|
-
|
|
702
|
-
"""Specifies
|
|
703
|
-
|
|
704
|
-
|
|
769
|
+
count_distinct_implementation: global___UserSettings.CountDistinctImplementation.ValueType
|
|
770
|
+
"""Specifies which of the uniq* functions should be used to perform the **COUNT(DISTINCT ...)** construction.
|
|
771
|
+
|
|
772
|
+
Default value: **COUNT_DISTINCT_IMPLEMENTATION_UNIQ_EXACT**.
|
|
773
|
+
|
|
774
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#count_distinct_implementation).
|
|
705
775
|
"""
|
|
706
776
|
@property
|
|
707
777
|
def readonly(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
708
|
-
"""Restricts permissions for non-DDL queries. To restrict permissions for DDL queries, use
|
|
709
|
-
* **0**
|
|
710
|
-
* **1
|
|
711
|
-
* **2
|
|
778
|
+
"""Restricts permissions for non-DDL queries. To restrict permissions for DDL queries, use **allow_ddl** instead.
|
|
779
|
+
* **0** - no restrictions.
|
|
780
|
+
* **1** - only read data queries are allowed.
|
|
781
|
+
* **2** - read data and change settings queries are allowed.
|
|
712
782
|
|
|
713
|
-
|
|
783
|
+
Default value: **0**.
|
|
784
|
+
|
|
785
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/permissions-for-queries#readonly).
|
|
714
786
|
"""
|
|
715
787
|
|
|
716
788
|
@property
|
|
717
789
|
def allow_ddl(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
718
|
-
"""
|
|
790
|
+
"""Allows or denies DDL queries (e.g., **CREATE**, **ALTER**, **RENAME**, etc).
|
|
719
791
|
|
|
720
792
|
Default value: **true**.
|
|
721
793
|
|
|
722
|
-
|
|
794
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/permissions-for-queries#allow_ddl).
|
|
723
795
|
"""
|
|
724
796
|
|
|
725
797
|
@property
|
|
726
798
|
def allow_introspection_functions(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
727
|
-
"""Enables
|
|
799
|
+
"""Enables or disables introspection functions for query profiling.
|
|
800
|
+
|
|
801
|
+
Default value: **false**.
|
|
728
802
|
|
|
729
|
-
|
|
803
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#allow_introspection_functions).
|
|
730
804
|
"""
|
|
731
805
|
|
|
732
806
|
@property
|
|
733
807
|
def connect_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
734
808
|
"""Connection timeout in milliseconds.
|
|
735
809
|
|
|
736
|
-
|
|
810
|
+
Default value: **10000** (10 seconds).
|
|
811
|
+
|
|
812
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#connect_timeout).
|
|
737
813
|
"""
|
|
738
814
|
|
|
739
815
|
@property
|
|
740
816
|
def connect_timeout_with_failover(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
741
|
-
"""The timeout in milliseconds for connecting to a remote server for a Distributed table engine.
|
|
817
|
+
"""The timeout in milliseconds for connecting to a remote server for a Distributed table engine.
|
|
742
818
|
|
|
743
|
-
|
|
819
|
+
Applies only if the cluster uses sharding and replication. If unsuccessful, several attempts are made to connect to various replicas.
|
|
820
|
+
|
|
821
|
+
Default value: **1000** (1 second).
|
|
744
822
|
|
|
745
|
-
|
|
823
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#connect_timeout_with_failover_ms).
|
|
746
824
|
"""
|
|
747
825
|
|
|
748
826
|
@property
|
|
749
827
|
def receive_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
750
828
|
"""Receive timeout in milliseconds.
|
|
751
829
|
|
|
752
|
-
|
|
830
|
+
Default value: **300000** (5 minutes).
|
|
831
|
+
|
|
832
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#receive_timeout).
|
|
753
833
|
"""
|
|
754
834
|
|
|
755
835
|
@property
|
|
756
836
|
def send_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
757
837
|
"""Send timeout in milliseconds.
|
|
758
838
|
|
|
759
|
-
|
|
839
|
+
Default value: **300000** (5 minutes).
|
|
840
|
+
|
|
841
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#send_timeout).
|
|
842
|
+
"""
|
|
843
|
+
|
|
844
|
+
@property
|
|
845
|
+
def idle_connection_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
846
|
+
"""Timeout to close idle TCP connections after specified time has elapsed, in milliseconds.
|
|
847
|
+
|
|
848
|
+
Default value: **3600000** (1 hour).
|
|
849
|
+
|
|
850
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#idle_connection_timeout).
|
|
760
851
|
"""
|
|
761
852
|
|
|
762
853
|
@property
|
|
763
854
|
def timeout_before_checking_execution_speed(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
764
|
-
"""
|
|
855
|
+
"""Checks that the speed is not too low after the specified time has elapsed, in milliseconds. It is checked that execution speed
|
|
856
|
+
is not less that specified in **min_execution_speed** parameter.
|
|
765
857
|
|
|
766
|
-
Default value: **
|
|
858
|
+
Default value: **60000** (1 minute).
|
|
859
|
+
|
|
860
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#timeout_before_checking_execution_speed).
|
|
767
861
|
"""
|
|
768
862
|
|
|
769
863
|
@property
|
|
770
864
|
def insert_quorum(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
771
|
-
"""Enables or disables
|
|
772
|
-
|
|
865
|
+
"""Enables or disables the quorum writes. If the value is less than **2**, then the quorum writes is disabled, otherwise it is enabled.
|
|
866
|
+
|
|
867
|
+
When used, write quorum guarantees that ClickHouse has written data to the quorum of **insert_quorum** replicas with no errors
|
|
868
|
+
until the **insert_quorum_timeout** expires. All replicas in the quorum are in the consistent state, meaning that they contain
|
|
869
|
+
linearized data from the previous **INSERT** queries. Employ write quorum, if you need the guarantees that the written data
|
|
870
|
+
would not be lost in case of one or more replicas failure.
|
|
773
871
|
|
|
774
|
-
|
|
775
|
-
All replicas in the quorum are in the consistent state, meaning that they contain linearized data from the previous **INSERT** queries.
|
|
776
|
-
Employ write quorum, if you need the guarantees that the written data would not be lost in case of one or more replicas failure.
|
|
872
|
+
You can use **select_sequential_consistency** setting to read the data written with write quorum.
|
|
777
873
|
|
|
778
|
-
|
|
874
|
+
Default value: **0**.
|
|
779
875
|
|
|
780
|
-
|
|
876
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#insert_quorum).
|
|
781
877
|
"""
|
|
782
878
|
|
|
783
879
|
@property
|
|
784
880
|
def insert_quorum_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
785
881
|
"""Quorum write timeout in milliseconds.
|
|
786
882
|
|
|
787
|
-
If the write quorum is enabled in the cluster, this timeout expires and some data is not written to the
|
|
788
|
-
|
|
883
|
+
If the write quorum is enabled in the cluster, this timeout expires and some data is not written to the **insert_quorum** replicas,
|
|
884
|
+
then ClickHouse will abort the execution of **INSERT** query and return an error. In this case, the client must send the query again
|
|
885
|
+
to write the data block into the same or another replica.
|
|
789
886
|
|
|
790
|
-
|
|
887
|
+
Default value: **600000** (10 minutes).
|
|
888
|
+
|
|
889
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#insert_quorum_timeout).
|
|
791
890
|
"""
|
|
792
891
|
|
|
793
892
|
@property
|
|
794
893
|
def insert_quorum_parallel(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
795
|
-
"""
|
|
796
|
-
|
|
797
|
-
@property
|
|
798
|
-
def insert_null_as_default(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
799
|
-
"""Enables the insertion of default values instead of NULL into columns with not nullable data type.
|
|
894
|
+
"""Enables or disables parallelism for quorum **INSERT** queries.
|
|
800
895
|
|
|
801
896
|
Default value: **true**.
|
|
802
897
|
|
|
803
|
-
|
|
898
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#insert_quorum_parallel).
|
|
804
899
|
"""
|
|
805
900
|
|
|
806
901
|
@property
|
|
807
902
|
def select_sequential_consistency(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
808
|
-
"""Determines the behavior of **SELECT** queries from
|
|
903
|
+
"""Determines the behavior of **SELECT** queries from replicated tables. If enabled, ClickHouse will terminate a query with error message in case
|
|
904
|
+
the replica does not have a chunk written with the quorum and will not read the parts that have not yet been written with the quorum.
|
|
809
905
|
|
|
810
|
-
Default value: **
|
|
811
|
-
"""
|
|
906
|
+
Default value: **true**.
|
|
812
907
|
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
"""See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings/#settings-deduplicate-blocks-in-dependent-materialized-views)."""
|
|
908
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#select_sequential_consistency).
|
|
909
|
+
"""
|
|
816
910
|
|
|
817
911
|
@property
|
|
818
912
|
def replication_alter_partitions_sync(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
819
|
-
"""Wait mode for asynchronous actions in **ALTER** queries on replicated tables
|
|
913
|
+
"""Wait mode for asynchronous actions in **ALTER** queries on replicated tables.
|
|
914
|
+
* **0** - do not wait for replicas.
|
|
915
|
+
* **1** - only wait for own execution.
|
|
916
|
+
* **2** - wait for all replicas.
|
|
820
917
|
|
|
821
|
-
|
|
822
|
-
* **1**-only wait for own execution (default).
|
|
823
|
-
* **2**-wait for all replicas.
|
|
918
|
+
Default value: **1**.
|
|
824
919
|
|
|
825
|
-
|
|
920
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#alter_sync).
|
|
826
921
|
"""
|
|
827
922
|
|
|
828
923
|
@property
|
|
829
924
|
def max_replica_delay_for_distributed_queries(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
830
925
|
"""Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one.
|
|
831
926
|
|
|
832
|
-
|
|
927
|
+
Default value: **300000** (5 minutes).
|
|
833
928
|
|
|
834
|
-
|
|
929
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_replica_delay_for_distributed_queries).
|
|
835
930
|
"""
|
|
836
931
|
|
|
837
932
|
@property
|
|
@@ -840,9 +935,9 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
840
935
|
If enabled, ClickHouse will choose the most up-to-date replica and force the query to use the data in this replica.
|
|
841
936
|
This setting can be used when doing **SELECT** query from a distributed table that points to replicated tables.
|
|
842
937
|
|
|
843
|
-
Default value: **true
|
|
938
|
+
Default value: **true**.
|
|
844
939
|
|
|
845
|
-
|
|
940
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#fallback_to_stale_replicas_for_distributed_queries).
|
|
846
941
|
"""
|
|
847
942
|
|
|
848
943
|
@property
|
|
@@ -852,134 +947,198 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
852
947
|
When ClickHouse works with a distributed query, external aggregation is done on remote servers.
|
|
853
948
|
Enable this setting to achieve a smaller memory footprint on the server that sourced such a distributed query.
|
|
854
949
|
|
|
855
|
-
Default value: **
|
|
950
|
+
Default value: **true**.
|
|
856
951
|
|
|
857
|
-
|
|
952
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#distributed_aggregation_memory_efficient).
|
|
858
953
|
"""
|
|
859
954
|
|
|
860
955
|
@property
|
|
861
956
|
def distributed_ddl_task_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
862
|
-
"""Timeout for DDL queries, in milliseconds.
|
|
957
|
+
"""Timeout for DDL queries, in milliseconds.
|
|
958
|
+
|
|
959
|
+
Default value: **180000** (3 minutes).
|
|
960
|
+
|
|
961
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#distributed_ddl_task_timeout).
|
|
962
|
+
"""
|
|
963
|
+
|
|
964
|
+
@property
|
|
965
|
+
def skip_unavailable_shards(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
966
|
+
"""Enables or disables silent skipping of unavailable shards.
|
|
967
|
+
|
|
968
|
+
A shard is considered unavailable if all its replicas are also unavailable.
|
|
969
|
+
|
|
970
|
+
Default value: **false**.
|
|
971
|
+
|
|
972
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#skip_unavailable_shards).
|
|
973
|
+
"""
|
|
974
|
+
|
|
975
|
+
@property
|
|
976
|
+
def use_hedged_requests(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
977
|
+
"""Enables or disables hedged requests logic for remote queries.
|
|
978
|
+
|
|
979
|
+
It allows to establish many connections with different replicas for query. New connection is enabled in case existent connection(s) with replica(s)
|
|
980
|
+
were not established within **hedged_connection_timeout** or no data was received within **receive_data_timeout**. Query uses the first connection
|
|
981
|
+
which send non empty progress packet, other connections are cancelled.
|
|
982
|
+
|
|
983
|
+
Default value: **true**.
|
|
984
|
+
|
|
985
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#use_hedged_requests).
|
|
986
|
+
"""
|
|
987
|
+
|
|
988
|
+
@property
|
|
989
|
+
def hedged_connection_timeout_ms(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
990
|
+
"""Connection timeout for establishing connection with replica for Hedged requests.
|
|
991
|
+
|
|
992
|
+
Default value: **50**.
|
|
863
993
|
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
"""Enables or disables silent skipping of unavailable shards.
|
|
994
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#hedged_connection_timeout_ms).
|
|
995
|
+
"""
|
|
867
996
|
|
|
868
|
-
|
|
997
|
+
@property
|
|
998
|
+
def prefer_localhost_replica(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
999
|
+
"""Enable or disable preferable using the localhost replica when processing distributed queries.
|
|
869
1000
|
|
|
870
|
-
Default value: **
|
|
1001
|
+
Default value: **true**.
|
|
871
1002
|
|
|
872
|
-
|
|
1003
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#prefer_localhost_replica).
|
|
873
1004
|
"""
|
|
874
1005
|
|
|
875
1006
|
@property
|
|
876
1007
|
def compile_expressions(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
877
|
-
"""
|
|
1008
|
+
"""Enable or disable expression compilation to native code.
|
|
1009
|
+
|
|
878
1010
|
If you execute a lot of queries that contain identical expressions, then enable this setting.
|
|
879
1011
|
As a result, such queries may be executed faster due to use of compiled expressions.
|
|
880
1012
|
|
|
881
|
-
Use this setting in combination with
|
|
1013
|
+
Use this setting in combination with **min_count_to_compile_expression** setting.
|
|
1014
|
+
|
|
1015
|
+
Default value: **true** for versions 25.5 and higher, **false** for versions 25.4 and lower.
|
|
882
1016
|
|
|
883
|
-
|
|
1017
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#compile_expressions).
|
|
884
1018
|
"""
|
|
885
1019
|
|
|
886
1020
|
@property
|
|
887
1021
|
def min_count_to_compile_expression(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
888
1022
|
"""How many identical expressions ClickHouse has to encounter before they are compiled.
|
|
889
1023
|
|
|
890
|
-
Minimum value: **0** (default: **3**).
|
|
891
|
-
|
|
892
1024
|
For the **0** value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution.
|
|
893
1025
|
It is recommended to set this value only for testing purposes.
|
|
894
1026
|
|
|
895
1027
|
For all other values, compilation is asynchronous: the compilation process executes in a separate thread.
|
|
896
1028
|
When a compiled expression is ready, it will be used by ClickHouse for eligible queries, including the ones that are currently running.
|
|
1029
|
+
|
|
1030
|
+
Default value: **3**.
|
|
1031
|
+
|
|
1032
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#min_count_to_compile_expression).
|
|
897
1033
|
"""
|
|
898
1034
|
|
|
899
1035
|
@property
|
|
900
1036
|
def max_block_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
901
|
-
"""
|
|
1037
|
+
"""Sets the recommended maximum number of rows to include in a single block when loading data from tables.
|
|
902
1038
|
|
|
903
|
-
|
|
904
|
-
|
|
1039
|
+
Blocks the size of **max_block_size** are not always loaded from the table: if ClickHouse determines that less data needs to be retrieved,
|
|
1040
|
+
a smaller block is processed.
|
|
905
1041
|
|
|
906
|
-
|
|
1042
|
+
The block size should not be too small to avoid noticeable costs when processing each block. It should also not be too large to ensure that
|
|
1043
|
+
queries with a **LIMIT** clause execute quickly after processing the first block. When setting **max_block_size**, the goal should be to avoid
|
|
1044
|
+
consuming too much memory when extracting a large number of columns in multiple threads and to preserve at least some cache locality.
|
|
907
1045
|
|
|
908
|
-
|
|
1046
|
+
Default value: **65409**.
|
|
909
1047
|
|
|
910
|
-
|
|
1048
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_block_size).
|
|
911
1049
|
"""
|
|
912
1050
|
|
|
913
1051
|
@property
|
|
914
1052
|
def min_insert_block_size_rows(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
915
|
-
"""Limits the minimum number of rows in a block to be inserted in a table by **INSERT** query.
|
|
916
|
-
|
|
1053
|
+
"""Limits the minimum number of rows in a block to be inserted in a table by **INSERT** query. Blocks that are smaller than the specified value,
|
|
1054
|
+
will be squashed together into the bigger blocks. If set to **0**, block squashing is disabled.
|
|
1055
|
+
|
|
1056
|
+
Default value: **1048449**.
|
|
917
1057
|
|
|
918
|
-
|
|
1058
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#min_insert_block_size_rows).
|
|
919
1059
|
"""
|
|
920
1060
|
|
|
921
1061
|
@property
|
|
922
1062
|
def min_insert_block_size_bytes(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
923
|
-
"""Limits the minimum number of bytes in a block to be inserted in a table by **INSERT** query.
|
|
924
|
-
|
|
1063
|
+
"""Limits the minimum number of bytes in a block to be inserted in a table by **INSERT** query. Blocks that are smaller than the specified value,
|
|
1064
|
+
will be squashed together into the bigger blocks. If set to **0**, block squashing is disabled.
|
|
925
1065
|
|
|
926
|
-
|
|
1066
|
+
Default value: **268402944**.
|
|
1067
|
+
|
|
1068
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#min_insert_block_size_bytes).
|
|
927
1069
|
"""
|
|
928
1070
|
|
|
929
1071
|
@property
|
|
930
1072
|
def max_insert_block_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
931
|
-
"""
|
|
932
|
-
|
|
1073
|
+
"""The size of blocks (in a count of rows) to form for insertion into a table.
|
|
1074
|
+
|
|
1075
|
+
This setting only applies in cases when the server forms the blocks. For example, for an **INSERT** via the HTTP interface, the server parses
|
|
1076
|
+
the data format and forms blocks of the specified size. But when using clickhouse-client, the client parses the data itself, and
|
|
1077
|
+
the **max_insert_block_size** setting on the server does not affect the size of the inserted blocks. The setting also does not have a purpose
|
|
1078
|
+
when using **INSERT SELECT**, since data is inserted using the same blocks that are formed after **SELECT**.
|
|
933
1079
|
|
|
934
|
-
|
|
1080
|
+
Default value: **1048449**.
|
|
935
1081
|
|
|
936
|
-
|
|
1082
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_insert_block_size).
|
|
1083
|
+
"""
|
|
1084
|
+
|
|
1085
|
+
@property
|
|
1086
|
+
def max_partitions_per_insert_block(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1087
|
+
"""When inserting data, ClickHouse calculates the number of partitions in the inserted block.
|
|
1088
|
+
If the number of partitions is more than **max_partitions_per_insert_block**, ClickHouse throws an exception.
|
|
1089
|
+
|
|
1090
|
+
Default value: **100**.
|
|
1091
|
+
|
|
1092
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/query-complexity#settings-max_partitions_per_insert_block).
|
|
937
1093
|
"""
|
|
938
1094
|
|
|
939
1095
|
@property
|
|
940
1096
|
def min_bytes_to_use_direct_io(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
941
|
-
"""Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O).
|
|
1097
|
+
"""Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). If set to **0**, Direct I/O is disabled.
|
|
942
1098
|
|
|
943
|
-
By default, ClickHouse does not read data directly from disk, but relies on the filesystem and its cache instead.
|
|
944
|
-
|
|
945
|
-
|
|
1099
|
+
By default, ClickHouse does not read data directly from disk, but relies on the filesystem and its cache instead. Such reading strategy
|
|
1100
|
+
is effective when the data volume is small. If the amount of the data to read is huge, it is more effective to read directly from the disk,
|
|
1101
|
+
bypassing the filesystem cache.
|
|
946
1102
|
|
|
947
|
-
|
|
1103
|
+
Default value: **0**.
|
|
948
1104
|
|
|
949
|
-
|
|
1105
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#min_bytes_to_use_direct_io).
|
|
950
1106
|
"""
|
|
951
1107
|
|
|
952
1108
|
@property
|
|
953
1109
|
def use_uncompressed_cache(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
954
1110
|
"""Determines whether to use the cache of uncompressed blocks, or not.
|
|
1111
|
+
|
|
955
1112
|
Using this cache can significantly reduce latency and increase the throughput when a huge amount of small queries is to be processed.
|
|
956
1113
|
Enable this setting for the users who instantiates small queries frequently.
|
|
957
1114
|
|
|
958
1115
|
This setting has effect only for tables of the MergeTree family.
|
|
959
1116
|
|
|
960
|
-
Default value: **false
|
|
1117
|
+
Default value: **false**.
|
|
961
1118
|
|
|
962
|
-
|
|
1119
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#use_uncompressed_cache).
|
|
963
1120
|
"""
|
|
964
1121
|
|
|
965
1122
|
@property
|
|
966
1123
|
def merge_tree_max_rows_to_use_cache(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
967
|
-
"""Limits the maximum size in rows of the request that can use the cache of uncompressed data. The cache is not used for requests larger
|
|
968
|
-
than the specified value.
|
|
1124
|
+
"""Limits the maximum size in rows of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value.
|
|
969
1125
|
|
|
970
|
-
Use this setting in combination with
|
|
1126
|
+
Use this setting in combination with **use_uncompressed_cache** setting.
|
|
971
1127
|
|
|
972
|
-
|
|
1128
|
+
Default value: **1048576**.
|
|
1129
|
+
|
|
1130
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#merge_tree_max_rows_to_use_cache).
|
|
973
1131
|
"""
|
|
974
1132
|
|
|
975
1133
|
@property
|
|
976
1134
|
def merge_tree_max_bytes_to_use_cache(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
977
|
-
"""Limits the maximum size in bytes of the request that can use the cache of uncompressed data. The cache is not used for requests larger
|
|
978
|
-
|
|
1135
|
+
"""Limits the maximum size in bytes of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value.
|
|
1136
|
+
|
|
1137
|
+
Use this setting in combination with **use_uncompressed_cache** setting.
|
|
979
1138
|
|
|
980
|
-
|
|
1139
|
+
Default value: **2013265920** (1920 MiB).
|
|
981
1140
|
|
|
982
|
-
|
|
1141
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#merge_tree_max_bytes_to_use_cache).
|
|
983
1142
|
"""
|
|
984
1143
|
|
|
985
1144
|
@property
|
|
@@ -989,7 +1148,9 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
989
1148
|
|
|
990
1149
|
This setting has effect only for tables of the MergeTree family.
|
|
991
1150
|
|
|
992
|
-
|
|
1151
|
+
Default value: **163840**.
|
|
1152
|
+
|
|
1153
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#merge_tree_min_rows_for_concurrent_read).
|
|
993
1154
|
"""
|
|
994
1155
|
|
|
995
1156
|
@property
|
|
@@ -999,282 +1160,407 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
999
1160
|
|
|
1000
1161
|
This setting has effect only for tables of the MergeTree family.
|
|
1001
1162
|
|
|
1002
|
-
|
|
1163
|
+
Default value: **251658240** (240 MiB).
|
|
1164
|
+
|
|
1165
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#merge_tree_min_bytes_for_concurrent_read).
|
|
1003
1166
|
"""
|
|
1004
1167
|
|
|
1005
1168
|
@property
|
|
1006
1169
|
def max_bytes_before_external_group_by(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1007
|
-
"""Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the **GROUP BY** operation,
|
|
1170
|
+
"""Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the **GROUP BY** operation,
|
|
1171
|
+
should be flushed to disk to limit the RAM consumption. If set to **0**, **GROUP BY** in the external memory is disabled.
|
|
1008
1172
|
|
|
1009
|
-
By default, aggregation is done by employing hash table that resides in RAM.
|
|
1010
|
-
|
|
1011
|
-
|
|
1173
|
+
By default, aggregation is done by employing hash table that resides in RAM. A query can result in aggregation of huge data
|
|
1174
|
+
volumes that can lead to memory exhaustion and abortion of the query (see the **max_memory_usage** setting). For such queries,
|
|
1175
|
+
you can use this setting to force ClickHouse to do flushing and complete aggregation successfully.
|
|
1012
1176
|
|
|
1013
|
-
|
|
1177
|
+
Default value: **0**.
|
|
1014
1178
|
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/sql-reference/statements/select/group-by/#select-group-by-in-external-memory).
|
|
1018
|
-
|
|
1019
|
-
See also: the [distributed_aggregation_memory_efficient] setting.
|
|
1179
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_before_external_group_by).
|
|
1020
1180
|
"""
|
|
1021
1181
|
|
|
1022
1182
|
@property
|
|
1023
1183
|
def max_bytes_before_external_sort(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1024
|
-
"""
|
|
1184
|
+
"""Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the **ORDER BY** operation,
|
|
1185
|
+
should be flushed to disk to limit the RAM consumption. If set to **0**, **ORDER BY** in the external memory is disabled.
|
|
1186
|
+
|
|
1187
|
+
Default value: **0**.
|
|
1188
|
+
|
|
1189
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_before_external_sort).
|
|
1190
|
+
"""
|
|
1025
1191
|
|
|
1026
1192
|
@property
|
|
1027
1193
|
def group_by_two_level_threshold(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1028
|
-
"""Sets the threshold of the number of keys, after that the two-level aggregation should be used.
|
|
1194
|
+
"""Sets the threshold of the number of keys, after that the two-level aggregation should be used. **0** means threshold is not set.
|
|
1195
|
+
|
|
1196
|
+
Default value: **100000**.
|
|
1029
1197
|
|
|
1030
|
-
|
|
1198
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#group_by_two_level_threshold).
|
|
1031
1199
|
"""
|
|
1032
1200
|
|
|
1033
1201
|
@property
|
|
1034
1202
|
def group_by_two_level_threshold_bytes(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1035
|
-
"""Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
|
|
1203
|
+
"""Sets the threshold of the number of bytes, after that the two-level aggregation should be used. **0** means threshold is not set.
|
|
1204
|
+
|
|
1205
|
+
Default value: **50000000**.
|
|
1206
|
+
|
|
1207
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#group_by_two_level_threshold_bytes).
|
|
1208
|
+
"""
|
|
1209
|
+
|
|
1210
|
+
@property
|
|
1211
|
+
def deduplicate_blocks_in_dependent_materialized_views(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1212
|
+
"""Enables or disables the deduplication check for materialized views that receive data from replicated tables.
|
|
1036
1213
|
|
|
1037
|
-
|
|
1214
|
+
Default value: **false**.
|
|
1215
|
+
|
|
1216
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#deduplicate_blocks_in_dependent_materialized_views).
|
|
1038
1217
|
"""
|
|
1039
1218
|
|
|
1040
1219
|
@property
|
|
1041
1220
|
def priority(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1042
1221
|
"""Sets the priority of a query.
|
|
1043
|
-
|
|
1044
|
-
* **
|
|
1045
|
-
* **1**-the highest priority.
|
|
1222
|
+
* **0** - priorities are not used.
|
|
1223
|
+
* **1** - the highest priority.
|
|
1046
1224
|
* and so on. The higher the number, the lower a query's priority.
|
|
1047
1225
|
|
|
1048
|
-
|
|
1226
|
+
If ClickHouse is working with the high-priority queries, and a low-priority query enters, then the low-priority query
|
|
1227
|
+
is paused until higher-priority queries are completed.
|
|
1049
1228
|
|
|
1050
|
-
|
|
1229
|
+
Default value: **0**.
|
|
1051
1230
|
|
|
1052
|
-
|
|
1231
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#priority).
|
|
1053
1232
|
"""
|
|
1054
1233
|
|
|
1055
1234
|
@property
|
|
1056
1235
|
def max_threads(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1057
|
-
"""Limits the maximum number of threads to process the request
|
|
1236
|
+
"""Limits the maximum number of threads to process the request. If set to **0**, the number of threads is calculated automatically based on the number of available CPU cores.
|
|
1237
|
+
|
|
1238
|
+
The setting applies to threads that perform the same stages of the query processing pipeline in parallel. It does not take threads that read data from remote servers into account.
|
|
1058
1239
|
|
|
1059
|
-
|
|
1240
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_threads).
|
|
1241
|
+
"""
|
|
1242
|
+
|
|
1243
|
+
@property
|
|
1244
|
+
def max_insert_threads(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1245
|
+
"""The maximum number of threads to execute the **INSERT SELECT** query.
|
|
1060
1246
|
|
|
1061
|
-
|
|
1247
|
+
Default value: **0**.
|
|
1062
1248
|
|
|
1063
|
-
|
|
1249
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_insert_threads).
|
|
1064
1250
|
"""
|
|
1065
1251
|
|
|
1066
1252
|
@property
|
|
1067
1253
|
def max_memory_usage(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1068
|
-
"""Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server.
|
|
1069
|
-
This setting does not take server's free RAM amount or total RAM amount into account.
|
|
1254
|
+
"""Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server. **0** means unlimited.
|
|
1070
1255
|
|
|
1071
1256
|
This limitation is enforced for any user's single query on a single server.
|
|
1072
1257
|
|
|
1073
|
-
|
|
1074
|
-
|
|
1258
|
+
If you use **max_bytes_before_external_group_by** or **max_bytes_before_external_sort** setting, then it is recommended to set
|
|
1259
|
+
their values twice as low as **max_memory_usage** setting value.
|
|
1075
1260
|
|
|
1076
|
-
|
|
1261
|
+
Default value: **0**.
|
|
1077
1262
|
|
|
1078
|
-
|
|
1263
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_memory_usage).
|
|
1079
1264
|
"""
|
|
1080
1265
|
|
|
1081
1266
|
@property
|
|
1082
1267
|
def max_memory_usage_for_user(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1083
|
-
"""Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
|
|
1084
|
-
This setting does not take server's free RAM amount or total RAM amount into account.
|
|
1268
|
+
"""Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. **0** means unlimited.
|
|
1085
1269
|
|
|
1086
1270
|
This limitation is enforced for all queries that belong to one user and run simultaneously on a single server.
|
|
1087
1271
|
|
|
1088
|
-
|
|
1272
|
+
Default value: **0**.
|
|
1273
|
+
|
|
1274
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_memory_usage_for_user).
|
|
1275
|
+
"""
|
|
1276
|
+
|
|
1277
|
+
@property
|
|
1278
|
+
def memory_overcommit_ratio_denominator(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1279
|
+
"""It represents the soft memory limit when the hard limit is reached on the global level.
|
|
1280
|
+
This value is used to compute the overcommit ratio for the query. **0** means skip the query.
|
|
1281
|
+
|
|
1282
|
+
Default value: **1073741824** (1 GiB).
|
|
1283
|
+
|
|
1284
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#memory_overcommit_ratio_denominator).
|
|
1285
|
+
"""
|
|
1286
|
+
|
|
1287
|
+
@property
|
|
1288
|
+
def memory_overcommit_ratio_denominator_for_user(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1289
|
+
"""It represents the soft memory limit when the hard limit is reached on the user level.
|
|
1290
|
+
This value is used to compute the overcommit ratio for the user. **0** means skip the query.
|
|
1291
|
+
|
|
1292
|
+
Default value: **1073741824** (1 GiB).
|
|
1293
|
+
|
|
1294
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#memory_overcommit_ratio_denominator_for_user).
|
|
1295
|
+
"""
|
|
1296
|
+
|
|
1297
|
+
@property
|
|
1298
|
+
def memory_usage_overcommit_max_wait_microseconds(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1299
|
+
"""Maximum time thread will wait for memory to be freed in the case of memory overcommit. If the timeout is reached and memory is not freed, an exception is thrown.
|
|
1300
|
+
|
|
1301
|
+
Default value: **5000000** (5 seconds).
|
|
1302
|
+
|
|
1303
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#memory_usage_overcommit_max_wait_microseconds).
|
|
1089
1304
|
"""
|
|
1090
1305
|
|
|
1091
1306
|
@property
|
|
1092
1307
|
def max_network_bandwidth(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1093
|
-
"""The maximum speed of data exchange over the network in bytes per second for a query.
|
|
1308
|
+
"""The maximum speed of data exchange over the network in bytes per second for a query. **0** means unlimited.
|
|
1309
|
+
|
|
1310
|
+
Default value: **0**.
|
|
1094
1311
|
|
|
1095
|
-
|
|
1312
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max-network-bandwidth).
|
|
1096
1313
|
"""
|
|
1097
1314
|
|
|
1098
1315
|
@property
|
|
1099
1316
|
def max_network_bandwidth_for_user(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1100
|
-
"""The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries.
|
|
1317
|
+
"""The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. **0** means unlimited.
|
|
1101
1318
|
|
|
1102
|
-
|
|
1319
|
+
Default value: **0**.
|
|
1320
|
+
|
|
1321
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max-network-bandwidth-for-user).
|
|
1103
1322
|
"""
|
|
1104
1323
|
|
|
1105
1324
|
@property
|
|
1106
|
-
def
|
|
1107
|
-
"""
|
|
1325
|
+
def max_temporary_data_on_disk_size_for_query(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1326
|
+
"""The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running queries. **0** means unlimited.
|
|
1327
|
+
|
|
1328
|
+
Default value: **0**.
|
|
1329
|
+
|
|
1330
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/query-complexity#settings_max_temporary_data_on_disk_size_for_query).
|
|
1331
|
+
"""
|
|
1332
|
+
|
|
1333
|
+
@property
|
|
1334
|
+
def max_temporary_data_on_disk_size_for_user(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1335
|
+
"""The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running user queries. **0** means unlimited.
|
|
1336
|
+
|
|
1337
|
+
Default value: **0**.
|
|
1338
|
+
|
|
1339
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/query-complexity#settings_max_temporary_data_on_disk_size_for_user).
|
|
1340
|
+
"""
|
|
1108
1341
|
|
|
1109
1342
|
@property
|
|
1110
1343
|
def max_concurrent_queries_for_user(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1111
|
-
"""The maximum number of
|
|
1112
|
-
|
|
1344
|
+
"""The maximum number of simultaneously processed queries per user. **0** means unlimited.
|
|
1345
|
+
|
|
1346
|
+
Default value: **0**.
|
|
1347
|
+
|
|
1348
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_concurrent_queries_for_user).
|
|
1113
1349
|
"""
|
|
1114
1350
|
|
|
1115
1351
|
@property
|
|
1116
1352
|
def force_index_by_date(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1117
|
-
"""
|
|
1353
|
+
"""Disables query execution if the index cannot be used by date.
|
|
1354
|
+
|
|
1118
1355
|
This setting has effect only for tables of the MergeTree family.
|
|
1119
1356
|
|
|
1120
|
-
Default value: **false
|
|
1357
|
+
Default value: **false**.
|
|
1121
1358
|
|
|
1122
|
-
|
|
1359
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#force_index_by_date).
|
|
1123
1360
|
"""
|
|
1124
1361
|
|
|
1125
1362
|
@property
|
|
1126
1363
|
def force_primary_key(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1127
|
-
"""
|
|
1364
|
+
"""Disables query execution if indexing by the primary key cannot be used.
|
|
1365
|
+
|
|
1128
1366
|
This setting has effect only for tables of the MergeTree family.
|
|
1129
1367
|
|
|
1130
|
-
Default value: **false
|
|
1368
|
+
Default value: **false**.
|
|
1131
1369
|
|
|
1132
|
-
|
|
1370
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#force_primary_key).
|
|
1133
1371
|
"""
|
|
1134
1372
|
|
|
1135
1373
|
@property
|
|
1136
1374
|
def max_rows_to_read(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1137
|
-
"""Limits the maximum number of rows that can be read from a table when running a query.
|
|
1375
|
+
"""Limits the maximum number of rows that can be read from a table when running a query. **0** means unlimited.
|
|
1138
1376
|
|
|
1139
|
-
|
|
1377
|
+
Default value: **0**.
|
|
1140
1378
|
|
|
1141
|
-
|
|
1379
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/query-complexity#max-rows-to-read).
|
|
1142
1380
|
"""
|
|
1143
1381
|
|
|
1144
1382
|
@property
|
|
1145
1383
|
def max_bytes_to_read(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1146
|
-
"""Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
|
|
1384
|
+
"""Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. **0** means unlimited.
|
|
1147
1385
|
|
|
1148
|
-
|
|
1386
|
+
Default value: **0**.
|
|
1387
|
+
|
|
1388
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/query-complexity#max-bytes-to-read).
|
|
1149
1389
|
"""
|
|
1150
1390
|
|
|
1151
1391
|
@property
|
|
1152
1392
|
def max_rows_to_group_by(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1153
|
-
"""Limits the maximum number of unique keys received from aggregation
|
|
1154
|
-
This setting
|
|
1393
|
+
"""Limits the maximum number of unique keys received from aggregation. **0** means unlimited.
|
|
1394
|
+
This setting lets you limit RAM consumption when aggregating.
|
|
1395
|
+
|
|
1396
|
+
Default value: **0**.
|
|
1155
1397
|
|
|
1156
|
-
|
|
1398
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_rows_to_group_by).
|
|
1157
1399
|
"""
|
|
1158
1400
|
|
|
1159
1401
|
@property
|
|
1160
1402
|
def max_rows_to_sort(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1161
|
-
"""Limits the maximum number of rows that can be read from a table for sorting.
|
|
1162
|
-
This setting
|
|
1403
|
+
"""Limits the maximum number of rows that can be read from a table for sorting. **0** means unlimited.
|
|
1404
|
+
This setting lets you to limit RAM consumption when sorting
|
|
1163
1405
|
|
|
1164
|
-
|
|
1406
|
+
Default value: **0**.
|
|
1407
|
+
|
|
1408
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_rows_to_sort).
|
|
1165
1409
|
"""
|
|
1166
1410
|
|
|
1167
1411
|
@property
|
|
1168
1412
|
def max_bytes_to_sort(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1169
|
-
"""Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
|
|
1170
|
-
This setting
|
|
1413
|
+
"""Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting. **0** means unlimited.
|
|
1414
|
+
This setting lets you to limit RAM consumption when sorting
|
|
1415
|
+
|
|
1416
|
+
Default value: **0**.
|
|
1171
1417
|
|
|
1172
|
-
|
|
1418
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_to_sort).
|
|
1173
1419
|
"""
|
|
1174
1420
|
|
|
1175
1421
|
@property
|
|
1176
1422
|
def max_result_rows(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1177
|
-
"""Limits the number of rows in the result.
|
|
1423
|
+
"""Limits the number of rows in the result. **0** means unlimited.
|
|
1424
|
+
|
|
1178
1425
|
This limitation is also checked for subqueries and parts of distributed queries that run on remote servers.
|
|
1179
1426
|
|
|
1180
|
-
|
|
1427
|
+
Default value: **0**.
|
|
1428
|
+
|
|
1429
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_result_rows).
|
|
1181
1430
|
"""
|
|
1182
1431
|
|
|
1183
1432
|
@property
|
|
1184
1433
|
def max_result_bytes(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1185
|
-
"""Limits the
|
|
1186
|
-
|
|
1434
|
+
"""Limits the result size in bytes (uncompressed data). **0** means unlimited.
|
|
1435
|
+
|
|
1436
|
+
Default value: **0**.
|
|
1187
1437
|
|
|
1188
|
-
|
|
1438
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_result_bytes).
|
|
1189
1439
|
"""
|
|
1190
1440
|
|
|
1191
1441
|
@property
|
|
1192
1442
|
def max_rows_in_distinct(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1193
|
-
"""Limits the maximum number of different rows
|
|
1443
|
+
"""Limits the maximum number of different rows in the state, which is used for performing **DISTINCT**. **0** means unlimited.
|
|
1194
1444
|
|
|
1195
|
-
|
|
1445
|
+
Default value: **0**.
|
|
1446
|
+
|
|
1447
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_rows_in_distinct).
|
|
1196
1448
|
"""
|
|
1197
1449
|
|
|
1198
1450
|
@property
|
|
1199
1451
|
def max_bytes_in_distinct(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1200
|
-
"""Limits the maximum
|
|
1452
|
+
"""Limits the maximum number of bytes (uncompressed data) in the state, which is used for performing **DISTINCT**. **0** means unlimited.
|
|
1453
|
+
|
|
1454
|
+
Default value: **0**.
|
|
1455
|
+
|
|
1456
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_in_distinct).
|
|
1457
|
+
"""
|
|
1201
1458
|
|
|
1202
1459
|
@property
|
|
1203
1460
|
def max_rows_to_transfer(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1204
|
-
"""Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using **GLOBAL IN**.
|
|
1461
|
+
"""Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using **GLOBAL IN|JOIN**. **0** means unlimited.
|
|
1205
1462
|
|
|
1206
|
-
|
|
1463
|
+
Default value: **0**.
|
|
1464
|
+
|
|
1465
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_rows_to_transfer).
|
|
1207
1466
|
"""
|
|
1208
1467
|
|
|
1209
1468
|
@property
|
|
1210
1469
|
def max_bytes_to_transfer(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1211
|
-
"""Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary
|
|
1212
|
-
|
|
1470
|
+
"""Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using **GLOBAL IN|JOIN**.
|
|
1471
|
+
**0** means unlimited.
|
|
1472
|
+
|
|
1473
|
+
Default value: **0**.
|
|
1213
1474
|
|
|
1214
|
-
|
|
1475
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_to_transfer).
|
|
1215
1476
|
"""
|
|
1216
1477
|
|
|
1217
1478
|
@property
|
|
1218
1479
|
def max_execution_time(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1219
|
-
"""Limits the maximum query execution time in milliseconds.
|
|
1220
|
-
At this moment, this limitation is not checked when passing one of the sorting stages, as well as merging and finalizing aggregation funictions.
|
|
1480
|
+
"""Limits the maximum query execution time in milliseconds. **0** means unlimited.
|
|
1221
1481
|
|
|
1222
|
-
|
|
1482
|
+
The timeout is checked and the query can stop only in designated places during data processing.
|
|
1483
|
+
|
|
1484
|
+
Default value: **0**.
|
|
1485
|
+
|
|
1486
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_execution_time).
|
|
1223
1487
|
"""
|
|
1224
1488
|
|
|
1225
1489
|
@property
|
|
1226
1490
|
def max_rows_in_set(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1227
|
-
"""
|
|
1491
|
+
"""Limits on the maximum number of rows in the set resulting from the execution of the **IN** section. **0** means unlimited.
|
|
1492
|
+
|
|
1493
|
+
Default value: **0**.
|
|
1494
|
+
|
|
1495
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_rows_in_set).
|
|
1496
|
+
"""
|
|
1228
1497
|
|
|
1229
1498
|
@property
|
|
1230
1499
|
def max_bytes_in_set(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1231
|
-
"""
|
|
1500
|
+
"""Limits on the maximum number of bytes (uncompressed data) in the set resulting from the execution of the **IN** section. **0** means unlimited.
|
|
1501
|
+
|
|
1502
|
+
Default value: **0**.
|
|
1503
|
+
|
|
1504
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_in_set).
|
|
1505
|
+
"""
|
|
1232
1506
|
|
|
1233
1507
|
@property
|
|
1234
1508
|
def max_rows_in_join(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1235
|
-
"""
|
|
1509
|
+
"""Limits the maximum number of rows in the hash table that is used when joining tables. **0** means unlimited.
|
|
1510
|
+
|
|
1511
|
+
Default value: **0**.
|
|
1512
|
+
|
|
1513
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_rows_in_join).
|
|
1514
|
+
"""
|
|
1236
1515
|
|
|
1237
1516
|
@property
|
|
1238
1517
|
def max_bytes_in_join(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1239
|
-
"""
|
|
1518
|
+
"""Limits the maximum number of bytes in the hash table that is used when joining tables. **0** means unlimited.
|
|
1240
1519
|
|
|
1241
|
-
|
|
1242
|
-
def join_algorithm(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___UserSettings.JoinAlgorithm.ValueType]:
|
|
1243
|
-
"""See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings/#settings-join_algorithm)."""
|
|
1520
|
+
Default value: **0**.
|
|
1244
1521
|
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
"""See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings/#any_join_distinct_right_table_keys)."""
|
|
1522
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_bytes_in_join).
|
|
1523
|
+
"""
|
|
1248
1524
|
|
|
1249
1525
|
@property
|
|
1250
1526
|
def max_columns_to_read(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1251
|
-
"""Limits the maximum number of columns that can be read from a table in a single query.
|
|
1527
|
+
"""Limits the maximum number of columns that can be read from a table in a single query. **0** means unlimited.
|
|
1252
1528
|
If the query requires to read more columns to complete, then it will be aborted.
|
|
1253
1529
|
|
|
1254
|
-
|
|
1530
|
+
Default value: **0**.
|
|
1531
|
+
|
|
1532
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_columns_to_read).
|
|
1255
1533
|
"""
|
|
1256
1534
|
|
|
1257
1535
|
@property
|
|
1258
1536
|
def max_temporary_columns(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1259
|
-
"""Limits the maximum number of temporary columns that must be kept in RAM
|
|
1537
|
+
"""Limits the maximum number of temporary columns that must be kept in RAM simultaneously when running a query, including constant columns. **0** means unlimited.
|
|
1538
|
+
If the query generates more than the specified number of temporary columns in memory as a result of intermediate calculation, then it will be aborted.
|
|
1539
|
+
|
|
1540
|
+
Default value: **0**.
|
|
1260
1541
|
|
|
1261
|
-
|
|
1542
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_temporary_columns).
|
|
1262
1543
|
"""
|
|
1263
1544
|
|
|
1264
1545
|
@property
|
|
1265
1546
|
def max_temporary_non_const_columns(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1266
|
-
"""Limits the maximum number of temporary columns that must be kept in RAM
|
|
1547
|
+
"""Limits the maximum number of temporary columns that must be kept in RAM simultaneously when running a query, not including constant columns. **0** means unlimited.
|
|
1548
|
+
If the query generates more than the specified number of temporary columns in memory as a result of intermediate calculation, then it will be aborted.
|
|
1267
1549
|
|
|
1268
|
-
|
|
1550
|
+
Default value: **0**.
|
|
1551
|
+
|
|
1552
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_temporary_non_const_columns).
|
|
1269
1553
|
"""
|
|
1270
1554
|
|
|
1271
1555
|
@property
|
|
1272
1556
|
def max_query_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1273
1557
|
"""Limits the size of the part of a query that can be transferred to RAM for parsing with the SQL parser, in bytes.
|
|
1274
1558
|
|
|
1275
|
-
|
|
1559
|
+
Data in the **VALUES** clause of **INSERT** queries is processed by a separate stream parser (that consumes O(1) RAM) and not affected by this restriction.
|
|
1560
|
+
|
|
1561
|
+
Default value: **262144** (256 KiB).
|
|
1276
1562
|
|
|
1277
|
-
|
|
1563
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_query_size).
|
|
1278
1564
|
"""
|
|
1279
1565
|
|
|
1280
1566
|
@property
|
|
@@ -1284,13 +1570,9 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1284
1570
|
Executing a big and complex query may result in building a syntax tree of enormous depth.
|
|
1285
1571
|
By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.
|
|
1286
1572
|
|
|
1287
|
-
|
|
1288
|
-
A user can be forced to construct more optimized queries, if this setting is used.
|
|
1573
|
+
Default value: **1000**.
|
|
1289
1574
|
|
|
1290
|
-
|
|
1291
|
-
If a too small value is set, it may render ClickHouse unable to execute even simple queries.
|
|
1292
|
-
|
|
1293
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/query-complexity/#max-ast-depth).
|
|
1575
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_ast_depth).
|
|
1294
1576
|
"""
|
|
1295
1577
|
|
|
1296
1578
|
@property
|
|
@@ -1300,10 +1582,9 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1300
1582
|
Executing a big and complex query may result in building a syntax tree of enormous size.
|
|
1301
1583
|
By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.
|
|
1302
1584
|
|
|
1303
|
-
|
|
1304
|
-
If a too small value is set, it may render ClickHouse unable to execute even simple queries.
|
|
1585
|
+
Default value: **50000**.
|
|
1305
1586
|
|
|
1306
|
-
|
|
1587
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_ast_elements).
|
|
1307
1588
|
"""
|
|
1308
1589
|
|
|
1309
1590
|
@property
|
|
@@ -1313,17 +1594,39 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1313
1594
|
Executing a big and complex query may result in building a syntax tree of enormous size.
|
|
1314
1595
|
By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.
|
|
1315
1596
|
|
|
1316
|
-
|
|
1317
|
-
|
|
1597
|
+
Default value: **500000**.
|
|
1598
|
+
|
|
1599
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_expanded_ast_elements).
|
|
1600
|
+
"""
|
|
1601
|
+
|
|
1602
|
+
@property
|
|
1603
|
+
def max_parser_depth(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1604
|
+
"""Limits maximum recursion depth in the recursive descent parser. Allows controlling the stack size. If set to **0**, recursion depth is unlimited.
|
|
1605
|
+
|
|
1606
|
+
Default value: **1000**.
|
|
1607
|
+
|
|
1608
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_parser_depth).
|
|
1318
1609
|
"""
|
|
1319
1610
|
|
|
1320
1611
|
@property
|
|
1321
1612
|
def min_execution_speed(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1322
|
-
"""Minimal execution speed in rows per second.
|
|
1613
|
+
"""Minimal execution speed in rows per second. Checked on every data block when timeout_before_checking_execution_speed expires.
|
|
1614
|
+
If the execution speed is lower, an exception is thrown. **0** means unlimited.
|
|
1615
|
+
|
|
1616
|
+
Default value: **0**.
|
|
1617
|
+
|
|
1618
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#min_execution_speed).
|
|
1619
|
+
"""
|
|
1323
1620
|
|
|
1324
1621
|
@property
|
|
1325
1622
|
def min_execution_speed_bytes(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1326
|
-
"""Minimal execution speed in bytes per second.
|
|
1623
|
+
"""Minimal execution speed in bytes per second. Checked on every data block when timeout_before_checking_execution_speed expires.
|
|
1624
|
+
If the execution speed is lower, an exception is thrown. **0** means unlimited.
|
|
1625
|
+
|
|
1626
|
+
Default value: **0**.
|
|
1627
|
+
|
|
1628
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#min_execution_speed_bytes).
|
|
1629
|
+
"""
|
|
1327
1630
|
|
|
1328
1631
|
@property
|
|
1329
1632
|
def input_format_values_interpret_expressions(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
@@ -1331,100 +1634,155 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1331
1634
|
|
|
1332
1635
|
Enable this setting, if the data that you want to insert into a table contains SQL expressions.
|
|
1333
1636
|
|
|
1334
|
-
For example, the stream parser is unable to parse a value that contains **now()** expression; therefore an **INSERT** query for this value
|
|
1335
|
-
With enabled SQL parser, this expression is parsed correctly: the **now()** expression
|
|
1637
|
+
For example, the stream parser is unable to parse a value that contains **now()** expression; therefore an **INSERT** query for this value
|
|
1638
|
+
will fail and no data will be inserted into a table. With enabled SQL parser, this expression is parsed correctly: the **now()** expression
|
|
1639
|
+
will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result.
|
|
1336
1640
|
|
|
1337
1641
|
This setting has effect only if you use [Values](https://clickhouse.com/docs/en/interfaces/formats/#data-format-values) format when inserting data.
|
|
1338
1642
|
|
|
1339
|
-
Default value: **true
|
|
1643
|
+
Default value: **true**.
|
|
1340
1644
|
|
|
1341
|
-
|
|
1645
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#input_format_values_interpret_expressions).
|
|
1342
1646
|
"""
|
|
1343
1647
|
|
|
1344
1648
|
@property
|
|
1345
1649
|
def input_format_defaults_for_omitted_fields(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1346
1650
|
"""Enables or disables replacing omitted input values with default values of the respective columns when performing **INSERT** queries.
|
|
1347
1651
|
|
|
1348
|
-
Default value: **true
|
|
1652
|
+
Default value: **true**.
|
|
1653
|
+
|
|
1654
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#input_format_defaults_for_omitted_fields).
|
|
1349
1655
|
"""
|
|
1350
1656
|
|
|
1351
1657
|
@property
|
|
1352
1658
|
def input_format_null_as_default(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1353
|
-
"""
|
|
1659
|
+
"""Enables or disables the initialization of **NULL** fields with default values, if data type of these fields is not nullable.
|
|
1660
|
+
|
|
1661
|
+
Default value: **true**.
|
|
1662
|
+
|
|
1663
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#input_format_null_as_default).
|
|
1664
|
+
"""
|
|
1354
1665
|
|
|
1355
1666
|
@property
|
|
1356
1667
|
def input_format_with_names_use_header(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1357
|
-
"""
|
|
1668
|
+
"""Enables or disables checking the column order when inserting data.
|
|
1669
|
+
|
|
1670
|
+
Default value: **true**.
|
|
1671
|
+
|
|
1672
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#input_format_with_names_use_header).
|
|
1673
|
+
"""
|
|
1358
1674
|
|
|
1359
1675
|
@property
|
|
1360
1676
|
def output_format_json_quote_64bit_integers(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1361
|
-
"""Enables quoting of 64-bit integers in JSON output format.
|
|
1677
|
+
"""Enables or disables quoting of 64-bit integers in JSON output format.
|
|
1678
|
+
|
|
1679
|
+
If this setting is enabled, then 64-bit integers (**UInt64** and **Int64**) will be quoted when written to JSON output
|
|
1680
|
+
in order to maintain compatibility with the most of the JavaScript engines. Otherwise, such integers will not be quoted.
|
|
1362
1681
|
|
|
1363
|
-
|
|
1364
|
-
Otherwise, such integers will not be quoted.
|
|
1682
|
+
Default value: **true**.
|
|
1365
1683
|
|
|
1366
|
-
|
|
1684
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#output_format_json_quote_64bit_integers).
|
|
1367
1685
|
"""
|
|
1368
1686
|
|
|
1369
1687
|
@property
|
|
1370
1688
|
def output_format_json_quote_denormals(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1371
1689
|
"""Enables special floating-point values (**+nan**, **-nan**, **+inf** and **-inf**) in JSON output format.
|
|
1372
1690
|
|
|
1373
|
-
Default value: **false
|
|
1691
|
+
Default value: **false**.
|
|
1692
|
+
|
|
1693
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#output_format_json_quote_denormals).
|
|
1374
1694
|
"""
|
|
1375
1695
|
|
|
1376
1696
|
@property
|
|
1377
1697
|
def low_cardinality_allow_in_native_format(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1378
|
-
"""
|
|
1379
|
-
|
|
1380
|
-
* **true** (default)-yes, use.
|
|
1381
|
-
* **false**-convert LowCardinality columns to regular columns when doing **SELECT**, and convert regular columns to LowCardinality when doing **INSERT**.
|
|
1698
|
+
"""Allows or restricts using the LowCardinality data type with the Native format.
|
|
1382
1699
|
|
|
1383
1700
|
LowCardinality columns (aka sparse columns) store data in more effective way, compared to regular columns, by using hash tables.
|
|
1384
1701
|
If data to insert suits this storage format, ClickHouse will place them into LowCardinality column.
|
|
1385
1702
|
|
|
1386
|
-
If you use a third-party ClickHouse client that can't work with LowCardinality columns, then this client will not be able to correctly interpret
|
|
1387
|
-
|
|
1703
|
+
If you use a third-party ClickHouse client that can't work with LowCardinality columns, then this client will not be able to correctly interpret
|
|
1704
|
+
the result of the query that asks for data stored in LowCardinality column. Disable this setting to convert LowCardinality column to regular column
|
|
1705
|
+
when creating the result, so such clients will be able to process the result.
|
|
1388
1706
|
|
|
1389
1707
|
Official ClickHouse client works with LowCardinality columns out-of-the-box.
|
|
1390
1708
|
|
|
1391
|
-
Default value: **true
|
|
1709
|
+
Default value: **true**.
|
|
1710
|
+
|
|
1711
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#low_cardinality_allow_in_native_format).
|
|
1392
1712
|
"""
|
|
1393
1713
|
|
|
1394
1714
|
@property
|
|
1395
|
-
def
|
|
1396
|
-
"""
|
|
1715
|
+
def empty_result_for_aggregation_by_empty_set(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1716
|
+
"""Enables or disables returning of empty result when aggregating without keys (with **GROUP BY** operation absent) on empty set (e.g., **SELECT count(*) FROM table WHERE 0**).
|
|
1717
|
+
* **true** - ClickHouse will return an empty result for such queries.
|
|
1718
|
+
* **false** - ClickHouse will return a single-line result consisting of **NULL** values for aggregation functions, in accordance with SQL standard.
|
|
1719
|
+
|
|
1720
|
+
Default value: **false**.
|
|
1397
1721
|
|
|
1398
|
-
|
|
1722
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#empty_result_for_aggregation_by_empty_set).
|
|
1399
1723
|
"""
|
|
1400
1724
|
|
|
1401
1725
|
@property
|
|
1402
|
-
def
|
|
1403
|
-
"""
|
|
1726
|
+
def format_regexp_skip_unmatched(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1727
|
+
"""Skip lines unmatched by regular expression (for Regexp format)
|
|
1728
|
+
|
|
1729
|
+
Default value: **false**.
|
|
1404
1730
|
|
|
1405
|
-
|
|
1406
|
-
|
|
1731
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#format_regexp_skip_unmatched).
|
|
1732
|
+
"""
|
|
1733
|
+
|
|
1734
|
+
@property
|
|
1735
|
+
def input_format_parallel_parsing(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1736
|
+
"""Enables or disables order-preserving parallel parsing of data formats. Supported only for TSV, TSKV, CSV and JSONEachRow formats.
|
|
1737
|
+
|
|
1738
|
+
Default value: **true**.
|
|
1739
|
+
|
|
1740
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#input_format_parallel_parsing).
|
|
1741
|
+
"""
|
|
1742
|
+
|
|
1743
|
+
@property
|
|
1744
|
+
def input_format_import_nested_json(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1745
|
+
"""Enables or disables the insertion of JSON data with nested objects.
|
|
1746
|
+
|
|
1747
|
+
Default value: **false**.
|
|
1748
|
+
|
|
1749
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/formats#input_format_import_nested_json).
|
|
1750
|
+
"""
|
|
1751
|
+
|
|
1752
|
+
@property
|
|
1753
|
+
def data_type_default_nullable(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1754
|
+
"""Allows data types without explicit modifiers **NULL** or **NOT NULL** in column definition will be Nullable.
|
|
1755
|
+
|
|
1756
|
+
Default value: **false**.
|
|
1757
|
+
|
|
1758
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#data_type_default_nullable).
|
|
1407
1759
|
"""
|
|
1408
1760
|
|
|
1409
1761
|
@property
|
|
1410
1762
|
def http_connection_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1411
1763
|
"""HTTP connection timeout, in milliseconds.
|
|
1412
1764
|
|
|
1413
|
-
|
|
1765
|
+
Default value: **1000** (1 second).
|
|
1766
|
+
|
|
1767
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#http_connection_timeout).
|
|
1414
1768
|
"""
|
|
1415
1769
|
|
|
1416
1770
|
@property
|
|
1417
1771
|
def http_receive_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1418
1772
|
"""HTTP receive timeout, in milliseconds.
|
|
1419
1773
|
|
|
1420
|
-
|
|
1774
|
+
Default value: **30000** (30 seconds).
|
|
1775
|
+
|
|
1776
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#http_receive_timeout).
|
|
1421
1777
|
"""
|
|
1422
1778
|
|
|
1423
1779
|
@property
|
|
1424
1780
|
def http_send_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1425
1781
|
"""HTTP send timeout, in milliseconds.
|
|
1426
1782
|
|
|
1427
|
-
|
|
1783
|
+
Default value: **30000** (30 seconds).
|
|
1784
|
+
|
|
1785
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#http_send_timeout).
|
|
1428
1786
|
"""
|
|
1429
1787
|
|
|
1430
1788
|
@property
|
|
@@ -1438,371 +1796,409 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1438
1796
|
|
|
1439
1797
|
ClickHouse support the following compression methods: **gzip**, **br** and **deflate**.
|
|
1440
1798
|
|
|
1441
|
-
Default value: **false
|
|
1799
|
+
Default value: **false**.
|
|
1442
1800
|
|
|
1443
|
-
|
|
1801
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#enable_http_compression).
|
|
1444
1802
|
"""
|
|
1445
1803
|
|
|
1446
1804
|
@property
|
|
1447
1805
|
def send_progress_in_http_headers(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1448
|
-
"""Enables progress notifications using **X-ClickHouse-Progress** HTTP header.
|
|
1806
|
+
"""Enables or disables progress notifications using **X-ClickHouse-Progress** HTTP header.
|
|
1807
|
+
|
|
1808
|
+
Default value: **false**.
|
|
1449
1809
|
|
|
1450
|
-
|
|
1810
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#send_progress_in_http_headers).
|
|
1451
1811
|
"""
|
|
1452
1812
|
|
|
1453
1813
|
@property
|
|
1454
1814
|
def http_headers_progress_interval(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1455
1815
|
"""Minimum interval between progress notifications with **X-ClickHouse-Progress** HTTP header, in milliseconds.
|
|
1456
1816
|
|
|
1457
|
-
|
|
1817
|
+
Default value: **100**.
|
|
1818
|
+
|
|
1819
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#http_headers_progress_interval_ms).
|
|
1458
1820
|
"""
|
|
1459
1821
|
|
|
1460
1822
|
@property
|
|
1461
1823
|
def add_http_cors_header(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1462
1824
|
"""Adds CORS header in HTTP responses.
|
|
1463
1825
|
|
|
1464
|
-
Default value: **false
|
|
1826
|
+
Default value: **false**.
|
|
1827
|
+
|
|
1828
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#add_http_cors_header).
|
|
1465
1829
|
"""
|
|
1466
1830
|
|
|
1467
1831
|
@property
|
|
1468
1832
|
def cancel_http_readonly_queries_on_client_close(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1469
|
-
"""Cancels HTTP read-only queries (e.g. SELECT) when a client closes the connection without waiting for the response.
|
|
1833
|
+
"""Cancels HTTP read-only queries (e.g. **SELECT**) when a client closes the connection without waiting for the response.
|
|
1470
1834
|
|
|
1471
1835
|
Default value: **false**.
|
|
1472
1836
|
|
|
1473
|
-
|
|
1837
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#cancel_http_readonly_queries_on_client_close).
|
|
1474
1838
|
"""
|
|
1475
1839
|
|
|
1476
1840
|
@property
|
|
1477
1841
|
def max_http_get_redirects(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1478
|
-
"""Limits the maximum number of HTTP GET redirect hops
|
|
1842
|
+
"""Limits the maximum number of HTTP GET redirect hops. If set to **0**, no hops is allowed.
|
|
1479
1843
|
|
|
1480
|
-
|
|
1844
|
+
Default value: **0**.
|
|
1481
1845
|
|
|
1482
|
-
|
|
1846
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_http_get_redirects).
|
|
1483
1847
|
"""
|
|
1484
1848
|
|
|
1485
1849
|
@property
|
|
1486
1850
|
def http_max_field_name_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1487
1851
|
"""Maximum length of field name in HTTP header.
|
|
1488
|
-
|
|
1852
|
+
|
|
1853
|
+
Default value: **131072**.
|
|
1854
|
+
|
|
1855
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#http_max_field_name_size).
|
|
1489
1856
|
"""
|
|
1490
1857
|
|
|
1491
1858
|
@property
|
|
1492
1859
|
def http_max_field_value_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1493
1860
|
"""Maximum length of field value in HTTP header.
|
|
1494
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#http_max_field_value_size).
|
|
1495
|
-
"""
|
|
1496
1861
|
|
|
1497
|
-
|
|
1498
|
-
def joined_subquery_requires_alias(self) -> google.protobuf.wrappers_pb2.BoolValue: ...
|
|
1499
|
-
@property
|
|
1500
|
-
def join_use_nulls(self) -> google.protobuf.wrappers_pb2.BoolValue: ...
|
|
1501
|
-
@property
|
|
1502
|
-
def transform_null_in(self) -> google.protobuf.wrappers_pb2.BoolValue: ...
|
|
1503
|
-
@property
|
|
1504
|
-
def flatten_nested(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1505
|
-
"""Sets the data format of a [nested](https://clickhouse.com/docs/en/sql-reference/data-types/nested-data-structures/nested) columns.
|
|
1862
|
+
Default value: **131072**.
|
|
1506
1863
|
|
|
1507
|
-
|
|
1864
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#http_max_field_value_size).
|
|
1508
1865
|
"""
|
|
1509
1866
|
|
|
1510
|
-
@property
|
|
1511
|
-
def format_regexp_skip_unmatched(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1512
|
-
"""See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings/#format_regexp_skip_unmatched)."""
|
|
1513
|
-
|
|
1514
1867
|
@property
|
|
1515
1868
|
def async_insert(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1516
|
-
"""
|
|
1517
|
-
|
|
1518
|
-
Disabled by default.
|
|
1519
|
-
|
|
1520
|
-
More info see in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings/#async-insert).
|
|
1521
|
-
"""
|
|
1522
|
-
|
|
1523
|
-
@property
|
|
1524
|
-
def async_insert_threads(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1525
|
-
"""The maximum number of threads for background data parsing and insertion.
|
|
1869
|
+
"""If enabled, data from **INSERT** query is stored in queue and later flushed to table in background.
|
|
1526
1870
|
|
|
1527
|
-
|
|
1871
|
+
Default value: **false**.
|
|
1528
1872
|
|
|
1529
|
-
|
|
1873
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#async_insert).
|
|
1530
1874
|
"""
|
|
1531
1875
|
|
|
1532
1876
|
@property
|
|
1533
1877
|
def wait_for_async_insert(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1534
|
-
"""Enables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted.
|
|
1878
|
+
"""Enables or disables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted.
|
|
1879
|
+
|
|
1880
|
+
Default value: **true**.
|
|
1535
1881
|
|
|
1536
|
-
|
|
1882
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#wait_for_async_insert).
|
|
1537
1883
|
"""
|
|
1538
1884
|
|
|
1539
1885
|
@property
|
|
1540
1886
|
def wait_for_async_insert_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1541
|
-
"""
|
|
1887
|
+
"""Timeout for waiting for processing asynchronous inserts, in seconds.
|
|
1542
1888
|
|
|
1543
|
-
Default value: **120
|
|
1889
|
+
Default value: **120** (2 minutes).
|
|
1544
1890
|
|
|
1545
|
-
|
|
1891
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#wait_for_async_insert_timeout).
|
|
1546
1892
|
"""
|
|
1547
1893
|
|
|
1548
1894
|
@property
|
|
1549
1895
|
def async_insert_max_data_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1550
1896
|
"""The maximum size of the unparsed data in bytes collected per query before being inserted.
|
|
1551
1897
|
|
|
1552
|
-
|
|
1898
|
+
Default value: **10485760** (10 MiB).
|
|
1553
1899
|
|
|
1554
|
-
|
|
1900
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#async_insert_max_data_size).
|
|
1555
1901
|
"""
|
|
1556
1902
|
|
|
1557
1903
|
@property
|
|
1558
1904
|
def async_insert_busy_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1559
|
-
"""
|
|
1905
|
+
"""Maximum time to wait before dumping collected data per query since the first data appeared.
|
|
1560
1906
|
|
|
1561
|
-
|
|
1907
|
+
Default value: **200**.
|
|
1562
1908
|
|
|
1563
|
-
|
|
1909
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#async_insert_busy_timeout_max_ms).
|
|
1564
1910
|
"""
|
|
1565
1911
|
|
|
1566
1912
|
@property
|
|
1567
1913
|
def async_insert_use_adaptive_busy_timeout(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1568
|
-
"""
|
|
1569
|
-
|
|
1914
|
+
"""Enables of disables adaptive busy timeout for asynchronous inserts.
|
|
1915
|
+
|
|
1916
|
+
Default value: **true**.
|
|
1917
|
+
|
|
1918
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#async_insert_use_adaptive_busy_timeout).
|
|
1570
1919
|
"""
|
|
1571
1920
|
|
|
1572
1921
|
@property
|
|
1573
|
-
def
|
|
1574
|
-
"""
|
|
1922
|
+
def log_query_threads(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1923
|
+
"""Enables or disables query threads logging to the the system.query_thread_log table.
|
|
1924
|
+
This setting has effect only when **log_queries** setting is enabled.
|
|
1575
1925
|
|
|
1576
|
-
|
|
1926
|
+
Default value: **false**.
|
|
1577
1927
|
|
|
1578
|
-
|
|
1928
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#log_query_threads).
|
|
1579
1929
|
"""
|
|
1580
1930
|
|
|
1581
1931
|
@property
|
|
1582
|
-
def
|
|
1583
|
-
"""
|
|
1932
|
+
def log_query_views(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1933
|
+
"""Enables or disables query views logging to the the system.query_views_log table.
|
|
1584
1934
|
|
|
1585
|
-
|
|
1586
|
-
"""
|
|
1935
|
+
Default value: **true**.
|
|
1587
1936
|
|
|
1588
|
-
|
|
1589
|
-
def max_final_threads(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1590
|
-
"""Sets the maximum number of parallel threads for the SELECT query data read phase with the FINAL modifier.
|
|
1591
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#max-final-threads).
|
|
1937
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#log_query_views).
|
|
1592
1938
|
"""
|
|
1593
1939
|
|
|
1594
1940
|
@property
|
|
1595
|
-
def
|
|
1596
|
-
"""
|
|
1597
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#input-format-parallel-parsing)
|
|
1598
|
-
"""
|
|
1941
|
+
def log_queries_probability(self) -> google.protobuf.wrappers_pb2.DoubleValue:
|
|
1942
|
+
"""Log queries with the specified probability.
|
|
1599
1943
|
|
|
1600
|
-
|
|
1601
|
-
def input_format_import_nested_json(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1602
|
-
"""Enables or disables the insertion of JSON data with nested objects.
|
|
1603
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#input-format-parallel-parsing)
|
|
1604
|
-
"""
|
|
1944
|
+
Default value: **1**.
|
|
1605
1945
|
|
|
1606
|
-
|
|
1607
|
-
def data_type_default_nullable(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1608
|
-
"""Allows data types without explicit modifiers NULL or NOT NULL in column definition will be Nullable.
|
|
1609
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#data_type_default_nullable).
|
|
1946
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#log_queries_probability).
|
|
1610
1947
|
"""
|
|
1611
1948
|
|
|
1612
1949
|
@property
|
|
1613
|
-
def
|
|
1614
|
-
"""
|
|
1615
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/codebrowser/ClickHouse/src/Core/Settings.h.html#DB::SettingsTraits::Data::max_read_buffer_size)
|
|
1616
|
-
"""
|
|
1950
|
+
def log_processors_profiles(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1951
|
+
"""Enables or disables logging of processors level profiling data to the the system.processors_profile_log table.
|
|
1617
1952
|
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
Default: 20 from 23.2, 0(disabled) before
|
|
1622
|
-
Min_version: 22.11
|
|
1623
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#insert_keeper_max_retries)
|
|
1953
|
+
Default value: **false**.
|
|
1954
|
+
|
|
1955
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#log_processors_profiles).
|
|
1624
1956
|
"""
|
|
1625
1957
|
|
|
1626
1958
|
@property
|
|
1627
|
-
def
|
|
1628
|
-
"""
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1959
|
+
def use_query_cache(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1960
|
+
"""If turned on, **SELECT** queries may utilize the query cache.
|
|
1961
|
+
|
|
1962
|
+
Default value: **false**.
|
|
1963
|
+
|
|
1964
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#use_query_cache).
|
|
1632
1965
|
"""
|
|
1633
1966
|
|
|
1634
1967
|
@property
|
|
1635
|
-
def
|
|
1636
|
-
"""
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1968
|
+
def enable_reads_from_query_cache(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1969
|
+
"""If turned on, results of **SELECT** queries are retrieved from the query cache.
|
|
1970
|
+
|
|
1971
|
+
Default value: **true**.
|
|
1972
|
+
|
|
1973
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#enable_reads_from_query_cache).
|
|
1640
1974
|
"""
|
|
1641
1975
|
|
|
1642
1976
|
@property
|
|
1643
|
-
def
|
|
1644
|
-
"""
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#max_parser_depth)
|
|
1648
|
-
"""
|
|
1977
|
+
def enable_writes_to_query_cache(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1978
|
+
"""If turned on, results of **SELECT** queries are stored in the query cache.
|
|
1979
|
+
|
|
1980
|
+
Default value: **true**.
|
|
1649
1981
|
|
|
1650
|
-
|
|
1651
|
-
def memory_overcommit_ratio_denominator(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1652
|
-
"""It represents soft memory limit in case when hard limit is reached on user level. This value is used to compute overcommit ratio for the query. Zero means skip the query.
|
|
1653
|
-
Default: 1GiB
|
|
1654
|
-
Min_version: 22.5
|
|
1655
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#memory_overcommit_ratio_denominator)
|
|
1982
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#enable_writes_to_query_cache).
|
|
1656
1983
|
"""
|
|
1657
1984
|
|
|
1658
1985
|
@property
|
|
1659
|
-
def
|
|
1660
|
-
"""
|
|
1661
|
-
Default: 1GiB
|
|
1662
|
-
Min_version: 22.5
|
|
1663
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#memory_overcommit_ratio_denominator_for_user)
|
|
1664
|
-
"""
|
|
1986
|
+
def query_cache_min_query_runs(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1987
|
+
"""Minimum number of times a **SELECT** query must run before its result is stored in the query cache.
|
|
1665
1988
|
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
Default: 5000000
|
|
1670
|
-
Min_version: 22.5
|
|
1671
|
-
See in-depth description in [ClickHouse documentation](https://clickhouse.com/docs/en/operations/settings/settings#memory_usage_overcommit_max_wait_microseconds)
|
|
1989
|
+
Default value: **0**.
|
|
1990
|
+
|
|
1991
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_min_query_runs).
|
|
1672
1992
|
"""
|
|
1673
1993
|
|
|
1674
1994
|
@property
|
|
1675
|
-
def
|
|
1676
|
-
"""
|
|
1677
|
-
|
|
1678
|
-
|
|
1995
|
+
def query_cache_min_query_duration(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1996
|
+
"""Minimum duration in milliseconds a query needs to run for its result to be stored in the query cache.
|
|
1997
|
+
|
|
1998
|
+
Default value: **0**.
|
|
1999
|
+
|
|
2000
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_min_query_duration).
|
|
1679
2001
|
"""
|
|
1680
2002
|
|
|
1681
2003
|
@property
|
|
1682
|
-
def
|
|
1683
|
-
"""
|
|
1684
|
-
|
|
1685
|
-
|
|
2004
|
+
def query_cache_ttl(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2005
|
+
"""After this time in seconds entries in the query cache become stale.
|
|
2006
|
+
|
|
2007
|
+
Default value: **60** (1 minute).
|
|
2008
|
+
|
|
2009
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_ttl).
|
|
1686
2010
|
"""
|
|
1687
2011
|
|
|
1688
2012
|
@property
|
|
1689
|
-
def
|
|
1690
|
-
"""
|
|
1691
|
-
|
|
2013
|
+
def query_cache_max_entries(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2014
|
+
"""The maximum number of query results the current user may store in the query cache. **0** means unlimited.
|
|
2015
|
+
|
|
2016
|
+
Default value: **0**.
|
|
2017
|
+
|
|
2018
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_max_entries).
|
|
1692
2019
|
"""
|
|
1693
2020
|
|
|
1694
2021
|
@property
|
|
1695
|
-
def
|
|
1696
|
-
"""
|
|
1697
|
-
|
|
2022
|
+
def query_cache_max_size_in_bytes(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2023
|
+
"""The maximum amount of memory (in bytes) the current user may allocate in the query cache. **0** means unlimited.
|
|
2024
|
+
|
|
2025
|
+
Default value: **0**.
|
|
2026
|
+
|
|
2027
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_max_size_in_bytes).
|
|
1698
2028
|
"""
|
|
1699
2029
|
|
|
1700
2030
|
@property
|
|
1701
|
-
def
|
|
1702
|
-
"""If turned on, SELECT queries
|
|
1703
|
-
|
|
2031
|
+
def query_cache_share_between_users(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2032
|
+
"""If turned on, the result of **SELECT** queries cached in the query cache can be read by other users.
|
|
2033
|
+
|
|
2034
|
+
It is not recommended to enable this setting due to security reasons.
|
|
2035
|
+
|
|
2036
|
+
Default value: **false**.
|
|
2037
|
+
|
|
2038
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#query_cache_share_between_users).
|
|
1704
2039
|
"""
|
|
1705
2040
|
|
|
1706
2041
|
@property
|
|
1707
|
-
def
|
|
1708
|
-
"""
|
|
1709
|
-
|
|
2042
|
+
def joined_subquery_requires_alias(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2043
|
+
"""Force joined subqueries and table functions to have aliases for correct name qualification.
|
|
2044
|
+
|
|
2045
|
+
Default value: **true**.
|
|
2046
|
+
|
|
2047
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#joined_subquery_requires_alias).
|
|
1710
2048
|
"""
|
|
1711
2049
|
|
|
1712
2050
|
@property
|
|
1713
|
-
def
|
|
1714
|
-
"""
|
|
1715
|
-
|
|
2051
|
+
def join_use_nulls(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2052
|
+
"""Determines **JOIN** behavior on filling empty cells when merging tables. If enabled, the empty cells are filled with **NULL**.
|
|
2053
|
+
Otherwise, the empty cells are filled with the default value of the corresponding field type.
|
|
2054
|
+
|
|
2055
|
+
Default value: **false**.
|
|
2056
|
+
|
|
2057
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#join_use_nulls).
|
|
1716
2058
|
"""
|
|
1717
2059
|
|
|
1718
2060
|
@property
|
|
1719
|
-
def
|
|
1720
|
-
"""
|
|
1721
|
-
|
|
2061
|
+
def transform_null_in(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2062
|
+
"""Enables equality of **NULL** values for **IN** operator.
|
|
2063
|
+
|
|
2064
|
+
By default, **NULL** values can't be compared because **NULL** means undefined value. Thus, comparison **expr = NULL** must always return false.
|
|
2065
|
+
With this setting enabled **NULL = NULL** returns true for **IN** operator.
|
|
2066
|
+
|
|
2067
|
+
Default value: **false**.
|
|
2068
|
+
|
|
2069
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#transform_null_in).
|
|
1722
2070
|
"""
|
|
1723
2071
|
|
|
1724
2072
|
@property
|
|
1725
|
-
def
|
|
1726
|
-
"""
|
|
1727
|
-
|
|
2073
|
+
def insert_null_as_default(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2074
|
+
"""Enables or disables the insertion of default values instead of **NULL** into columns with not nullable data type.
|
|
2075
|
+
|
|
2076
|
+
If column type is not nullable and this setting is disabled, then inserting NULL causes an exception.
|
|
2077
|
+
If column type is nullable, then NULL values are inserted as is, regardless of this setting.
|
|
2078
|
+
|
|
2079
|
+
Default value: **true**.
|
|
2080
|
+
|
|
2081
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#insert_null_as_default).
|
|
1728
2082
|
"""
|
|
1729
2083
|
|
|
1730
2084
|
@property
|
|
1731
|
-
def
|
|
1732
|
-
"""
|
|
1733
|
-
|
|
2085
|
+
def join_algorithm(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___UserSettings.JoinAlgorithm.ValueType]:
|
|
2086
|
+
"""Specifies which JOIN algorithm to use.
|
|
2087
|
+
|
|
2088
|
+
Default value: **JOIN_ALGORITHM_DIRECT,JOIN_ALGORITHM_PARALLEL_HASH,JOIN_ALGORITHM_HASH** for versions 24.12 and higher, **JOIN_ALGORITHM_DIRECT,JOIN_ALGORITHM_AUTO** for versions from 23.8 to 24.11, **JOIN_ALGORITHM_AUTO** for versions 23.7 and lower.
|
|
2089
|
+
|
|
2090
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#join_algorithm).
|
|
1734
2091
|
"""
|
|
1735
2092
|
|
|
1736
2093
|
@property
|
|
1737
|
-
def
|
|
1738
|
-
"""
|
|
1739
|
-
|
|
2094
|
+
def any_join_distinct_right_table_keys(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2095
|
+
"""Enables legacy ClickHouse server behaviour in **ANY INNER|LEFT JOIN** operations.
|
|
2096
|
+
|
|
2097
|
+
Default value: **false**.
|
|
2098
|
+
|
|
2099
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#any_join_distinct_right_table_keys).
|
|
1740
2100
|
"""
|
|
1741
2101
|
|
|
1742
2102
|
@property
|
|
1743
|
-
def
|
|
1744
|
-
"""
|
|
1745
|
-
|
|
2103
|
+
def allow_suspicious_low_cardinality_types(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2104
|
+
"""Allows or restricts using LowCardinality with data types with fixed size of 8 bytes or less.
|
|
2105
|
+
|
|
2106
|
+
Default value: **false**.
|
|
2107
|
+
|
|
2108
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#allow_suspicious_low_cardinality_types).
|
|
1746
2109
|
"""
|
|
1747
2110
|
|
|
1748
2111
|
@property
|
|
1749
|
-
def
|
|
1750
|
-
"""
|
|
1751
|
-
|
|
2112
|
+
def flatten_nested(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2113
|
+
"""Sets the data format of nested columns.
|
|
2114
|
+
|
|
2115
|
+
Default value: **true**.
|
|
2116
|
+
|
|
2117
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#flatten_nested).
|
|
1752
2118
|
"""
|
|
1753
2119
|
|
|
1754
2120
|
@property
|
|
1755
|
-
def
|
|
1756
|
-
"""
|
|
1757
|
-
|
|
1758
|
-
|
|
2121
|
+
def memory_profiler_step(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2122
|
+
"""Sets the step of memory profiler. Whenever query memory usage becomes larger than every next step in number of bytes the memory profiler
|
|
2123
|
+
will collect the allocating stacktrace and will write it into trace_log. If set to **0**, memory profiler is disabled.
|
|
2124
|
+
|
|
2125
|
+
Default value: **4194304**.
|
|
2126
|
+
|
|
2127
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#memory_profiler_step).
|
|
1759
2128
|
"""
|
|
1760
2129
|
|
|
1761
2130
|
@property
|
|
1762
|
-
def
|
|
1763
|
-
"""
|
|
1764
|
-
|
|
1765
|
-
|
|
2131
|
+
def memory_profiler_sample_probability(self) -> google.protobuf.wrappers_pb2.DoubleValue:
|
|
2132
|
+
"""Collect random allocations and deallocations and write them into system.trace_log with MemorySample trace_type.
|
|
2133
|
+
The probability is for every alloc/free regardless to the size of the allocation.
|
|
2134
|
+
|
|
2135
|
+
Default value: **0**.
|
|
2136
|
+
|
|
2137
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#memory_profiler_sample_probability).
|
|
1766
2138
|
"""
|
|
1767
2139
|
|
|
1768
2140
|
@property
|
|
1769
|
-
def
|
|
1770
|
-
"""
|
|
1771
|
-
|
|
1772
|
-
|
|
2141
|
+
def max_final_threads(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2142
|
+
"""Sets the maximum number of parallel threads for the **SELECT** query data read phase with the **FINAL** modifier.
|
|
2143
|
+
|
|
2144
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_final_threads).
|
|
1773
2145
|
"""
|
|
1774
2146
|
|
|
1775
2147
|
@property
|
|
1776
|
-
def
|
|
1777
|
-
"""
|
|
1778
|
-
|
|
1779
|
-
|
|
2148
|
+
def max_read_buffer_size(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2149
|
+
"""The maximum size of the buffer to read from the filesystem.
|
|
2150
|
+
|
|
2151
|
+
Default value: **1048576** (1 MiB).
|
|
2152
|
+
|
|
2153
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#max_read_buffer_size).
|
|
1780
2154
|
"""
|
|
1781
2155
|
|
|
1782
2156
|
@property
|
|
1783
|
-
def
|
|
1784
|
-
"""
|
|
1785
|
-
|
|
1786
|
-
|
|
2157
|
+
def insert_keeper_max_retries(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2158
|
+
"""The setting sets the maximum number of retries for ClickHouse Keeper (or ZooKeeper) requests during insert into replicated MergeTree tables.
|
|
2159
|
+
Only Keeper requests which failed due to network error, Keeper session timeout or request timeout are considered for retries.
|
|
2160
|
+
|
|
2161
|
+
Default value: **20**.
|
|
2162
|
+
|
|
2163
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#insert_keeper_max_retries).
|
|
1787
2164
|
"""
|
|
1788
2165
|
|
|
1789
2166
|
@property
|
|
1790
2167
|
def do_not_merge_across_partitions_select_final(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1791
|
-
"""
|
|
1792
|
-
|
|
1793
|
-
|
|
2168
|
+
"""Enable or disable independent processing of partitions for **SELECT** queries with **FINAL**.
|
|
2169
|
+
|
|
2170
|
+
Default value: **false**.
|
|
2171
|
+
|
|
2172
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/guides/replacing-merge-tree#exploiting-partitions-with-replacingmergetree).
|
|
1794
2173
|
"""
|
|
1795
2174
|
|
|
1796
2175
|
@property
|
|
1797
2176
|
def ignore_materialized_views_with_dropped_target_table(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1798
2177
|
"""Ignore materialized views with dropped target table during pushing to views.
|
|
1799
|
-
|
|
2178
|
+
|
|
2179
|
+
Default value: **false**.
|
|
2180
|
+
|
|
2181
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#ignore_materialized_views_with_dropped_target_table).
|
|
1800
2182
|
"""
|
|
1801
2183
|
|
|
1802
2184
|
@property
|
|
1803
2185
|
def enable_analyzer(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
1804
|
-
"""
|
|
1805
|
-
|
|
2186
|
+
"""Enables or disables new query analyzer.
|
|
2187
|
+
|
|
2188
|
+
Default value: **true** for versions 25.5 and higher, **false** for versions 25.4 and lower.
|
|
2189
|
+
|
|
2190
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/guides/developer/understanding-query-execution-with-the-analyzer#analyzer).
|
|
2191
|
+
"""
|
|
2192
|
+
|
|
2193
|
+
@property
|
|
2194
|
+
def s3_use_adaptive_timeouts(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2195
|
+
"""Enables or disables adaptive timeouts for S3 requests.
|
|
2196
|
+
* **true** - for all S3 requests first two attempts are made with low send and receive timeouts.
|
|
2197
|
+
* **false** - all attempts are made with identical timeouts.
|
|
2198
|
+
|
|
2199
|
+
Default value: **true**.
|
|
2200
|
+
|
|
2201
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/settings/settings#s3_use_adaptive_timeouts).
|
|
1806
2202
|
"""
|
|
1807
2203
|
|
|
1808
2204
|
@property
|
|
@@ -1813,6 +2209,10 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1813
2209
|
def min_count_to_compile(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1814
2210
|
"""The setting is deprecated and has no effect."""
|
|
1815
2211
|
|
|
2212
|
+
@property
|
|
2213
|
+
def async_insert_threads(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2214
|
+
"""The setting is deprecated and has no effect."""
|
|
2215
|
+
|
|
1816
2216
|
@property
|
|
1817
2217
|
def async_insert_stale_timeout(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
1818
2218
|
"""The setting is deprecated and has no effect."""
|
|
@@ -1827,26 +2227,31 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1827
2227
|
connect_timeout_with_failover: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1828
2228
|
receive_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1829
2229
|
send_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2230
|
+
idle_connection_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1830
2231
|
timeout_before_checking_execution_speed: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1831
2232
|
insert_quorum: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1832
2233
|
insert_quorum_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1833
2234
|
insert_quorum_parallel: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1834
|
-
insert_null_as_default: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1835
2235
|
select_sequential_consistency: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1836
|
-
deduplicate_blocks_in_dependent_materialized_views: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1837
2236
|
replication_alter_partitions_sync: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1838
2237
|
max_replica_delay_for_distributed_queries: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1839
2238
|
fallback_to_stale_replicas_for_distributed_queries: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1840
2239
|
distributed_product_mode: global___UserSettings.DistributedProductMode.ValueType = ...,
|
|
1841
2240
|
distributed_aggregation_memory_efficient: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1842
2241
|
distributed_ddl_task_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2242
|
+
distributed_ddl_output_mode: global___UserSettings.DistributedDdlOutputMode.ValueType = ...,
|
|
1843
2243
|
skip_unavailable_shards: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2244
|
+
use_hedged_requests: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2245
|
+
hedged_connection_timeout_ms: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2246
|
+
load_balancing: global___UserSettings.LoadBalancing.ValueType = ...,
|
|
2247
|
+
prefer_localhost_replica: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1844
2248
|
compile_expressions: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1845
2249
|
min_count_to_compile_expression: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1846
2250
|
max_block_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1847
2251
|
min_insert_block_size_rows: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1848
2252
|
min_insert_block_size_bytes: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1849
2253
|
max_insert_block_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2254
|
+
max_partitions_per_insert_block: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1850
2255
|
min_bytes_to_use_direct_io: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1851
2256
|
use_uncompressed_cache: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1852
2257
|
merge_tree_max_rows_to_use_cache: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
@@ -1857,13 +2262,21 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1857
2262
|
max_bytes_before_external_sort: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1858
2263
|
group_by_two_level_threshold: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1859
2264
|
group_by_two_level_threshold_bytes: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2265
|
+
deduplicate_blocks_in_dependent_materialized_views: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2266
|
+
local_filesystem_read_method: global___UserSettings.LocalFilesystemReadMethod.ValueType = ...,
|
|
2267
|
+
remote_filesystem_read_method: global___UserSettings.RemoteFilesystemReadMethod.ValueType = ...,
|
|
1860
2268
|
priority: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1861
2269
|
max_threads: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2270
|
+
max_insert_threads: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1862
2271
|
max_memory_usage: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1863
2272
|
max_memory_usage_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2273
|
+
memory_overcommit_ratio_denominator: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2274
|
+
memory_overcommit_ratio_denominator_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2275
|
+
memory_usage_overcommit_max_wait_microseconds: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1864
2276
|
max_network_bandwidth: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1865
2277
|
max_network_bandwidth_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1866
|
-
|
|
2278
|
+
max_temporary_data_on_disk_size_for_query: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2279
|
+
max_temporary_data_on_disk_size_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1867
2280
|
max_concurrent_queries_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1868
2281
|
force_index_by_date: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1869
2282
|
force_primary_key: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
@@ -1892,8 +2305,6 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1892
2305
|
max_rows_in_join: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1893
2306
|
max_bytes_in_join: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1894
2307
|
join_overflow_mode: global___UserSettings.OverflowMode.ValueType = ...,
|
|
1895
|
-
join_algorithm: collections.abc.Iterable[global___UserSettings.JoinAlgorithm.ValueType] | None = ...,
|
|
1896
|
-
any_join_distinct_right_table_keys: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1897
2308
|
max_columns_to_read: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1898
2309
|
max_temporary_columns: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1899
2310
|
max_temporary_non_const_columns: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
@@ -1901,20 +2312,26 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1901
2312
|
max_ast_depth: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1902
2313
|
max_ast_elements: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1903
2314
|
max_expanded_ast_elements: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2315
|
+
max_parser_depth: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1904
2316
|
min_execution_speed: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1905
2317
|
min_execution_speed_bytes: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1906
|
-
count_distinct_implementation: global___UserSettings.CountDistinctImplementation.ValueType = ...,
|
|
1907
2318
|
input_format_values_interpret_expressions: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1908
2319
|
input_format_defaults_for_omitted_fields: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1909
2320
|
input_format_null_as_default: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1910
|
-
date_time_input_format: global___UserSettings.DateTimeInputFormat.ValueType = ...,
|
|
1911
2321
|
input_format_with_names_use_header: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1912
2322
|
output_format_json_quote_64bit_integers: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1913
2323
|
output_format_json_quote_denormals: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2324
|
+
date_time_input_format: global___UserSettings.DateTimeInputFormat.ValueType = ...,
|
|
1914
2325
|
date_time_output_format: global___UserSettings.DateTimeOutputFormat.ValueType = ...,
|
|
1915
2326
|
low_cardinality_allow_in_native_format: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1916
|
-
allow_suspicious_low_cardinality_types: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1917
2327
|
empty_result_for_aggregation_by_empty_set: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2328
|
+
format_regexp: builtins.str = ...,
|
|
2329
|
+
format_regexp_escaping_rule: global___UserSettings.FormatRegexpEscapingRule.ValueType = ...,
|
|
2330
|
+
format_regexp_skip_unmatched: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2331
|
+
input_format_parallel_parsing: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2332
|
+
input_format_import_nested_json: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2333
|
+
format_avro_schema_registry_url: builtins.str = ...,
|
|
2334
|
+
data_type_default_nullable: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1918
2335
|
http_connection_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1919
2336
|
http_receive_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1920
2337
|
http_send_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
@@ -1926,38 +2343,13 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1926
2343
|
max_http_get_redirects: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1927
2344
|
http_max_field_name_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1928
2345
|
http_max_field_value_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1929
|
-
joined_subquery_requires_alias: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1930
|
-
join_use_nulls: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1931
|
-
transform_null_in: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1932
2346
|
quota_mode: global___UserSettings.QuotaMode.ValueType = ...,
|
|
1933
|
-
flatten_nested: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1934
|
-
format_regexp: builtins.str = ...,
|
|
1935
|
-
format_regexp_escaping_rule: global___UserSettings.FormatRegexpEscapingRule.ValueType = ...,
|
|
1936
|
-
format_regexp_skip_unmatched: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1937
2347
|
async_insert: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1938
|
-
async_insert_threads: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1939
2348
|
wait_for_async_insert: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1940
2349
|
wait_for_async_insert_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1941
2350
|
async_insert_max_data_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1942
2351
|
async_insert_busy_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1943
2352
|
async_insert_use_adaptive_busy_timeout: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1944
|
-
memory_profiler_step: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1945
|
-
memory_profiler_sample_probability: google.protobuf.wrappers_pb2.DoubleValue | None = ...,
|
|
1946
|
-
max_final_threads: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1947
|
-
input_format_parallel_parsing: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1948
|
-
input_format_import_nested_json: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1949
|
-
format_avro_schema_registry_url: builtins.str = ...,
|
|
1950
|
-
data_type_default_nullable: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1951
|
-
local_filesystem_read_method: global___UserSettings.LocalFilesystemReadMethod.ValueType = ...,
|
|
1952
|
-
max_read_buffer_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1953
|
-
insert_keeper_max_retries: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1954
|
-
max_temporary_data_on_disk_size_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1955
|
-
max_temporary_data_on_disk_size_for_query: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1956
|
-
max_parser_depth: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1957
|
-
remote_filesystem_read_method: global___UserSettings.RemoteFilesystemReadMethod.ValueType = ...,
|
|
1958
|
-
memory_overcommit_ratio_denominator: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1959
|
-
memory_overcommit_ratio_denominator_for_user: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1960
|
-
memory_usage_overcommit_max_wait_microseconds: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1961
2353
|
log_query_threads: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1962
2354
|
log_query_views: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1963
2355
|
log_queries_probability: google.protobuf.wrappers_pb2.DoubleValue | None = ...,
|
|
@@ -1974,28 +2366,38 @@ class UserSettings(google.protobuf.message.Message):
|
|
|
1974
2366
|
query_cache_share_between_users: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1975
2367
|
query_cache_nondeterministic_function_handling: global___UserSettings.QueryCacheNondeterministicFunctionHandling.ValueType = ...,
|
|
1976
2368
|
query_cache_system_table_handling: global___UserSettings.QueryCacheSystemTableHandling.ValueType = ...,
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
|
|
1981
|
-
|
|
1982
|
-
|
|
2369
|
+
count_distinct_implementation: global___UserSettings.CountDistinctImplementation.ValueType = ...,
|
|
2370
|
+
joined_subquery_requires_alias: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2371
|
+
join_use_nulls: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2372
|
+
transform_null_in: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2373
|
+
insert_null_as_default: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2374
|
+
join_algorithm: collections.abc.Iterable[global___UserSettings.JoinAlgorithm.ValueType] | None = ...,
|
|
2375
|
+
any_join_distinct_right_table_keys: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2376
|
+
allow_suspicious_low_cardinality_types: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2377
|
+
flatten_nested: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2378
|
+
memory_profiler_step: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2379
|
+
memory_profiler_sample_probability: google.protobuf.wrappers_pb2.DoubleValue | None = ...,
|
|
2380
|
+
max_final_threads: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2381
|
+
max_read_buffer_size: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2382
|
+
insert_keeper_max_retries: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1983
2383
|
do_not_merge_across_partitions_select_final: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1984
2384
|
ignore_materialized_views_with_dropped_target_table: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1985
2385
|
enable_analyzer: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2386
|
+
s3_use_adaptive_timeouts: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1986
2387
|
compile: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
1987
2388
|
min_count_to_compile: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
2389
|
+
async_insert_threads: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1988
2390
|
async_insert_stale_timeout: google.protobuf.wrappers_pb2.Int64Value | None = ...,
|
|
1989
2391
|
) -> None: ...
|
|
1990
|
-
def HasField(self, field_name: typing.Literal["add_http_cors_header", b"add_http_cors_header", "allow_ddl", b"allow_ddl", "allow_introspection_functions", b"allow_introspection_functions", "allow_suspicious_low_cardinality_types", b"allow_suspicious_low_cardinality_types", "any_join_distinct_right_table_keys", b"any_join_distinct_right_table_keys", "async_insert", b"async_insert", "async_insert_busy_timeout", b"async_insert_busy_timeout", "async_insert_max_data_size", b"async_insert_max_data_size", "async_insert_stale_timeout", b"async_insert_stale_timeout", "async_insert_threads", b"async_insert_threads", "async_insert_use_adaptive_busy_timeout", b"async_insert_use_adaptive_busy_timeout", "cancel_http_readonly_queries_on_client_close", b"cancel_http_readonly_queries_on_client_close", "compile", b"compile", "compile_expressions", b"compile_expressions", "connect_timeout", b"connect_timeout", "connect_timeout_with_failover", b"connect_timeout_with_failover", "data_type_default_nullable", b"data_type_default_nullable", "deduplicate_blocks_in_dependent_materialized_views", b"deduplicate_blocks_in_dependent_materialized_views", "distributed_aggregation_memory_efficient", b"distributed_aggregation_memory_efficient", "distributed_ddl_task_timeout", b"distributed_ddl_task_timeout", "do_not_merge_across_partitions_select_final", b"do_not_merge_across_partitions_select_final", "empty_result_for_aggregation_by_empty_set", b"empty_result_for_aggregation_by_empty_set", "enable_analyzer", b"enable_analyzer", "enable_http_compression", b"enable_http_compression", "enable_reads_from_query_cache", b"enable_reads_from_query_cache", "enable_writes_to_query_cache", b"enable_writes_to_query_cache", "fallback_to_stale_replicas_for_distributed_queries", b"fallback_to_stale_replicas_for_distributed_queries", "flatten_nested", b"flatten_nested", "force_index_by_date", b"force_index_by_date", "force_primary_key", b"force_primary_key", "format_regexp_skip_unmatched", b"format_regexp_skip_unmatched", "group_by_two_level_threshold", b"group_by_two_level_threshold", "group_by_two_level_threshold_bytes", b"group_by_two_level_threshold_bytes", "hedged_connection_timeout_ms", b"hedged_connection_timeout_ms", "http_connection_timeout", b"http_connection_timeout", "http_headers_progress_interval", b"http_headers_progress_interval", "http_max_field_name_size", b"http_max_field_name_size", "http_max_field_value_size", b"http_max_field_value_size", "http_receive_timeout", b"http_receive_timeout", "http_send_timeout", b"http_send_timeout", "idle_connection_timeout", b"idle_connection_timeout", "ignore_materialized_views_with_dropped_target_table", b"ignore_materialized_views_with_dropped_target_table", "input_format_defaults_for_omitted_fields", b"input_format_defaults_for_omitted_fields", "input_format_import_nested_json", b"input_format_import_nested_json", "input_format_null_as_default", b"input_format_null_as_default", "input_format_parallel_parsing", b"input_format_parallel_parsing", "input_format_values_interpret_expressions", b"input_format_values_interpret_expressions", "input_format_with_names_use_header", b"input_format_with_names_use_header", "insert_keeper_max_retries", b"insert_keeper_max_retries", "insert_null_as_default", b"insert_null_as_default", "insert_quorum", b"insert_quorum", "insert_quorum_parallel", b"insert_quorum_parallel", "insert_quorum_timeout", b"insert_quorum_timeout", "join_use_nulls", b"join_use_nulls", "joined_subquery_requires_alias", b"joined_subquery_requires_alias", "log_processors_profiles", b"log_processors_profiles", "log_queries_probability", b"log_queries_probability", "log_query_threads", b"log_query_threads", "log_query_views", b"log_query_views", "low_cardinality_allow_in_native_format", b"low_cardinality_allow_in_native_format", "max_ast_depth", b"max_ast_depth", "max_ast_elements", b"max_ast_elements", "max_block_size", b"max_block_size", "max_bytes_before_external_group_by", b"max_bytes_before_external_group_by", "max_bytes_before_external_sort", b"max_bytes_before_external_sort", "max_bytes_in_distinct", b"max_bytes_in_distinct", "max_bytes_in_join", b"max_bytes_in_join", "max_bytes_in_set", b"max_bytes_in_set", "max_bytes_to_read", b"max_bytes_to_read", "max_bytes_to_sort", b"max_bytes_to_sort", "max_bytes_to_transfer", b"max_bytes_to_transfer", "max_columns_to_read", b"max_columns_to_read", "max_concurrent_queries_for_user", b"max_concurrent_queries_for_user", "max_execution_time", b"max_execution_time", "max_expanded_ast_elements", b"max_expanded_ast_elements", "max_final_threads", b"max_final_threads", "max_http_get_redirects", b"max_http_get_redirects", "max_insert_block_size", b"max_insert_block_size", "max_insert_threads", b"max_insert_threads", "max_memory_usage", b"max_memory_usage", "max_memory_usage_for_user", b"max_memory_usage_for_user", "max_network_bandwidth", b"max_network_bandwidth", "max_network_bandwidth_for_user", b"max_network_bandwidth_for_user", "max_parser_depth", b"max_parser_depth", "max_partitions_per_insert_block", b"max_partitions_per_insert_block", "max_query_size", b"max_query_size", "max_read_buffer_size", b"max_read_buffer_size", "max_replica_delay_for_distributed_queries", b"max_replica_delay_for_distributed_queries", "max_result_bytes", b"max_result_bytes", "max_result_rows", b"max_result_rows", "max_rows_in_distinct", b"max_rows_in_distinct", "max_rows_in_join", b"max_rows_in_join", "max_rows_in_set", b"max_rows_in_set", "max_rows_to_group_by", b"max_rows_to_group_by", "max_rows_to_read", b"max_rows_to_read", "max_rows_to_sort", b"max_rows_to_sort", "max_rows_to_transfer", b"max_rows_to_transfer", "max_temporary_columns", b"max_temporary_columns", "max_temporary_data_on_disk_size_for_query", b"max_temporary_data_on_disk_size_for_query", "max_temporary_data_on_disk_size_for_user", b"max_temporary_data_on_disk_size_for_user", "max_temporary_non_const_columns", b"max_temporary_non_const_columns", "max_threads", b"max_threads", "memory_overcommit_ratio_denominator", b"memory_overcommit_ratio_denominator", "memory_overcommit_ratio_denominator_for_user", b"memory_overcommit_ratio_denominator_for_user", "memory_profiler_sample_probability", b"memory_profiler_sample_probability", "memory_profiler_step", b"memory_profiler_step", "memory_usage_overcommit_max_wait_microseconds", b"memory_usage_overcommit_max_wait_microseconds", "merge_tree_max_bytes_to_use_cache", b"merge_tree_max_bytes_to_use_cache", "merge_tree_max_rows_to_use_cache", b"merge_tree_max_rows_to_use_cache", "merge_tree_min_bytes_for_concurrent_read", b"merge_tree_min_bytes_for_concurrent_read", "merge_tree_min_rows_for_concurrent_read", b"merge_tree_min_rows_for_concurrent_read", "min_bytes_to_use_direct_io", b"min_bytes_to_use_direct_io", "min_count_to_compile", b"min_count_to_compile", "min_count_to_compile_expression", b"min_count_to_compile_expression", "min_execution_speed", b"min_execution_speed", "min_execution_speed_bytes", b"min_execution_speed_bytes", "min_insert_block_size_bytes", b"min_insert_block_size_bytes", "min_insert_block_size_rows", b"min_insert_block_size_rows", "output_format_json_quote_64bit_integers", b"output_format_json_quote_64bit_integers", "output_format_json_quote_denormals", b"output_format_json_quote_denormals", "prefer_localhost_replica", b"prefer_localhost_replica", "priority", b"priority", "query_cache_max_entries", b"query_cache_max_entries", "query_cache_max_size_in_bytes", b"query_cache_max_size_in_bytes", "query_cache_min_query_duration", b"query_cache_min_query_duration", "query_cache_min_query_runs", b"query_cache_min_query_runs", "query_cache_share_between_users", b"query_cache_share_between_users", "query_cache_ttl", b"query_cache_ttl", "readonly", b"readonly", "receive_timeout", b"receive_timeout", "replication_alter_partitions_sync", b"replication_alter_partitions_sync", "select_sequential_consistency", b"select_sequential_consistency", "send_progress_in_http_headers", b"send_progress_in_http_headers", "send_timeout", b"send_timeout", "skip_unavailable_shards", b"skip_unavailable_shards", "timeout_before_checking_execution_speed", b"timeout_before_checking_execution_speed", "transform_null_in", b"transform_null_in", "use_hedged_requests", b"use_hedged_requests", "use_query_cache", b"use_query_cache", "use_uncompressed_cache", b"use_uncompressed_cache", "wait_for_async_insert", b"wait_for_async_insert", "wait_for_async_insert_timeout", b"wait_for_async_insert_timeout"]) -> builtins.bool: ...
|
|
1991
|
-
def ClearField(self, field_name: typing.Literal["add_http_cors_header", b"add_http_cors_header", "allow_ddl", b"allow_ddl", "allow_introspection_functions", b"allow_introspection_functions", "allow_suspicious_low_cardinality_types", b"allow_suspicious_low_cardinality_types", "any_join_distinct_right_table_keys", b"any_join_distinct_right_table_keys", "async_insert", b"async_insert", "async_insert_busy_timeout", b"async_insert_busy_timeout", "async_insert_max_data_size", b"async_insert_max_data_size", "async_insert_stale_timeout", b"async_insert_stale_timeout", "async_insert_threads", b"async_insert_threads", "async_insert_use_adaptive_busy_timeout", b"async_insert_use_adaptive_busy_timeout", "cancel_http_readonly_queries_on_client_close", b"cancel_http_readonly_queries_on_client_close", "compile", b"compile", "compile_expressions", b"compile_expressions", "connect_timeout", b"connect_timeout", "connect_timeout_with_failover", b"connect_timeout_with_failover", "count_distinct_implementation", b"count_distinct_implementation", "data_type_default_nullable", b"data_type_default_nullable", "date_time_input_format", b"date_time_input_format", "date_time_output_format", b"date_time_output_format", "deduplicate_blocks_in_dependent_materialized_views", b"deduplicate_blocks_in_dependent_materialized_views", "distinct_overflow_mode", b"distinct_overflow_mode", "distributed_aggregation_memory_efficient", b"distributed_aggregation_memory_efficient", "distributed_ddl_task_timeout", b"distributed_ddl_task_timeout", "distributed_product_mode", b"distributed_product_mode", "do_not_merge_across_partitions_select_final", b"do_not_merge_across_partitions_select_final", "empty_result_for_aggregation_by_empty_set", b"empty_result_for_aggregation_by_empty_set", "enable_analyzer", b"enable_analyzer", "enable_http_compression", b"enable_http_compression", "enable_reads_from_query_cache", b"enable_reads_from_query_cache", "enable_writes_to_query_cache", b"enable_writes_to_query_cache", "fallback_to_stale_replicas_for_distributed_queries", b"fallback_to_stale_replicas_for_distributed_queries", "flatten_nested", b"flatten_nested", "force_index_by_date", b"force_index_by_date", "force_primary_key", b"force_primary_key", "format_avro_schema_registry_url", b"format_avro_schema_registry_url", "format_regexp", b"format_regexp", "format_regexp_escaping_rule", b"format_regexp_escaping_rule", "format_regexp_skip_unmatched", b"format_regexp_skip_unmatched", "group_by_overflow_mode", b"group_by_overflow_mode", "group_by_two_level_threshold", b"group_by_two_level_threshold", "group_by_two_level_threshold_bytes", b"group_by_two_level_threshold_bytes", "hedged_connection_timeout_ms", b"hedged_connection_timeout_ms", "http_connection_timeout", b"http_connection_timeout", "http_headers_progress_interval", b"http_headers_progress_interval", "http_max_field_name_size", b"http_max_field_name_size", "http_max_field_value_size", b"http_max_field_value_size", "http_receive_timeout", b"http_receive_timeout", "http_send_timeout", b"http_send_timeout", "idle_connection_timeout", b"idle_connection_timeout", "ignore_materialized_views_with_dropped_target_table", b"ignore_materialized_views_with_dropped_target_table", "input_format_defaults_for_omitted_fields", b"input_format_defaults_for_omitted_fields", "input_format_import_nested_json", b"input_format_import_nested_json", "input_format_null_as_default", b"input_format_null_as_default", "input_format_parallel_parsing", b"input_format_parallel_parsing", "input_format_values_interpret_expressions", b"input_format_values_interpret_expressions", "input_format_with_names_use_header", b"input_format_with_names_use_header", "insert_keeper_max_retries", b"insert_keeper_max_retries", "insert_null_as_default", b"insert_null_as_default", "insert_quorum", b"insert_quorum", "insert_quorum_parallel", b"insert_quorum_parallel", "insert_quorum_timeout", b"insert_quorum_timeout", "join_algorithm", b"join_algorithm", "join_overflow_mode", b"join_overflow_mode", "join_use_nulls", b"join_use_nulls", "joined_subquery_requires_alias", b"joined_subquery_requires_alias", "load_balancing", b"load_balancing", "local_filesystem_read_method", b"local_filesystem_read_method", "log_processors_profiles", b"log_processors_profiles", "log_queries_probability", b"log_queries_probability", "log_query_threads", b"log_query_threads", "log_query_views", b"log_query_views", "low_cardinality_allow_in_native_format", b"low_cardinality_allow_in_native_format", "max_ast_depth", b"max_ast_depth", "max_ast_elements", b"max_ast_elements", "max_block_size", b"max_block_size", "max_bytes_before_external_group_by", b"max_bytes_before_external_group_by", "max_bytes_before_external_sort", b"max_bytes_before_external_sort", "max_bytes_in_distinct", b"max_bytes_in_distinct", "max_bytes_in_join", b"max_bytes_in_join", "max_bytes_in_set", b"max_bytes_in_set", "max_bytes_to_read", b"max_bytes_to_read", "max_bytes_to_sort", b"max_bytes_to_sort", "max_bytes_to_transfer", b"max_bytes_to_transfer", "max_columns_to_read", b"max_columns_to_read", "max_concurrent_queries_for_user", b"max_concurrent_queries_for_user", "max_execution_time", b"max_execution_time", "max_expanded_ast_elements", b"max_expanded_ast_elements", "max_final_threads", b"max_final_threads", "max_http_get_redirects", b"max_http_get_redirects", "max_insert_block_size", b"max_insert_block_size", "max_insert_threads", b"max_insert_threads", "max_memory_usage", b"max_memory_usage", "max_memory_usage_for_user", b"max_memory_usage_for_user", "max_network_bandwidth", b"max_network_bandwidth", "max_network_bandwidth_for_user", b"max_network_bandwidth_for_user", "max_parser_depth", b"max_parser_depth", "max_partitions_per_insert_block", b"max_partitions_per_insert_block", "max_query_size", b"max_query_size", "max_read_buffer_size", b"max_read_buffer_size", "max_replica_delay_for_distributed_queries", b"max_replica_delay_for_distributed_queries", "max_result_bytes", b"max_result_bytes", "max_result_rows", b"max_result_rows", "max_rows_in_distinct", b"max_rows_in_distinct", "max_rows_in_join", b"max_rows_in_join", "max_rows_in_set", b"max_rows_in_set", "max_rows_to_group_by", b"max_rows_to_group_by", "max_rows_to_read", b"max_rows_to_read", "max_rows_to_sort", b"max_rows_to_sort", "max_rows_to_transfer", b"max_rows_to_transfer", "max_temporary_columns", b"max_temporary_columns", "max_temporary_data_on_disk_size_for_query", b"max_temporary_data_on_disk_size_for_query", "max_temporary_data_on_disk_size_for_user", b"max_temporary_data_on_disk_size_for_user", "max_temporary_non_const_columns", b"max_temporary_non_const_columns", "max_threads", b"max_threads", "memory_overcommit_ratio_denominator", b"memory_overcommit_ratio_denominator", "memory_overcommit_ratio_denominator_for_user", b"memory_overcommit_ratio_denominator_for_user", "memory_profiler_sample_probability", b"memory_profiler_sample_probability", "memory_profiler_step", b"memory_profiler_step", "memory_usage_overcommit_max_wait_microseconds", b"memory_usage_overcommit_max_wait_microseconds", "merge_tree_max_bytes_to_use_cache", b"merge_tree_max_bytes_to_use_cache", "merge_tree_max_rows_to_use_cache", b"merge_tree_max_rows_to_use_cache", "merge_tree_min_bytes_for_concurrent_read", b"merge_tree_min_bytes_for_concurrent_read", "merge_tree_min_rows_for_concurrent_read", b"merge_tree_min_rows_for_concurrent_read", "min_bytes_to_use_direct_io", b"min_bytes_to_use_direct_io", "min_count_to_compile", b"min_count_to_compile", "min_count_to_compile_expression", b"min_count_to_compile_expression", "min_execution_speed", b"min_execution_speed", "min_execution_speed_bytes", b"min_execution_speed_bytes", "min_insert_block_size_bytes", b"min_insert_block_size_bytes", "min_insert_block_size_rows", b"min_insert_block_size_rows", "output_format_json_quote_64bit_integers", b"output_format_json_quote_64bit_integers", "output_format_json_quote_denormals", b"output_format_json_quote_denormals", "prefer_localhost_replica", b"prefer_localhost_replica", "priority", b"priority", "query_cache_max_entries", b"query_cache_max_entries", "query_cache_max_size_in_bytes", b"query_cache_max_size_in_bytes", "query_cache_min_query_duration", b"query_cache_min_query_duration", "query_cache_min_query_runs", b"query_cache_min_query_runs", "query_cache_nondeterministic_function_handling", b"query_cache_nondeterministic_function_handling", "query_cache_share_between_users", b"query_cache_share_between_users", "query_cache_system_table_handling", b"query_cache_system_table_handling", "query_cache_tag", b"query_cache_tag", "query_cache_ttl", b"query_cache_ttl", "quota_mode", b"quota_mode", "read_overflow_mode", b"read_overflow_mode", "readonly", b"readonly", "receive_timeout", b"receive_timeout", "remote_filesystem_read_method", b"remote_filesystem_read_method", "replication_alter_partitions_sync", b"replication_alter_partitions_sync", "result_overflow_mode", b"result_overflow_mode", "select_sequential_consistency", b"select_sequential_consistency", "send_progress_in_http_headers", b"send_progress_in_http_headers", "send_timeout", b"send_timeout", "set_overflow_mode", b"set_overflow_mode", "skip_unavailable_shards", b"skip_unavailable_shards", "sort_overflow_mode", b"sort_overflow_mode", "timeout_before_checking_execution_speed", b"timeout_before_checking_execution_speed", "timeout_overflow_mode", b"timeout_overflow_mode", "transfer_overflow_mode", b"transfer_overflow_mode", "transform_null_in", b"transform_null_in", "use_hedged_requests", b"use_hedged_requests", "use_query_cache", b"use_query_cache", "use_uncompressed_cache", b"use_uncompressed_cache", "wait_for_async_insert", b"wait_for_async_insert", "wait_for_async_insert_timeout", b"wait_for_async_insert_timeout"]) -> None: ...
|
|
2392
|
+
def HasField(self, field_name: typing.Literal["add_http_cors_header", b"add_http_cors_header", "allow_ddl", b"allow_ddl", "allow_introspection_functions", b"allow_introspection_functions", "allow_suspicious_low_cardinality_types", b"allow_suspicious_low_cardinality_types", "any_join_distinct_right_table_keys", b"any_join_distinct_right_table_keys", "async_insert", b"async_insert", "async_insert_busy_timeout", b"async_insert_busy_timeout", "async_insert_max_data_size", b"async_insert_max_data_size", "async_insert_stale_timeout", b"async_insert_stale_timeout", "async_insert_threads", b"async_insert_threads", "async_insert_use_adaptive_busy_timeout", b"async_insert_use_adaptive_busy_timeout", "cancel_http_readonly_queries_on_client_close", b"cancel_http_readonly_queries_on_client_close", "compile", b"compile", "compile_expressions", b"compile_expressions", "connect_timeout", b"connect_timeout", "connect_timeout_with_failover", b"connect_timeout_with_failover", "data_type_default_nullable", b"data_type_default_nullable", "deduplicate_blocks_in_dependent_materialized_views", b"deduplicate_blocks_in_dependent_materialized_views", "distributed_aggregation_memory_efficient", b"distributed_aggregation_memory_efficient", "distributed_ddl_task_timeout", b"distributed_ddl_task_timeout", "do_not_merge_across_partitions_select_final", b"do_not_merge_across_partitions_select_final", "empty_result_for_aggregation_by_empty_set", b"empty_result_for_aggregation_by_empty_set", "enable_analyzer", b"enable_analyzer", "enable_http_compression", b"enable_http_compression", "enable_reads_from_query_cache", b"enable_reads_from_query_cache", "enable_writes_to_query_cache", b"enable_writes_to_query_cache", "fallback_to_stale_replicas_for_distributed_queries", b"fallback_to_stale_replicas_for_distributed_queries", "flatten_nested", b"flatten_nested", "force_index_by_date", b"force_index_by_date", "force_primary_key", b"force_primary_key", "format_regexp_skip_unmatched", b"format_regexp_skip_unmatched", "group_by_two_level_threshold", b"group_by_two_level_threshold", "group_by_two_level_threshold_bytes", b"group_by_two_level_threshold_bytes", "hedged_connection_timeout_ms", b"hedged_connection_timeout_ms", "http_connection_timeout", b"http_connection_timeout", "http_headers_progress_interval", b"http_headers_progress_interval", "http_max_field_name_size", b"http_max_field_name_size", "http_max_field_value_size", b"http_max_field_value_size", "http_receive_timeout", b"http_receive_timeout", "http_send_timeout", b"http_send_timeout", "idle_connection_timeout", b"idle_connection_timeout", "ignore_materialized_views_with_dropped_target_table", b"ignore_materialized_views_with_dropped_target_table", "input_format_defaults_for_omitted_fields", b"input_format_defaults_for_omitted_fields", "input_format_import_nested_json", b"input_format_import_nested_json", "input_format_null_as_default", b"input_format_null_as_default", "input_format_parallel_parsing", b"input_format_parallel_parsing", "input_format_values_interpret_expressions", b"input_format_values_interpret_expressions", "input_format_with_names_use_header", b"input_format_with_names_use_header", "insert_keeper_max_retries", b"insert_keeper_max_retries", "insert_null_as_default", b"insert_null_as_default", "insert_quorum", b"insert_quorum", "insert_quorum_parallel", b"insert_quorum_parallel", "insert_quorum_timeout", b"insert_quorum_timeout", "join_use_nulls", b"join_use_nulls", "joined_subquery_requires_alias", b"joined_subquery_requires_alias", "log_processors_profiles", b"log_processors_profiles", "log_queries_probability", b"log_queries_probability", "log_query_threads", b"log_query_threads", "log_query_views", b"log_query_views", "low_cardinality_allow_in_native_format", b"low_cardinality_allow_in_native_format", "max_ast_depth", b"max_ast_depth", "max_ast_elements", b"max_ast_elements", "max_block_size", b"max_block_size", "max_bytes_before_external_group_by", b"max_bytes_before_external_group_by", "max_bytes_before_external_sort", b"max_bytes_before_external_sort", "max_bytes_in_distinct", b"max_bytes_in_distinct", "max_bytes_in_join", b"max_bytes_in_join", "max_bytes_in_set", b"max_bytes_in_set", "max_bytes_to_read", b"max_bytes_to_read", "max_bytes_to_sort", b"max_bytes_to_sort", "max_bytes_to_transfer", b"max_bytes_to_transfer", "max_columns_to_read", b"max_columns_to_read", "max_concurrent_queries_for_user", b"max_concurrent_queries_for_user", "max_execution_time", b"max_execution_time", "max_expanded_ast_elements", b"max_expanded_ast_elements", "max_final_threads", b"max_final_threads", "max_http_get_redirects", b"max_http_get_redirects", "max_insert_block_size", b"max_insert_block_size", "max_insert_threads", b"max_insert_threads", "max_memory_usage", b"max_memory_usage", "max_memory_usage_for_user", b"max_memory_usage_for_user", "max_network_bandwidth", b"max_network_bandwidth", "max_network_bandwidth_for_user", b"max_network_bandwidth_for_user", "max_parser_depth", b"max_parser_depth", "max_partitions_per_insert_block", b"max_partitions_per_insert_block", "max_query_size", b"max_query_size", "max_read_buffer_size", b"max_read_buffer_size", "max_replica_delay_for_distributed_queries", b"max_replica_delay_for_distributed_queries", "max_result_bytes", b"max_result_bytes", "max_result_rows", b"max_result_rows", "max_rows_in_distinct", b"max_rows_in_distinct", "max_rows_in_join", b"max_rows_in_join", "max_rows_in_set", b"max_rows_in_set", "max_rows_to_group_by", b"max_rows_to_group_by", "max_rows_to_read", b"max_rows_to_read", "max_rows_to_sort", b"max_rows_to_sort", "max_rows_to_transfer", b"max_rows_to_transfer", "max_temporary_columns", b"max_temporary_columns", "max_temporary_data_on_disk_size_for_query", b"max_temporary_data_on_disk_size_for_query", "max_temporary_data_on_disk_size_for_user", b"max_temporary_data_on_disk_size_for_user", "max_temporary_non_const_columns", b"max_temporary_non_const_columns", "max_threads", b"max_threads", "memory_overcommit_ratio_denominator", b"memory_overcommit_ratio_denominator", "memory_overcommit_ratio_denominator_for_user", b"memory_overcommit_ratio_denominator_for_user", "memory_profiler_sample_probability", b"memory_profiler_sample_probability", "memory_profiler_step", b"memory_profiler_step", "memory_usage_overcommit_max_wait_microseconds", b"memory_usage_overcommit_max_wait_microseconds", "merge_tree_max_bytes_to_use_cache", b"merge_tree_max_bytes_to_use_cache", "merge_tree_max_rows_to_use_cache", b"merge_tree_max_rows_to_use_cache", "merge_tree_min_bytes_for_concurrent_read", b"merge_tree_min_bytes_for_concurrent_read", "merge_tree_min_rows_for_concurrent_read", b"merge_tree_min_rows_for_concurrent_read", "min_bytes_to_use_direct_io", b"min_bytes_to_use_direct_io", "min_count_to_compile", b"min_count_to_compile", "min_count_to_compile_expression", b"min_count_to_compile_expression", "min_execution_speed", b"min_execution_speed", "min_execution_speed_bytes", b"min_execution_speed_bytes", "min_insert_block_size_bytes", b"min_insert_block_size_bytes", "min_insert_block_size_rows", b"min_insert_block_size_rows", "output_format_json_quote_64bit_integers", b"output_format_json_quote_64bit_integers", "output_format_json_quote_denormals", b"output_format_json_quote_denormals", "prefer_localhost_replica", b"prefer_localhost_replica", "priority", b"priority", "query_cache_max_entries", b"query_cache_max_entries", "query_cache_max_size_in_bytes", b"query_cache_max_size_in_bytes", "query_cache_min_query_duration", b"query_cache_min_query_duration", "query_cache_min_query_runs", b"query_cache_min_query_runs", "query_cache_share_between_users", b"query_cache_share_between_users", "query_cache_ttl", b"query_cache_ttl", "readonly", b"readonly", "receive_timeout", b"receive_timeout", "replication_alter_partitions_sync", b"replication_alter_partitions_sync", "s3_use_adaptive_timeouts", b"s3_use_adaptive_timeouts", "select_sequential_consistency", b"select_sequential_consistency", "send_progress_in_http_headers", b"send_progress_in_http_headers", "send_timeout", b"send_timeout", "skip_unavailable_shards", b"skip_unavailable_shards", "timeout_before_checking_execution_speed", b"timeout_before_checking_execution_speed", "transform_null_in", b"transform_null_in", "use_hedged_requests", b"use_hedged_requests", "use_query_cache", b"use_query_cache", "use_uncompressed_cache", b"use_uncompressed_cache", "wait_for_async_insert", b"wait_for_async_insert", "wait_for_async_insert_timeout", b"wait_for_async_insert_timeout"]) -> builtins.bool: ...
|
|
2393
|
+
def ClearField(self, field_name: typing.Literal["add_http_cors_header", b"add_http_cors_header", "allow_ddl", b"allow_ddl", "allow_introspection_functions", b"allow_introspection_functions", "allow_suspicious_low_cardinality_types", b"allow_suspicious_low_cardinality_types", "any_join_distinct_right_table_keys", b"any_join_distinct_right_table_keys", "async_insert", b"async_insert", "async_insert_busy_timeout", b"async_insert_busy_timeout", "async_insert_max_data_size", b"async_insert_max_data_size", "async_insert_stale_timeout", b"async_insert_stale_timeout", "async_insert_threads", b"async_insert_threads", "async_insert_use_adaptive_busy_timeout", b"async_insert_use_adaptive_busy_timeout", "cancel_http_readonly_queries_on_client_close", b"cancel_http_readonly_queries_on_client_close", "compile", b"compile", "compile_expressions", b"compile_expressions", "connect_timeout", b"connect_timeout", "connect_timeout_with_failover", b"connect_timeout_with_failover", "count_distinct_implementation", b"count_distinct_implementation", "data_type_default_nullable", b"data_type_default_nullable", "date_time_input_format", b"date_time_input_format", "date_time_output_format", b"date_time_output_format", "deduplicate_blocks_in_dependent_materialized_views", b"deduplicate_blocks_in_dependent_materialized_views", "distinct_overflow_mode", b"distinct_overflow_mode", "distributed_aggregation_memory_efficient", b"distributed_aggregation_memory_efficient", "distributed_ddl_output_mode", b"distributed_ddl_output_mode", "distributed_ddl_task_timeout", b"distributed_ddl_task_timeout", "distributed_product_mode", b"distributed_product_mode", "do_not_merge_across_partitions_select_final", b"do_not_merge_across_partitions_select_final", "empty_result_for_aggregation_by_empty_set", b"empty_result_for_aggregation_by_empty_set", "enable_analyzer", b"enable_analyzer", "enable_http_compression", b"enable_http_compression", "enable_reads_from_query_cache", b"enable_reads_from_query_cache", "enable_writes_to_query_cache", b"enable_writes_to_query_cache", "fallback_to_stale_replicas_for_distributed_queries", b"fallback_to_stale_replicas_for_distributed_queries", "flatten_nested", b"flatten_nested", "force_index_by_date", b"force_index_by_date", "force_primary_key", b"force_primary_key", "format_avro_schema_registry_url", b"format_avro_schema_registry_url", "format_regexp", b"format_regexp", "format_regexp_escaping_rule", b"format_regexp_escaping_rule", "format_regexp_skip_unmatched", b"format_regexp_skip_unmatched", "group_by_overflow_mode", b"group_by_overflow_mode", "group_by_two_level_threshold", b"group_by_two_level_threshold", "group_by_two_level_threshold_bytes", b"group_by_two_level_threshold_bytes", "hedged_connection_timeout_ms", b"hedged_connection_timeout_ms", "http_connection_timeout", b"http_connection_timeout", "http_headers_progress_interval", b"http_headers_progress_interval", "http_max_field_name_size", b"http_max_field_name_size", "http_max_field_value_size", b"http_max_field_value_size", "http_receive_timeout", b"http_receive_timeout", "http_send_timeout", b"http_send_timeout", "idle_connection_timeout", b"idle_connection_timeout", "ignore_materialized_views_with_dropped_target_table", b"ignore_materialized_views_with_dropped_target_table", "input_format_defaults_for_omitted_fields", b"input_format_defaults_for_omitted_fields", "input_format_import_nested_json", b"input_format_import_nested_json", "input_format_null_as_default", b"input_format_null_as_default", "input_format_parallel_parsing", b"input_format_parallel_parsing", "input_format_values_interpret_expressions", b"input_format_values_interpret_expressions", "input_format_with_names_use_header", b"input_format_with_names_use_header", "insert_keeper_max_retries", b"insert_keeper_max_retries", "insert_null_as_default", b"insert_null_as_default", "insert_quorum", b"insert_quorum", "insert_quorum_parallel", b"insert_quorum_parallel", "insert_quorum_timeout", b"insert_quorum_timeout", "join_algorithm", b"join_algorithm", "join_overflow_mode", b"join_overflow_mode", "join_use_nulls", b"join_use_nulls", "joined_subquery_requires_alias", b"joined_subquery_requires_alias", "load_balancing", b"load_balancing", "local_filesystem_read_method", b"local_filesystem_read_method", "log_processors_profiles", b"log_processors_profiles", "log_queries_probability", b"log_queries_probability", "log_query_threads", b"log_query_threads", "log_query_views", b"log_query_views", "low_cardinality_allow_in_native_format", b"low_cardinality_allow_in_native_format", "max_ast_depth", b"max_ast_depth", "max_ast_elements", b"max_ast_elements", "max_block_size", b"max_block_size", "max_bytes_before_external_group_by", b"max_bytes_before_external_group_by", "max_bytes_before_external_sort", b"max_bytes_before_external_sort", "max_bytes_in_distinct", b"max_bytes_in_distinct", "max_bytes_in_join", b"max_bytes_in_join", "max_bytes_in_set", b"max_bytes_in_set", "max_bytes_to_read", b"max_bytes_to_read", "max_bytes_to_sort", b"max_bytes_to_sort", "max_bytes_to_transfer", b"max_bytes_to_transfer", "max_columns_to_read", b"max_columns_to_read", "max_concurrent_queries_for_user", b"max_concurrent_queries_for_user", "max_execution_time", b"max_execution_time", "max_expanded_ast_elements", b"max_expanded_ast_elements", "max_final_threads", b"max_final_threads", "max_http_get_redirects", b"max_http_get_redirects", "max_insert_block_size", b"max_insert_block_size", "max_insert_threads", b"max_insert_threads", "max_memory_usage", b"max_memory_usage", "max_memory_usage_for_user", b"max_memory_usage_for_user", "max_network_bandwidth", b"max_network_bandwidth", "max_network_bandwidth_for_user", b"max_network_bandwidth_for_user", "max_parser_depth", b"max_parser_depth", "max_partitions_per_insert_block", b"max_partitions_per_insert_block", "max_query_size", b"max_query_size", "max_read_buffer_size", b"max_read_buffer_size", "max_replica_delay_for_distributed_queries", b"max_replica_delay_for_distributed_queries", "max_result_bytes", b"max_result_bytes", "max_result_rows", b"max_result_rows", "max_rows_in_distinct", b"max_rows_in_distinct", "max_rows_in_join", b"max_rows_in_join", "max_rows_in_set", b"max_rows_in_set", "max_rows_to_group_by", b"max_rows_to_group_by", "max_rows_to_read", b"max_rows_to_read", "max_rows_to_sort", b"max_rows_to_sort", "max_rows_to_transfer", b"max_rows_to_transfer", "max_temporary_columns", b"max_temporary_columns", "max_temporary_data_on_disk_size_for_query", b"max_temporary_data_on_disk_size_for_query", "max_temporary_data_on_disk_size_for_user", b"max_temporary_data_on_disk_size_for_user", "max_temporary_non_const_columns", b"max_temporary_non_const_columns", "max_threads", b"max_threads", "memory_overcommit_ratio_denominator", b"memory_overcommit_ratio_denominator", "memory_overcommit_ratio_denominator_for_user", b"memory_overcommit_ratio_denominator_for_user", "memory_profiler_sample_probability", b"memory_profiler_sample_probability", "memory_profiler_step", b"memory_profiler_step", "memory_usage_overcommit_max_wait_microseconds", b"memory_usage_overcommit_max_wait_microseconds", "merge_tree_max_bytes_to_use_cache", b"merge_tree_max_bytes_to_use_cache", "merge_tree_max_rows_to_use_cache", b"merge_tree_max_rows_to_use_cache", "merge_tree_min_bytes_for_concurrent_read", b"merge_tree_min_bytes_for_concurrent_read", "merge_tree_min_rows_for_concurrent_read", b"merge_tree_min_rows_for_concurrent_read", "min_bytes_to_use_direct_io", b"min_bytes_to_use_direct_io", "min_count_to_compile", b"min_count_to_compile", "min_count_to_compile_expression", b"min_count_to_compile_expression", "min_execution_speed", b"min_execution_speed", "min_execution_speed_bytes", b"min_execution_speed_bytes", "min_insert_block_size_bytes", b"min_insert_block_size_bytes", "min_insert_block_size_rows", b"min_insert_block_size_rows", "output_format_json_quote_64bit_integers", b"output_format_json_quote_64bit_integers", "output_format_json_quote_denormals", b"output_format_json_quote_denormals", "prefer_localhost_replica", b"prefer_localhost_replica", "priority", b"priority", "query_cache_max_entries", b"query_cache_max_entries", "query_cache_max_size_in_bytes", b"query_cache_max_size_in_bytes", "query_cache_min_query_duration", b"query_cache_min_query_duration", "query_cache_min_query_runs", b"query_cache_min_query_runs", "query_cache_nondeterministic_function_handling", b"query_cache_nondeterministic_function_handling", "query_cache_share_between_users", b"query_cache_share_between_users", "query_cache_system_table_handling", b"query_cache_system_table_handling", "query_cache_tag", b"query_cache_tag", "query_cache_ttl", b"query_cache_ttl", "quota_mode", b"quota_mode", "read_overflow_mode", b"read_overflow_mode", "readonly", b"readonly", "receive_timeout", b"receive_timeout", "remote_filesystem_read_method", b"remote_filesystem_read_method", "replication_alter_partitions_sync", b"replication_alter_partitions_sync", "result_overflow_mode", b"result_overflow_mode", "s3_use_adaptive_timeouts", b"s3_use_adaptive_timeouts", "select_sequential_consistency", b"select_sequential_consistency", "send_progress_in_http_headers", b"send_progress_in_http_headers", "send_timeout", b"send_timeout", "set_overflow_mode", b"set_overflow_mode", "skip_unavailable_shards", b"skip_unavailable_shards", "sort_overflow_mode", b"sort_overflow_mode", "timeout_before_checking_execution_speed", b"timeout_before_checking_execution_speed", "timeout_overflow_mode", b"timeout_overflow_mode", "transfer_overflow_mode", b"transfer_overflow_mode", "transform_null_in", b"transform_null_in", "use_hedged_requests", b"use_hedged_requests", "use_query_cache", b"use_query_cache", "use_uncompressed_cache", b"use_uncompressed_cache", "wait_for_async_insert", b"wait_for_async_insert", "wait_for_async_insert_timeout", b"wait_for_async_insert_timeout"]) -> None: ...
|
|
1992
2394
|
|
|
1993
2395
|
global___UserSettings = UserSettings
|
|
1994
2396
|
|
|
1995
2397
|
@typing.final
|
|
1996
2398
|
class UserQuota(google.protobuf.message.Message):
|
|
1997
2399
|
"""ClickHouse quota representation. Each quota associated with an user and limits it resource usage for an interval.
|
|
1998
|
-
|
|
2400
|
+
For details, see [ClickHouse documentation](https://clickhouse.com/docs/operations/quotas/).
|
|
1999
2401
|
"""
|
|
2000
2402
|
|
|
2001
2403
|
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
@@ -2008,39 +2410,27 @@ class UserQuota(google.protobuf.message.Message):
|
|
|
2008
2410
|
EXECUTION_TIME_FIELD_NUMBER: builtins.int
|
|
2009
2411
|
@property
|
|
2010
2412
|
def interval_duration(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2011
|
-
"""Duration of interval for quota in milliseconds.
|
|
2012
|
-
Minimal value is 1 second.
|
|
2013
|
-
"""
|
|
2413
|
+
"""Duration of interval for quota in milliseconds."""
|
|
2014
2414
|
|
|
2015
2415
|
@property
|
|
2016
2416
|
def queries(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2017
|
-
"""The total number of queries.
|
|
2018
|
-
0 - unlimited.
|
|
2019
|
-
"""
|
|
2417
|
+
"""The total number of queries. **0** means unlimited."""
|
|
2020
2418
|
|
|
2021
2419
|
@property
|
|
2022
2420
|
def errors(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2023
|
-
"""The number of queries that threw exception.
|
|
2024
|
-
0 - unlimited.
|
|
2025
|
-
"""
|
|
2421
|
+
"""The number of queries that threw exception. **0** means unlimited."""
|
|
2026
2422
|
|
|
2027
2423
|
@property
|
|
2028
2424
|
def result_rows(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2029
|
-
"""The total number of rows given as the result
|
|
2030
|
-
0 - unlimited.
|
|
2031
|
-
"""
|
|
2425
|
+
"""The total number of rows given as the result. **0** means unlimited."""
|
|
2032
2426
|
|
|
2033
2427
|
@property
|
|
2034
2428
|
def read_rows(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2035
|
-
"""The total number of source rows read from tables for running the query, on all remote servers.
|
|
2036
|
-
0 - unlimited.
|
|
2037
|
-
"""
|
|
2429
|
+
"""The total number of source rows read from tables for running the query, on all remote servers. **0** means unlimited."""
|
|
2038
2430
|
|
|
2039
2431
|
@property
|
|
2040
2432
|
def execution_time(self) -> google.protobuf.wrappers_pb2.Int64Value:
|
|
2041
|
-
"""The total query execution time, in milliseconds (wall time).
|
|
2042
|
-
0 - unlimited.
|
|
2043
|
-
"""
|
|
2433
|
+
"""The total query execution time, in milliseconds (wall time). **0** means unlimited."""
|
|
2044
2434
|
|
|
2045
2435
|
def __init__(
|
|
2046
2436
|
self,
|
|
@@ -2056,3 +2446,69 @@ class UserQuota(google.protobuf.message.Message):
|
|
|
2056
2446
|
def ClearField(self, field_name: typing.Literal["errors", b"errors", "execution_time", b"execution_time", "interval_duration", b"interval_duration", "queries", b"queries", "read_rows", b"read_rows", "result_rows", b"result_rows"]) -> None: ...
|
|
2057
2447
|
|
|
2058
2448
|
global___UserQuota = UserQuota
|
|
2449
|
+
|
|
2450
|
+
@typing.final
|
|
2451
|
+
class ConnectionManager(google.protobuf.message.Message):
|
|
2452
|
+
"""Connection Manager connection configuration."""
|
|
2453
|
+
|
|
2454
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
2455
|
+
|
|
2456
|
+
CONNECTION_ID_FIELD_NUMBER: builtins.int
|
|
2457
|
+
connection_id: builtins.str
|
|
2458
|
+
"""ID of Connection Manager connection."""
|
|
2459
|
+
def __init__(
|
|
2460
|
+
self,
|
|
2461
|
+
*,
|
|
2462
|
+
connection_id: builtins.str = ...,
|
|
2463
|
+
) -> None: ...
|
|
2464
|
+
def ClearField(self, field_name: typing.Literal["connection_id", b"connection_id"]) -> None: ...
|
|
2465
|
+
|
|
2466
|
+
global___ConnectionManager = ConnectionManager
|
|
2467
|
+
|
|
2468
|
+
@typing.final
|
|
2469
|
+
class UserSpec(google.protobuf.message.Message):
|
|
2470
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
2471
|
+
|
|
2472
|
+
NAME_FIELD_NUMBER: builtins.int
|
|
2473
|
+
PASSWORD_FIELD_NUMBER: builtins.int
|
|
2474
|
+
GENERATE_PASSWORD_FIELD_NUMBER: builtins.int
|
|
2475
|
+
PERMISSIONS_FIELD_NUMBER: builtins.int
|
|
2476
|
+
SETTINGS_FIELD_NUMBER: builtins.int
|
|
2477
|
+
QUOTAS_FIELD_NUMBER: builtins.int
|
|
2478
|
+
name: builtins.str
|
|
2479
|
+
"""User name."""
|
|
2480
|
+
password: builtins.str
|
|
2481
|
+
"""User password."""
|
|
2482
|
+
@property
|
|
2483
|
+
def generate_password(self) -> google.protobuf.wrappers_pb2.BoolValue:
|
|
2484
|
+
"""Enable or disable password generation using Connection Manager.
|
|
2485
|
+
|
|
2486
|
+
Default value: **false**.
|
|
2487
|
+
"""
|
|
2488
|
+
|
|
2489
|
+
@property
|
|
2490
|
+
def permissions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Permission]:
|
|
2491
|
+
"""Set of permissions to grant to the user. If not set, it's granted permissions to access all databases."""
|
|
2492
|
+
|
|
2493
|
+
@property
|
|
2494
|
+
def settings(self) -> global___UserSettings:
|
|
2495
|
+
"""User settings"""
|
|
2496
|
+
|
|
2497
|
+
@property
|
|
2498
|
+
def quotas(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UserQuota]:
|
|
2499
|
+
"""Quotas assigned to the user."""
|
|
2500
|
+
|
|
2501
|
+
def __init__(
|
|
2502
|
+
self,
|
|
2503
|
+
*,
|
|
2504
|
+
name: builtins.str = ...,
|
|
2505
|
+
password: builtins.str = ...,
|
|
2506
|
+
generate_password: google.protobuf.wrappers_pb2.BoolValue | None = ...,
|
|
2507
|
+
permissions: collections.abc.Iterable[global___Permission] | None = ...,
|
|
2508
|
+
settings: global___UserSettings | None = ...,
|
|
2509
|
+
quotas: collections.abc.Iterable[global___UserQuota] | None = ...,
|
|
2510
|
+
) -> None: ...
|
|
2511
|
+
def HasField(self, field_name: typing.Literal["generate_password", b"generate_password", "settings", b"settings"]) -> builtins.bool: ...
|
|
2512
|
+
def ClearField(self, field_name: typing.Literal["generate_password", b"generate_password", "name", b"name", "password", b"password", "permissions", b"permissions", "quotas", b"quotas", "settings", b"settings"]) -> None: ...
|
|
2513
|
+
|
|
2514
|
+
global___UserSpec = UserSpec
|