mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-10 01:25:21 +00:00
Formatting fixes
This commit is contained in:
Blargian
parent
38ef6ac291
commit
f1b565048e
@ -9,23 +9,23 @@ sidebar_label: Embedded Dictionaries
|
||||
:::note
|
||||
In order for the functions below to work, the server config must specify the paths and addresses for getting all the embedded dictionaries. The dictionaries are loaded at the first call of any of these functions. If the reference lists can’t be loaded, an exception is thrown.
|
||||
|
||||
As such, the examples shown in this section cannot be run in [ClickHouse Fiddle](https://fiddle.clickhouse.com/).
|
||||
As such, the examples shown in this section will throw an exception in [ClickHouse Fiddle](https://fiddle.clickhouse.com/) and in quick release and production deployments by default, unless first configured.
|
||||
:::
|
||||
|
||||
For information about creating reference lists, see the section [“Dictionaries”](../../sql-reference/dictionaries/index.md).
|
||||
For information about creating reference lists, see the section [“Dictionaries”](../../sql-reference/dictionaries/index.md#embedded-dictionaries).
|
||||
|
||||
## Multiple Geobases
|
||||
|
||||
ClickHouse supports working with multiple alternative geobases (regional hierarchies) simultaneously, in order to support various perspectives on which countries certain regions belong to.
|
||||
|
||||
The ‘clickhouse-server’ config specifies the file with the regional hierarchy::`<path_to_regions_hierarchy_file>/opt/geo/regions_hierarchy.txt</path_to_regions_hierarchy_file>`
|
||||
The ‘clickhouse-server’ config specifies the file with the regional hierarchy:
|
||||
|
||||
Besides this file, it also searches for files nearby that have the _ symbol and any suffix appended to the name (before the file extension).
|
||||
For example, it will also find the file `/opt/geo/regions_hierarchy_ua.txt`, if present.
|
||||
```<path_to_regions_hierarchy_file>/opt/geo/regions_hierarchy.txt</path_to_regions_hierarchy_file>```
|
||||
|
||||
`ua` is called the dictionary key. For a dictionary without a suffix, the key is an empty string.
|
||||
Besides this file, it also searches for files nearby that have the `_` symbol and any suffix appended to the name (before the file extension).
|
||||
For example, it will also find the file `/opt/geo/regions_hierarchy_ua.txt`, if present. Here `ua` is called the dictionary key. For a dictionary without a suffix, the key is an empty string.
|
||||
|
||||
All the dictionaries are re-loaded in runtime (once every certain number of seconds, as defined in the [`builtin_dictionaries_reload_interval`](../../operations/server-configuration-parameters/settings#builtin-dictionaries-reload-interval) config parameter, or once an hour by default). However, the list of available dictionaries is defined one time, when the server starts.
|
||||
All the dictionaries are re-loaded during runtime (once every certain number of seconds, as defined in the [`builtin_dictionaries_reload_interval`](../../operations/server-configuration-parameters/settings#builtin-dictionaries-reload-interval) config parameter, or once an hour by default). However, the list of available dictionaries is defined once, when the server starts.
|
||||
|
||||
All functions for working with regions have an optional argument at the end – the dictionary key. It is referred to as the geobase.
|
||||
|
||||
@ -37,6 +37,45 @@ regionToCountry(RegionID, '') – Uses the default dictionary: /opt/geo/regions_
|
||||
regionToCountry(RegionID, 'ua') – Uses the dictionary for the 'ua' key: /opt/geo/regions_hierarchy_ua.txt
|
||||
```
|
||||
|
||||
### regionToName
|
||||
|
||||
Accepts a region ID and geobase and returns a string of the name of the region in the corresponding language. If the region with the specified ID does not exist, an empty string is returned.
|
||||
|
||||
**Syntax**
|
||||
|
||||
``` sql
|
||||
regionToName(id\[, lang\])
|
||||
```
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Name of the region in the corresponding language specified by `geobase`. [String](../data-types/string).
|
||||
- Otherwise, an empty string.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
|
||||
``` sql
|
||||
SELECT regionToName(number::UInt32,'en') FROM numbers(0,5);
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
``` text
|
||||
┌─regionToName(CAST(number, 'UInt32'), 'en')─┐
|
||||
│ │
|
||||
│ World │
|
||||
│ USA │
|
||||
│ Colorado │
|
||||
│ Boulder County │
|
||||
└────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### regionToCity
|
||||
|
||||
Accepts a region ID from the geobase. If this region is a city or part of a city, it returns the region ID for the appropriate city. Otherwise, returns 0.
|
||||
@ -49,16 +88,14 @@ regionToCity(id [, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Region ID for the appropriate city, if it exists.
|
||||
- Region ID for the appropriate city, if it exists. [UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -99,16 +136,14 @@ regionToArea(id [, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Area
|
||||
- Region ID for the appropriate area, if it exists. [UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -153,16 +188,14 @@ regionToDistrict(id [, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id`: the region ID from the geobase. [UInt32](../data-types/int-uint.md/#uint8-uint16-uint32-uint64-uint128-uint256-int8-int16-int32-int64-int128-int256)
|
||||
- `geobase` (optional): geobase (dictionary key). [Dictionary Key](../../sql-reference/dictionaries/index.md/#dictionary-key-and-fields-dictionary-key-and-fields)
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Region ID for the appropriate city, if it exists.
|
||||
- Region ID for the appropriate city, if it exists. [UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -197,8 +230,7 @@ Result:
|
||||
|
||||
### regionToCountry
|
||||
|
||||
Converts a region to a country. In every other way, this function is the same as ‘regionToCity’.
|
||||
Example: `regionToCountry(toUInt32(213)) = 225` converts Moscow (213) to Russia (225).
|
||||
Converts a region to a country (type 3 in the geobase). In every other way, this function is the same as ‘regionToCity’.
|
||||
|
||||
**Syntax**
|
||||
|
||||
@ -208,16 +240,14 @@ regionToCountry(id [, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Region ID for the appropriate country, if it exists.
|
||||
- Region ID for the appropriate country, if it exists. [UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -248,7 +278,7 @@ Result:
|
||||
|
||||
### regionToContinent
|
||||
|
||||
Converts a region to a continent. In every other way, this function is the same as ‘regionToCity’.
|
||||
Converts a region to a continent (type 1 in the geobase). In every other way, this function is the same as ‘regionToCity’.
|
||||
|
||||
**Syntax**
|
||||
|
||||
@ -258,16 +288,14 @@ regionToContinent(id [, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Region ID for the appropriate continent, if it exists.
|
||||
- Region ID for the appropriate continent, if it exists. [UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -308,16 +336,14 @@ regionToTopContinent(id[, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Identifier of the top level continent (the latter when you climb the hierarchy of regions).
|
||||
- Identifier of the top level continent (the latter when you climb the hierarchy of regions).[UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -358,16 +384,14 @@ regionToPopulation(id[, geobase])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Population for the region.
|
||||
- Population for the region. [UInt32](../data-types/int-uint).
|
||||
- 0, if there is none.
|
||||
|
||||
Type: `UInt32`.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
@ -398,7 +422,7 @@ Result:
|
||||
|
||||
### regionIn
|
||||
|
||||
Checks whether a ‘lhs’ region belongs to a ‘rhs’ region. Returns a UInt8 number equal to 1 if it belongs, or 0 if it does not belong.
|
||||
Checks whether a `lhs` region belongs to a `rhs` region. Returns a UInt8 number equal to 1 if it belongs, or 0 if it does not belong.
|
||||
|
||||
**Syntax**
|
||||
|
||||
@ -408,17 +432,15 @@ regionIn(lhs, rhs\[, geobase\])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `lhs` — Lhs region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `rhs` — Rhs region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `lhs` — Lhs region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint).
|
||||
- `rhs` — Rhs region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- 1, if it belongs.
|
||||
- 1, if it belongs. [UInt8](../../sql-reference/data-types/int-uint).
|
||||
- 0, if it doesn't belong.
|
||||
|
||||
Type: `UInt8`.
|
||||
|
||||
**Implementation details**
|
||||
|
||||
The relationship is reflexive – any region also belongs to itself.
|
||||
@ -449,7 +471,6 @@ USA is not in Boulder
|
||||
### regionHierarchy
|
||||
|
||||
Accepts a UInt32 number – the region ID from the geobase. Returns an array of region IDs consisting of the passed region and all parents along the chain.
|
||||
Example: `regionHierarchy(toUInt32(213)) = [213,1,3,225,10001,10000]`.
|
||||
|
||||
**Syntax**
|
||||
|
||||
@ -459,15 +480,12 @@ regionHierarchy(id\[, geobase\])
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
- `id` — Region ID from the geobase. [UInt32](../data-types/int-uint).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../data-types/string). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Array of region IDs consisting of the passed region and all parents along the chain.
|
||||
|
||||
Type: `Array(UInt32)`
|
||||
|
||||
- Array of region IDs consisting of the passed region and all parents along the chain. [Array](../data-types/array)([UInt32](../data-types/int-uint.md)).
|
||||
|
||||
**Example**
|
||||
|
||||
@ -487,44 +505,4 @@ Result:
|
||||
│ [3,2,10,9,1] │ ['Colorado','USA','North America','America','World'] │
|
||||
│ [4,3,2,10,9,1] │ ['Boulder County','Colorado','USA','North America','America','World'] │
|
||||
└────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### regionToName
|
||||
|
||||
Accepts a region ID and geobase and returns a string of the name of the region in the corresponding language. If the region with the specified ID does not exist, an empty string is returned.
|
||||
|
||||
**Syntax**
|
||||
|
||||
``` sql
|
||||
regionToName(id\[, lang\])
|
||||
```
|
||||
**Parameters**
|
||||
|
||||
- `id` — Region ID from the geobase. [UInt32](../../sql-reference/data-types/int-uint.md).
|
||||
- `geobase` — Dictionary key. See [Multiple Geobases](#multiple-geobases). [String](../../sql-reference/data-types/string.md). Optional.
|
||||
|
||||
**Returned value**
|
||||
|
||||
- Name of the region in the corresponding language specified by `geobase`.
|
||||
|
||||
Type: String.
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
|
||||
``` sql
|
||||
SELECT regionToName(number::UInt32,'en') FROM numbers(0,5);
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
``` text
|
||||
┌─regionToName(CAST(number, 'UInt32'), 'en')─┐
|
||||
│ │
|
||||
│ World │
|
||||
│ USA │
|
||||
│ Colorado │
|
||||
│ Boulder County │
|
||||
└────────────────────────────────────────────┘
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user