Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed some ERRORS and WARNINGS during RU docs build. #772

Merged
merged 22 commits into from May 8, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion doc/presentations
Submodule presentations deleted from b0b67a
58 changes: 30 additions & 28 deletions docs/ru/agg_functions/index.rst

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/ru/data_types/enum.rst
Expand Up @@ -5,7 +5,9 @@ Enum8 или Enum16. Представляет собой конечное мно

Пример:
::

Enum8('hello' = 1, 'world' = 2)

- тип данных с двумя возможными значениями - 'hello' и 'world'.

Для каждого из значений прописывается число в диапазоне -128..127 для ``Enum8`` или в диапазоне -32768..32767 для ``Enum16``. Все строки должны быть разными, числа - тоже. Разрешена пустая строка. При указании такого типа (в определении таблицы), числа могут идти не подряд и в произвольном порядке. При этом, порядок не имеет значения.
Expand Down
11 changes: 6 additions & 5 deletions docs/ru/dicts/external_dicts.rst
Expand Up @@ -155,20 +155,21 @@ flat
Поддерживаются все виды источников. При обновлении, данные (из файла, из таблицы) читаются целиком.

hashed
-------
------
В виде хэш-таблиц. Слегка менее эффективный способ. Словарь тоже загружается в оперативку целиком, и может содержать произвольное количество элементов с произвольными идентификаторами. На практике, имеет смысл использовать до десятков миллионов элементов, пока хватает оперативки.
Поддерживаются все виды источников. При обновлении, данные (из файла, из таблицы) читаются целиком.

cache
-------
-----
Наименее эффективный способ. Подходит, если словарь не помещается в оперативку. Представляет собой кэш из фиксированного количества ячеек, в которых могут быть расположены часто используемые данные. Поддерживается источник MySQL, ClickHouse, executable, http; источник-файл не поддерживается. При поиске в словаре, сначала просматривается кэш. На каждый блок данных, все не найденные в кэше ключи (или устаревшие ключи) собираются в пачку, и с этой пачкой делается запрос к источнику вида SELECT attrs... FROM db.table WHERE id IN (k1, k2, ...). Затем полученные данные записываются в кэш.

range_hashed
--------
------------
В таблице прописаны какие-то данные для диапазонов дат, для каждого ключа. Дать возможность доставать эти данные для заданного ключа, для заданной даты.

Пример: в таблице записаны скидки для каждого рекламодателя в виде:
::

id рекламодателя дата начала действия скидки дата конца величина
123 2015-01-01 2015-01-15 0.15
123 2015-01-16 2015-01-31 0.25
Expand Down Expand Up @@ -255,12 +256,12 @@ range_hashed
</dictionaries>

complex_key_hashed
----------------
------------------

Для использования с составными ключами. Аналогичен hashed.

complex_key_cache
----------
-----------------

Для использования с составными ключами. Аналогичен cache.

Expand Down
3 changes: 3 additions & 0 deletions docs/ru/external_data.rst
Expand Up @@ -11,6 +11,7 @@ ClickHouse позволяет отправить на сервер данные,

В клиенте командной строки, может быть указана секция параметров вида
::

--external --file=... [--name=...] [--format=...] [--types=...|--structure=...]

Таких секций может быть несколько - по числу передаваемых таблиц.
Expand All @@ -31,6 +32,7 @@ ClickHouse позволяет отправить на сервер данные,

Примеры:
::

echo -ne "1\n2\n3\n" | clickhouse-client --query="SELECT count() FROM test.visits WHERE TraficSourceID IN _data" --external --file=- --types=Int8
849897
cat /etc/passwd | sed 's/:/\t/g' | clickhouse-client --query="SELECT shell, count() AS c FROM passwd GROUP BY shell ORDER BY c DESC" --external --file=- --name=passwd --structure='login String, unused String, uid UInt16, gid UInt16, comment String, home String, shell String'
Expand All @@ -44,6 +46,7 @@ ClickHouse позволяет отправить на сервер данные,

Пример:
::

cat /etc/passwd | sed 's/:/\t/g' > passwd.tsv

curl -F 'passwd=@passwd.tsv;' 'http://localhost:8123/?query=SELECT+shell,+count()+AS+c+FROM+passwd+GROUP+BY+shell+ORDER+BY+c+DESC&passwd_structure=login+String,+unused+String,+uid+UInt16,+gid+UInt16,+comment+String,+home+String,+shell+String'
Expand Down
1 change: 1 addition & 0 deletions docs/ru/formats/jsoncompact.rst
Expand Up @@ -5,6 +5,7 @@ JSONCompact

Пример:
::

{
"meta":
[
Expand Down
4 changes: 3 additions & 1 deletion docs/ru/formats/jsoneachrow.rst
Expand Up @@ -2,7 +2,9 @@ JSONEachRow
-----------

Выводит данные в виде отдельных JSON объектов для каждой строки (newline delimited JSON).
::

.. code-block:: json

{"SearchPhrase":"","count()":"8267016"}
{"SearchPhrase":"интерьер ванной комнаты","count()":"2166"}
{"SearchPhrase":"яндекс","count()":"1655"}
Expand Down
4 changes: 3 additions & 1 deletion docs/ru/formats/prettynoescapes.rst
Expand Up @@ -4,7 +4,9 @@ PrettyNoEscapes
Отличается от Pretty тем, что не используются ANSI-escape последовательности. Это нужно для отображения этого формата в браузере, а также при использовании утилиты командной строки watch.

Пример:
::

.. code-block:: bash

watch -n1 "clickhouse-client --query='SELECT * FROM system.events FORMAT PrettyCompactNoEscapes'"

Для отображения в браузере, вы можете использовать HTTP интерфейс.
Expand Down
1 change: 1 addition & 0 deletions docs/ru/formats/tabseparated.rst
Expand Up @@ -18,6 +18,7 @@ TabSeparated

Строки выводятся с экранированием спец-символов с помощью обратного слеша. При выводе, используются следующие escape-последовательности: ``\b``, ``\f``, ``\r``, ``\n``, ``\t``, ``\0``, ``\'``, ``\\``. При парсинге, также поддерживаются последовательности ``\a``, ``\v``, а также ``\xHH`` (hex escape-последовательности) и любые последовательности вида ``\c``, где ``c`` - любой символ - такие последовательности преобразуется в ``c``. Таким образом, при чтении поддерживаются форматы, где перевод строки может быть записан как ``\n`` и как ``\`` и перевод строки. Например, строка ``Hello world``, где между словами вместо пробела стоит перевод строки, может быть считана в любом из следующих вариантов:
::

Hello\nworld

Hello\
Expand Down
1 change: 1 addition & 0 deletions docs/ru/formats/tskv.rst
Expand Up @@ -3,6 +3,7 @@ TSKV

Похож на TabSeparated, но выводит значения в формате name=value. Имена экранируются так же, как строки в формате TabSeparated и, дополнительно, экранируется также символ =.
::

SearchPhrase= count()=8267016
SearchPhrase=интерьер ванной комнаты count()=2166
SearchPhrase=яндекс count()=1655
Expand Down
30 changes: 15 additions & 15 deletions docs/ru/functions/array_functions.rst
Expand Up @@ -20,38 +20,38 @@ length
Функция также работает для строк.

emptyArrayUInt8, emptyArrayUInt16, emptyArrayUInt32, emptyArrayUInt64
~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

emptyArrayInt8, emptyArrayInt16, emptyArrayInt32, emptyArrayInt64
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

emptyArrayFloat32, emptyArrayFloat64
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

emptyArrayDate, emptyArrayDateTime
~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

emptyArrayString
~~~~~~~~~~~~
~~~~~~~~~~~~~~~~
Принимает ноль аргументов и возвращает пустой массив соответствующего типа.

emptyArrayToSingle
~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~
Принимает пустой массив и возвращает массив из одного элемента, равного значению по умолчанию.

range(N)
~~~~~~~
~~~~~~~~
Возвращает массив чисел от 0 до N-1.
На всякий случай, если на блок данных, создаются массивы суммарной длины больше 100 000 000 элементов, то кидается исключение.

array(x1, ...), оператор [x1, ...]
~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Создаёт массив из аргументов функции.
Аргументы должны быть константами и иметь типы, для которых есть наименьший общий тип. Должен быть передан хотя бы один аргумент, так как иначе непонятно, какого типа создавать массив. То есть, с помощью этой функции невозможно создать пустой массив (для этого используйте функции emptyArray*, описанные выше).
Возвращает результат типа Array(T), где T - наименьший общий тип от переданных аргументов.

arrayElement(arr, n), оператор arr[n]
~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Достаёт элемент с индексом n из массива arr.
n должен быть любым целочисленным типом.
Индексы в массиве начинаются с единицы.
Expand All @@ -62,21 +62,21 @@ n должен быть любым целочисленным типом.
- иначе, возвращается некоторое значение по умолчанию (0 для чисел, пустая строка для строк и т. п.).

has(arr, elem)
~~~~~~~~~~~
~~~~~~~~~~~~~~
Проверяет наличие элемента elem в массиве arr.
Возвращает 0, если элемента в массиве нет, или 1, если есть.
elem должен быть константой.

indexOf(arr, x)
~~~~~~~~~~
~~~~~~~~~~~~~~~
Возвращает индекс элемента x (начиная с 1), если он есть в массиве, или 0, если его нет.

countEqual(arr, x)
~~~~~~~~
~~~~~~~~~~~~~~~~~~
Возвращает количество элементов массива, равных x. Эквивалентно arrayCount(elem -> elem = x, arr).

arrayEnumerate(arr)
~~~~~~~~~
~~~~~~~~~~~~~~~~~~~
Возвращает массив [1, 2, 3, ..., length(arr)]

Эта функция обычно используется совместно с ARRAY JOIN. Она позволяет, после применения ARRAY JOIN, посчитать что-либо только один раз для каждого массива. Пример:
Expand Down Expand Up @@ -114,7 +114,7 @@ arrayEnumerate(arr)
Также эта функция может быть использована в функциях высшего порядка. Например, с её помощью можно достать индексы массива для элементов, удовлетворяющих некоторому условию.

arrayEnumerateUniq(arr, ...)
~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Возвращает массив, такого же размера, как исходный, где для каждого элемента указано, какой он по счету среди элементов с таким же значением.
Например: arrayEnumerateUniq([10, 20, 10, 30]) = [1, 1, 2, 1].

Expand Down Expand Up @@ -171,5 +171,5 @@ arrayUniq(arr, ...)
Если необходимо получить список уникальных элементов массива, можно воспользоваться arrayReduce('groupUniqArray', arr).

arrayJoin(arr)
~~~~~~~~
~~~~~~~~~~~~~~
Особенная функция. Смотрите раздел "Функция arrayJoin".
2 changes: 1 addition & 1 deletion docs/ru/functions/array_join.rst
@@ -1,5 +1,5 @@
Функция arrayJoin
---------------
-----------------
Это совсем необычная функция.

Обычные функции не изменяют множество строк, а лишь изменяют значения в каждой строке (map).
Expand Down
2 changes: 1 addition & 1 deletion docs/ru/functions/bit_functions.rst
Expand Up @@ -21,4 +21,4 @@ bitShiftLeft(a, b)
~~~~~~~~~~~~~~~~~~

bitShiftRight(a, b)
~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~
6 changes: 3 additions & 3 deletions docs/ru/functions/comparison_functions.rst
@@ -1,5 +1,5 @@
Функции сравнения
------------------
-----------------

Функции сравнения возвращают всегда 0 или 1 (UInt8).

Expand Down Expand Up @@ -30,7 +30,7 @@ greater, оператор >
~~~~~~~~~~~~~~~~~~~

lessOrEquals, оператор <=
~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~

greaterOrEquals, оператор >=
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2 changes: 1 addition & 1 deletion docs/ru/functions/conditional_functions.rst
Expand Up @@ -2,6 +2,6 @@
-------------

if(cond, then, else), оператор cond ? then : else
~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Возвращает then, если cond != 0 или else, если cond = 0.
cond должно иметь тип UInt8, а then и else должны иметь тип, для которого есть наименьший общий тип.
2 changes: 2 additions & 0 deletions docs/ru/functions/date_time_functions.rst
Expand Up @@ -6,6 +6,7 @@
Все функции по работе с датой и временем, для которых это имеет смысл, могут принимать второй, необязательный аргумент - имя часового пояса. Пример: Asia/Yekaterinburg. В этом случае, они используют не локальный часовой пояс (по умолчанию), а указанный.

.. code-block:: sql

SELECT
toDateTime('2016-06-15 23:00:00') AS time,
toDate(time) AS date_local,
Expand All @@ -15,6 +16,7 @@
┌────────────────time─┬─date_local─┬─date_yekat─┬─time_samoa──────────┐
│ 2016-06-15 23:00:00 │ 2016-06-15 │ 2016-06-16 │ 2016-06-15 09:00:00 │
└─────────────────────┴────────────┴────────────┴─────────────────────┘

Поддерживаются только часовые пояса, отличающиеся от UTC на целое число часов.

toYear
Expand Down
14 changes: 7 additions & 7 deletions docs/ru/functions/encoding_functions.rst
@@ -1,27 +1,27 @@
Функции кодирования
--------
-------------------

hex
~~~~~
~~~
Принимает строку, число, дату или дату-с-временем. Возвращает строку, содержащую шестнадцатеричное представление аргумента. Используются заглавные буквы A-F. Не используются префиксы 0x и суффиксы h. Для строк просто все байты кодируются в виде двух шестнадцатеричных цифр. Числа выводятся в big endian ("человеческом") формате. Для чисел вырезаются старшие нули, но только по целым байтам. Например, hex(1) = '01'. Даты кодируются как число дней с начала unix-эпохи. Даты-с-временем кодируются как число секунд с начала unix-эпохи.

unhex(str)
~~~~~~~
~~~~~~~~~~
Принимает строку, содержащую произвольное количество шестнадцатеричных цифр, и возвращает строку, содержащую соответствующие байты. Поддерживаются как строчные, так и заглавные буквы A-F. Число шестнадцатеричных цифр не обязано быть чётным. Если оно нечётное - последняя цифра интерпретируется как младшая половинка байта 00-0F. Если строка-аргумент содержит что-либо кроме шестнадцатеричных цифр, то будет возвращён какой-либо implementation-defined результат (не кидается исключение).
Если вы хотите преобразовать результат в число, то вы можете использовать функции reverse и reinterpretAsType.

UUIDStringToNum(str)
~~~~~~~
~~~~~~~~~~~~~~~~~~~~
Принимает строку, содержащую 36 символов в формате 123e4567-e89b-12d3-a456-426655440000, и возвращает в виде набора байт в FixedString(16).

UUIDNumToString(str)
~~~~~~~~
~~~~~~~~~~~~~~~~~~~~
Принимает значение типа FixedString(16). Возвращает строку из 36 символов в текстовом виде.

bitmaskToList(num)
~~~~~~~
~~~~~~~~~~~~~~~~~~
Принимает целое число. Возвращает строку, содержащую список степеней двойки, в сумме дающих исходное число; по возрастанию, в текстовом виде, через запятую, без пробелов.

bitmaskToArray(num)
~~~~~~~~~
~~~~~~~~~~~~~~~~~~~
Принимает целое число. Возвращает массив чисел типа UInt64, содержащий степени двойки, в сумме дающих исходное число; числа в массиве идут по возрастанию.