ClickHouse/docs/ru/sql-reference/functions/url-functions.md
Ivan Blinkov d91c97d15d
[docs] replace underscores with hyphens (#10606)
* Replace underscores with hyphens

* remove temporary code

* fix style check

* fix collapse
2020-04-30 21:19:18 +03:00

202 lines
9.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Функции для работы с URL {#funktsii-dlia-raboty-s-url}
Все функции работают не по RFC - то есть, максимально упрощены ради производительности.
## Функции, извлекающие часть URL-а {#funktsii-izvlekaiushchie-chast-url-a}
Если в URL-е нет ничего похожего, то возвращается пустая строка.
### protocol {#protocol}
Возвращает протокол. Примеры: http, ftp, mailto, magnet…
### domain {#domain}
Извлекает имя хоста из URL.
``` sql
domain(url)
```
**Параметры**
- `url` — URL. Тип — [String](../../sql-reference/functions/url-functions.md).
URL может быть указан со схемой или без неё. Примеры:
``` text
svn+ssh://some.svn-hosting.com:80/repo/trunk
some.svn-hosting.com:80/repo/trunk
https://yandex.com/time/
```
Для указанных примеров функция `domain` возвращает следующие результаты:
``` text
some.svn-hosting.com
some.svn-hosting.com
yandex.com
```
**Возвращаемые значения**
- Имя хоста. Если ClickHouse может распарсить входную строку как URL.
- Пустая строка. Если ClickHouse не может распарсить входную строку как URL.
Тип — `String`.
**Пример**
``` sql
SELECT domain('svn+ssh://some.svn-hosting.com:80/repo/trunk')
```
``` text
┌─domain('svn+ssh://some.svn-hosting.com:80/repo/trunk')─┐
│ some.svn-hosting.com │
└────────────────────────────────────────────────────────┘
```
### domainWithoutWWW {#domainwithoutwww}
Возвращает домен, удалив префикс www., если он присутствовал.
### topLevelDomain {#topleveldomain}
Извлекает домен верхнего уровня из URL.
``` sql
topLevelDomain(url)
```
**Параметры**
- `url` — URL. Тип — [String](../../sql-reference/functions/url-functions.md).
URL может быть указан со схемой или без неё. Примеры:
``` text
svn+ssh://some.svn-hosting.com:80/repo/trunk
some.svn-hosting.com:80/repo/trunk
https://yandex.com/time/
```
**Возвращаемые значения**
- Имя домена. Если ClickHouse может распарсить входную строку как URL.
- Пустая строка. Если ClickHouse не может распарсить входную строку как URL.
Тип — `String`.
**Пример**
``` sql
SELECT topLevelDomain('svn+ssh://www.some.svn-hosting.com:80/repo/trunk')
```
``` text
┌─topLevelDomain('svn+ssh://www.some.svn-hosting.com:80/repo/trunk')─┐
│ com │
└────────────────────────────────────────────────────────────────────┘
```
### firstSignificantSubdomain {#firstsignificantsubdomain}
Возвращает «первый существенный поддомен». Это понятие является нестандартным и специфично для Яндекс.Метрики. Первый существенный поддомен - это домен второго уровня, если он не равен одному из com, net, org, co, или домен третьего уровня, иначе. Например, firstSignificantSubdomain(https://news.yandex.ru/) = yandex, firstSignificantSubdomain(https://news.yandex.com.tr/) = yandex. Список «несущественных» доменов второго уровня и другие детали реализации могут изменяться в будущем.
### cutToFirstSignificantSubdomain {#cuttofirstsignificantsubdomain}
Возвращает часть домена, включающую поддомены верхнего уровня до «первого существенного поддомена» (см. выше).
Например, `cutToFirstSignificantSubdomain('https://news.yandex.com.tr/') = 'yandex.com.tr'`.
### path {#path}
Возвращает путь. Пример: `/top/news.html` Путь не включает в себя query string.
### pathFull {#pathfull}
То же самое, но включая query string и fragment. Пример: /top/news.html?page=2\#comments
### queryString {#querystring}
Возвращает query-string. Пример: page=1&lr=213. query-string не включает в себя начальный знак вопроса, а также \# и всё, что после \#.
### fragment {#fragment}
Возвращает fragment identifier. fragment не включает в себя начальный символ решётки.
### queryStringAndFragment {#querystringandfragment}
Возвращает query string и fragment identifier. Пример: страница=1\#29390.
### extractURLParameter(URL, name) {#extracturlparameterurl-name}
Возвращает значение параметра name в URL, если такой есть; или пустую строку, иначе; если параметров с таким именем много - вернуть первый попавшийся. Функция работает при допущении, что имя параметра закодировано в URL в точности таким же образом, что и в переданном аргументе.
### extractURLParameters(URL) {#extracturlparametersurl}
Возвращает массив строк вида name=value, соответствующих параметрам URL. Значения никак не декодируются.
### extractURLParameterNames(URL) {#extracturlparameternamesurl}
Возвращает массив строк вида name, соответствующих именам параметров URL. Значения никак не декодируются.
### URLHierarchy(URL) {#urlhierarchyurl}
Возвращает массив, содержащий URL, обрезанный с конца по символам /, ? в пути и query-string. Подряд идущие символы-разделители считаются за один. Резка производится в позиции после всех подряд идущих символов-разделителей. Пример:
### URLPathHierarchy(URL) {#urlpathhierarchyurl}
То же самое, но без протокола и хоста в результате. Элемент / (корень) не включается. Пример:
Функция используется для реализации древовидных отчётов по URL в Яндекс.Метрике.
``` text
URLPathHierarchy('https://example.com/browse/CONV-6788') =
[
'/browse/',
'/browse/CONV-6788'
]
```
### decodeURLComponent(URL) {#decodeurlcomponenturl}
Возвращает декодированный URL.
Пример:
``` sql
SELECT decodeURLComponent('http://127.0.0.1:8123/?query=SELECT%201%3B') AS DecodedURL;
```
``` text
┌─DecodedURL─────────────────────────────┐
│ http://127.0.0.1:8123/?query=SELECT 1; │
└────────────────────────────────────────┘
```
## Функции, удаляющие часть из URL-а {#funktsii-udaliaiushchie-chast-iz-url-a}
Если в URL-е нет ничего похожего, то URL остаётся без изменений.
### cutWWW {#cutwww}
Удаляет не более одного www. с начала домена URL-а, если есть.
### cutQueryString {#cutquerystring}
Удаляет query string. Знак вопроса тоже удаляется.
### cutFragment {#cutfragment}
Удаляет fragment identifier. Символ решётки тоже удаляется.
### cutQueryStringAndFragment {#cutquerystringandfragment}
Удаляет query string и fragment identifier. Знак вопроса и символ решётки тоже удаляются.
### cutURLParameter(URL, name) {#cuturlparameterurl-name}
Удаляет параметр URL с именем name, если такой есть. Функция работает при допущении, что имя параметра закодировано в URL в точности таким же образом, что и в переданном аргументе.
[Оригинальная статья](https://clickhouse.tech/docs/ru/query_language/functions/url_functions/) <!--hide-->