mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-09-23 10:10:50 +00:00
67c2e50331
* update presentations * CLICKHOUSE-2936: redirect from clickhouse.yandex.ru and clickhouse.yandex.com * update submodule * lost files * CLICKHOUSE-2981: prefer sphinx docs over original reference * CLICKHOUSE-2981: docs styles more similar to main website + add flags to switch language links * update presentations * Less confusing directory structure (docs -> doc/reference/) * Minify sphinx docs too * Website release script: fail fast + pass docker hash on deploy * Do not underline links in docs * shorter * cleanup docker images * tune nginx config * CLICKHOUSE-3043: get rid of habrastorage links * Lost translation * CLICKHOUSE-2936: temporary client-side redirect * behaves weird in test * put redirect back * CLICKHOUSE-3047: copy docs txts to public too * move to proper file * remove old pages to avoid confusion * Remove reference redirect warning for now * Refresh README.md * Yellow buttons in docs * Use svg flags instead of unicode ones in docs * fix test website instance * Put flags to separate files * wrong flag * Copy Yandex.Metrica introduction from main page to docs * Yet another home page structure change, couple new blocks (CLICKHOUSE-3045) * Update Contacts section * CLICKHOUSE-2849: more detailed legal information * CLICKHOUSE-2978 preparation - split by files * More changes in Contacts block * Tune texts on index page * update presentations * One more benchmark * Add usage sections to index page, adapted from slides * Get the roadmap started, based on slides from last ClickHouse Meetup * CLICKHOUSE-2977: some rendering tuning * Get rid of excessive section in the end of getting started * Make headers linkable * CLICKHOUSE-2981: links to editing reference - https://github.com/yandex/ClickHouse/issues/849 * CLICKHOUSE-2981: fix mobile styles in docs * Ban crawling of duplicating docs * Open some external links in new tab * Ban old docs too * Lots of trivial fixes in english docs * Lots of trivial fixes in russian docs * Remove getting started copies in markdown * Add Yandex.Webmaster * Fix some sphinx warnings * More warnings fixed in english docs * More sphinx warnings fixed * Add code-block:: text * More code-block:: text * These headers look not that well * Better switch between documentation languages * merge use_case.rst into ya_metrika_task.rst * Edit the agg_functions.rst texts * Add lost empty lines * Lost blank lines * Add new logo sizes * update presentations * Next step in migrating to new documentation * Fix all warnings in en reference * Fix all warnings in ru reference * Re-arrange existing reference * Move operation tips to main reference * Fix typos noticed by milovidov@ * Get rid of zookeeper.md * Looks like duplicate of tutorial.html * Fix some mess with html tags in tutorial * No idea why nobody noticed this before, but it was completely not clear whet to get the data * Match code block styling between main and tutorial pages (in favor of the latter) * Get rid of some copypaste in tutorial * Normalize header styles * Move example_datasets to sphinx * Move presentations submodule to website * Move and update README.md * No point in duplicating articles from habrahabr here * Move development-related docs as is for now * doc/reference/ -> docs/ (to match the URL on website) * Adapt links to match the previous commit * Adapt development docs to rst (still lacks translation and strikethrough support) * clean on release * blacklist presentations in gulp * strikethrough support in sphinx * just copy development folder for now * fix weird introduction in style article * Style guide translation (WIP) * Finish style guide translation to English * gulp clean separately * Update year in LICENSE * Initial CONTRIBUTING.md * Fix remaining links to old docs in tutorial * Some tutorial fixes * Typo * Another typo * Update list of authors from yandex-team accoding to git log
126 lines
7.5 KiB
ReStructuredText
126 lines
7.5 KiB
ReStructuredText
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 indicated as the geobase.
|
|
Example:
|
|
|
|
.. code-block:: text
|
|
|
|
regionToCountry(RegionID) - Uses the default dictionary: /opt/geo/regions_hierarchy.txt
|
|
regionToCountry(RegionID, '') - Uses the default dictionary: /opt/geo/regions_hierarchy.txt
|
|
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'.
|
|
|
|
.. code-block:: sql
|
|
|
|
SELECT DISTINCT regionToName(regionToArea(toUInt32(number), 'ua'), 'en')
|
|
FROM system.numbers
|
|
LIMIT 15
|
|
|
|
.. code-block:: text
|
|
|
|
┌─regionToName(regionToArea(toUInt32(number), \'ua\'), \'en\')─┐
|
|
│ │
|
|
│ Moscow and Moscow region │
|
|
│ Saint-Petersburg and Leningradskaya oblast │
|
|
│ Belgorod District │
|
|
│ Ivanovo district │
|
|
│ Kaluga District │
|
|
│ Kostroma District │
|
|
│ Kursk District │
|
|
│ Lipetsk District │
|
|
│ Orel District │
|
|
│ Ryazhan District │
|
|
│ Smolensk District │
|
|
│ Tambov District │
|
|
│ Tver District │
|
|
│ Tula District │
|
|
└──────────────────────────────────────────────────────────────┘
|
|
|
|
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'.
|
|
|
|
.. code-block:: sql
|
|
|
|
SELECT DISTINCT regionToName(regionToDistrict(toUInt32(number), 'ua'), 'en')
|
|
FROM system.numbers
|
|
LIMIT 15
|
|
|
|
.. code-block:: text
|
|
|
|
┌─regionToName(regionToDistrict(toUInt32(number), \'ua\'), \'en\')─┐
|
|
│ │
|
|
│ Central │
|
|
│ Northwest │
|
|
│ South │
|
|
│ North Kavkaz │
|
|
│ Volga Region │
|
|
│ Ural │
|
|
│ Siberian │
|
|
│ Far East │
|
|
│ Scotland │
|
|
│ Faroe Islands │
|
|
│ Flemish Region │
|
|
│ Brussels-Capital Region │
|
|
│ Wallonia │
|
|
│ Federation of Bosnia and Herzegovina │
|
|
└──────────────────────────────────────────────────────────────────┘
|
|
|
|
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`` mean the same thing - Ukrainian.
|