From fce91c2a8ae6dab50860ca52d3f97bc02af9c88c Mon Sep 17 00:00:00 2001 From: Ivan Blinkov Date: Fri, 20 Jul 2018 15:48:08 +0300 Subject: [PATCH] Use admonitions instead of divs --- docs/en/development/build_osx.md | 5 ++-- .../en/operations/server_settings/settings.md | 26 ++++++----------- docs/en/operations/table_engines/file.md | 5 ++-- docs/en/operations/utils/clickhouse-local.md | 5 ++-- .../en/query_language/dicts/external_dicts.md | 7 ++--- .../dicts/external_dicts_dict_layout.md | 7 ++--- .../dicts/external_dicts_dict_structure.md | 12 +++----- docs/en/query_language/misc.md | 3 ++ docs/en/query_language/select.md | 7 ++--- .../query_language/table_functions/remote.md | 7 ++--- .../ru/operations/server_settings/settings.md | 29 +++++++------------ docs/ru/operations/table_engines/file.md | 5 ++-- docs/ru/operations/utils/clickhouse-local.md | 6 ++-- .../dicts/external_dicts_dict_layout.md | 7 ++--- .../dicts/external_dicts_dict_structure.md | 12 +++----- docs/ru/query_language/misc.md | 5 ++-- docs/ru/query_language/select.md | 7 ++--- .../query_language/table_functions/remote.md | 7 ++--- 18 files changed, 56 insertions(+), 106 deletions(-) diff --git a/docs/en/development/build_osx.md b/docs/en/development/build_osx.md index d29301a4b2b..46ce91b3b9d 100644 --- a/docs/en/development/build_osx.md +++ b/docs/en/development/build_osx.md @@ -43,9 +43,8 @@ cd .. If you intend to run clickhouse-server, make sure to increase the system's maxfiles variable. -
-Note: you'll need to use sudo. -
+!!! info "Note" + You'll need to use sudo. To do so, create the following file: diff --git a/docs/en/operations/server_settings/settings.md b/docs/en/operations/server_settings/settings.md index 7745f226128..b93fdd15e62 100644 --- a/docs/en/operations/server_settings/settings.md +++ b/docs/en/operations/server_settings/settings.md @@ -22,11 +22,8 @@ Default value: 3600. Data compression settings. -
- -Don't use it if you have just started using ClickHouse. - -
+!!! warning "Warning" + Don't use it if you have just started using ClickHouse. The configuration looks like this: @@ -334,7 +331,7 @@ Also, logging to syslog is possible. Configuration example: 1
syslog.remote:10514
- myhost.local + myhost.local LOG_LOCAL6 syslog @@ -345,8 +342,8 @@ Keys: - user_syslog - activation key, turning on syslog logging. - address - host[:port] of syslogd. If not specified, local one would be used. - hostname - optional, source host of logs -- facility - [syslog facility](https://en.wikipedia.org/wiki/Syslog#Facility), -in uppercase, prefixed with "LOG_": (``LOG_USER``, ``LOG_DAEMON``, ``LOG_LOCAL3`` etc.). +- facility - [syslog facility](https://en.wikipedia.org/wiki/Syslog#Facility), +in uppercase, prefixed with "LOG_": (``LOG_USER``, ``LOG_DAEMON``, ``LOG_LOCAL3`` etc.). Default values: when ``address`` is specified, then ``LOG_USER``, otherwise - ``LOG_DAEMON`` - format - message format. Possible values are - ``bsd`` and ``syslog`` @@ -561,11 +558,9 @@ Use the following parameters to configure logging: The path to the directory containing data. -
+!!! warning "Attention" + The trailing slash is mandatory. -The end slash is mandatory. - -
**Example** @@ -651,11 +646,8 @@ Port for communicating with clients over the TCP protocol. Path to temporary data for processing large queries. -
- -The end slash is mandatory. - -
+!!! warning "Attention" + The trailing slash is mandatory. **Example** diff --git a/docs/en/operations/table_engines/file.md b/docs/en/operations/table_engines/file.md index 400601c8d91..ea78a7ca86e 100644 --- a/docs/en/operations/table_engines/file.md +++ b/docs/en/operations/table_engines/file.md @@ -24,9 +24,8 @@ When creating table using `File(Format)` it creates empty subdirectory in that f You may manually create this subfolder and file in server filesystem and then [ATTACH](../../query_language/misc.md#queries-attach) it to table information with matching name, so you can query data from that file. -
-Be careful with this funcionality, because ClickHouse does not keep track of external changes to such files. The result of simultaneous writes via ClickHouse and outside of ClickHouse is undefined. -
+!!! warning + Be careful with this funcionality, because ClickHouse does not keep track of external changes to such files. The result of simultaneous writes via ClickHouse and outside of ClickHouse is undefined. **Example:** diff --git a/docs/en/operations/utils/clickhouse-local.md b/docs/en/operations/utils/clickhouse-local.md index 1960263caaa..bfa612569f3 100644 --- a/docs/en/operations/utils/clickhouse-local.md +++ b/docs/en/operations/utils/clickhouse-local.md @@ -10,9 +10,8 @@ Accepts data that represent tables and queries them using [ClickHouse SQL dialec By default `clickhouse-local` does not have access to data on the same host, but it supports loading server configuration using `--config-file` argument. -
-It is not recommended to load production server configuration into `clickhouse-local` because data can be damaged in case of human error. -
+!!! warning + It is not recommended to load production server configuration into `clickhouse-local` because data can be damaged in case of human error. ## Usage diff --git a/docs/en/query_language/dicts/external_dicts.md b/docs/en/query_language/dicts/external_dicts.md index af8c280a4e6..4ab71d97826 100644 --- a/docs/en/query_language/dicts/external_dicts.md +++ b/docs/en/query_language/dicts/external_dicts.md @@ -39,8 +39,5 @@ You can [configure](external_dicts_dict.md#dicts-external_dicts_dict) any number See also "[Functions for working with external dictionaries](../functions/ext_dict_functions.md#ext_dict_functions)". -
- -You can convert values ​​for a small dictionary by describing it in a `SELECT` query (see the [transform](../functions/other_functions.md#other_functions-transform) function). This functionality is not related to external dictionaries. - -
+!!! attention + You can convert values for a small dictionary by describing it in a `SELECT` query (see the [transform](../functions/other_functions.md#other_functions-transform) function). This functionality is not related to external dictionaries. diff --git a/docs/en/query_language/dicts/external_dicts_dict_layout.md b/docs/en/query_language/dicts/external_dicts_dict_layout.md index ef59cefae7d..6e2129003d6 100644 --- a/docs/en/query_language/dicts/external_dicts_dict_layout.md +++ b/docs/en/query_language/dicts/external_dicts_dict_layout.md @@ -219,11 +219,8 @@ Set a large enough cache size. You need to experiment to select the number of ce 3. Assess memory consumption using the `system.dictionaries` table. 4. Increase or decrease the number of cells until the required memory consumption is reached. -
- -Do not use ClickHouse as a source, because it is slow to process queries with random reads. - -
+!!! warning + Do not use ClickHouse as a source, because it is slow to process queries with random reads. diff --git a/docs/en/query_language/dicts/external_dicts_dict_structure.md b/docs/en/query_language/dicts/external_dicts_dict_structure.md index 869d6f16ca5..41c106957f9 100644 --- a/docs/en/query_language/dicts/external_dicts_dict_structure.md +++ b/docs/en/query_language/dicts/external_dicts_dict_structure.md @@ -39,11 +39,8 @@ ClickHouse supports the following types of keys: A structure can contain either `` or `` . -
- -The key doesn't need to be defined separately in attributes. - -
+!!! warning + The key doesn't need to be defined separately in attributes. ### Numeric key @@ -65,9 +62,8 @@ Configuration fields: The key can be a `tuple` from any types of fields. The [layout](external_dicts_dict_layout.md#dicts-external_dicts_dict_layout) in this case must be `complex_key_hashed` or `complex_key_cache`. -
-A composite key can consist of a single element. This makes it possible to use a string as the key, for instance. -
+!!! tip + A composite key can consist of a single element. This makes it possible to use a string as the key, for instance. The key structure is set in the element ``. Key fields are specified in the same format as the dictionary [attributes](external_dicts_dict_structure.md#dicts-external_dicts_dict_structure-attributes). Example: diff --git a/docs/en/query_language/misc.md b/docs/en/query_language/misc.md index 237c58902a3..afa6d5164dc 100644 --- a/docs/en/query_language/misc.md +++ b/docs/en/query_language/misc.md @@ -175,6 +175,9 @@ Supported only by `*MergeTree` engines, in which this query initializes a non-sc If you specify a `PARTITION`, only the specified partition will be optimized. If you specify `FINAL`, optimization will be performed even when all the data is already in one part. +!!! warning + OPTIMIZE can't fix the "Too many parts" error. + ## KILL QUERY ```sql diff --git a/docs/en/query_language/select.md b/docs/en/query_language/select.md index 1b457819342..c92ac7c9dc4 100644 --- a/docs/en/query_language/select.md +++ b/docs/en/query_language/select.md @@ -722,11 +722,8 @@ A subquery in the IN clause is always run just one time on a single server. Ther There are two options for IN-s with subqueries (similar to JOINs): normal `IN` / ` OIN` and `IN GLOBAL` / `GLOBAL JOIN`. They differ in how they are run for distributed query processing. -
- -Remember that the algorithms described below may work differently depending on the [settings](../operations/settings/settings.md#settings-distributed_product_mode) `distributed_product_mode` setting. - -
+!!! attention + Remember that the algorithms described below may work differently depending on the [settings](../operations/settings/settings.md#settings-distributed_product_mode) `distributed_product_mode` setting. When using the regular IN, the query is sent to remote servers, and each of them runs the subqueries in the `IN` or `JOIN` clause. diff --git a/docs/en/query_language/table_functions/remote.md b/docs/en/query_language/table_functions/remote.md index 8ceaa0cd659..425c6f81a7d 100644 --- a/docs/en/query_language/table_functions/remote.md +++ b/docs/en/query_language/table_functions/remote.md @@ -13,11 +13,8 @@ remote('addresses_expr', db.table[, 'user'[, 'password']]) `addresses_expr` – An expression that generates addresses of remote servers. This may be just one server address. The server address is `host:port`, or just `host`. The host can be specified as the server name, or as the IPv4 or IPv6 address. An IPv6 address is specified in square brackets. The port is the TCP port on the remote server. If the port is omitted, it uses `tcp_port` from the server's config file (by default, 9000). -
- -The port is required for an IPv6 address. - -
+!!! important + The port is required for an IPv6 address. Examples: diff --git a/docs/ru/operations/server_settings/settings.md b/docs/ru/operations/server_settings/settings.md index e15782a34c4..ed1ed92da9f 100644 --- a/docs/ru/operations/server_settings/settings.md +++ b/docs/ru/operations/server_settings/settings.md @@ -22,11 +22,8 @@ ClickHouse перезагружает встроенные словари с з Настройки компрессии данных. -
- -Не используйте, если вы только начали работать с ClickHouse. - -
+!!! warning "Внимание" + Лучше не использовать, если вы только начали работать с ClickHouse. Общий вид конфигурации: @@ -335,7 +332,7 @@ ClickHouse проверит условия `min_part_size` и `min_part_size_rat 1
syslog.remote:10514
- myhost.local + myhost.local LOG_LOCAL6 syslog @@ -346,12 +343,12 @@ ClickHouse проверит условия `min_part_size` и `min_part_size_rat - user_syslog - обязательная настройка, если требуется запись в syslog - address - хост[:порт] демона syslogd. Если не указан, используется локальный - hostname - опционально, имя хоста, с которого отсылаются логи -- facility - [категория syslog](https://en.wikipedia.org/wiki/Syslog#Facility), -записанная в верхнем регистре, с префиксом "LOG_": (``LOG_USER``, ``LOG_DAEMON``, ``LOG_LOCAL3`` и прочие). +- facility - [категория syslog](https://en.wikipedia.org/wiki/Syslog#Facility), +записанная в верхнем регистре, с префиксом "LOG_": (``LOG_USER``, ``LOG_DAEMON``, ``LOG_LOCAL3`` и прочие). Значения по-умолчанию: при указанном ``address`` - ``LOG_USER``, иначе - ``LOG_DAEMON`` - format - формат сообщений. Возможные значения - ``bsd`` и ``syslog`` - + ## macros @@ -564,11 +561,8 @@ ClickHouse проверит условия `min_part_size` и `min_part_size_rat Путь к каталогу с данными. -
- -Завершающий слеш обязателен. - -
+!!! warning "Обратите внимание" + Завершающий слеш обязателен. **Пример** @@ -655,11 +649,8 @@ ClickHouse проверит условия `min_part_size` и `min_part_size_rat Путь ко временным данным для обработки больших запросов. -
- -Завершающий слеш обязателен. - -
+!!! warning "Обратите внимание" + Завершающий слеш обязателен. **Пример** diff --git a/docs/ru/operations/table_engines/file.md b/docs/ru/operations/table_engines/file.md index aaa334c7806..a4672929d72 100644 --- a/docs/ru/operations/table_engines/file.md +++ b/docs/ru/operations/table_engines/file.md @@ -24,9 +24,8 @@ File(Format) Можно вручную создать в хранилище каталог таблицы, поместить туда файл, затем на сервере ClickHouse добавить ([ATTACH](../../query_language/misc.md#queries-attach)) информацию о таблице, соответствующей имени каталога и прочитать из файла данные. -
-Будьте аккуратны с этой функциональностью, поскольку сервер ClickHouse не отслеживает внешние изменения данных. Если в файл будет производиться запись одновременно со стороны сервера ClickHouse и с внешней стороны, то результат непредсказуем. -
+!!! warning + Будьте аккуратны с этой функциональностью, поскольку сервер ClickHouse не отслеживает внешние изменения данных. Если в файл будет производиться запись одновременно со стороны сервера ClickHouse и с внешней стороны, то результат непредсказуем. **Пример:** diff --git a/docs/ru/operations/utils/clickhouse-local.md b/docs/ru/operations/utils/clickhouse-local.md index 06053e15a2f..60ab2b0a8e8 100644 --- a/docs/ru/operations/utils/clickhouse-local.md +++ b/docs/ru/operations/utils/clickhouse-local.md @@ -8,10 +8,8 @@ `clickhouse-local` при настройке по умолчанию не имеет доступа к данным, которыми управляет сервер ClickHouse, установленный на этом же хосте, однако можно подключить конфигурацию сервера с помощью ключа `--config-file`. -
-Мы не рекомендуем подключать серверную конфигурацию к `clickhouse-local`, поскольку данные можно легко повредить неосторожными действиями. -
- +!!! warning + Мы не рекомендуем подключать серверную конфигурацию к `clickhouse-local`, поскольку данные можно легко повредить неосторожными действиями. ## Вызов программы diff --git a/docs/ru/query_language/dicts/external_dicts_dict_layout.md b/docs/ru/query_language/dicts/external_dicts_dict_layout.md index efe872f616c..d2ee91d5d3d 100644 --- a/docs/ru/query_language/dicts/external_dicts_dict_layout.md +++ b/docs/ru/query_language/dicts/external_dicts_dict_layout.md @@ -217,11 +217,8 @@ 3. Оценить потребление оперативной памяти с помощью таблицы `system.dictionaries`. 4. Увеличивать/уменьшать количество ячеек до получения требуемого расхода оперативной памяти. -
- -Не используйте в качестве источника ClickHouse, поскольку он медленно обрабатывает запросы со случайным чтением. - -
+!!! warning + Не используйте в качестве источника ClickHouse, поскольку он медленно обрабатывает запросы со случайным чтением. diff --git a/docs/ru/query_language/dicts/external_dicts_dict_structure.md b/docs/ru/query_language/dicts/external_dicts_dict_structure.md index b032003ec8c..15952024c06 100644 --- a/docs/ru/query_language/dicts/external_dicts_dict_structure.md +++ b/docs/ru/query_language/dicts/external_dicts_dict_structure.md @@ -39,11 +39,8 @@ ClickHouse поддерживает следующие виды ключей: Структура может содержать либо `` либо ``. -
- -Ключ не надо дополнительно описывать в атрибутах. - -
+!!! attention "Обратите внимание" + Ключ не надо дополнительно описывать в атрибутах. ### Числовой ключ @@ -65,9 +62,8 @@ ClickHouse поддерживает следующие виды ключей: Ключем может быть кортеж (`tuple`) из полей произвольных типов. [layout](external_dicts_dict_layout.md#dicts-external_dicts_dict_layout) в этом случае должен быть `complex_key_hashed` или `complex_key_cache`. -
-Cоставной ключ может состоять из одного элемента. Это даёт возможность использовать в качестве ключа, например, строку. -
+!!! tip "Совет" + Cоставной ключ может состоять из одного элемента. Это даёт возможность использовать в качестве ключа, например, строку. Структура ключа задаётся в элементе ``. Поля ключа задаются в том же формате, что и [атрибуты](external_dicts_dict_structure.md#dicts-external_dicts_dict_structure-attributes) словаря. Пример: diff --git a/docs/ru/query_language/misc.md b/docs/ru/query_language/misc.md index 4027a5fba43..f7e00babe1a 100644 --- a/docs/ru/query_language/misc.md +++ b/docs/ru/query_language/misc.md @@ -174,9 +174,8 @@ OPTIMIZE TABLE [db.]name [PARTITION partition] [FINAL] Если указан `PARTITION`, то оптимизация будет производиться только для указаной партиции. Если указан `FINAL`, то оптимизация будет производиться даже когда все данные уже лежат в одном куске. -
-Запрос OPTIMIZE не может устранить причину появления ошибки "Too many parts". -
+!!! warning "Внимание" + Запрос OPTIMIZE не может устранить причину появления ошибки "Too many parts". ## KILL QUERY diff --git a/docs/ru/query_language/select.md b/docs/ru/query_language/select.md index 8f006ef4965..6bf3517044e 100644 --- a/docs/ru/query_language/select.md +++ b/docs/ru/query_language/select.md @@ -724,11 +724,8 @@ ORDER BY EventDate ASC Существует два варианта IN-ов с подзапросами (аналогично для JOIN-ов): обычный `IN` / `JOIN` и `GLOBAL IN` / `GLOBAL JOIN`. Они отличаются способом выполнения при распределённой обработке запроса. -
- -Помните, что алгоритмы, описанные ниже, могут работать иначе в зависимости от [настройки](../operations/settings/settings.md#settings-distributed_product_mode) `distributed_product_mode`. - -
+!!! attention + Помните, что алгоритмы, описанные ниже, могут работать иначе в зависимости от [настройки](../operations/settings/settings.md#settings-distributed_product_mode) `distributed_product_mode`. При использовании обычного IN-а, запрос отправляется на удалённые серверы, и на каждом из них выполняются подзапросы в секциях `IN` / `JOIN`. diff --git a/docs/ru/query_language/table_functions/remote.md b/docs/ru/query_language/table_functions/remote.md index 71bf70ba8d8..a2366607fe7 100644 --- a/docs/ru/query_language/table_functions/remote.md +++ b/docs/ru/query_language/table_functions/remote.md @@ -13,11 +13,8 @@ remote('addresses_expr', db.table[, 'user'[, 'password']]) `addresses_expr` - выражение, генерирующее адреса удалённых серверов. Это может быть просто один адрес сервера. Адрес сервера - это `хост:порт`, или только `хост`. Хост может быть указан в виде имени сервера, или в виде IPv4 или IPv6 адреса. IPv6 адрес указывается в квадратных скобках. Порт - TCP-порт удалённого сервера. Если порт не указан, используется `tcp_port` из конфигурационного файла сервера (по умолчанию - 9000). -
- -С IPv6-адресом обязательно указывать порт. - -
+!!! important "Важно" + С IPv6-адресом обязательно нужно указывать порт. Примеры: