thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-19 14:11:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
e319a1abeb
ClickHouse/docs/ru/functions/ym_dict_functions.rst

126 lines
9.9 KiB
ReStructuredText
Raw Normal View History

Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Функции для работы со словарями Яндекс.Метрики
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
----------------------------------------------
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Чтобы указанные ниже функции работали, в конфиге сервера должны быть указаны пути и адреса для получения всех словарей Яндекс.Метрики. Словари загружаются при первом вызове любой из этих функций. Если справочники не удаётся загрузить - будет выкинуто исключение.
О том, как создать справочники, смотрите в разделе "Словари".
Множественные геобазы
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
ClickHouse поддерживает работу одновременно с несколькими альтернативными геобазами (иерархиями регионов), для того чтобы можно было поддержать разные точки зрения о принадлежности регионов странам.
В конфиге clickhouse-server указывается файл с иерархией регионов:
``<path_to_regions_hierarchy_file>/opt/geo/regions_hierarchy.txt</path_to_regions_hierarchy_file>``
Кроме указанного файла, рядом ищутся файлы, к имени которых (до расширения) добавлен символ _ и какой угодно суффикс.
Например, также найдётся файл ``/opt/geo/regions_hierarchy_ua.txt``, если такой есть.
``ua`` называется ключом словаря. Для словаря без суффикса, ключ является пустой строкой.
Все словари перезагружаются в рантайме (раз в количество секунд, заданное в конфигурационном параметре builtin_dictionaries_reload_interval, по умолчанию - раз в час), но перечень доступных словарей определяется один раз, при старте сервера.
Во все функции по работе с регионами, в конце добавлен один необязательный аргумент - ключ словаря. Далее он обозначен как geobase.
Пример:
Fixed newlines in .rst files before code blocks [#CLICKHOUSE-2]. for i in $(find . -name '*.rst'); do grep -F -q '.. code-block:: ' $i && cat $i | sed -r -e 's/$/<NEWLINE>/' | tr -d '\n' | sed -r -e 's/([^>])<NEWLINE>.. code-block::/\1<NEWLINE><NEWLINE>.. code-block::/g' | sed -r -e 's/<NEWLINE>/\n/g' > ${i}.tmp && mv ${i}.tmp ${i}; done
2017-06-13 20:35:07 +00:00
CLICKHOUSE-2720: progress on website (#865) * 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
2017-06-13 04:15:47 +00:00
.. code-block:: text
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
regionToCountry(RegionID) - использует словарь по умолчанию: /opt/geo/regions_hierarchy.txt;
regionToCountry(RegionID, '') - использует словарь по умолчанию: /opt/geo/regions_hierarchy.txt;
regionToCountry(RegionID, 'ua') - использует словарь для ключа ua: /opt/geo/regions_hierarchy_ua.txt;
regionToCity(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Принимает число типа UInt32 - идентификатор региона из геобазы Яндекса. Если регион является городом или входит в некоторый город, то возвращает идентификатор региона - соответствующего города. Иначе возвращает 0.
regionToArea(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Переводит регион в область (тип в геобазе - 5). В остальном, аналогично функции regionToCity.
.. code-block:: sql
SELECT DISTINCT regionToName(regionToArea(toUInt32(number), 'ua'))
FROM system.numbers
LIMIT 15
Removed deprecated functions from documentation [#CLICKHOUSE-2].
2017-03-28 04:59:05 +00:00
CLICKHOUSE-2720: progress on website (#865) * 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
2017-06-13 04:15:47 +00:00
.. code-block:: text
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
┌─regionToName(regionToArea(toUInt32(number), \'ua\'))─┐
│ │
│ Москва и Московская область │
│ Санкт-Петербург и Ленинградская область │
│ Белгородская область │
│ Ивановская область │
│ Калужская область │
│ Костромская область │
│ Курская область │
│ Липецкая область │
│ Орловская область │
│ Рязанская область │
│ Смоленская область │
│ Тамбовская область │
│ Тверская область │
│ Тульская область │
└──────────────────────────────────────────────────────┘
regionToDistrict(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Переводит регион в федеральный округ (тип в геобазе - 4). В остальном, аналогично функции regionToCity.
.. code-block:: sql
SELECT DISTINCT regionToName(regionToDistrict(toUInt32(number), 'ua'))
FROM system.numbers
LIMIT 15
Removed deprecated functions from documentation [#CLICKHOUSE-2].
2017-03-28 04:59:05 +00:00
CLICKHOUSE-2720: progress on website (#865) * 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
2017-06-13 04:15:47 +00:00
.. code-block:: text
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
┌─regionToName(regionToDistrict(toUInt32(number), \'ua\'))─┐
│ │
│ Центральный федеральный округ │
│ Северо-Западный федеральный округ │
│ Южный федеральный округ │
│ Северо-Кавказский федеральный округ │
│ Приволжский федеральный округ │
│ Уральский федеральный округ │
│ Сибирский федеральный округ │
│ Дальневосточный федеральный округ │
│ Шотландия │
│ Фарерские острова │
│ Фламандский регион │
│ Брюссельский столичный регион │
│ Валлония │
│ Федерация Боснии и Герцеговины │
└──────────────────────────────────────────────────────────┘
regionToCountry(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Переводит регион в страну. В остальном, аналогично функции regionToCity.
Пример: ``regionToCountry(toUInt32(213)) = 225`` - преобразовали Москву (213) в Россию (225).
regionToContinent(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Переводит регион в континент. В остальном, аналогично функции regionToCity.
Пример: ``regionToContinent(toUInt32(213)) = 10001`` - преобразовали Москву (213) в Евразию (10001).
regionToPopulation(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Получает население для региона.
Население может быть прописано в файлах с геобазой. Смотрите в разделе "Встроенные словари".
Если для региона не прописано население, возвращается 0.
В геобазе Яндекса, население может быть прописано для дочерних регионов, но не прописано для родительских.
regionIn(lhs, rhs[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Проверяет принадлежность региона lhs региону rhs. Возвращает число типа UInt8, равное 1, если принадлежит и 0, если не принадлежит.
Отношение рефлексивное - любой регион принадлежит также самому себе.
regionHierarchy(id[, geobase])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Принимает число типа UInt32 - идентификатор региона из геобазы Яндекса. Возвращает массив идентификаторов регионов, состоящий из переданного региона и всех родителей по цепочке.
Пример: ``regionHierarchy(toUInt32(213)) = [213,1,3,225,10001,10000]``.
regionToName(id[, lang])
Fixed some ERRORS and WARNINGS during RU docs build. (#772) * Initial commit if EN docs * Part of EN documentation * Full queries section * External data * Table engines * System tables * Table functions * Formats * Data types * Operators * Functions * Dictionaries * Settings * Configuration files * Access rights * Quotas * Fixed few formatting errors * Fixed few formatting errors * Fixed few formatting errors * FIX: "WARNING: Title underline too short." during build RU docs. * FIX: "WARNING: Title underline too short." during build RU docs.
2017-05-08 05:06:04 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~
Added documentation in RST format. (ReadTheDocs ready)
2017-03-12 17:58:51 +00:00
Принимает число типа UInt32 - идентификатор региона из геобазы Яндекса. Вторым аргументом может быть передана строка - название языка. Поддерживаются языки ru, en, ua, uk, by, kz, tr. Если второй аргумент отсутствует - используется язык ru. Если язык не поддерживается - кидается исключение. Возвращает строку - название региона на соответствующем языке. Если региона с указанным идентификатором не существует - возвращается пустая строка.
``ua`` и ``uk`` обозначают одно и то же - украинский язык.
Reference in New Issue Copy Permalink