Yandex v0.13.0, Feb 22 22

Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

yandex.getMdbClickhouseCluster

Explore with Pulumi AI

Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetMdbClickhouseCluster.InvokeAsync(new Yandex.GetMdbClickhouseClusterArgs
        {
            Name = "test",
        }));
        this.NetworkId = foo.Apply(foo => foo.NetworkId);
    }

    [Output("networkId")]
    public Output<string> NetworkId { get; set; }
}

package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "test"
		foo, err := yandex.LookupMdbClickhouseCluster(ctx, &GetMdbClickhouseClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkId", foo.NetworkId)
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const foo = pulumi.output(yandex.getMdbClickhouseCluster({
    name: "test",
}));

export const networkId = foo.networkId;

import pulumi
import pulumi_yandex as yandex

foo = yandex.get_mdb_clickhouse_cluster(name="test")
pulumi.export("networkId", foo.network_id)

Coming soon!

Using getMdbClickhouseCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getMdbClickhouseCluster(args: GetMdbClickhouseClusterArgs, opts?: InvokeOptions): Promise<GetMdbClickhouseClusterResult>
function getMdbClickhouseClusterOutput(args: GetMdbClickhouseClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbClickhouseClusterResult>

def get_mdb_clickhouse_cluster(cloud_storage: Optional[GetMdbClickhouseClusterCloudStorage] = None,
                               cluster_id: Optional[str] = None,
                               deletion_protection: Optional[bool] = None,
                               folder_id: Optional[str] = None,
                               name: Optional[str] = None,
                               service_account_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetMdbClickhouseClusterResult
def get_mdb_clickhouse_cluster_output(cloud_storage: Optional[pulumi.Input[GetMdbClickhouseClusterCloudStorageArgs]] = None,
                               cluster_id: Optional[pulumi.Input[str]] = None,
                               deletion_protection: Optional[pulumi.Input[bool]] = None,
                               folder_id: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               service_account_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetMdbClickhouseClusterResult]

func LookupMdbClickhouseCluster(ctx *Context, args *LookupMdbClickhouseClusterArgs, opts ...InvokeOption) (*LookupMdbClickhouseClusterResult, error)
func LookupMdbClickhouseClusterOutput(ctx *Context, args *LookupMdbClickhouseClusterOutputArgs, opts ...InvokeOption) LookupMdbClickhouseClusterResultOutput

> Note: This function is named LookupMdbClickhouseCluster in the Go SDK.

public static class GetMdbClickhouseCluster 
{
    public static Task<GetMdbClickhouseClusterResult> InvokeAsync(GetMdbClickhouseClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbClickhouseClusterResult> Invoke(GetMdbClickhouseClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMdbClickhouseClusterResult> getMdbClickhouseCluster(GetMdbClickhouseClusterArgs args, InvokeOptions options)
public static Output<GetMdbClickhouseClusterResult> getMdbClickhouseCluster(GetMdbClickhouseClusterArgs args, InvokeOptions options)

fn::invoke:
  function: yandex:index/getMdbClickhouseCluster:getMdbClickhouseCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

CloudStorage GetMdbClickhouseClusterCloudStorage
ClusterId string: The ID of the ClickHouse cluster.
DeletionProtection bool
FolderId string: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Name string: The name of the ClickHouse cluster.
ServiceAccountId string

CloudStorage GetMdbClickhouseClusterCloudStorage
ClusterId string: The ID of the ClickHouse cluster.
DeletionProtection bool
FolderId string: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Name string: The name of the ClickHouse cluster.
ServiceAccountId string

cloudStorage GetMdbClickhouseClusterCloudStorage
clusterId String: The ID of the ClickHouse cluster.
deletionProtection Boolean
folderId String: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name String: The name of the ClickHouse cluster.
serviceAccountId String

cloudStorage GetMdbClickhouseClusterCloudStorage
clusterId string: The ID of the ClickHouse cluster.
deletionProtection boolean
folderId string: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name string: The name of the ClickHouse cluster.
serviceAccountId string

cloud_storage GetMdbClickhouseClusterCloudStorage
cluster_id str: The ID of the ClickHouse cluster.
deletion_protection bool
folder_id str: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name str: The name of the ClickHouse cluster.
service_account_id str

cloudStorage Property Map
clusterId String: The ID of the ClickHouse cluster.
deletionProtection Boolean
folderId String: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name String: The name of the ClickHouse cluster.
serviceAccountId String

getMdbClickhouseCluster Result

The following output properties are available:

Accesses List<GetMdbClickhouseClusterAccess>: Access policy to the ClickHouse cluster. The structure is documented below.
BackupWindowStarts List<GetMdbClickhouseClusterBackupWindowStart>: Time to start the daily backup, in the UTC timezone. The structure is documented below.
Clickhouses List<GetMdbClickhouseClusterClickhouse>: Configuration of the ClickHouse subcluster. The structure is documented below.
ClusterId string
CreatedAt string: Creation timestamp of the key.
Databases List<GetMdbClickhouseClusterDatabase>: A database of the ClickHouse cluster. The structure is documented below.
DeletionProtection bool
Description string: Description of the shard group.
Environment string: Deployment environment of the ClickHouse cluster.
FolderId string
FormatSchemas List<GetMdbClickhouseClusterFormatSchema>: A set of protobuf or cap'n proto format schemas. The structure is documented below.
Health string: Aggregated health of the cluster.
Hosts List<GetMdbClickhouseClusterHost>: A host of the ClickHouse cluster. The structure is documented below.
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>: A set of key/value label pairs to assign to the ClickHouse cluster.
MaintenanceWindows List<GetMdbClickhouseClusterMaintenanceWindow>
MlModels List<GetMdbClickhouseClusterMlModel>: A group of machine learning models. The structure is documented below.
Name string: Graphite rollup configuration name.
NetworkId string: ID of the network, to which the ClickHouse cluster belongs.
SecurityGroupIds List<string>: A set of ids of security groups assigned to hosts of the cluster.
ServiceAccountId string
ShardGroups List<GetMdbClickhouseClusterShardGroup>: A group of clickhouse shards. The structure is documented below.
SqlDatabaseManagement bool: Grants admin user database management permission.
SqlUserManagement bool: Enables admin user with user management permission.
Status string: Status of the cluster.
Users List<GetMdbClickhouseClusterUser>: A user of the ClickHouse cluster. The structure is documented below.
Version string
Zookeepers List<GetMdbClickhouseClusterZookeeper>: Configuration of the ZooKeeper subcluster. The structure is documented below.
CloudStorage GetMdbClickhouseClusterCloudStorage

Accesses []GetMdbClickhouseClusterAccess: Access policy to the ClickHouse cluster. The structure is documented below.
BackupWindowStarts []GetMdbClickhouseClusterBackupWindowStart: Time to start the daily backup, in the UTC timezone. The structure is documented below.
Clickhouses []GetMdbClickhouseClusterClickhouse: Configuration of the ClickHouse subcluster. The structure is documented below.
ClusterId string
CreatedAt string: Creation timestamp of the key.
Databases []GetMdbClickhouseClusterDatabase: A database of the ClickHouse cluster. The structure is documented below.
DeletionProtection bool
Description string: Description of the shard group.
Environment string: Deployment environment of the ClickHouse cluster.
FolderId string
FormatSchemas []GetMdbClickhouseClusterFormatSchema: A set of protobuf or cap'n proto format schemas. The structure is documented below.
Health string: Aggregated health of the cluster.
Hosts []GetMdbClickhouseClusterHost: A host of the ClickHouse cluster. The structure is documented below.
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]string: A set of key/value label pairs to assign to the ClickHouse cluster.
MaintenanceWindows []GetMdbClickhouseClusterMaintenanceWindow
MlModels []GetMdbClickhouseClusterMlModel: A group of machine learning models. The structure is documented below.
Name string: Graphite rollup configuration name.
NetworkId string: ID of the network, to which the ClickHouse cluster belongs.
SecurityGroupIds []string: A set of ids of security groups assigned to hosts of the cluster.
ServiceAccountId string
ShardGroups []GetMdbClickhouseClusterShardGroup: A group of clickhouse shards. The structure is documented below.
SqlDatabaseManagement bool: Grants admin user database management permission.
SqlUserManagement bool: Enables admin user with user management permission.
Status string: Status of the cluster.
Users []GetMdbClickhouseClusterUser: A user of the ClickHouse cluster. The structure is documented below.
Version string
Zookeepers []GetMdbClickhouseClusterZookeeper: Configuration of the ZooKeeper subcluster. The structure is documented below.
CloudStorage GetMdbClickhouseClusterCloudStorage

accesses List<GetMdbClickhouseClusterAccess>: Access policy to the ClickHouse cluster. The structure is documented below.
backupWindowStarts List<GetMdbClickhouseClusterBackupWindowStart>: Time to start the daily backup, in the UTC timezone. The structure is documented below.
clickhouses List<GetMdbClickhouseClusterClickhouse>: Configuration of the ClickHouse subcluster. The structure is documented below.
clusterId String
createdAt String: Creation timestamp of the key.
databases List<GetMdbClickhouseClusterDatabase>: A database of the ClickHouse cluster. The structure is documented below.
deletionProtection Boolean
description String: Description of the shard group.
environment String: Deployment environment of the ClickHouse cluster.
folderId String
formatSchemas List<GetMdbClickhouseClusterFormatSchema>: A set of protobuf or cap'n proto format schemas. The structure is documented below.
health String: Aggregated health of the cluster.
hosts List<GetMdbClickhouseClusterHost>: A host of the ClickHouse cluster. The structure is documented below.
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,String>: A set of key/value label pairs to assign to the ClickHouse cluster.
maintenanceWindows List<GetMdbClickhouseClusterMaintenanceWindow>
mlModels List<GetMdbClickhouseClusterMlModel>: A group of machine learning models. The structure is documented below.
name String: Graphite rollup configuration name.
networkId String: ID of the network, to which the ClickHouse cluster belongs.
securityGroupIds List<String>: A set of ids of security groups assigned to hosts of the cluster.
serviceAccountId String
shardGroups List<GetMdbClickhouseClusterShardGroup>: A group of clickhouse shards. The structure is documented below.
sqlDatabaseManagement Boolean: Grants admin user database management permission.
sqlUserManagement Boolean: Enables admin user with user management permission.
status String: Status of the cluster.
users List<GetMdbClickhouseClusterUser>: A user of the ClickHouse cluster. The structure is documented below.
version String
zookeepers List<GetMdbClickhouseClusterZookeeper>: Configuration of the ZooKeeper subcluster. The structure is documented below.
cloudStorage GetMdbClickhouseClusterCloudStorage

accesses GetMdbClickhouseClusterAccess[]: Access policy to the ClickHouse cluster. The structure is documented below.
backupWindowStarts GetMdbClickhouseClusterBackupWindowStart[]: Time to start the daily backup, in the UTC timezone. The structure is documented below.
clickhouses GetMdbClickhouseClusterClickhouse[]: Configuration of the ClickHouse subcluster. The structure is documented below.
clusterId string
createdAt string: Creation timestamp of the key.
databases GetMdbClickhouseClusterDatabase[]: A database of the ClickHouse cluster. The structure is documented below.
deletionProtection boolean
description string: Description of the shard group.
environment string: Deployment environment of the ClickHouse cluster.
folderId string
formatSchemas GetMdbClickhouseClusterFormatSchema[]: A set of protobuf or cap'n proto format schemas. The structure is documented below.
health string: Aggregated health of the cluster.
hosts GetMdbClickhouseClusterHost[]: A host of the ClickHouse cluster. The structure is documented below.
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}: A set of key/value label pairs to assign to the ClickHouse cluster.
maintenanceWindows GetMdbClickhouseClusterMaintenanceWindow[]
mlModels GetMdbClickhouseClusterMlModel[]: A group of machine learning models. The structure is documented below.
name string: Graphite rollup configuration name.
networkId string: ID of the network, to which the ClickHouse cluster belongs.
securityGroupIds string[]: A set of ids of security groups assigned to hosts of the cluster.
serviceAccountId string
shardGroups GetMdbClickhouseClusterShardGroup[]: A group of clickhouse shards. The structure is documented below.
sqlDatabaseManagement boolean: Grants admin user database management permission.
sqlUserManagement boolean: Enables admin user with user management permission.
status string: Status of the cluster.
users GetMdbClickhouseClusterUser[]: A user of the ClickHouse cluster. The structure is documented below.
version string
zookeepers GetMdbClickhouseClusterZookeeper[]: Configuration of the ZooKeeper subcluster. The structure is documented below.
cloudStorage GetMdbClickhouseClusterCloudStorage

accesses Sequence[GetMdbClickhouseClusterAccess]: Access policy to the ClickHouse cluster. The structure is documented below.
backup_window_starts Sequence[GetMdbClickhouseClusterBackupWindowStart]: Time to start the daily backup, in the UTC timezone. The structure is documented below.
clickhouses Sequence[GetMdbClickhouseClusterClickhouse]: Configuration of the ClickHouse subcluster. The structure is documented below.
cluster_id str
created_at str: Creation timestamp of the key.
databases Sequence[GetMdbClickhouseClusterDatabase]: A database of the ClickHouse cluster. The structure is documented below.
deletion_protection bool
description str: Description of the shard group.
environment str: Deployment environment of the ClickHouse cluster.
folder_id str
format_schemas Sequence[GetMdbClickhouseClusterFormatSchema]: A set of protobuf or cap'n proto format schemas. The structure is documented below.
health str: Aggregated health of the cluster.
hosts Sequence[GetMdbClickhouseClusterHost]: A host of the ClickHouse cluster. The structure is documented below.
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]: A set of key/value label pairs to assign to the ClickHouse cluster.
maintenance_windows Sequence[GetMdbClickhouseClusterMaintenanceWindow]
ml_models Sequence[GetMdbClickhouseClusterMlModel]: A group of machine learning models. The structure is documented below.
name str: Graphite rollup configuration name.
network_id str: ID of the network, to which the ClickHouse cluster belongs.
security_group_ids Sequence[str]: A set of ids of security groups assigned to hosts of the cluster.
service_account_id str
shard_groups Sequence[GetMdbClickhouseClusterShardGroup]: A group of clickhouse shards. The structure is documented below.
sql_database_management bool: Grants admin user database management permission.
sql_user_management bool: Enables admin user with user management permission.
status str: Status of the cluster.
users Sequence[GetMdbClickhouseClusterUser]: A user of the ClickHouse cluster. The structure is documented below.
version str
zookeepers Sequence[GetMdbClickhouseClusterZookeeper]: Configuration of the ZooKeeper subcluster. The structure is documented below.
cloud_storage GetMdbClickhouseClusterCloudStorage

accesses List<Property Map>: Access policy to the ClickHouse cluster. The structure is documented below.
backupWindowStarts List<Property Map>: Time to start the daily backup, in the UTC timezone. The structure is documented below.
clickhouses List<Property Map>: Configuration of the ClickHouse subcluster. The structure is documented below.
clusterId String
createdAt String: Creation timestamp of the key.
databases List<Property Map>: A database of the ClickHouse cluster. The structure is documented below.
deletionProtection Boolean
description String: Description of the shard group.
environment String: Deployment environment of the ClickHouse cluster.
folderId String
formatSchemas List<Property Map>: A set of protobuf or cap'n proto format schemas. The structure is documented below.
health String: Aggregated health of the cluster.
hosts List<Property Map>: A host of the ClickHouse cluster. The structure is documented below.
id String: The provider-assigned unique ID for this managed resource.
labels Map<String>: A set of key/value label pairs to assign to the ClickHouse cluster.
maintenanceWindows List<Property Map>
mlModels List<Property Map>: A group of machine learning models. The structure is documented below.
name String: Graphite rollup configuration name.
networkId String: ID of the network, to which the ClickHouse cluster belongs.
securityGroupIds List<String>: A set of ids of security groups assigned to hosts of the cluster.
serviceAccountId String
shardGroups List<Property Map>: A group of clickhouse shards. The structure is documented below.
sqlDatabaseManagement Boolean: Grants admin user database management permission.
sqlUserManagement Boolean: Enables admin user with user management permission.
status String: Status of the cluster.
users List<Property Map>: A user of the ClickHouse cluster. The structure is documented below.
version String
zookeepers List<Property Map>: Configuration of the ZooKeeper subcluster. The structure is documented below.
cloudStorage Property Map

Supporting Types

GetMdbClickhouseClusterAccess

DataLens bool: Allow access for Web SQL.
Metrika bool: Allow access for Yandex.Metrika.
Serverless bool: Allow access for Serverless.
WebSql bool: Allow access for DataLens.

DataLens bool: Allow access for Web SQL.
Metrika bool: Allow access for Yandex.Metrika.
Serverless bool: Allow access for Serverless.
WebSql bool: Allow access for DataLens.

dataLens Boolean: Allow access for Web SQL.
metrika Boolean: Allow access for Yandex.Metrika.
serverless Boolean: Allow access for Serverless.
webSql Boolean: Allow access for DataLens.

dataLens boolean: Allow access for Web SQL.
metrika boolean: Allow access for Yandex.Metrika.
serverless boolean: Allow access for Serverless.
webSql boolean: Allow access for DataLens.

data_lens bool: Allow access for Web SQL.
metrika bool: Allow access for Yandex.Metrika.
serverless bool: Allow access for Serverless.
web_sql bool: Allow access for DataLens.

dataLens Boolean: Allow access for Web SQL.
metrika Boolean: Allow access for Yandex.Metrika.
serverless Boolean: Allow access for Serverless.
webSql Boolean: Allow access for DataLens.

GetMdbClickhouseClusterBackupWindowStart

Hours int: The hour at which backup will be started.
Minutes int: The minute at which backup will be started.

Hours int: The hour at which backup will be started.
Minutes int: The minute at which backup will be started.

hours Integer: The hour at which backup will be started.
minutes Integer: The minute at which backup will be started.

hours number: The hour at which backup will be started.
minutes number: The minute at which backup will be started.

hours int: The hour at which backup will be started.
minutes int: The minute at which backup will be started.

hours Number: The hour at which backup will be started.
minutes Number: The minute at which backup will be started.

GetMdbClickhouseClusterClickhouse

Config GetMdbClickhouseClusterClickhouseConfig: Main ClickHouse cluster configuration. The structure is documented below.
Resources List<GetMdbClickhouseClusterClickhouseResource>: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

Config GetMdbClickhouseClusterClickhouseConfig: Main ClickHouse cluster configuration. The structure is documented below.
Resources []GetMdbClickhouseClusterClickhouseResource: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

config GetMdbClickhouseClusterClickhouseConfig: Main ClickHouse cluster configuration. The structure is documented below.
resources List<GetMdbClickhouseClusterClickhouseResource>: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

config GetMdbClickhouseClusterClickhouseConfig: Main ClickHouse cluster configuration. The structure is documented below.
resources GetMdbClickhouseClusterClickhouseResource[]: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

config GetMdbClickhouseClusterClickhouseConfig: Main ClickHouse cluster configuration. The structure is documented below.
resources Sequence[GetMdbClickhouseClusterClickhouseResource]: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

config Property Map: Main ClickHouse cluster configuration. The structure is documented below.
resources List<Property Map>: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

GetMdbClickhouseClusterClickhouseConfig

Kafkas List<GetMdbClickhouseClusterClickhouseConfigKafka>: Kafka connection configuration. The structure is documented below.
MergeTree GetMdbClickhouseClusterClickhouseConfigMergeTree: MergeTree engine configuration. The structure is documented below.
Rabbitmq GetMdbClickhouseClusterClickhouseConfigRabbitmq: RabbitMQ connection configuration. The structure is documented below.
BackgroundPoolSize int
BackgroundSchedulePoolSize int
Compressions List<GetMdbClickhouseClusterClickhouseConfigCompression>: Data compression configuration. The structure is documented below.
GeobaseUri string
GraphiteRollups List<GetMdbClickhouseClusterClickhouseConfigGraphiteRollup>: Graphite rollup configuration. The structure is documented below.
KafkaTopics List<GetMdbClickhouseClusterClickhouseConfigKafkaTopic>: Kafka topic connection configuration. The structure is documented below.
KeepAliveTimeout int
LogLevel string
MarkCacheSize int
MaxConcurrentQueries int
MaxConnections int
MaxPartitionSizeToDrop int
MaxTableSizeToDrop int
MetricLogEnabled bool
MetricLogRetentionSize int
MetricLogRetentionTime int
PartLogRetentionSize int
PartLogRetentionTime int
QueryLogRetentionSize int
QueryLogRetentionTime int
QueryThreadLogEnabled bool
QueryThreadLogRetentionSize int
QueryThreadLogRetentionTime int
TextLogEnabled bool
TextLogLevel string
TextLogRetentionSize int
TextLogRetentionTime int
Timezone string
TraceLogEnabled bool
TraceLogRetentionSize int
TraceLogRetentionTime int
UncompressedCacheSize int

Kafkas []GetMdbClickhouseClusterClickhouseConfigKafka: Kafka connection configuration. The structure is documented below.
MergeTree GetMdbClickhouseClusterClickhouseConfigMergeTree: MergeTree engine configuration. The structure is documented below.
Rabbitmq GetMdbClickhouseClusterClickhouseConfigRabbitmq: RabbitMQ connection configuration. The structure is documented below.
BackgroundPoolSize int
BackgroundSchedulePoolSize int
Compressions []GetMdbClickhouseClusterClickhouseConfigCompression: Data compression configuration. The structure is documented below.
GeobaseUri string
GraphiteRollups []GetMdbClickhouseClusterClickhouseConfigGraphiteRollup: Graphite rollup configuration. The structure is documented below.
KafkaTopics []GetMdbClickhouseClusterClickhouseConfigKafkaTopic: Kafka topic connection configuration. The structure is documented below.
KeepAliveTimeout int
LogLevel string
MarkCacheSize int
MaxConcurrentQueries int
MaxConnections int
MaxPartitionSizeToDrop int
MaxTableSizeToDrop int
MetricLogEnabled bool
MetricLogRetentionSize int
MetricLogRetentionTime int
PartLogRetentionSize int
PartLogRetentionTime int
QueryLogRetentionSize int
QueryLogRetentionTime int
QueryThreadLogEnabled bool
QueryThreadLogRetentionSize int
QueryThreadLogRetentionTime int
TextLogEnabled bool
TextLogLevel string
TextLogRetentionSize int
TextLogRetentionTime int
Timezone string
TraceLogEnabled bool
TraceLogRetentionSize int
TraceLogRetentionTime int
UncompressedCacheSize int

kafkas List<GetMdbClickhouseClusterClickhouseConfigKafka>: Kafka connection configuration. The structure is documented below.
mergeTree GetMdbClickhouseClusterClickhouseConfigMergeTree: MergeTree engine configuration. The structure is documented below.
rabbitmq GetMdbClickhouseClusterClickhouseConfigRabbitmq: RabbitMQ connection configuration. The structure is documented below.
backgroundPoolSize Integer
backgroundSchedulePoolSize Integer
compressions List<GetMdbClickhouseClusterClickhouseConfigCompression>: Data compression configuration. The structure is documented below.
geobaseUri String
graphiteRollups List<GetMdbClickhouseClusterClickhouseConfigGraphiteRollup>: Graphite rollup configuration. The structure is documented below.
kafkaTopics List<GetMdbClickhouseClusterClickhouseConfigKafkaTopic>: Kafka topic connection configuration. The structure is documented below.
keepAliveTimeout Integer
logLevel String
markCacheSize Integer
maxConcurrentQueries Integer
maxConnections Integer
maxPartitionSizeToDrop Integer
maxTableSizeToDrop Integer
metricLogEnabled Boolean
metricLogRetentionSize Integer
metricLogRetentionTime Integer
partLogRetentionSize Integer
partLogRetentionTime Integer
queryLogRetentionSize Integer
queryLogRetentionTime Integer
queryThreadLogEnabled Boolean
queryThreadLogRetentionSize Integer
queryThreadLogRetentionTime Integer
textLogEnabled Boolean
textLogLevel String
textLogRetentionSize Integer
textLogRetentionTime Integer
timezone String
traceLogEnabled Boolean
traceLogRetentionSize Integer
traceLogRetentionTime Integer
uncompressedCacheSize Integer

kafkas GetMdbClickhouseClusterClickhouseConfigKafka[]: Kafka connection configuration. The structure is documented below.
mergeTree GetMdbClickhouseClusterClickhouseConfigMergeTree: MergeTree engine configuration. The structure is documented below.
rabbitmq GetMdbClickhouseClusterClickhouseConfigRabbitmq: RabbitMQ connection configuration. The structure is documented below.
backgroundPoolSize number
backgroundSchedulePoolSize number
compressions GetMdbClickhouseClusterClickhouseConfigCompression[]: Data compression configuration. The structure is documented below.
geobaseUri string
graphiteRollups GetMdbClickhouseClusterClickhouseConfigGraphiteRollup[]: Graphite rollup configuration. The structure is documented below.
kafkaTopics GetMdbClickhouseClusterClickhouseConfigKafkaTopic[]: Kafka topic connection configuration. The structure is documented below.
keepAliveTimeout number
logLevel string
markCacheSize number
maxConcurrentQueries number
maxConnections number
maxPartitionSizeToDrop number
maxTableSizeToDrop number
metricLogEnabled boolean
metricLogRetentionSize number
metricLogRetentionTime number
partLogRetentionSize number
partLogRetentionTime number
queryLogRetentionSize number
queryLogRetentionTime number
queryThreadLogEnabled boolean
queryThreadLogRetentionSize number
queryThreadLogRetentionTime number
textLogEnabled boolean
textLogLevel string
textLogRetentionSize number
textLogRetentionTime number
timezone string
traceLogEnabled boolean
traceLogRetentionSize number
traceLogRetentionTime number
uncompressedCacheSize number

kafkas Sequence[GetMdbClickhouseClusterClickhouseConfigKafka]: Kafka connection configuration. The structure is documented below.
merge_tree GetMdbClickhouseClusterClickhouseConfigMergeTree: MergeTree engine configuration. The structure is documented below.
rabbitmq GetMdbClickhouseClusterClickhouseConfigRabbitmq: RabbitMQ connection configuration. The structure is documented below.
background_pool_size int
background_schedule_pool_size int
compressions Sequence[GetMdbClickhouseClusterClickhouseConfigCompression]: Data compression configuration. The structure is documented below.
geobase_uri str
graphite_rollups Sequence[GetMdbClickhouseClusterClickhouseConfigGraphiteRollup]: Graphite rollup configuration. The structure is documented below.
kafka_topics Sequence[GetMdbClickhouseClusterClickhouseConfigKafkaTopic]: Kafka topic connection configuration. The structure is documented below.
keep_alive_timeout int
log_level str
mark_cache_size int
max_concurrent_queries int
max_connections int
max_partition_size_to_drop int
max_table_size_to_drop int
metric_log_enabled bool
metric_log_retention_size int
metric_log_retention_time int
part_log_retention_size int
part_log_retention_time int
query_log_retention_size int
query_log_retention_time int
query_thread_log_enabled bool
query_thread_log_retention_size int
query_thread_log_retention_time int
text_log_enabled bool
text_log_level str
text_log_retention_size int
text_log_retention_time int
timezone str
trace_log_enabled bool
trace_log_retention_size int
trace_log_retention_time int
uncompressed_cache_size int

kafkas List<Property Map>: Kafka connection configuration. The structure is documented below.
mergeTree Property Map: MergeTree engine configuration. The structure is documented below.
rabbitmq Property Map: RabbitMQ connection configuration. The structure is documented below.
backgroundPoolSize Number
backgroundSchedulePoolSize Number
compressions List<Property Map>: Data compression configuration. The structure is documented below.
geobaseUri String
graphiteRollups List<Property Map>: Graphite rollup configuration. The structure is documented below.
kafkaTopics List<Property Map>: Kafka topic connection configuration. The structure is documented below.
keepAliveTimeout Number
logLevel String
markCacheSize Number
maxConcurrentQueries Number
maxConnections Number
maxPartitionSizeToDrop Number
maxTableSizeToDrop Number
metricLogEnabled Boolean
metricLogRetentionSize Number
metricLogRetentionTime Number
partLogRetentionSize Number
partLogRetentionTime Number
queryLogRetentionSize Number
queryLogRetentionTime Number
queryThreadLogEnabled Boolean
queryThreadLogRetentionSize Number
queryThreadLogRetentionTime Number
textLogEnabled Boolean
textLogLevel String
textLogRetentionSize Number
textLogRetentionTime Number
timezone String
traceLogEnabled Boolean
traceLogRetentionSize Number
traceLogRetentionTime Number
uncompressedCacheSize Number

GetMdbClickhouseClusterClickhouseConfigCompression

Method string: Method: Compression method. Two methods are available: LZ4 and zstd.
MinPartSize int: Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
MinPartSizeRatio double: Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

Method string: Method: Compression method. Two methods are available: LZ4 and zstd.
MinPartSize int: Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
MinPartSizeRatio float64: Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

method String: Method: Compression method. Two methods are available: LZ4 and zstd.
minPartSize Integer: Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
minPartSizeRatio Double: Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

method string: Method: Compression method. Two methods are available: LZ4 and zstd.
minPartSize number: Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
minPartSizeRatio number: Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

method str: Method: Compression method. Two methods are available: LZ4 and zstd.
min_part_size int: Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
min_part_size_ratio float: Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

method String: Method: Compression method. Two methods are available: LZ4 and zstd.
minPartSize Number: Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
minPartSizeRatio Number: Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

GetMdbClickhouseClusterClickhouseConfigGraphiteRollup

Name string: The name of the ClickHouse cluster.
Patterns List<GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern>: Set of thinning rules.

Name string: The name of the ClickHouse cluster.
Patterns []GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern: Set of thinning rules.

name String: The name of the ClickHouse cluster.
patterns List<GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern>: Set of thinning rules.

name string: The name of the ClickHouse cluster.
patterns GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern[]: Set of thinning rules.

name str: The name of the ClickHouse cluster.
patterns Sequence[GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern]: Set of thinning rules.

name String: The name of the ClickHouse cluster.
patterns List<Property Map>: Set of thinning rules.

GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern

Function string: Aggregation function name.
Regexp string: Regular expression that the metric name must match.
Retentions List<GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention>: Retain parameters.

Function string: Aggregation function name.
Regexp string: Regular expression that the metric name must match.
Retentions []GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention: Retain parameters.

function String: Aggregation function name.
regexp String: Regular expression that the metric name must match.
retentions List<GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention>: Retain parameters.

function string: Aggregation function name.
regexp string: Regular expression that the metric name must match.
retentions GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention[]: Retain parameters.

function str: Aggregation function name.
regexp str: Regular expression that the metric name must match.
retentions Sequence[GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention]: Retain parameters.

function String: Aggregation function name.
regexp String: Regular expression that the metric name must match.
retentions List<Property Map>: Retain parameters.

GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention

Age int: Minimum data age in seconds.
Precision int: Accuracy of determining the age of the data in seconds.

Age int: Minimum data age in seconds.
Precision int: Accuracy of determining the age of the data in seconds.

age Integer: Minimum data age in seconds.
precision Integer: Accuracy of determining the age of the data in seconds.

age number: Minimum data age in seconds.
precision number: Accuracy of determining the age of the data in seconds.

age int: Minimum data age in seconds.
precision int: Accuracy of determining the age of the data in seconds.

age Number: Minimum data age in seconds.
precision Number: Accuracy of determining the age of the data in seconds.

GetMdbClickhouseClusterClickhouseConfigKafka

SaslMechanism string: SASL mechanism used in kafka authentication.
SaslPassword string: User password on kafka server.
SaslUsername string: Username on kafka server.
SecurityProtocol string: Security protocol used to connect to kafka server.

SaslMechanism string: SASL mechanism used in kafka authentication.
SaslPassword string: User password on kafka server.
SaslUsername string: Username on kafka server.
SecurityProtocol string: Security protocol used to connect to kafka server.

saslMechanism String: SASL mechanism used in kafka authentication.
saslPassword String: User password on kafka server.
saslUsername String: Username on kafka server.
securityProtocol String: Security protocol used to connect to kafka server.

saslMechanism string: SASL mechanism used in kafka authentication.
saslPassword string: User password on kafka server.
saslUsername string: Username on kafka server.
securityProtocol string: Security protocol used to connect to kafka server.

sasl_mechanism str: SASL mechanism used in kafka authentication.
sasl_password str: User password on kafka server.
sasl_username str: Username on kafka server.
security_protocol str: Security protocol used to connect to kafka server.

saslMechanism String: SASL mechanism used in kafka authentication.
saslPassword String: User password on kafka server.
saslUsername String: Username on kafka server.
securityProtocol String: Security protocol used to connect to kafka server.

GetMdbClickhouseClusterClickhouseConfigKafkaTopic

Name string: The name of the ClickHouse cluster.
Settings GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings: Kafka connection settngs sanem as kafka block.

Name string: The name of the ClickHouse cluster.
Settings GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings: Kafka connection settngs sanem as kafka block.

name String: The name of the ClickHouse cluster.
settings GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings: Kafka connection settngs sanem as kafka block.

name string: The name of the ClickHouse cluster.
settings GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings: Kafka connection settngs sanem as kafka block.

name str: The name of the ClickHouse cluster.
settings GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings: Kafka connection settngs sanem as kafka block.

name String: The name of the ClickHouse cluster.
settings Property Map: Kafka connection settngs sanem as kafka block.

GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings

SaslMechanism string: SASL mechanism used in kafka authentication.
SaslPassword string: User password on kafka server.
SaslUsername string: Username on kafka server.
SecurityProtocol string: Security protocol used to connect to kafka server.

SaslMechanism string: SASL mechanism used in kafka authentication.
SaslPassword string: User password on kafka server.
SaslUsername string: Username on kafka server.
SecurityProtocol string: Security protocol used to connect to kafka server.

saslMechanism String: SASL mechanism used in kafka authentication.
saslPassword String: User password on kafka server.
saslUsername String: Username on kafka server.
securityProtocol String: Security protocol used to connect to kafka server.

saslMechanism string: SASL mechanism used in kafka authentication.
saslPassword string: User password on kafka server.
saslUsername string: Username on kafka server.
securityProtocol string: Security protocol used to connect to kafka server.

sasl_mechanism str: SASL mechanism used in kafka authentication.
sasl_password str: User password on kafka server.
sasl_username str: Username on kafka server.
security_protocol str: Security protocol used to connect to kafka server.

saslMechanism String: SASL mechanism used in kafka authentication.
saslPassword String: User password on kafka server.
saslUsername String: Username on kafka server.
securityProtocol String: Security protocol used to connect to kafka server.

GetMdbClickhouseClusterClickhouseConfigMergeTree

MaxBytesToMergeAtMinSpaceInPool int: Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
MaxReplicatedMergesInQueue int: Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
NumberOfFreeEntriesInPoolToLowerMaxSizeOfMerge int: Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
PartsToDelayInsert int: Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table.
PartsToThrowInsert int: Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
ReplicatedDeduplicationWindow int: Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
ReplicatedDeduplicationWindowSeconds int: Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones wil be deleted).

MaxBytesToMergeAtMinSpaceInPool int: Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
MaxReplicatedMergesInQueue int: Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
NumberOfFreeEntriesInPoolToLowerMaxSizeOfMerge int: Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
PartsToDelayInsert int: Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table.
PartsToThrowInsert int: Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
ReplicatedDeduplicationWindow int: Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
ReplicatedDeduplicationWindowSeconds int: Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones wil be deleted).

maxBytesToMergeAtMinSpaceInPool Integer: Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
maxReplicatedMergesInQueue Integer: Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge Integer: Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
partsToDelayInsert Integer: Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table.
partsToThrowInsert Integer: Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
replicatedDeduplicationWindow Integer: Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
replicatedDeduplicationWindowSeconds Integer: Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones wil be deleted).

maxBytesToMergeAtMinSpaceInPool number: Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
maxReplicatedMergesInQueue number: Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge number: Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
partsToDelayInsert number: Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table.
partsToThrowInsert number: Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
replicatedDeduplicationWindow number: Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
replicatedDeduplicationWindowSeconds number: Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones wil be deleted).

max_bytes_to_merge_at_min_space_in_pool int: Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
max_replicated_merges_in_queue int: Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
number_of_free_entries_in_pool_to_lower_max_size_of_merge int: Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
parts_to_delay_insert int: Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table.
parts_to_throw_insert int: Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
replicated_deduplication_window int: Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
replicated_deduplication_window_seconds int: Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones wil be deleted).

maxBytesToMergeAtMinSpaceInPool Number: Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
maxReplicatedMergesInQueue Number: Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge Number: Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
partsToDelayInsert Number: Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table.
partsToThrowInsert Number: Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
replicatedDeduplicationWindow Number: Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
replicatedDeduplicationWindowSeconds Number: Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones wil be deleted).

GetMdbClickhouseClusterClickhouseConfigRabbitmq

Password string: RabbitMQ user password.
Username string: RabbitMQ username.

Password string: RabbitMQ user password.
Username string: RabbitMQ username.

password String: RabbitMQ user password.
username String: RabbitMQ username.

password string: RabbitMQ user password.
username string: RabbitMQ username.

password str: RabbitMQ user password.
username str: RabbitMQ username.

password String: RabbitMQ user password.
username String: RabbitMQ username.

GetMdbClickhouseClusterClickhouseResource

DiskSize int: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
DiskTypeId string: Type of the storage of ClickHouse or ZooKeeper hosts.
ResourcePresetId string

DiskSize int: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
DiskTypeId string: Type of the storage of ClickHouse or ZooKeeper hosts.
ResourcePresetId string

diskSize Integer: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
diskTypeId String: Type of the storage of ClickHouse or ZooKeeper hosts.
resourcePresetId String

diskSize number: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
diskTypeId string: Type of the storage of ClickHouse or ZooKeeper hosts.
resourcePresetId string

disk_size int: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
disk_type_id str: Type of the storage of ClickHouse or ZooKeeper hosts.
resource_preset_id str

diskSize Number: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
diskTypeId String: Type of the storage of ClickHouse or ZooKeeper hosts.
resourcePresetId String

GetMdbClickhouseClusterCloudStorage

Enabled bool: (Required) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

Enabled bool: (Required) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

enabled Boolean: (Required) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

enabled boolean: (Required) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

enabled bool: (Required) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

enabled Boolean: (Required) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

GetMdbClickhouseClusterDatabase

Name string: The name of the ClickHouse cluster.

Name string: The name of the ClickHouse cluster.

name String: The name of the ClickHouse cluster.

name string: The name of the ClickHouse cluster.

name str: The name of the ClickHouse cluster.

name String: The name of the ClickHouse cluster.

GetMdbClickhouseClusterFormatSchema

Name string: The name of the ClickHouse cluster.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
Uri string: Model file URL. You can only use models stored in Yandex Object Storage.

Name string: The name of the ClickHouse cluster.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
Uri string: Model file URL. You can only use models stored in Yandex Object Storage.

name String: The name of the ClickHouse cluster.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri String: Model file URL. You can only use models stored in Yandex Object Storage.

name string: The name of the ClickHouse cluster.
type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri string: Model file URL. You can only use models stored in Yandex Object Storage.

name str: The name of the ClickHouse cluster.
type str: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri str: Model file URL. You can only use models stored in Yandex Object Storage.

name String: The name of the ClickHouse cluster.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri String: Model file URL. You can only use models stored in Yandex Object Storage.

GetMdbClickhouseClusterHost

AssignPublicIp bool: Sets whether the host should get a public IP address on creation.
Fqdn string: The fully qualified domain name of the host.
ShardName string: The name of the shard to which the host belongs.
SubnetId string: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
Zone string: The availability zone where the ClickHouse host will be created.

AssignPublicIp bool: Sets whether the host should get a public IP address on creation.
Fqdn string: The fully qualified domain name of the host.
ShardName string: The name of the shard to which the host belongs.
SubnetId string: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
Zone string: The availability zone where the ClickHouse host will be created.

assignPublicIp Boolean: Sets whether the host should get a public IP address on creation.
fqdn String: The fully qualified domain name of the host.
shardName String: The name of the shard to which the host belongs.
subnetId String: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
zone String: The availability zone where the ClickHouse host will be created.

assignPublicIp boolean: Sets whether the host should get a public IP address on creation.
fqdn string: The fully qualified domain name of the host.
shardName string: The name of the shard to which the host belongs.
subnetId string: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
zone string: The availability zone where the ClickHouse host will be created.

assign_public_ip bool: Sets whether the host should get a public IP address on creation.
fqdn str: The fully qualified domain name of the host.
shard_name str: The name of the shard to which the host belongs.
subnet_id str: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
type str: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
zone str: The availability zone where the ClickHouse host will be created.

assignPublicIp Boolean: Sets whether the host should get a public IP address on creation.
fqdn String: The fully qualified domain name of the host.
shardName String: The name of the shard to which the host belongs.
subnetId String: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
zone String: The availability zone where the ClickHouse host will be created.

GetMdbClickhouseClusterMaintenanceWindow

Day string: Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
Hour int: Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

Day string: Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
Hour int: Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day String: Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
hour Integer: Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day string: Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
hour number: Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.
type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day str: Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
hour int: Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.
type str: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

day String: Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
hour Number: Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

GetMdbClickhouseClusterMlModel

Name string: The name of the ClickHouse cluster.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
Uri string: Model file URL. You can only use models stored in Yandex Object Storage.

Name string: The name of the ClickHouse cluster.
Type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
Uri string: Model file URL. You can only use models stored in Yandex Object Storage.

name String: The name of the ClickHouse cluster.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri String: Model file URL. You can only use models stored in Yandex Object Storage.

name string: The name of the ClickHouse cluster.
type string: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri string: Model file URL. You can only use models stored in Yandex Object Storage.

name str: The name of the ClickHouse cluster.
type str: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri str: Model file URL. You can only use models stored in Yandex Object Storage.

name String: The name of the ClickHouse cluster.
type String: Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.
uri String: Model file URL. You can only use models stored in Yandex Object Storage.

GetMdbClickhouseClusterShardGroup

Description string: Description of the shard group.
Name string: The name of the ClickHouse cluster.
ShardNames List<string>: List of shards names that belong to the shard group.

Description string: Description of the shard group.
Name string: The name of the ClickHouse cluster.
ShardNames []string: List of shards names that belong to the shard group.

description String: Description of the shard group.
name String: The name of the ClickHouse cluster.
shardNames List<String>: List of shards names that belong to the shard group.

description string: Description of the shard group.
name string: The name of the ClickHouse cluster.
shardNames string[]: List of shards names that belong to the shard group.

description str: Description of the shard group.
name str: The name of the ClickHouse cluster.
shard_names Sequence[str]: List of shards names that belong to the shard group.

description String: Description of the shard group.
name String: The name of the ClickHouse cluster.
shardNames List<String>: List of shards names that belong to the shard group.

GetMdbClickhouseClusterUser

Name string: The name of the ClickHouse cluster.
Permissions List<GetMdbClickhouseClusterUserPermission>: Set of permissions granted to the user. The structure is documented below.
Quotas List<GetMdbClickhouseClusterUserQuota>: Set of user quotas. The structure is documented below.
Settings GetMdbClickhouseClusterUserSettings: Kafka connection settngs sanem as kafka block.

Name string: The name of the ClickHouse cluster.
Permissions []GetMdbClickhouseClusterUserPermission: Set of permissions granted to the user. The structure is documented below.
Quotas []GetMdbClickhouseClusterUserQuota: Set of user quotas. The structure is documented below.
Settings GetMdbClickhouseClusterUserSettings: Kafka connection settngs sanem as kafka block.

name String: The name of the ClickHouse cluster.
permissions List<GetMdbClickhouseClusterUserPermission>: Set of permissions granted to the user. The structure is documented below.
quotas List<GetMdbClickhouseClusterUserQuota>: Set of user quotas. The structure is documented below.
settings GetMdbClickhouseClusterUserSettings: Kafka connection settngs sanem as kafka block.

name string: The name of the ClickHouse cluster.
permissions GetMdbClickhouseClusterUserPermission[]: Set of permissions granted to the user. The structure is documented below.
quotas GetMdbClickhouseClusterUserQuota[]: Set of user quotas. The structure is documented below.
settings GetMdbClickhouseClusterUserSettings: Kafka connection settngs sanem as kafka block.

name str: The name of the ClickHouse cluster.
permissions Sequence[GetMdbClickhouseClusterUserPermission]: Set of permissions granted to the user. The structure is documented below.
quotas Sequence[GetMdbClickhouseClusterUserQuota]: Set of user quotas. The structure is documented below.
settings GetMdbClickhouseClusterUserSettings: Kafka connection settngs sanem as kafka block.

name String: The name of the ClickHouse cluster.
permissions List<Property Map>: Set of permissions granted to the user. The structure is documented below.
quotas List<Property Map>: Set of user quotas. The structure is documented below.
settings Property Map: Kafka connection settngs sanem as kafka block.

GetMdbClickhouseClusterUserPermission

DatabaseName string: The name of the database that the permission grants access to.

DatabaseName string: The name of the database that the permission grants access to.

databaseName String: The name of the database that the permission grants access to.

databaseName string: The name of the database that the permission grants access to.

database_name str: The name of the database that the permission grants access to.

databaseName String: The name of the database that the permission grants access to.

GetMdbClickhouseClusterUserQuota

Errors int: The number of queries that threw exception.
ExecutionTime int: The total query execution time, in milliseconds (wall time).
IntervalDuration int: Duration of interval for quota in milliseconds.
Queries int: The total number of queries.
ReadRows int: The total number of source rows read from tables for running the query, on all remote servers.
ResultRows int: The total number of rows given as the result.

Errors int: The number of queries that threw exception.
ExecutionTime int: The total query execution time, in milliseconds (wall time).
IntervalDuration int: Duration of interval for quota in milliseconds.
Queries int: The total number of queries.
ReadRows int: The total number of source rows read from tables for running the query, on all remote servers.
ResultRows int: The total number of rows given as the result.

errors Integer: The number of queries that threw exception.
executionTime Integer: The total query execution time, in milliseconds (wall time).
intervalDuration Integer: Duration of interval for quota in milliseconds.
queries Integer: The total number of queries.
readRows Integer: The total number of source rows read from tables for running the query, on all remote servers.
resultRows Integer: The total number of rows given as the result.

errors number: The number of queries that threw exception.
executionTime number: The total query execution time, in milliseconds (wall time).
intervalDuration number: Duration of interval for quota in milliseconds.
queries number: The total number of queries.
readRows number: The total number of source rows read from tables for running the query, on all remote servers.
resultRows number: The total number of rows given as the result.

errors int: The number of queries that threw exception.
execution_time int: The total query execution time, in milliseconds (wall time).
interval_duration int: Duration of interval for quota in milliseconds.
queries int: The total number of queries.
read_rows int: The total number of source rows read from tables for running the query, on all remote servers.
result_rows int: The total number of rows given as the result.

errors Number: The number of queries that threw exception.
executionTime Number: The total query execution time, in milliseconds (wall time).
intervalDuration Number: Duration of interval for quota in milliseconds.
queries Number: The total number of queries.
readRows Number: The total number of source rows read from tables for running the query, on all remote servers.
resultRows Number: The total number of rows given as the result.

GetMdbClickhouseClusterUserSettings

AddHttpCorsHeader bool: Include CORS headers in HTTP responces.
AllowDdl bool: Allows or denies DDL queries.
Compile bool: Enable compilation of queries.
CompileExpressions bool: Turn on expression compilation.
ConnectTimeout int: Connect timeout in milliseconds on the socket used for communicating with the client.
CountDistinctImplementation string: Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.
DistinctOverflowMode string: Sets behaviour on overflow when using DISTINCT. Possible values:
DistributedAggregationMemoryEfficient bool: Determine the behavior of distributed subqueries.
DistributedDdlTaskTimeout int: Timeout for DDL queries, in milliseconds.
DistributedProductMode string: Changes the behaviour of distributed subqueries.
EmptyResultForAggregationByEmptySet bool: Allows to retunr empty result.
EnableHttpCompression bool: Enables or disables data compression in the response to an HTTP request.
FallbackToStaleReplicasForDistributedQueries bool: Forces a query to an out-of-date replica if updated data is not available.
ForceIndexByDate bool: Disables query execution if the index can’t be used by date.
ForcePrimaryKey bool: Disables query execution if indexing by the primary key is not possible.
GroupByOverflowMode string: Sets behaviour on overflow while GROUP BY operation. Possible values:
GroupByTwoLevelThreshold int: Sets the threshold of the number of keys, after that the two-level aggregation should be used.
GroupByTwoLevelThresholdBytes int: Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
HttpConnectionTimeout int: Timeout for HTTP connection in milliseconds.
HttpHeadersProgressInterval int: Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.
HttpReceiveTimeout int: Timeout for HTTP connection in milliseconds.
HttpSendTimeout int: Timeout for HTTP connection in milliseconds.
InputFormatDefaultsForOmittedFields bool: When performing INSERT queries, replace omitted input column values with default values of the respective columns.
InputFormatValuesInterpretExpressions bool: Enables or disables the full SQL parser if the fast stream parser can’t parse the data.
InsertQuorum int: Enables the quorum writes.
InsertQuorumTimeout int: Write to a quorum timeout in milliseconds.
JoinOverflowMode string: Sets behaviour on overflow in JOIN. Possible values:
JoinUseNulls bool: Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.
JoinedSubqueryRequiresAlias bool: Require aliases for subselects and table functions in FROM that more than one table is present.
LowCardinalityAllowInNativeFormat bool: Allows or restricts using the LowCardinality data type with the Native format.
MaxAstDepth int: Maximum abstract syntax tree depth.
MaxAstElements int: Maximum abstract syntax tree elements.
MaxBlockSize int: A recommendation for what size of the block (in a count of rows) to load from tables.
MaxBytesBeforeExternalGroupBy int: Limit in bytes for using memoru for GROUP BY before using swap on disk.
MaxBytesBeforeExternalSort int: This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.
MaxBytesInDistinct int: Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.
MaxBytesInJoin int: Limit on maximum size of the hash table for JOIN, in bytes.
MaxBytesInSet int: Limit on the number of bytes in the set resulting from the execution of the IN section.
MaxBytesToRead int: Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
MaxBytesToSort int: Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
MaxBytesToTransfer int: 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.
MaxColumnsToRead int: Limits the maximum number of columns that can be read from a table in a single query.
MaxExecutionTime int: Limits the maximum query execution time in milliseconds.
MaxExpandedAstElements int: Maximum abstract syntax tree depth after after expansion of aliases.
MaxInsertBlockSize int: The size of blocks (in a count of rows) to form for insertion into a table.
MaxMemoryUsage int: Limits the maximum memory usage (in bytes) for processing queries on a single server.
MaxMemoryUsageForUser int: Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
MaxNetworkBandwidth int: Limits the speed of the data exchange over the network in bytes per second.
MaxNetworkBandwidthForUser int: Limits the speed of the data exchange over the network in bytes per second.
MaxQuerySize int: The maximum part of a query that can be taken to RAM for parsing with the SQL parser.
MaxReplicaDelayForDistributedQueries int: Disables lagging replicas for distributed queries.
MaxResultBytes int: Limits the number of bytes in the result.
MaxResultRows int: Limits the number of rows in the result.
MaxRowsInDistinct int: Limits the maximum number of different rows when using DISTINCT.
MaxRowsInJoin int: Limit on maximum size of the hash table for JOIN, in rows.
MaxRowsInSet int: Limit on the number of rows in the set resulting from the execution of the IN section.
MaxRowsToGroupBy int: Limits the maximum number of unique keys received from aggregation function.
MaxRowsToRead int: Limits the maximum number of rows that can be read from a table when running a query.
MaxRowsToSort int: Limits the maximum number of rows that can be read from a table for sorting.
MaxRowsToTransfer int: Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.
MaxTemporaryColumns int: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.
MaxTemporaryNonConstColumns int: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.
MaxThreads int: The maximum number of query processing threads, excluding threads for retrieving data from remote servers.
MergeTreeMaxBytesToUseCache int: If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.
MergeTreeMaxRowsToUseCache int: If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.
MergeTreeMinBytesForConcurrentRead int: If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.
MergeTreeMinRowsForConcurrentRead int: If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.
MinBytesToUseDirectIo int: The minimum data volume required for using direct I/O access to the storage disk.
MinCountToCompile int: How many times to potentially use a compiled chunk of code before running compilation.
MinCountToCompileExpression int: A query waits for expression compilation process to complete prior to continuing execution.
MinExecutionSpeed int: Minimal execution speed in rows per second.
MinExecutionSpeedBytes int: Minimal execution speed in bytes per second.
MinInsertBlockSizeBytes int: Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.
MinInsertBlockSizeRows int: Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.
OutputFormatJsonQuote64bitIntegers bool: If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.
OutputFormatJsonQuoteDenormals bool: Enables +nan, -nan, +inf, -inf outputs in JSON output format.
Priority int: Query priority.
QuotaMode string: Quota accounting mode.
ReadOverflowMode string: Sets behaviour on overflow while read. Possible values:
Readonly int: Restricts permissions for reading data, write data and change settings queries.
ReceiveTimeout int: Receive timeout in milliseconds on the socket used for communicating with the client.
ReplicationAlterPartitionsSync int: For ALTER ... ATTACH|DETACH|DROP queries, you can use the replication_alter_partitions_sync setting to set up waiting.
ResultOverflowMode string: Sets behaviour on overflow in result. Possible values:
SelectSequentialConsistency bool: Enables or disables sequential consistency for SELECT queries.
SendProgressInHttpHeaders bool: Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.
SendTimeout int: Send timeout in milliseconds on the socket used for communicating with the client.
SetOverflowMode string: Sets behaviour on overflow in the set resulting. Possible values:
SkipUnavailableShards bool: Enables or disables silently skipping of unavailable shards.
SortOverflowMode string: Sets behaviour on overflow while sort. Possible values:
TimeoutOverflowMode string: Sets behaviour on overflow. Possible values:
TransferOverflowMode string: Sets behaviour on overflow. Possible values:
TransformNullIn bool: Enables equality of NULL values for IN operator.
UseUncompressedCache bool: Whether to use a cache of uncompressed blocks.

AddHttpCorsHeader bool: Include CORS headers in HTTP responces.
AllowDdl bool: Allows or denies DDL queries.
Compile bool: Enable compilation of queries.
CompileExpressions bool: Turn on expression compilation.
ConnectTimeout int: Connect timeout in milliseconds on the socket used for communicating with the client.
CountDistinctImplementation string: Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.
DistinctOverflowMode string: Sets behaviour on overflow when using DISTINCT. Possible values:
DistributedAggregationMemoryEfficient bool: Determine the behavior of distributed subqueries.
DistributedDdlTaskTimeout int: Timeout for DDL queries, in milliseconds.
DistributedProductMode string: Changes the behaviour of distributed subqueries.
EmptyResultForAggregationByEmptySet bool: Allows to retunr empty result.
EnableHttpCompression bool: Enables or disables data compression in the response to an HTTP request.
FallbackToStaleReplicasForDistributedQueries bool: Forces a query to an out-of-date replica if updated data is not available.
ForceIndexByDate bool: Disables query execution if the index can’t be used by date.
ForcePrimaryKey bool: Disables query execution if indexing by the primary key is not possible.
GroupByOverflowMode string: Sets behaviour on overflow while GROUP BY operation. Possible values:
GroupByTwoLevelThreshold int: Sets the threshold of the number of keys, after that the two-level aggregation should be used.
GroupByTwoLevelThresholdBytes int: Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
HttpConnectionTimeout int: Timeout for HTTP connection in milliseconds.
HttpHeadersProgressInterval int: Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.
HttpReceiveTimeout int: Timeout for HTTP connection in milliseconds.
HttpSendTimeout int: Timeout for HTTP connection in milliseconds.
InputFormatDefaultsForOmittedFields bool: When performing INSERT queries, replace omitted input column values with default values of the respective columns.
InputFormatValuesInterpretExpressions bool: Enables or disables the full SQL parser if the fast stream parser can’t parse the data.
InsertQuorum int: Enables the quorum writes.
InsertQuorumTimeout int: Write to a quorum timeout in milliseconds.
JoinOverflowMode string: Sets behaviour on overflow in JOIN. Possible values:
JoinUseNulls bool: Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.
JoinedSubqueryRequiresAlias bool: Require aliases for subselects and table functions in FROM that more than one table is present.
LowCardinalityAllowInNativeFormat bool: Allows or restricts using the LowCardinality data type with the Native format.
MaxAstDepth int: Maximum abstract syntax tree depth.
MaxAstElements int: Maximum abstract syntax tree elements.
MaxBlockSize int: A recommendation for what size of the block (in a count of rows) to load from tables.
MaxBytesBeforeExternalGroupBy int: Limit in bytes for using memoru for GROUP BY before using swap on disk.
MaxBytesBeforeExternalSort int: This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.
MaxBytesInDistinct int: Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.
MaxBytesInJoin int: Limit on maximum size of the hash table for JOIN, in bytes.
MaxBytesInSet int: Limit on the number of bytes in the set resulting from the execution of the IN section.
MaxBytesToRead int: Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
MaxBytesToSort int: Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
MaxBytesToTransfer int: 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.
MaxColumnsToRead int: Limits the maximum number of columns that can be read from a table in a single query.
MaxExecutionTime int: Limits the maximum query execution time in milliseconds.
MaxExpandedAstElements int: Maximum abstract syntax tree depth after after expansion of aliases.
MaxInsertBlockSize int: The size of blocks (in a count of rows) to form for insertion into a table.
MaxMemoryUsage int: Limits the maximum memory usage (in bytes) for processing queries on a single server.
MaxMemoryUsageForUser int: Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
MaxNetworkBandwidth int: Limits the speed of the data exchange over the network in bytes per second.
MaxNetworkBandwidthForUser int: Limits the speed of the data exchange over the network in bytes per second.
MaxQuerySize int: The maximum part of a query that can be taken to RAM for parsing with the SQL parser.
MaxReplicaDelayForDistributedQueries int: Disables lagging replicas for distributed queries.
MaxResultBytes int: Limits the number of bytes in the result.
MaxResultRows int: Limits the number of rows in the result.
MaxRowsInDistinct int: Limits the maximum number of different rows when using DISTINCT.
MaxRowsInJoin int: Limit on maximum size of the hash table for JOIN, in rows.
MaxRowsInSet int: Limit on the number of rows in the set resulting from the execution of the IN section.
MaxRowsToGroupBy int: Limits the maximum number of unique keys received from aggregation function.
MaxRowsToRead int: Limits the maximum number of rows that can be read from a table when running a query.
MaxRowsToSort int: Limits the maximum number of rows that can be read from a table for sorting.
MaxRowsToTransfer int: Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.
MaxTemporaryColumns int: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.
MaxTemporaryNonConstColumns int: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.
MaxThreads int: The maximum number of query processing threads, excluding threads for retrieving data from remote servers.
MergeTreeMaxBytesToUseCache int: If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.
MergeTreeMaxRowsToUseCache int: If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.
MergeTreeMinBytesForConcurrentRead int: If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.
MergeTreeMinRowsForConcurrentRead int: If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.
MinBytesToUseDirectIo int: The minimum data volume required for using direct I/O access to the storage disk.
MinCountToCompile int: How many times to potentially use a compiled chunk of code before running compilation.
MinCountToCompileExpression int: A query waits for expression compilation process to complete prior to continuing execution.
MinExecutionSpeed int: Minimal execution speed in rows per second.
MinExecutionSpeedBytes int: Minimal execution speed in bytes per second.
MinInsertBlockSizeBytes int: Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.
MinInsertBlockSizeRows int: Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.
OutputFormatJsonQuote64bitIntegers bool: If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.
OutputFormatJsonQuoteDenormals bool: Enables +nan, -nan, +inf, -inf outputs in JSON output format.
Priority int: Query priority.
QuotaMode string: Quota accounting mode.
ReadOverflowMode string: Sets behaviour on overflow while read. Possible values:
Readonly int: Restricts permissions for reading data, write data and change settings queries.
ReceiveTimeout int: Receive timeout in milliseconds on the socket used for communicating with the client.
ReplicationAlterPartitionsSync int: For ALTER ... ATTACH|DETACH|DROP queries, you can use the replication_alter_partitions_sync setting to set up waiting.
ResultOverflowMode string: Sets behaviour on overflow in result. Possible values:
SelectSequentialConsistency bool: Enables or disables sequential consistency for SELECT queries.
SendProgressInHttpHeaders bool: Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.
SendTimeout int: Send timeout in milliseconds on the socket used for communicating with the client.
SetOverflowMode string: Sets behaviour on overflow in the set resulting. Possible values:
SkipUnavailableShards bool: Enables or disables silently skipping of unavailable shards.
SortOverflowMode string: Sets behaviour on overflow while sort. Possible values:
TimeoutOverflowMode string: Sets behaviour on overflow. Possible values:
TransferOverflowMode string: Sets behaviour on overflow. Possible values:
TransformNullIn bool: Enables equality of NULL values for IN operator.
UseUncompressedCache bool: Whether to use a cache of uncompressed blocks.

addHttpCorsHeader Boolean: Include CORS headers in HTTP responces.
allowDdl Boolean: Allows or denies DDL queries.
compile Boolean: Enable compilation of queries.
compileExpressions Boolean: Turn on expression compilation.
connectTimeout Integer: Connect timeout in milliseconds on the socket used for communicating with the client.
countDistinctImplementation String: Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.
distinctOverflowMode String: Sets behaviour on overflow when using DISTINCT. Possible values:
distributedAggregationMemoryEfficient Boolean: Determine the behavior of distributed subqueries.
distributedDdlTaskTimeout Integer: Timeout for DDL queries, in milliseconds.
distributedProductMode String: Changes the behaviour of distributed subqueries.
emptyResultForAggregationByEmptySet Boolean: Allows to retunr empty result.
enableHttpCompression Boolean: Enables or disables data compression in the response to an HTTP request.
fallbackToStaleReplicasForDistributedQueries Boolean: Forces a query to an out-of-date replica if updated data is not available.
forceIndexByDate Boolean: Disables query execution if the index can’t be used by date.
forcePrimaryKey Boolean: Disables query execution if indexing by the primary key is not possible.
groupByOverflowMode String: Sets behaviour on overflow while GROUP BY operation. Possible values:
groupByTwoLevelThreshold Integer: Sets the threshold of the number of keys, after that the two-level aggregation should be used.
groupByTwoLevelThresholdBytes Integer: Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
httpConnectionTimeout Integer: Timeout for HTTP connection in milliseconds.
httpHeadersProgressInterval Integer: Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.
httpReceiveTimeout Integer: Timeout for HTTP connection in milliseconds.
httpSendTimeout Integer: Timeout for HTTP connection in milliseconds.
inputFormatDefaultsForOmittedFields Boolean: When performing INSERT queries, replace omitted input column values with default values of the respective columns.
inputFormatValuesInterpretExpressions Boolean: Enables or disables the full SQL parser if the fast stream parser can’t parse the data.
insertQuorum Integer: Enables the quorum writes.
insertQuorumTimeout Integer: Write to a quorum timeout in milliseconds.
joinOverflowMode String: Sets behaviour on overflow in JOIN. Possible values:
joinUseNulls Boolean: Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.
joinedSubqueryRequiresAlias Boolean: Require aliases for subselects and table functions in FROM that more than one table is present.
lowCardinalityAllowInNativeFormat Boolean: Allows or restricts using the LowCardinality data type with the Native format.
maxAstDepth Integer: Maximum abstract syntax tree depth.
maxAstElements Integer: Maximum abstract syntax tree elements.
maxBlockSize Integer: A recommendation for what size of the block (in a count of rows) to load from tables.
maxBytesBeforeExternalGroupBy Integer: Limit in bytes for using memoru for GROUP BY before using swap on disk.
maxBytesBeforeExternalSort Integer: This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.
maxBytesInDistinct Integer: Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.
maxBytesInJoin Integer: Limit on maximum size of the hash table for JOIN, in bytes.
maxBytesInSet Integer: Limit on the number of bytes in the set resulting from the execution of the IN section.
maxBytesToRead Integer: Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
maxBytesToSort Integer: Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
maxBytesToTransfer Integer: 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.
maxColumnsToRead Integer: Limits the maximum number of columns that can be read from a table in a single query.
maxExecutionTime Integer: Limits the maximum query execution time in milliseconds.
maxExpandedAstElements Integer: Maximum abstract syntax tree depth after after expansion of aliases.
maxInsertBlockSize Integer: The size of blocks (in a count of rows) to form for insertion into a table.
maxMemoryUsage Integer: Limits the maximum memory usage (in bytes) for processing queries on a single server.
maxMemoryUsageForUser Integer: Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
maxNetworkBandwidth Integer: Limits the speed of the data exchange over the network in bytes per second.
maxNetworkBandwidthForUser Integer: Limits the speed of the data exchange over the network in bytes per second.
maxQuerySize Integer: The maximum part of a query that can be taken to RAM for parsing with the SQL parser.
maxReplicaDelayForDistributedQueries Integer: Disables lagging replicas for distributed queries.
maxResultBytes Integer: Limits the number of bytes in the result.
maxResultRows Integer: Limits the number of rows in the result.
maxRowsInDistinct Integer: Limits the maximum number of different rows when using DISTINCT.
maxRowsInJoin Integer: Limit on maximum size of the hash table for JOIN, in rows.
maxRowsInSet Integer: Limit on the number of rows in the set resulting from the execution of the IN section.
maxRowsToGroupBy Integer: Limits the maximum number of unique keys received from aggregation function.
maxRowsToRead Integer: Limits the maximum number of rows that can be read from a table when running a query.
maxRowsToSort Integer: Limits the maximum number of rows that can be read from a table for sorting.
maxRowsToTransfer Integer: Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.
maxTemporaryColumns Integer: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.
maxTemporaryNonConstColumns Integer: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.
maxThreads Integer: The maximum number of query processing threads, excluding threads for retrieving data from remote servers.
mergeTreeMaxBytesToUseCache Integer: If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.
mergeTreeMaxRowsToUseCache Integer: If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.
mergeTreeMinBytesForConcurrentRead Integer: If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.
mergeTreeMinRowsForConcurrentRead Integer: If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.
minBytesToUseDirectIo Integer: The minimum data volume required for using direct I/O access to the storage disk.
minCountToCompile Integer: How many times to potentially use a compiled chunk of code before running compilation.
minCountToCompileExpression Integer: A query waits for expression compilation process to complete prior to continuing execution.
minExecutionSpeed Integer: Minimal execution speed in rows per second.
minExecutionSpeedBytes Integer: Minimal execution speed in bytes per second.
minInsertBlockSizeBytes Integer: Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.
minInsertBlockSizeRows Integer: Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.
outputFormatJsonQuote64bitIntegers Boolean: If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.
outputFormatJsonQuoteDenormals Boolean: Enables +nan, -nan, +inf, -inf outputs in JSON output format.
priority Integer: Query priority.
quotaMode String: Quota accounting mode.
readOverflowMode String: Sets behaviour on overflow while read. Possible values:
readonly Integer: Restricts permissions for reading data, write data and change settings queries.
receiveTimeout Integer: Receive timeout in milliseconds on the socket used for communicating with the client.
replicationAlterPartitionsSync Integer: For ALTER ... ATTACH|DETACH|DROP queries, you can use the replication_alter_partitions_sync setting to set up waiting.
resultOverflowMode String: Sets behaviour on overflow in result. Possible values:
selectSequentialConsistency Boolean: Enables or disables sequential consistency for SELECT queries.
sendProgressInHttpHeaders Boolean: Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.
sendTimeout Integer: Send timeout in milliseconds on the socket used for communicating with the client.
setOverflowMode String: Sets behaviour on overflow in the set resulting. Possible values:
skipUnavailableShards Boolean: Enables or disables silently skipping of unavailable shards.
sortOverflowMode String: Sets behaviour on overflow while sort. Possible values:
timeoutOverflowMode String: Sets behaviour on overflow. Possible values:
transferOverflowMode String: Sets behaviour on overflow. Possible values:
transformNullIn Boolean: Enables equality of NULL values for IN operator.
useUncompressedCache Boolean: Whether to use a cache of uncompressed blocks.

addHttpCorsHeader boolean: Include CORS headers in HTTP responces.
allowDdl boolean: Allows or denies DDL queries.
compile boolean: Enable compilation of queries.
compileExpressions boolean: Turn on expression compilation.
connectTimeout number: Connect timeout in milliseconds on the socket used for communicating with the client.
countDistinctImplementation string: Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.
distinctOverflowMode string: Sets behaviour on overflow when using DISTINCT. Possible values:
distributedAggregationMemoryEfficient boolean: Determine the behavior of distributed subqueries.
distributedDdlTaskTimeout number: Timeout for DDL queries, in milliseconds.
distributedProductMode string: Changes the behaviour of distributed subqueries.
emptyResultForAggregationByEmptySet boolean: Allows to retunr empty result.
enableHttpCompression boolean: Enables or disables data compression in the response to an HTTP request.
fallbackToStaleReplicasForDistributedQueries boolean: Forces a query to an out-of-date replica if updated data is not available.
forceIndexByDate boolean: Disables query execution if the index can’t be used by date.
forcePrimaryKey boolean: Disables query execution if indexing by the primary key is not possible.
groupByOverflowMode string: Sets behaviour on overflow while GROUP BY operation. Possible values:
groupByTwoLevelThreshold number: Sets the threshold of the number of keys, after that the two-level aggregation should be used.
groupByTwoLevelThresholdBytes number: Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
httpConnectionTimeout number: Timeout for HTTP connection in milliseconds.
httpHeadersProgressInterval number: Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.
httpReceiveTimeout number: Timeout for HTTP connection in milliseconds.
httpSendTimeout number: Timeout for HTTP connection in milliseconds.
inputFormatDefaultsForOmittedFields boolean: When performing INSERT queries, replace omitted input column values with default values of the respective columns.
inputFormatValuesInterpretExpressions boolean: Enables or disables the full SQL parser if the fast stream parser can’t parse the data.
insertQuorum number: Enables the quorum writes.
insertQuorumTimeout number: Write to a quorum timeout in milliseconds.
joinOverflowMode string: Sets behaviour on overflow in JOIN. Possible values:
joinUseNulls boolean: Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.
joinedSubqueryRequiresAlias boolean: Require aliases for subselects and table functions in FROM that more than one table is present.
lowCardinalityAllowInNativeFormat boolean: Allows or restricts using the LowCardinality data type with the Native format.
maxAstDepth number: Maximum abstract syntax tree depth.
maxAstElements number: Maximum abstract syntax tree elements.
maxBlockSize number: A recommendation for what size of the block (in a count of rows) to load from tables.
maxBytesBeforeExternalGroupBy number: Limit in bytes for using memoru for GROUP BY before using swap on disk.
maxBytesBeforeExternalSort number: This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.
maxBytesInDistinct number: Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.
maxBytesInJoin number: Limit on maximum size of the hash table for JOIN, in bytes.
maxBytesInSet number: Limit on the number of bytes in the set resulting from the execution of the IN section.
maxBytesToRead number: Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
maxBytesToSort number: Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
maxBytesToTransfer number: 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.
maxColumnsToRead number: Limits the maximum number of columns that can be read from a table in a single query.
maxExecutionTime number: Limits the maximum query execution time in milliseconds.
maxExpandedAstElements number: Maximum abstract syntax tree depth after after expansion of aliases.
maxInsertBlockSize number: The size of blocks (in a count of rows) to form for insertion into a table.
maxMemoryUsage number: Limits the maximum memory usage (in bytes) for processing queries on a single server.
maxMemoryUsageForUser number: Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
maxNetworkBandwidth number: Limits the speed of the data exchange over the network in bytes per second.
maxNetworkBandwidthForUser number: Limits the speed of the data exchange over the network in bytes per second.
maxQuerySize number: The maximum part of a query that can be taken to RAM for parsing with the SQL parser.
maxReplicaDelayForDistributedQueries number: Disables lagging replicas for distributed queries.
maxResultBytes number: Limits the number of bytes in the result.
maxResultRows number: Limits the number of rows in the result.
maxRowsInDistinct number: Limits the maximum number of different rows when using DISTINCT.
maxRowsInJoin number: Limit on maximum size of the hash table for JOIN, in rows.
maxRowsInSet number: Limit on the number of rows in the set resulting from the execution of the IN section.
maxRowsToGroupBy number: Limits the maximum number of unique keys received from aggregation function.
maxRowsToRead number: Limits the maximum number of rows that can be read from a table when running a query.
maxRowsToSort number: Limits the maximum number of rows that can be read from a table for sorting.
maxRowsToTransfer number: Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.
maxTemporaryColumns number: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.
maxTemporaryNonConstColumns number: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.
maxThreads number: The maximum number of query processing threads, excluding threads for retrieving data from remote servers.
mergeTreeMaxBytesToUseCache number: If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.
mergeTreeMaxRowsToUseCache number: If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.
mergeTreeMinBytesForConcurrentRead number: If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.
mergeTreeMinRowsForConcurrentRead number: If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.
minBytesToUseDirectIo number: The minimum data volume required for using direct I/O access to the storage disk.
minCountToCompile number: How many times to potentially use a compiled chunk of code before running compilation.
minCountToCompileExpression number: A query waits for expression compilation process to complete prior to continuing execution.
minExecutionSpeed number: Minimal execution speed in rows per second.
minExecutionSpeedBytes number: Minimal execution speed in bytes per second.
minInsertBlockSizeBytes number: Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.
minInsertBlockSizeRows number: Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.
outputFormatJsonQuote64bitIntegers boolean: If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.
outputFormatJsonQuoteDenormals boolean: Enables +nan, -nan, +inf, -inf outputs in JSON output format.
priority number: Query priority.
quotaMode string: Quota accounting mode.
readOverflowMode string: Sets behaviour on overflow while read. Possible values:
readonly number: Restricts permissions for reading data, write data and change settings queries.
receiveTimeout number: Receive timeout in milliseconds on the socket used for communicating with the client.
replicationAlterPartitionsSync number: For ALTER ... ATTACH|DETACH|DROP queries, you can use the replication_alter_partitions_sync setting to set up waiting.
resultOverflowMode string: Sets behaviour on overflow in result. Possible values:
selectSequentialConsistency boolean: Enables or disables sequential consistency for SELECT queries.
sendProgressInHttpHeaders boolean: Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.
sendTimeout number: Send timeout in milliseconds on the socket used for communicating with the client.
setOverflowMode string: Sets behaviour on overflow in the set resulting. Possible values:
skipUnavailableShards boolean: Enables or disables silently skipping of unavailable shards.
sortOverflowMode string: Sets behaviour on overflow while sort. Possible values:
timeoutOverflowMode string: Sets behaviour on overflow. Possible values:
transferOverflowMode string: Sets behaviour on overflow. Possible values:
transformNullIn boolean: Enables equality of NULL values for IN operator.
useUncompressedCache boolean: Whether to use a cache of uncompressed blocks.

add_http_cors_header bool: Include CORS headers in HTTP responces.
allow_ddl bool: Allows or denies DDL queries.
compile bool: Enable compilation of queries.
compile_expressions bool: Turn on expression compilation.
connect_timeout int: Connect timeout in milliseconds on the socket used for communicating with the client.
count_distinct_implementation str: Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.
distinct_overflow_mode str: Sets behaviour on overflow when using DISTINCT. Possible values:
distributed_aggregation_memory_efficient bool: Determine the behavior of distributed subqueries.
distributed_ddl_task_timeout int: Timeout for DDL queries, in milliseconds.
distributed_product_mode str: Changes the behaviour of distributed subqueries.
empty_result_for_aggregation_by_empty_set bool: Allows to retunr empty result.
enable_http_compression bool: Enables or disables data compression in the response to an HTTP request.
fallback_to_stale_replicas_for_distributed_queries bool: Forces a query to an out-of-date replica if updated data is not available.
force_index_by_date bool: Disables query execution if the index can’t be used by date.
force_primary_key bool: Disables query execution if indexing by the primary key is not possible.
group_by_overflow_mode str: Sets behaviour on overflow while GROUP BY operation. Possible values:
group_by_two_level_threshold int: Sets the threshold of the number of keys, after that the two-level aggregation should be used.
group_by_two_level_threshold_bytes int: Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
http_connection_timeout int: Timeout for HTTP connection in milliseconds.
http_headers_progress_interval int: Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.
http_receive_timeout int: Timeout for HTTP connection in milliseconds.
http_send_timeout int: Timeout for HTTP connection in milliseconds.
input_format_defaults_for_omitted_fields bool: When performing INSERT queries, replace omitted input column values with default values of the respective columns.
input_format_values_interpret_expressions bool: Enables or disables the full SQL parser if the fast stream parser can’t parse the data.
insert_quorum int: Enables the quorum writes.
insert_quorum_timeout int: Write to a quorum timeout in milliseconds.
join_overflow_mode str: Sets behaviour on overflow in JOIN. Possible values:
join_use_nulls bool: Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.
joined_subquery_requires_alias bool: Require aliases for subselects and table functions in FROM that more than one table is present.
low_cardinality_allow_in_native_format bool: Allows or restricts using the LowCardinality data type with the Native format.
max_ast_depth int: Maximum abstract syntax tree depth.
max_ast_elements int: Maximum abstract syntax tree elements.
max_block_size int: A recommendation for what size of the block (in a count of rows) to load from tables.
max_bytes_before_external_group_by int: Limit in bytes for using memoru for GROUP BY before using swap on disk.
max_bytes_before_external_sort int: This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.
max_bytes_in_distinct int: Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.
max_bytes_in_join int: Limit on maximum size of the hash table for JOIN, in bytes.
max_bytes_in_set int: Limit on the number of bytes in the set resulting from the execution of the IN section.
max_bytes_to_read int: Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
max_bytes_to_sort int: Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
max_bytes_to_transfer int: 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.
max_columns_to_read int: Limits the maximum number of columns that can be read from a table in a single query.
max_execution_time int: Limits the maximum query execution time in milliseconds.
max_expanded_ast_elements int: Maximum abstract syntax tree depth after after expansion of aliases.
max_insert_block_size int: The size of blocks (in a count of rows) to form for insertion into a table.
max_memory_usage int: Limits the maximum memory usage (in bytes) for processing queries on a single server.
max_memory_usage_for_user int: Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
max_network_bandwidth int: Limits the speed of the data exchange over the network in bytes per second.
max_network_bandwidth_for_user int: Limits the speed of the data exchange over the network in bytes per second.
max_query_size int: The maximum part of a query that can be taken to RAM for parsing with the SQL parser.
max_replica_delay_for_distributed_queries int: Disables lagging replicas for distributed queries.
max_result_bytes int: Limits the number of bytes in the result.
max_result_rows int: Limits the number of rows in the result.
max_rows_in_distinct int: Limits the maximum number of different rows when using DISTINCT.
max_rows_in_join int: Limit on maximum size of the hash table for JOIN, in rows.
max_rows_in_set int: Limit on the number of rows in the set resulting from the execution of the IN section.
max_rows_to_group_by int: Limits the maximum number of unique keys received from aggregation function.
max_rows_to_read int: Limits the maximum number of rows that can be read from a table when running a query.
max_rows_to_sort int: Limits the maximum number of rows that can be read from a table for sorting.
max_rows_to_transfer int: Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.
max_temporary_columns int: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.
max_temporary_non_const_columns int: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.
max_threads int: The maximum number of query processing threads, excluding threads for retrieving data from remote servers.
merge_tree_max_bytes_to_use_cache int: If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.
merge_tree_max_rows_to_use_cache int: If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.
merge_tree_min_bytes_for_concurrent_read int: If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.
merge_tree_min_rows_for_concurrent_read int: If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.
min_bytes_to_use_direct_io int: The minimum data volume required for using direct I/O access to the storage disk.
min_count_to_compile int: How many times to potentially use a compiled chunk of code before running compilation.
min_count_to_compile_expression int: A query waits for expression compilation process to complete prior to continuing execution.
min_execution_speed int: Minimal execution speed in rows per second.
min_execution_speed_bytes int: Minimal execution speed in bytes per second.
min_insert_block_size_bytes int: Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.
min_insert_block_size_rows int: Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.
output_format_json_quote64bit_integers bool: If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.
output_format_json_quote_denormals bool: Enables +nan, -nan, +inf, -inf outputs in JSON output format.
priority int: Query priority.
quota_mode str: Quota accounting mode.
read_overflow_mode str: Sets behaviour on overflow while read. Possible values:
readonly int: Restricts permissions for reading data, write data and change settings queries.
receive_timeout int: Receive timeout in milliseconds on the socket used for communicating with the client.
replication_alter_partitions_sync int: For ALTER ... ATTACH|DETACH|DROP queries, you can use the replication_alter_partitions_sync setting to set up waiting.
result_overflow_mode str: Sets behaviour on overflow in result. Possible values:
select_sequential_consistency bool: Enables or disables sequential consistency for SELECT queries.
send_progress_in_http_headers bool: Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.
send_timeout int: Send timeout in milliseconds on the socket used for communicating with the client.
set_overflow_mode str: Sets behaviour on overflow in the set resulting. Possible values:
skip_unavailable_shards bool: Enables or disables silently skipping of unavailable shards.
sort_overflow_mode str: Sets behaviour on overflow while sort. Possible values:
timeout_overflow_mode str: Sets behaviour on overflow. Possible values:
transfer_overflow_mode str: Sets behaviour on overflow. Possible values:
transform_null_in bool: Enables equality of NULL values for IN operator.
use_uncompressed_cache bool: Whether to use a cache of uncompressed blocks.

addHttpCorsHeader Boolean: Include CORS headers in HTTP responces.
allowDdl Boolean: Allows or denies DDL queries.
compile Boolean: Enable compilation of queries.
compileExpressions Boolean: Turn on expression compilation.
connectTimeout Number: Connect timeout in milliseconds on the socket used for communicating with the client.
countDistinctImplementation String: Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.
distinctOverflowMode String: Sets behaviour on overflow when using DISTINCT. Possible values:
distributedAggregationMemoryEfficient Boolean: Determine the behavior of distributed subqueries.
distributedDdlTaskTimeout Number: Timeout for DDL queries, in milliseconds.
distributedProductMode String: Changes the behaviour of distributed subqueries.
emptyResultForAggregationByEmptySet Boolean: Allows to retunr empty result.
enableHttpCompression Boolean: Enables or disables data compression in the response to an HTTP request.
fallbackToStaleReplicasForDistributedQueries Boolean: Forces a query to an out-of-date replica if updated data is not available.
forceIndexByDate Boolean: Disables query execution if the index can’t be used by date.
forcePrimaryKey Boolean: Disables query execution if indexing by the primary key is not possible.
groupByOverflowMode String: Sets behaviour on overflow while GROUP BY operation. Possible values:
groupByTwoLevelThreshold Number: Sets the threshold of the number of keys, after that the two-level aggregation should be used.
groupByTwoLevelThresholdBytes Number: Sets the threshold of the number of bytes, after that the two-level aggregation should be used.
httpConnectionTimeout Number: Timeout for HTTP connection in milliseconds.
httpHeadersProgressInterval Number: Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.
httpReceiveTimeout Number: Timeout for HTTP connection in milliseconds.
httpSendTimeout Number: Timeout for HTTP connection in milliseconds.
inputFormatDefaultsForOmittedFields Boolean: When performing INSERT queries, replace omitted input column values with default values of the respective columns.
inputFormatValuesInterpretExpressions Boolean: Enables or disables the full SQL parser if the fast stream parser can’t parse the data.
insertQuorum Number: Enables the quorum writes.
insertQuorumTimeout Number: Write to a quorum timeout in milliseconds.
joinOverflowMode String: Sets behaviour on overflow in JOIN. Possible values:
joinUseNulls Boolean: Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.
joinedSubqueryRequiresAlias Boolean: Require aliases for subselects and table functions in FROM that more than one table is present.
lowCardinalityAllowInNativeFormat Boolean: Allows or restricts using the LowCardinality data type with the Native format.
maxAstDepth Number: Maximum abstract syntax tree depth.
maxAstElements Number: Maximum abstract syntax tree elements.
maxBlockSize Number: A recommendation for what size of the block (in a count of rows) to load from tables.
maxBytesBeforeExternalGroupBy Number: Limit in bytes for using memoru for GROUP BY before using swap on disk.
maxBytesBeforeExternalSort Number: This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.
maxBytesInDistinct Number: Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.
maxBytesInJoin Number: Limit on maximum size of the hash table for JOIN, in bytes.
maxBytesInSet Number: Limit on the number of bytes in the set resulting from the execution of the IN section.
maxBytesToRead Number: Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.
maxBytesToSort Number: Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.
maxBytesToTransfer Number: 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.
maxColumnsToRead Number: Limits the maximum number of columns that can be read from a table in a single query.
maxExecutionTime Number: Limits the maximum query execution time in milliseconds.
maxExpandedAstElements Number: Maximum abstract syntax tree depth after after expansion of aliases.
maxInsertBlockSize Number: The size of blocks (in a count of rows) to form for insertion into a table.
maxMemoryUsage Number: Limits the maximum memory usage (in bytes) for processing queries on a single server.
maxMemoryUsageForUser Number: Limits the maximum memory usage (in bytes) for processing of user's queries on a single server.
maxNetworkBandwidth Number: Limits the speed of the data exchange over the network in bytes per second.
maxNetworkBandwidthForUser Number: Limits the speed of the data exchange over the network in bytes per second.
maxQuerySize Number: The maximum part of a query that can be taken to RAM for parsing with the SQL parser.
maxReplicaDelayForDistributedQueries Number: Disables lagging replicas for distributed queries.
maxResultBytes Number: Limits the number of bytes in the result.
maxResultRows Number: Limits the number of rows in the result.
maxRowsInDistinct Number: Limits the maximum number of different rows when using DISTINCT.
maxRowsInJoin Number: Limit on maximum size of the hash table for JOIN, in rows.
maxRowsInSet Number: Limit on the number of rows in the set resulting from the execution of the IN section.
maxRowsToGroupBy Number: Limits the maximum number of unique keys received from aggregation function.
maxRowsToRead Number: Limits the maximum number of rows that can be read from a table when running a query.
maxRowsToSort Number: Limits the maximum number of rows that can be read from a table for sorting.
maxRowsToTransfer Number: Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.
maxTemporaryColumns Number: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.
maxTemporaryNonConstColumns Number: Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.
maxThreads Number: The maximum number of query processing threads, excluding threads for retrieving data from remote servers.
mergeTreeMaxBytesToUseCache Number: If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.
mergeTreeMaxRowsToUseCache Number: If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.
mergeTreeMinBytesForConcurrentRead Number: If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.
mergeTreeMinRowsForConcurrentRead Number: If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.
minBytesToUseDirectIo Number: The minimum data volume required for using direct I/O access to the storage disk.
minCountToCompile Number: How many times to potentially use a compiled chunk of code before running compilation.
minCountToCompileExpression Number: A query waits for expression compilation process to complete prior to continuing execution.
minExecutionSpeed Number: Minimal execution speed in rows per second.
minExecutionSpeedBytes Number: Minimal execution speed in bytes per second.
minInsertBlockSizeBytes Number: Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.
minInsertBlockSizeRows Number: Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.
outputFormatJsonQuote64bitIntegers Boolean: If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.
outputFormatJsonQuoteDenormals Boolean: Enables +nan, -nan, +inf, -inf outputs in JSON output format.
priority Number: Query priority.
quotaMode String: Quota accounting mode.
readOverflowMode String: Sets behaviour on overflow while read. Possible values:
readonly Number: Restricts permissions for reading data, write data and change settings queries.
receiveTimeout Number: Receive timeout in milliseconds on the socket used for communicating with the client.
replicationAlterPartitionsSync Number: For ALTER ... ATTACH|DETACH|DROP queries, you can use the replication_alter_partitions_sync setting to set up waiting.
resultOverflowMode String: Sets behaviour on overflow in result. Possible values:
selectSequentialConsistency Boolean: Enables or disables sequential consistency for SELECT queries.
sendProgressInHttpHeaders Boolean: Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.
sendTimeout Number: Send timeout in milliseconds on the socket used for communicating with the client.
setOverflowMode String: Sets behaviour on overflow in the set resulting. Possible values:
skipUnavailableShards Boolean: Enables or disables silently skipping of unavailable shards.
sortOverflowMode String: Sets behaviour on overflow while sort. Possible values:
timeoutOverflowMode String: Sets behaviour on overflow. Possible values:
transferOverflowMode String: Sets behaviour on overflow. Possible values:
transformNullIn Boolean: Enables equality of NULL values for IN operator.
useUncompressedCache Boolean: Whether to use a cache of uncompressed blocks.

GetMdbClickhouseClusterZookeeper

Resources List<GetMdbClickhouseClusterZookeeperResource>: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

Resources []GetMdbClickhouseClusterZookeeperResource: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

resources List<GetMdbClickhouseClusterZookeeperResource>: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

resources GetMdbClickhouseClusterZookeeperResource[]: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

resources Sequence[GetMdbClickhouseClusterZookeeperResource]: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

resources List<Property Map>: Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

GetMdbClickhouseClusterZookeeperResource

DiskSize int: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
DiskTypeId string: Type of the storage of ClickHouse or ZooKeeper hosts.
ResourcePresetId string

DiskSize int: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
DiskTypeId string: Type of the storage of ClickHouse or ZooKeeper hosts.
ResourcePresetId string

diskSize Integer: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
diskTypeId String: Type of the storage of ClickHouse or ZooKeeper hosts.
resourcePresetId String

diskSize number: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
diskTypeId string: Type of the storage of ClickHouse or ZooKeeper hosts.
resourcePresetId string

disk_size int: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
disk_type_id str: Type of the storage of ClickHouse or ZooKeeper hosts.
resource_preset_id str

diskSize Number: Volume of the storage available to a ClickHouse or ZooKeeper host, in gigabytes.
diskTypeId String: Type of the storage of ClickHouse or ZooKeeper hosts.
resourcePresetId String

Package Details

Repository: Yandex pulumi/pulumi-yandex
License: Apache-2.0
Notes: This Pulumi package is based on the yandex Terraform Provider.

Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

pulumi/pulumi-yandex

yandex.getMdbClickhouseCluster

On this page

On this page

Example Usage

Using getMdbClickhouseCluster

getMdbClickhouseCluster Result

Supporting Types

GetMdbClickhouseClusterAccess

GetMdbClickhouseClusterBackupWindowStart

GetMdbClickhouseClusterClickhouse

GetMdbClickhouseClusterClickhouseConfig

GetMdbClickhouseClusterClickhouseConfigCompression

GetMdbClickhouseClusterClickhouseConfigGraphiteRollup

GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPattern

GetMdbClickhouseClusterClickhouseConfigGraphiteRollupPatternRetention

GetMdbClickhouseClusterClickhouseConfigKafka

GetMdbClickhouseClusterClickhouseConfigKafkaTopic

GetMdbClickhouseClusterClickhouseConfigKafkaTopicSettings

GetMdbClickhouseClusterClickhouseConfigMergeTree

GetMdbClickhouseClusterClickhouseConfigRabbitmq

GetMdbClickhouseClusterClickhouseResource

GetMdbClickhouseClusterCloudStorage

GetMdbClickhouseClusterDatabase

GetMdbClickhouseClusterFormatSchema

GetMdbClickhouseClusterHost

GetMdbClickhouseClusterMaintenanceWindow

GetMdbClickhouseClusterMlModel

GetMdbClickhouseClusterShardGroup

GetMdbClickhouseClusterUser

GetMdbClickhouseClusterUserPermission

GetMdbClickhouseClusterUserQuota

GetMdbClickhouseClusterUserSettings

GetMdbClickhouseClusterZookeeper

GetMdbClickhouseClusterZookeeperResource

Package Details

On this page

On this page