Functions for working with Yandex.Metrica dictionaries

In order for the functions below to work, the server config must specify the paths and addresses for getting all the Yandex.Metrica 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.

For information about creating reference lists, see the section “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>

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.

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 config parameter, or once an hour by default). However, the list of available dictionaries is defined one time, 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.
Example:

  1. regionToCountry(RegionID) – Uses the default dictionary: /opt/geo/regions_hierarchy.txt
  2. regionToCountry(RegionID, '') – Uses the default dictionary: /opt/geo/regions_hierarchy.txt
  3. regionToCountry(RegionID, 'ua') – Uses the dictionary for the 'ua' key: /opt/geo/regions_hierarchy_ua.txt

regionToCity(id[, geobase])

Accepts a UInt32 number – the region ID from the Yandex geobase. If this region is a city or part of a city, it returns the region ID for the appropriate city. Otherwise, returns 0.

regionToArea(id[, geobase])

Converts a region to an area (type 5 in the geobase). In every other way, this function is the same as ‘regionToCity’.

  1. SELECT DISTINCT regionToName(regionToArea(toUInt32(number), 'ua'))
  2. FROM system.numbers
  3. LIMIT 15
  1. ┌─regionToName(regionToArea(toUInt32(number), \'ua\'))─┐
  2. │                                                      │
  3. │ Moscow and Moscow region                             │
  4. │ St. Petersburg and Leningrad region                  │
  5. │ Belgorod region                                      │
  6. │ Ivanovsk region                                      │
  7. │ Kaluga region                                        │
  8. │ Kostroma region                                      │
  9. │ Kursk region                                         │
  10. │ Lipetsk region                                       │
  11. │ Orlov region                                         │
  12. │ Ryazan region                                        │
  13. │ Smolensk region                                      │
  14. │ Tambov region                                        │
  15. │ Tver region                                          │
  16. │ Tula region                                          │
  17. └──────────────────────────────────────────────────────┘

regionToDistrict(id[, geobase])

Converts a region to a federal district (type 4 in the geobase). In every other way, this function is the same as ‘regionToCity’.

  1. SELECT DISTINCT regionToName(regionToDistrict(toUInt32(number), 'ua'))
  2. FROM system.numbers
  3. LIMIT 15
  1. ┌─regionToName(regionToDistrict(toUInt32(number), \'ua\'))─┐
  2. │                                                          │
  3. │ Central federal district                                 │
  4. │ Northwest federal district                               │
  5. │ South federal district                                   │
  6. │ North Caucases federal district                          │
  7. │ Privolga federal district                                │
  8. │ Ural federal district                                    │
  9. │ Siberian federal district                                │
  10. │ Far East federal district                                │
  11. │ Scotland                                                 │
  12. │ Faroe Islands                                            │
  13. │ Flemish region                                           │
  14. │ Brussels capital region                                  │
  15. │ Wallonia                                                 │
  16. │ Federation of Bosnia and Herzegovina                     │
  17. └──────────────────────────────────────────────────────────┘

regionToCountry(id[, geobase])

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).

regionToContinent(id[, geobase])

Converts a region to a continent. In every other way, this function is the same as ‘regionToCity’.
Example: regionToContinent(toUInt32(213)) = 10001 converts Moscow (213) to Eurasia (10001).

regionToPopulation(id[, geobase])

Gets the population for a region.
The population can be recorded in files with the geobase. See the section “External dictionaries”.
If the population is not recorded for the region, it returns 0.
In the Yandex geobase, the population might be recorded for child regions, but not for parent regions.

regionIn(lhs, rhs[, geobase])

Checks whether a ‘lhs’ region belongs to a ‘rhs’ region. Returns a UInt8 number equal to 1 if it belongs, or 0 if it doesn’t belong.
The relationship is reflexive – any region also belongs to itself.

regionHierarchy(id[, geobase])

Accepts a UInt32 number – the region ID from the Yandex 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].

regionToName(id[, lang])

Accepts a UInt32 number – the region ID from the Yandex geobase. A string with the name of the language can be passed as a second argument. Supported languages are: ru, en, ua, uk, by, kz, tr. If the second argument is omitted, the language ‘ru’ is used. If the language is not supported, an exception is thrown. Returns a string – the name of the region in the corresponding language. If the region with the specified ID doesn’t exist, an empty string is returned.

ua and uk both mean Ukrainian.