mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-21 15:12:02 +00:00
Merge pull request #27986 from sevirov/sevirov-DOCSUP-13590-document_the_getserverport_function
DOCSUP-13590: Document the getServerPort function
This commit is contained in:
commit
1324ed5292
@ -2236,6 +2236,53 @@ defaultRoles()
|
||||
|
||||
Type: [Array](../../sql-reference/data-types/array.md)([String](../../sql-reference/data-types/string.md)).
|
||||
|
||||
## getServerPort {#getserverport}
|
||||
|
||||
Returns the number of the server port. When the port is not used by the server, throws an exception.
|
||||
|
||||
**Syntax**
|
||||
|
||||
``` sql
|
||||
getServerPort(port_name)
|
||||
```
|
||||
|
||||
**Arguments**
|
||||
|
||||
- `port_name` — The name of the server port. [String](../../sql-reference/data-types/string.md#string). Possible values:
|
||||
|
||||
- 'tcp_port'
|
||||
- 'tcp_port_secure'
|
||||
- 'http_port'
|
||||
- 'https_port'
|
||||
- 'interserver_http_port'
|
||||
- 'interserver_https_port'
|
||||
- 'mysql_port'
|
||||
- 'postgresql_port'
|
||||
- 'grpc_port'
|
||||
- 'prometheus.port'
|
||||
|
||||
**Returned value**
|
||||
|
||||
- The number of the server port.
|
||||
|
||||
Type: [UInt16](../../sql-reference/data-types/int-uint.md).
|
||||
|
||||
**Example**
|
||||
|
||||
Query:
|
||||
|
||||
``` sql
|
||||
SELECT getServerPort('tcp_port');
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
``` text
|
||||
┌─getServerPort('tcp_port')─┐
|
||||
│ 9000 │
|
||||
└───────────────────────────┘
|
||||
```
|
||||
|
||||
## queryID {#query-id}
|
||||
|
||||
Returns the ID of the current query. Other parameters of a query can be extracted from the [system.query_log](../../operations/system-tables/query_log.md) table via `query_id`.
|
||||
|
@ -2186,6 +2186,53 @@ defaultRoles()
|
||||
|
||||
Тип: [Array](../../sql-reference/data-types/array.md)([String](../../sql-reference/data-types/string.md)).
|
||||
|
||||
## getServerPort {#getserverport}
|
||||
|
||||
Возвращает номер порта сервера. Если порт не используется сервером, генерируется исключение.
|
||||
|
||||
**Синтаксис**
|
||||
|
||||
``` sql
|
||||
getServerPort(port_name)
|
||||
```
|
||||
|
||||
**Аргументы**
|
||||
|
||||
- `port_name` — имя порта сервера. [String](../../sql-reference/data-types/string.md#string). Возможные значения:
|
||||
|
||||
- 'tcp_port'
|
||||
- 'tcp_port_secure'
|
||||
- 'http_port'
|
||||
- 'https_port'
|
||||
- 'interserver_http_port'
|
||||
- 'interserver_https_port'
|
||||
- 'mysql_port'
|
||||
- 'postgresql_port'
|
||||
- 'grpc_port'
|
||||
- 'prometheus.port'
|
||||
|
||||
**Возвращаемое значение**
|
||||
|
||||
- Номер порта сервера.
|
||||
|
||||
Тип: [UInt16](../../sql-reference/data-types/int-uint.md).
|
||||
|
||||
**Пример**
|
||||
|
||||
Запрос:
|
||||
|
||||
``` sql
|
||||
SELECT getServerPort('tcp_port');
|
||||
```
|
||||
|
||||
Результат:
|
||||
|
||||
``` text
|
||||
┌─getServerPort('tcp_port')─┐
|
||||
│ 9000 │
|
||||
└───────────────────────────┘
|
||||
```
|
||||
|
||||
## queryID {#query-id}
|
||||
|
||||
Возвращает идентификатор текущего запроса. Другие параметры запроса могут быть извлечены из системной таблицы [system.query_log](../../operations/system-tables/query_log.md) через `query_id`.
|
||||
|
Loading…
Reference in New Issue
Block a user