Managed Service for ClickHouse API, REST: Cluster.listExternalDictionaries
Retrieves a list of external dictionaries that belong to specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/externalDictionaries
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the cluster that the external dictionaries belong to. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a [ListClusterExternalDictionaryResponse.next_page_token] that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set pageToken to the [ListClusterExternalDictionaryResponse.next_page_token] returned by a previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"externalDictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string"
},
// `externalDictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"fixedLifetime": "string",
"lifetimeRange": {
"min": "string",
"max": "string"
},
// end of the list of possible fields`externalDictionaries[]`
"httpSource": {
"url": "string",
"format": "string"
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "string",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "string",
"port": "string",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string"
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"where": "string"
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
externalDictionaries[] | object List of ClickHouse Cluster external dictionaries. |
externalDictionaries[]. name |
string Required. Name of the external dictionary. |
externalDictionaries[]. structure |
object Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation |
externalDictionaries[]. structure. id |
object Single numeric key column for the dictionary. Numeric key. |
externalDictionaries[]. structure. id. name |
string Required. Name of the numeric key. |
externalDictionaries[]. structure. key |
object Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation. Complex key. |
externalDictionaries[]. structure. key. attributes[] |
object Required. Attributes of a complex key. Must contain at least one element. |
externalDictionaries[]. structure. key. attributes[]. name |
string Required. Name of the column. |
externalDictionaries[]. structure. key. attributes[]. type |
string Required. Type of the column. |
externalDictionaries[]. structure. key. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
externalDictionaries[]. structure. key. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
externalDictionaries[]. structure. key. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
externalDictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
externalDictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
externalDictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
externalDictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
externalDictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
externalDictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
externalDictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
externalDictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
externalDictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
externalDictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
externalDictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
externalDictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
externalDictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
externalDictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
externalDictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
externalDictionaries[]. structure. attributes[] |
object Required. Description of the fields available for database queries. For details, see ClickHouse documentation. Must contain at least one element. |
externalDictionaries[]. structure. attributes[]. name |
string Required. Name of the column. |
externalDictionaries[]. structure. attributes[]. type |
string Required. Type of the column. |
externalDictionaries[]. structure. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
externalDictionaries[]. structure. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
externalDictionaries[]. structure. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
externalDictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
externalDictionaries[]. layout |
object Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation |
externalDictionaries[]. layout. type |
string Required. Layout type for an external dictionary.
|
externalDictionaries[]. layout. sizeInCells |
string (int64) Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. |
externalDictionaries[]. fixedLifetime |
string (int64) externalDictionaries[] includes only one of the fields fixedLifetime , lifetimeRange Fixed interval between dictionary updates. |
externalDictionaries[]. lifetimeRange |
object Range of intervals between dictionary updates for ClickHouse to choose from. externalDictionaries[] includes only one of the fields fixedLifetime , lifetimeRange |
externalDictionaries[]. lifetimeRange. min |
string (int64) Minimum dictionary lifetime. |
externalDictionaries[]. lifetimeRange. max |
string (int64) Maximum dictionary lifetime. |
externalDictionaries[]. httpSource |
object HTTP source for the dictionary. externalDictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
externalDictionaries[]. httpSource. url |
string Required. URL of the source dictionary available over HTTP. |
externalDictionaries[]. httpSource. format |
string Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
externalDictionaries[]. mysqlSource |
object MySQL source for the dictionary. externalDictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
externalDictionaries[]. mysqlSource. db |
string Required. Name of the MySQL database to connect to. |
externalDictionaries[]. mysqlSource. table |
string Required. Name of the database table to use as a ClickHouse dictionary. |
externalDictionaries[]. mysqlSource. port |
string (int64) Default port to use when connecting to a replica of the dictionary source. Acceptable values are 0 to 65535, inclusive. |
externalDictionaries[]. mysqlSource. user |
string Name of the default user for replicas of the dictionary source. |
externalDictionaries[]. mysqlSource. password |
string Password of the default user for replicas of the dictionary source. |
externalDictionaries[]. mysqlSource. replicas[] |
object Required. List of MySQL replicas of the database used as dictionary source. Must contain at least one element. |
externalDictionaries[]. mysqlSource. replicas[]. host |
string Required. MySQL host of the replica. The maximum string length in characters is 253. |
externalDictionaries[]. mysqlSource. replicas[]. priority |
string (int64) Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number. Value must be greater than 0. |
externalDictionaries[]. mysqlSource. replicas[]. port |
string (int64) Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source. Acceptable values are 0 to 65535, inclusive. |
externalDictionaries[]. mysqlSource. replicas[]. user |
string Name of the MySQL database user. |
externalDictionaries[]. mysqlSource. replicas[]. password |
string Password of the MySQL database user. |
externalDictionaries[]. mysqlSource. where |
string Selection criteria for the data in the specified MySQL table. |
externalDictionaries[]. mysqlSource. invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries. |
externalDictionaries[]. clickhouseSource |
object ClickHouse source for the dictionary. externalDictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
externalDictionaries[]. clickhouseSource. db |
string Required. Name of the ClickHouse database. |
externalDictionaries[]. clickhouseSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
externalDictionaries[]. clickhouseSource. host |
string Required. ClickHouse host of the specified database. The maximum string length in characters is 253. |
externalDictionaries[]. clickhouseSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
externalDictionaries[]. clickhouseSource. user |
string Required. Name of the ClickHouse database user. |
externalDictionaries[]. clickhouseSource. password |
string Password of the ClickHouse database user. |
externalDictionaries[]. clickhouseSource. where |
string Selection criteria for the data in the specified ClickHouse table. |
externalDictionaries[]. mongodbSource |
object MongoDB source for the dictionary. externalDictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
externalDictionaries[]. mongodbSource. db |
string Required. Name of the MongoDB database. |
externalDictionaries[]. mongodbSource. collection |
string Required. Name of the collection in the specified database to be used as the dictionary source. |
externalDictionaries[]. mongodbSource. host |
string Required. MongoDB host of the specified database. The maximum string length in characters is 253. |
externalDictionaries[]. mongodbSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
externalDictionaries[]. mongodbSource. user |
string Required. Name of the MongoDB database user. |
externalDictionaries[]. mongodbSource. password |
string Password of the MongoDB database user. |
externalDictionaries[]. mongodbSource. options |
string |
externalDictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. externalDictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
externalDictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
externalDictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
externalDictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
externalDictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
externalDictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
externalDictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
externalDictionaries[]. postgresqlSource. invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries. |
externalDictionaries[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than [ListClusterExternalDictionaryRequest.page_size], use the nextPageToken as the value for the [ListClusterExternalDictionaryRequest.page_token] parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |