Various docs fixes

This commit is contained in:
rfraposa 2022-04-29 05:33:51 -06:00
parent 06ac99b1e7
commit e7b7b7ecd3
16 changed files with 84 additions and 43 deletions

View File

@ -9,6 +9,13 @@ Creates a ClickHouse database with tables from PostgreSQL database. Firstly, dat
Replication is implemented with PostgreSQL Logical Replication Protocol, which does not allow to replicate DDL, but allows to know whether replication breaking changes happened (column type changes, adding/removing columns). Such changes are detected and according tables stop receiving updates. Such tables can be automatically reloaded in the background in case required setting is turned on (can be used starting from 22.1). Safest way for now is to use `ATTACH`/ `DETACH` queries to reload table completely. If DDL does not break replication (for example, renaming a column) table will still receive updates (insertion is done by position). Replication is implemented with PostgreSQL Logical Replication Protocol, which does not allow to replicate DDL, but allows to know whether replication breaking changes happened (column type changes, adding/removing columns). Such changes are detected and according tables stop receiving updates. Such tables can be automatically reloaded in the background in case required setting is turned on (can be used starting from 22.1). Safest way for now is to use `ATTACH`/ `DETACH` queries to reload table completely. If DDL does not break replication (for example, renaming a column) table will still receive updates (insertion is done by position).
:::note
This database engine is experimental. To use it, set `allow_experimental_database_materialized_postgresql` to 1 in your configuration files or by using the `SET` command:
```sql
SET allow_experimental_database_materialized_postgresql=1
```
:::
## Creating a Database {#creating-a-database} ## Creating a Database {#creating-a-database}
``` sql ``` sql

View File

@ -43,14 +43,14 @@ or via config (since version 21.11):
<postgres1> <postgres1>
<host></host> <host></host>
<port></port> <port></port>
<username></username> <user></user>
<password></password> <password></password>
<table></table> <table></table>
</postgres1> </postgres1>
<postgres2> <postgres2>
<host></host> <host></host>
<port></port> <port></port>
<username></username> <user></user>
<password></password> <password></password>
</postgres2> </postgres2>
</named_collections> </named_collections>

View File

@ -13,10 +13,18 @@ Alias: `INET_NTOA`.
## IPv4StringToNum(s) {#ipv4stringtonums} ## IPv4StringToNum(s) {#ipv4stringtonums}
The reverse function of IPv4NumToString. If the IPv4 address has an invalid format, it returns 0. The reverse function of IPv4NumToString. If the IPv4 address has an invalid format, it throws exception.
Alias: `INET_ATON`. Alias: `INET_ATON`.
## IPv4StringToNumOrDefault(s) {#ipv4stringtonums}
Same as `IPv4StringToNum`, but if the IPv4 address has an invalid format, it returns 0.
## IPv4StringToNumOrNull(s) {#ipv4stringtonums}
Same as `IPv4StringToNum`, but if the IPv4 address has an invalid format, it returns null.
## IPv4NumToStringClassC(num) {#ipv4numtostringclasscnum} ## IPv4NumToStringClassC(num) {#ipv4numtostringclasscnum}
Similar to IPv4NumToString, but using xxx instead of the last octet. Similar to IPv4NumToString, but using xxx instead of the last octet.
@ -123,7 +131,7 @@ LIMIT 10
## IPv6StringToNum {#ipv6stringtonums} ## IPv6StringToNum {#ipv6stringtonums}
The reverse function of [IPv6NumToString](#ipv6numtostringx). If the IPv6 address has an invalid format, it returns a string of null bytes. The reverse function of [IPv6NumToString](#ipv6numtostringx). If the IPv6 address has an invalid format, it throws exception.
If the input string contains a valid IPv4 address, returns its IPv6 equivalent. If the input string contains a valid IPv4 address, returns its IPv6 equivalent.
HEX can be uppercase or lowercase. HEX can be uppercase or lowercase.
@ -168,6 +176,14 @@ Result:
- [cutIPv6](#cutipv6x-bytestocutforipv6-bytestocutforipv4). - [cutIPv6](#cutipv6x-bytestocutforipv6-bytestocutforipv4).
## IPv6StringToNumOrDefault(s) {#ipv6stringtonums}
Same as `IPv6StringToNum`, but if the IPv6 address has an invalid format, it returns 0.
## IPv6StringToNumOrNull(s) {#ipv6stringtonums}
Same as `IPv6StringToNum`, but if the IPv6 address has an invalid format, it returns null.
## IPv4ToIPv6(x) {#ipv4toipv6x} ## IPv4ToIPv6(x) {#ipv4toipv6x}
Takes a `UInt32` number. Interprets it as an IPv4 address in [big endian](https://en.wikipedia.org/wiki/Endianness). Returns a `FixedString(16)` value containing the IPv6 address in binary format. Examples: Takes a `UInt32` number. Interprets it as an IPv4 address in [big endian](https://en.wikipedia.org/wiki/Endianness). Returns a `FixedString(16)` value containing the IPv6 address in binary format. Examples:
@ -261,6 +277,14 @@ SELECT
└───────────────────────────────────┴──────────────────────────┘ └───────────────────────────────────┴──────────────────────────┘
``` ```
## toIPv4OrDefault(string) {#toipv4ordefaultstring}
Same as `toIPv4`, but if the IPv4 address has an invalid format, it returns 0.
## toIPv4OrNull(string) {#toipv4ornullstring}
Same as `toIPv4`, but if the IPv4 address has an invalid format, it returns null.
## toIPv6 {#toipv6string} ## toIPv6 {#toipv6string}
Converts a string form of IPv6 address to [IPv6](../../sql-reference/data-types/domains/ipv6.md) type. If the IPv6 address has an invalid format, returns an empty value. Converts a string form of IPv6 address to [IPv6](../../sql-reference/data-types/domains/ipv6.md) type. If the IPv6 address has an invalid format, returns an empty value.
@ -317,6 +341,14 @@ Result:
└─────────────────────┘ └─────────────────────┘
``` ```
## IPv6StringToNumOrDefault(s) {#toipv6ordefaultstring}
Same as `toIPv6`, but if the IPv6 address has an invalid format, it returns 0.
## IPv6StringToNumOrNull(s) {#toipv6ornullstring}
Same as `toIPv6`, but if the IPv6 address has an invalid format, it returns null.
## isIPv4String {#isipv4string} ## isIPv4String {#isipv4string}
Determines whether the input string is an IPv4 address or not. If `string` is IPv6 address returns `0`. Determines whether the input string is an IPv4 address or not. If `string` is IPv6 address returns `0`.

View File

@ -476,7 +476,7 @@ clickhouse-client --query "INSERT INTO tutorial.hits_v1 FORMAT TSV" --max_insert
clickhouse-client --query "INSERT INTO tutorial.visits_v1 FORMAT TSV" --max_insert_block_size=100000 < visits_v1.tsv clickhouse-client --query "INSERT INTO tutorial.visits_v1 FORMAT TSV" --max_insert_block_size=100000 < visits_v1.tsv
``` ```
ClickHouse has a lot of [settings to tune](../operations/settings/overview.md) and one way to specify them in console client is via arguments, as we can see with `--max_insert_block_size`. The easiest way to figure out what settings are available, what do they mean and what the defaults are is to query the `system.settings` table: ClickHouse has a lot of [settings to tune](../operations/settings/) and one way to specify them in console client is via arguments, as we can see with `--max_insert_block_size`. The easiest way to figure out what settings are available, what do they mean and what the defaults are is to query the `system.settings` table:
``` sql ``` sql
SELECT name, value, changed, description SELECT name, value, changed, description

View File

@ -242,7 +242,7 @@ $ echo 'SELECT 1' | curl -H 'X-ClickHouse-User: user' -H 'X-ClickHouse-Key: pass
Если пользователь не задан,то используется `default`. Если пароль не задан, то используется пустой пароль. Если пользователь не задан,то используется `default`. Если пароль не задан, то используется пустой пароль.
Также в параметрах URL вы можете указать любые настройки, которые будут использованы для обработки одного запроса, или целые профили настроек. Пример:http://localhost:8123/?profile=web&max_rows_to_read=1000000000&query=SELECT+1 Также в параметрах URL вы можете указать любые настройки, которые будут использованы для обработки одного запроса, или целые профили настроек. Пример:http://localhost:8123/?profile=web&max_rows_to_read=1000000000&query=SELECT+1
Подробнее смотрите в разделе [Настройки](../operations/settings/overview.md). Подробнее смотрите в разделе [Настройки](../operations/settings/).
``` bash ``` bash
$ echo 'SELECT number FROM system.numbers LIMIT 10' | curl 'http://localhost:8123/?' --data-binary @- $ echo 'SELECT number FROM system.numbers LIMIT 10' | curl 'http://localhost:8123/?' --data-binary @-
@ -432,7 +432,7 @@ $ curl -v 'http://localhost:8123/predefined_query'
``` xml ``` xml
<http_handlers> <http_handlers>
<rule> <rule>
<url><![CDATA[/query_param_with_url/\w+/(?P<name_1>[^/]+)(/(?P<name_2>[^/]+))?]]></url> <url><![CDATA[regex:/query_param_with_url/\w+/(?P<name_1>[^/]+)(/(?P<name_2>[^/]+))?]]></url>
<methods>GET</methods> <methods>GET</methods>
<headers> <headers>
<XXX>TEST_HEADER_VALUE</XXX> <XXX>TEST_HEADER_VALUE</XXX>

View File

@ -111,7 +111,7 @@ ClickHouse поддерживает управление доступом на
## Профиль настроек {#settings-profiles-management} ## Профиль настроек {#settings-profiles-management}
Профиль настроек — это набор [настроек](settings/overview.md). Профиль настроек содержит настройки и ограничения, а также список ролей и/или пользователей, по отношению к которым применяется данный профиль. Профиль настроек — это набор [настроек](settings/index.md). Профиль настроек содержит настройки и ограничения, а также список ролей и/или пользователей, по отношению к которым применяется данный профиль.
Запросы управления: Запросы управления:

View File

@ -19,6 +19,6 @@ sidebar_label: "Эксплуатация"
- [Системные таблицы](system-tables/index.md) - [Системные таблицы](system-tables/index.md)
- [Конфигурационные параметры сервера](server-configuration-parameters/index.md) - [Конфигурационные параметры сервера](server-configuration-parameters/index.md)
- [Тестирование серверов с помощью ClickHouse](performance-test.md) - [Тестирование серверов с помощью ClickHouse](performance-test.md)
- [Настройки](settings/overview.md#settings) - [Настройки](settings/index.md#settings)
- [Утилиты](utilities/index.md) - [Утилиты](utilities/index.md)

View File

@ -9,7 +9,7 @@ sidebar_position: 54
Рассмотренные настройки хранятся в файле `config.xml` сервера ClickHouse. Рассмотренные настройки хранятся в файле `config.xml` сервера ClickHouse.
Прочие настройки описаны в разделе «[Настройки](../settings/overview.md#settings)». Прочие настройки описаны в разделе «[Настройки](../settings/index.md#settings)».
Перед изучением настроек ознакомьтесь с разделом [Конфигурационные файлы](../configuration-files.md#configuration_files), обратите внимание на использование подстановок (атрибуты `incl` и `optional`). Перед изучением настроек ознакомьтесь с разделом [Конфигурационные файлы](../configuration-files.md#configuration_files), обратите внимание на использование подстановок (атрибуты `incl` и `optional`).

View File

@ -1,6 +1,7 @@
--- ---
sidebar_label: Settings sidebar_label: Settings
sidebar_position: 55 sidebar_position: 55
slug: /ru/operations/settings/
--- ---
# Настройки {#session-settings-intro} # Настройки {#session-settings-intro}

View File

@ -1,6 +1,7 @@
--- ---
sidebar_position: 60 sidebar_position: 60
sidebar_label: "Настройки" sidebar_label: "Настройки"
slug: /ru/operations/settings/settings
--- ---
# Настройки {#settings} # Настройки {#settings}
@ -2871,7 +2872,7 @@ SELECT CAST(toNullable(toInt32(0)) AS Int32) as x, toTypeName(x);
Значение по умолчанию: `1`. Значение по умолчанию: `1`.
## output_format_csv_null_representation {#output_format_csv_null_representation} ## format_csv_null_representation {#format_csv_null_representation}
Определяет представление `NULL` для формата выходных данных [CSV](../../interfaces/formats.md#csv). Пользователь может установить в качестве значения любую строку, например, `My NULL`. Определяет представление `NULL` для формата выходных данных [CSV](../../interfaces/formats.md#csv). Пользователь может установить в качестве значения любую строку, например, `My NULL`.
@ -2896,7 +2897,7 @@ SELECT * FROM csv_custom_null FORMAT CSV;
Запрос: Запрос:
```sql ```sql
SET output_format_csv_null_representation = 'My NULL'; SET format_csv_null_representation = 'My NULL';
SELECT * FROM csv_custom_null FORMAT CSV; SELECT * FROM csv_custom_null FORMAT CSV;
``` ```
@ -2908,7 +2909,7 @@ My NULL
My NULL My NULL
``` ```
## output_format_tsv_null_representation {#output_format_tsv_null_representation} ## format_tsv_null_representation {#format_tsv_null_representation}
Определяет представление `NULL` для формата выходных данных [TSV](../../interfaces/formats.md#tabseparated). Пользователь может установить в качестве значения любую строку. Определяет представление `NULL` для формата выходных данных [TSV](../../interfaces/formats.md#tabseparated). Пользователь может установить в качестве значения любую строку.
@ -2933,7 +2934,7 @@ SELECT * FROM tsv_custom_null FORMAT TSV;
Запрос Запрос
```sql ```sql
SET output_format_tsv_null_representation = 'My NULL'; SET format_tsv_null_representation = 'My NULL';
SELECT * FROM tsv_custom_null FORMAT TSV; SELECT * FROM tsv_custom_null FORMAT TSV;
``` ```

View File

@ -45,7 +45,7 @@ SELECT * FROM system.settings WHERE changed AND name='load_balancing'
**Cм. также** **Cм. также**
- [Настройки](../settings/overview.md#settings) - [Настройки](../settings/index.md#settings)
- [Разрешения для запросов](../settings/permissions-for-queries.md#settings_readonly) - [Разрешения для запросов](../settings/permissions-for-queries.md#settings_readonly)
- [Ограничения для значений настроек](../settings/constraints-on-settings.md) - [Ограничения для значений настроек](../settings/constraints-on-settings.md)
- Выражение [SHOW SETTINGS](../../sql-reference/statements/show.md#show-settings) - Выражение [SHOW SETTINGS](../../sql-reference/statements/show.md#show-settings)

View File

@ -59,7 +59,7 @@ clickhouse-benchmark [keys] < queries_file;
- `--stage=WORD` — стадия обработки запроса на сервере. ClickHouse останавливает обработку запроса и возвращает ответ `clickhouse-benchmark` на заданной стадии. Возможные значения: `complete`, `fetch_columns`, `with_mergeable_state`. Значение по умолчанию: `complete`. - `--stage=WORD` — стадия обработки запроса на сервере. ClickHouse останавливает обработку запроса и возвращает ответ `clickhouse-benchmark` на заданной стадии. Возможные значения: `complete`, `fetch_columns`, `with_mergeable_state`. Значение по умолчанию: `complete`.
- `--help` — показывает справку. - `--help` — показывает справку.
Если нужно применить [настройки](../../operations/settings/overview.md) для запросов, их можно передать как ключ `--<session setting name>= SETTING_VALUE`. Например, `--max_memory_usage=1048576`. Если нужно применить [настройки](../../operations/settings/) для запросов, их можно передать как ключ `--<session setting name>= SETTING_VALUE`. Например, `--max_memory_usage=1048576`.
## Вывод {#clickhouse-benchmark-output} ## Вывод {#clickhouse-benchmark-output}

View File

@ -1927,7 +1927,7 @@ SELECT randomStringUTF8(13)
## getSetting {#getSetting} ## getSetting {#getSetting}
Возвращает текущее значение [пользовательской настройки](../../operations/settings/overview.md#custom_settings). Возвращает текущее значение [пользовательской настройки](../../operations/settings/index.md#custom_settings).
**Синтаксис** **Синтаксис**
@ -1958,7 +1958,7 @@ SELECT getSetting('custom_a');
**См. также** **См. также**
- [Пользовательские настройки](../../operations/settings/overview.md#custom_settings) - [Пользовательские настройки](../../operations/settings/index.md#custom_settings)
## isDecimalOverflow {#is-decimal-overflow} ## isDecimalOverflow {#is-decimal-overflow}

View File

@ -273,7 +273,7 @@ SELECT * REPLACE(i + 1 AS i) EXCEPT (j) APPLY(sum) from columns_transformers;
Вы можете задать значения необходимых настроек непосредственно в запросе `SELECT` в секции `SETTINGS`. Эти настройки действуют только в рамках данного запроса, а после его выполнения сбрасываются до предыдущего значения или значения по умолчанию. Вы можете задать значения необходимых настроек непосредственно в запросе `SELECT` в секции `SETTINGS`. Эти настройки действуют только в рамках данного запроса, а после его выполнения сбрасываются до предыдущего значения или значения по умолчанию.
Другие способы задания настроек описаны [здесь](../../../operations/settings/overview.md). Другие способы задания настроек описаны [здесь](../../../operations/settings/index.md).
**Пример** **Пример**

View File

@ -9,7 +9,7 @@ sidebar_label: SET
SET param = value SET param = value
``` ```
Устанавливает значение `value` для [настройки](../../operations/settings/overview.md) `param` в текущей сессии. [Конфигурационные параметры сервера](../../operations/server-configuration-parameters/settings.md) нельзя изменить подобным образом. Устанавливает значение `value` для [настройки](../../operations/settings/index.md) `param` в текущей сессии. [Конфигурационные параметры сервера](../../operations/server-configuration-parameters/settings.md) нельзя изменить подобным образом.
Можно одним запросом установить все настройки из заданного профиля настроек. Можно одним запросом установить все настройки из заданного профиля настроек.

View File

@ -44,9 +44,9 @@
`a > b` 对应函数 `greater(a, b)` `a > b` 对应函数 `greater(a, b)`
`a LIKE s` 对应函数 `like(a, b)` `a LIKE b` 对应函数 `like(a, b)`
`a NOT LIKE s` 对应函数 `notLike(a, b)` `a NOT LIKE b` 对应函数 `notLike(a, b)`
`a BETWEEN b AND c` 等价于 `a >= b AND a <= c` `a BETWEEN b AND c` 等价于 `a >= b AND a <= c`