mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-09-20 08:40:50 +00:00
d91c97d15d
* Replace underscores with hyphens * remove temporary code * fix style check * fix collapse
208 lines
7.0 KiB
Markdown
208 lines
7.0 KiB
Markdown
---
|
||
toc_priority: 54
|
||
toc_title: Working with URLs
|
||
---
|
||
|
||
# Functions for Working with URLs {#functions-for-working-with-urls}
|
||
|
||
All these functions don’t follow the RFC. They are maximally simplified for improved performance.
|
||
|
||
## Functions that Extract Parts of a URL {#functions-that-extract-parts-of-a-url}
|
||
|
||
If the relevant part isn’t present in a URL, an empty string is returned.
|
||
|
||
### protocol {#protocol}
|
||
|
||
Extracts the protocol from a URL.
|
||
|
||
Examples of typical returned values: http, https, ftp, mailto, tel, magnet…
|
||
|
||
### domain {#domain}
|
||
|
||
Extracts the hostname from a URL.
|
||
|
||
``` sql
|
||
domain(url)
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
- `url` — URL. Type: [String](../../sql-reference/data-types/string.md).
|
||
|
||
The URL can be specified with or without a scheme. Examples:
|
||
|
||
``` text
|
||
svn+ssh://some.svn-hosting.com:80/repo/trunk
|
||
some.svn-hosting.com:80/repo/trunk
|
||
https://yandex.com/time/
|
||
```
|
||
|
||
For these examples, the `domain` function returns the following results:
|
||
|
||
``` text
|
||
some.svn-hosting.com
|
||
some.svn-hosting.com
|
||
yandex.com
|
||
```
|
||
|
||
**Returned values**
|
||
|
||
- Host name. If ClickHouse can parse the input string as a URL.
|
||
- Empty string. If ClickHouse can’t parse the input string as a URL.
|
||
|
||
Type: `String`.
|
||
|
||
**Example**
|
||
|
||
``` 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}
|
||
|
||
Returns the domain and removes no more than one ‘www.’ from the beginning of it, if present.
|
||
|
||
### topLevelDomain {#topleveldomain}
|
||
|
||
Extracts the the top-level domain from a URL.
|
||
|
||
``` sql
|
||
topLevelDomain(url)
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
- `url` — URL. Type: [String](../../sql-reference/data-types/string.md).
|
||
|
||
The URL can be specified with or without a scheme. Examples:
|
||
|
||
``` text
|
||
svn+ssh://some.svn-hosting.com:80/repo/trunk
|
||
some.svn-hosting.com:80/repo/trunk
|
||
https://yandex.com/time/
|
||
```
|
||
|
||
**Returned values**
|
||
|
||
- Domain name. If ClickHouse can parse the input string as a URL.
|
||
- Empty string. If ClickHouse cannot parse the input string as a URL.
|
||
|
||
Type: `String`.
|
||
|
||
**Example**
|
||
|
||
``` 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}
|
||
|
||
Returns the “first significant subdomain”. This is a non-standard concept specific to Yandex.Metrica. The first significant subdomain is a second-level domain if it is ‘com’, ‘net’, ‘org’, or ‘co’. Otherwise, it is a third-level domain. For example, `firstSignificantSubdomain (‘https://news.yandex.ru/’) = ‘yandex’, firstSignificantSubdomain (‘https://news.yandex.com.tr/’) = ‘yandex’`. The list of “insignificant” second-level domains and other implementation details may change in the future.
|
||
|
||
### cutToFirstSignificantSubdomain {#cuttofirstsignificantsubdomain}
|
||
|
||
Returns the part of the domain that includes top-level subdomains up to the “first significant subdomain” (see the explanation above).
|
||
|
||
For example, `cutToFirstSignificantSubdomain('https://news.yandex.com.tr/') = 'yandex.com.tr'`.
|
||
|
||
### path {#path}
|
||
|
||
Returns the path. Example: `/top/news.html` The path does not include the query string.
|
||
|
||
### pathFull {#pathfull}
|
||
|
||
The same as above, but including query string and fragment. Example: /top/news.html?page=2\#comments
|
||
|
||
### queryString {#querystring}
|
||
|
||
Returns the query string. Example: page=1&lr=213. query-string does not include the initial question mark, as well as \# and everything after \#.
|
||
|
||
### fragment {#fragment}
|
||
|
||
Returns the fragment identifier. fragment does not include the initial hash symbol.
|
||
|
||
### queryStringAndFragment {#querystringandfragment}
|
||
|
||
Returns the query string and fragment identifier. Example: page=1\#29390.
|
||
|
||
### extractURLParameter(URL, name) {#extracturlparameterurl-name}
|
||
|
||
Returns the value of the ‘name’ parameter in the URL, if present. Otherwise, an empty string. If there are many parameters with this name, it returns the first occurrence. This function works under the assumption that the parameter name is encoded in the URL exactly the same way as in the passed argument.
|
||
|
||
### extractURLParameters(URL) {#extracturlparametersurl}
|
||
|
||
Returns an array of name=value strings corresponding to the URL parameters. The values are not decoded in any way.
|
||
|
||
### extractURLParameterNames(URL) {#extracturlparameternamesurl}
|
||
|
||
Returns an array of name strings corresponding to the names of URL parameters. The values are not decoded in any way.
|
||
|
||
### URLHierarchy(URL) {#urlhierarchyurl}
|
||
|
||
Returns an array containing the URL, truncated at the end by the symbols /,? in the path and query-string. Consecutive separator characters are counted as one. The cut is made in the position after all the consecutive separator characters.
|
||
|
||
### URLPathHierarchy(URL) {#urlpathhierarchyurl}
|
||
|
||
The same as above, but without the protocol and host in the result. The / element (root) is not included. Example: the function is used to implement tree reports the URL in Yandex. Metric.
|
||
|
||
``` text
|
||
URLPathHierarchy('https://example.com/browse/CONV-6788') =
|
||
[
|
||
'/browse/',
|
||
'/browse/CONV-6788'
|
||
]
|
||
```
|
||
|
||
### decodeURLComponent(URL) {#decodeurlcomponenturl}
|
||
|
||
Returns the decoded URL.
|
||
Example:
|
||
|
||
``` 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; │
|
||
└────────────────────────────────────────┘
|
||
```
|
||
|
||
## Functions that Remove Part of a URL {#functions-that-remove-part-of-a-url}
|
||
|
||
If the URL doesn’t have anything similar, the URL remains unchanged.
|
||
|
||
### cutWWW {#cutwww}
|
||
|
||
Removes no more than one ‘www.’ from the beginning of the URL’s domain, if present.
|
||
|
||
### cutQueryString {#cutquerystring}
|
||
|
||
Removes query string. The question mark is also removed.
|
||
|
||
### cutFragment {#cutfragment}
|
||
|
||
Removes the fragment identifier. The number sign is also removed.
|
||
|
||
### cutQueryStringAndFragment {#cutquerystringandfragment}
|
||
|
||
Removes the query string and fragment identifier. The question mark and number sign are also removed.
|
||
|
||
### cutURLParameter(URL, name) {#cuturlparameterurl-name}
|
||
|
||
Removes the ‘name’ URL parameter, if present. This function works under the assumption that the parameter name is encoded in the URL exactly the same way as in the passed argument.
|
||
|
||
[Original article](https://clickhouse.tech/docs/en/query_language/functions/url_functions/) <!--hide-->
|