yc managed-clickhouse cluster add-external-dictionary
Written by
Updated at October 3, 2024
Add an external dictionary to a ClickHouse cluster.
Command Usage
Syntax:
yc managed-clickhouse cluster add-external-dictionary <CLUSTER-NAME>|<CLUSTER-ID> [Flags...] [Global Flags...]
Flags
Flag | Description |
---|---|
--id |
string ID of the ClickHouse cluster. |
--name |
string Name of the ClickHouse cluster. |
--async |
Display information about the operation in progress, without waiting for the operation to complete. |
--dict-name |
string Name to set for the external dictionary. |
--structure-id |
string Numeric key of the column for the dictionary. |
--structure-key |
PROPERTY=VALUE[,PROPERTY=VALUE...] Specifies composite keys for the dictionary. Possible property names:
|
--structure-attribute |
PROPERTY=VALUE[,PROPERTY=VALUE...] Description of the fields available for database queries. Possible property names:
|
--fixed-lifetime |
int Fixed time between dictionary updates. |
--lifetime-range |
PROPERTY=VALUE[,PROPERTY=VALUE...] Range of possible time intervals between dictionary updates. Possible property names:
|
--layout-type |
string Layout type for the external dictionary. |
--layout-size-in-cells |
int Number of cells in the cache. Rounded up to a power of two. |
--layout-max-array-size |
int Maximum dictionary key size. |
--http-source-url |
string URL of the source for the external HTTP dictionary. |
--http-source-format |
string Data format for the external HTTP dictionary. |
--http-source |
PROPERTY=VALUE[,PROPERTY=VALUE...] Description of the source for the external HTTP dictionary. Possible property names:
|
--http-header |
PROPERTY=VALUE[,PROPERTY=VALUE...] Single HTTP header entry. Possible property names:
|
--mongodb-source |
PROPERTY=VALUE[,PROPERTY=VALUE...] Description of the MongoDB source for the external dictionary. Possible property names:
|
--clickhouse-source |
PROPERTY=VALUE[,PROPERTY=VALUE...] Description of the ClickHouse source for the external dictionary. Possible property names:
|
--mysql-source |
PROPERTY=VALUE[,PROPERTY=VALUE...] Description of the MySQL source for the external dictionary Possible property names:
|
--mysql-replica |
PROPERTY=VALUE[,PROPERTY=VALUE...] MySQL replica of the database to be used as the dictionary source. Possible property names:
|
--mysql-invalidate-query |
string Query for checking the dictionary status, to pull only updated data. |
--postgresql-source |
PROPERTY=VALUE[,PROPERTY=VALUE...] Description of the PostgreSQL source for the external dictionary Possible property names:
|
--postgresql-source-hosts |
value[,value] Replica hosts names. |
--postgresql-invalidate-query |
string Query for checking the dictionary status, to pull only updated data. |
Global Flags
Flag | Description |
---|---|
--profile |
string Set the custom configuration file. |
--debug |
Debug logging. |
--debug-grpc |
Debug gRPC logging. Very verbose, used for debugging connection problems. |
--no-user-output |
Disable printing user intended output to stderr. |
--retry |
int Enable gRPC retries. By default, retries are enabled with maximum 5 attempts. Pass 0 to disable retries. Pass any negative value for infinite retries. Even infinite retries are capped with 2 minutes timeout. |
--cloud-id |
string Set the ID of the cloud to use. |
--folder-id |
string Set the ID of the folder to use. |
--folder-name |
string Set the name of the folder to use (will be resolved to id). |
--endpoint |
string Set the Cloud API endpoint (host:port). |
--token |
string Set the OAuth token to use. |
--impersonate-service-account-id |
string Set the ID of the service account to impersonate. |
--no-browser |
Disable opening browser for authentication. |
--format |
string Set the output format: text (default), yaml, json, json-rest. |
--jq |
string Query to select values from the response using jq syntax |
-h ,--help |
Display help for the command. |