diff --git a/API/API.md b/API/API.md
index a1d80112..5c4524f8 100644
--- a/API/API.md
+++ b/API/API.md
@@ -5,7 +5,7 @@
* выполнение скрипта: информация об окружении и управление выводом/действиями после завершения работы (см. `Common`, `Environment`, `Optimization`);
* взаимодействие с моделью, как сущностью: создание бэкапа, пересчёт всей модели (см. `Common.ModelInfo`, `Users`);
* взаимодействие с данными и метаданными модели (см. `Multicubes`, `Times`, `Versions`, `Lists`, `Common.CopyData`);
-* взаимодействие с внешним миром (см. `Common.ApiService`, `Filesystems`, `Connectors`, `Notifications`);
+* взаимодействие с внешним миром (см. `Common.ApiService`, `Filesystems`, `Connectors`, `Notifications`, `Secrets`);
* административное: настройка API-сервисов (`ApiServices`), работа с аудитом (`Audit`);
* функции, напрямую не связанные с Оптимакросом, функции помощники — интерфейс `Crypto`.
@@ -33,6 +33,7 @@
1. [Аудит](audit.md)
1. [Криптография, хэширование и вспомогательные функции](crypto.md)
1. [Пользователи](users.md)
+1. [Секреты](secrets.md)
## Интерфейс OM
```ts
@@ -52,6 +53,7 @@ interface OM {
readonly audit: Audit;
readonly crypto: Crypto;
readonly users: Users;
+ readonly secrets: Secrets;
}
var om: OM;
@@ -165,4 +167,11 @@ readonly users: Users;
+```js
+readonly secrets: Secrets;
+```
+Ссылка на интерфейс [`Secrets`](./secrets.md).
+
+
+
[Оглавление](../README.md)
diff --git a/API/apiService.md b/API/apiService.md
index 45948f9e..4e015f7c 100644
--- a/API/apiService.md
+++ b/API/apiService.md
@@ -159,7 +159,7 @@ interface RequestFileInfos {
getAll(): RequestFileInfo[];
}
```
-Интерфейс для получения информации о загруженных клиентом файлах.
+Интерфейс для получения информации о загруженных клиентом файлах. Если требуется загрузить несколько файлов в одном ключе, в запросе для каждого файла нужно указывать одинаковый ключ-массив вида `key[]`.
diff --git a/API/audit.md b/API/audit.md
index 973a142f..b07489e7 100644
--- a/API/audit.md
+++ b/API/audit.md
@@ -93,9 +93,9 @@ eventTypeFilter(data: string | number | (string | number)[]): this;
- `string` — название типа события,
-- `number` — [`longId`](./views.md#long-id) типа события,
+- `number` — [`longId`](./common.md#long-id) типа события,
-- `(string | number)[]` — массив (возможно, смешанный) названий и [`longId`](./views.md#long-id) типов событий.
+- `(string | number)[]` — массив (возможно, смешанный) названий и [`longId`](./common.md#long-id) типов событий.
Возвращает `this`.
diff --git a/API/clickhouse.md b/API/clickhouse.md
new file mode 100644
index 00000000..5d23effd
--- /dev/null
+++ b/API/clickhouse.md
@@ -0,0 +1,359 @@
+# Clickhouse
+
+## Интерфейс ClickhouseConnectorBuilder
+```ts
+interface ClickhouseConnectorBuilder {
+ setHost(value: string | SecretValue): this;
+ setPort(value: number | SecretValue): this;
+ setUsername(value: string | SecretValue): this;
+ setPassword(value: string | SecretValue): this;
+ setDatabase(value: string | SecretValue): this;
+ setHttps(value: boolean): this;
+ load(): ClickhouseConnection;
+}
+```
+Интерфейс, реализующий шаблон проектирования [`строитель`](https://ru.wikipedia.org/wiki/%D0%A1%D1%82%D1%80%D0%BE%D0%B8%D1%82%D0%B5%D0%BB%D1%8C_(%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)), базовый интерфейс [`коннекторов`](../appendix/glossary.md#connector) для настройки подключения к базе данных [`Clickhouse`](https://ru.wikipedia.org/wiki/ClickHouse). Функции для установки параметров подключения поддерживают [секреты](./secrets.md).
+
+
+
+```js
+setHost(value: string | SecretValue): this;
+```
+Устанавливает адрес подключения. Возвращает `this`.
+
+
+
+```js
+setPort(value: number | SecretValue): this;
+```
+Устанавливает номер порта для подключения. Возвращает `this`.
+
+
+
+```js
+setUsername(value: string | SecretValue): this;
+```
+Устанавливает имя пользователя. Возвращает `this`.
+
+
+
+```js
+setPassword(value: string | SecretValue): this;
+```
+Устанавливает пароль. Возвращает `this`.
+
+
+
+```js
+setDatabase(value: string | SecretValue): this;
+```
+Устанавливает имя базы данных. Возвращает `this`.
+
+
+
+```js
+setHttps(value: boolean): this;
+```
+Устанавливает флаг `https`. Если он равен `true`, то выполнять подключение по протоколу [HTTPS](https://ru.wikipedia.org/wiki/HTTPS), иначе по протоколу [HTTP](https://ru.wikipedia.org/wiki/HTTP). Значение по умолчанию: `false`. Возвращает `this`.
+
+
+
+```js
+load(): ClickhouseConnection;
+```
+Соединяется с БД и возвращает объект соединения [`ClickhouseConnection`](#clickhouse-connection).
+
+
+
+## Интерфейс ClickhouseConnection
+```ts
+interface ClickhouseConnection {
+ qb(): ClickhouseQueryBuilder;
+}
+```
+Объект соединения с базой данных [`Clickhouse`](https://ru.wikipedia.org/wiki/ClickHouse).
+
+
+
+```js
+qb(): ClickhouseQueryBuilder;
+```
+Возвращает интерфейс [`ClickhouseQueryBuilder`](#clickhouse-query-builder) построения запроса к базе данных.
+
+
+
+## Интерфейс ClickhouseQueryBuilder
+```ts
+interface ClickhouseQueryBuilder {
+ select(columns?: string[]): this;
+ addSelect(column: string): this;
+ addSelectRaw(expression: string): this;
+ distinct(columns?: string[]): this;
+
+ setFrom(table: string, alias?: string | null): this;
+ setTable(table: string, alias?: string | null): this;
+
+ where(column: string, operator: string, value: any[] | any, concatOperator?: string): this;
+ orWhere(column: string, operator: string, value: any[] | any): this;
+ whereIn(column: string, values: any[], concatOperator?: string, not?: boolean): this;
+ whereBetween(column: string, minValue: string | number, maxValue: string | number, concatOperator?: string, not?: boolean): this;
+ orWhereBetween(column: string, minValue: string | number, maxValue: string | number): this;
+
+ orderBy(column: string, direction?: string): this;
+ orderByDesc(column: string): this;
+ groupBy(column: string): this;
+ limit(count: number, offset?: number): this;
+
+ exists(): boolean;
+ count(): number;
+ sum(column: string): number;
+
+ truncate(): boolean;
+ insert(values: Object[] | Object): boolean;
+
+ get(): ClickhouseQueryResult;
+ exportToCsv(path: string, ignoreHeader?: boolean): number;
+}
+```
+Интерфейс построения запроса к базе данных.
+
+
+
+```js
+select(columns?: string[]): this;
+```
+Устанавливает к выборке набор колонок `columns`. Заменяет установленные ранее колонки/выражения.
+Значение по умолчанию: `['*']` - выбрать все колонки. Возвращает `this`.
+
+
+
+```js
+addSelect(column: string): this;
+```
+Добавляет к выборке колонку `column`. Возвращает `this`.
+
+
+
+```js
+addSelectRaw(expression: string): this;
+```
+Добавляет к выборке выражение `expression`, полезно для использования функций. Возвращает `this`.
+
+
+
+```js
+distinct(columns?: string[]): this;
+```
+Позволяет выбрать только уникальные строки для указанных колонок `columns`. Заменяет собой установленные ранее колонки вызовом метода `select()`. Возможно добавление колонок к выборке через методы `addSelect()` или `addSelectRaw()`. Значение по умолчанию: `['*']` - выбрать все колонки. Возвращает `this`.
+
+
+
+```js
+setFrom(table: string, alias?: string | null): this;
+```
+Устанавливает таблицу, из которой будет производиться выборка. Для создания псевдонима используется `alias` (по умолчанию: `null`). Возвращает `this`.
+
+Вызов `setFrom('table1', 't1')` в запросе будет преобразован в `table1 AS t1`.
+
+
+
+```js
+setTable(table: string, alias?: string | null): this;
+```
+Алиас для метода `setFrom()`.
+
+
+
+```js
+where(column: string, operator: string, value: any[] | any, concatOperator?: string): this;
+```
+Добавляет условие вида `column operator value`. Возвращает `this`.
+
+Например, для вызова `where('columnName', '=', 5)` будет сформировано условие `columnName = 5`.
+
+К ранее заданному условию добавляется через оператор конкатенации `concatOperator`. Допустимые значения: `AND`, `OR`. Значение по умолчанию: `AND`.
+
+
+
+```js
+orWhere(column: string, operator: string, value: any[] | any): this;
+```
+Аналогично вызову метода `where(column, operator, value, 'OR')`.
+
+
+
+```js
+whereIn(column: string, values: any[], concatOperator?: string, not?: boolean): this;
+```
+Добавляет условие с оператором `IN` вида `column IN (values[0], values[1], ...)`. Возвращает `this`.
+
+К ранее заданному условию добавляется через оператор конкатенации `concatOperator`. Допустимые значения: `AND`, `OR`. Значение по умолчанию: `AND`.
+
+Флаг `not` устанавливает отрицание операции. Если значение `true`, то получим условие вида `column NOT IN (values[0], values[1], ...)`. Значение по умолчанию: `false`.
+
+
+
+```js
+whereBetween(column: string, minValue: string | number, maxValue: string | number, concatOperator?: string, not?: boolean): this;
+```
+Добавляет условие с оператором `BETWEEN` вида `column BETWEEN minValue AND maxValue`. Возвращает `this`.
+
+К ранее заданному условию добавляется через оператор конкатенации `concatOperator`. Допустимые значения: `AND`, `OR`. Значение по умолчанию: `AND`.
+
+Флаг `not` устанавливает отрицание операции. Если значение `true`, то получим условие вида `column NOT BETWEEN minValue AND maxValue`. Значение по умолчанию: `false`.
+
+
+
+```js
+orWhereBetween(column: string, minValue: string | number, maxValue: string | number): this;
+```
+Аналогично вызову метода `whereBetween(column, minValue, maxValue, 'OR')`.
+
+
+
+```js
+orderBy(column: string, direction?: string): this;
+```
+Устанавливает сортировку по колонке `column`. Возвращает `this`.
+
+Направление сортировки задается аргументом `direction`. Допустимые значения: `ASC` - по возрастанию, `DESC` - по убыванию. Значение по умолчанию: `ASC`.
+
+
+
+```js
+orderByDesc(column: string): this;
+```
+Устанавливает сортировку по убыванию по колонке `column`. Возвращает `this`.
+
+
+
+```js
+groupBy(column: string): this;
+```
+Устанавливает группировку по колонке `column`. Возвращает `this`.
+
+
+
+```js
+limit(count: number, offset?: number): this;
+```
+Устанавливает максимальное количество строк в выборке и количество строк, которое надо пропустить, прежде чем начать выборку. По умолчанию выборка начинается с первой строки (аргумент `offset` равен `0`). Возвращает `this`.
+
+
+
+```js
+exists(): boolean;
+```
+Проверяет наличие строк для сформированного запроса. Возвращает `true`, если результат непустой, иначе `false`.
+
+
+
+```js
+count(): number;
+```
+Возвращает количество найденных строк для сформированного запроса.
+
+
+
+```js
+sum(column: string): number;
+```
+Суммирует значения в колонке `column` и возвращает полученную сумму.
+
+
+
+```js
+truncate(): boolean;
+```
+Очищает таблицу запросом `TRUNCATE`. В случае успешного выполнения операции возвращает `true`, иначе `false`.
+
+
+
+```js
+insert(values: Object[] | Object): boolean;
+```
+Вставляет значения `values` в таблицу, заданную методом `setTable()`. В случае успешного выполнения операции возвращает `true`, иначе `false`.
+
+Значения могут быть переданы в виде объекта (ключом является название колонки):
+```js
+insert({id: 1, name: 'Apple', count: 10})
+```
+Или массива объектов:
+```js
+insert([
+ {id: 1, name: 'Apple', count: 10},
+ {id: 2, name: 'Orange', count: 15},
+ {id: 3, name: 'Banana', count: 18},
+ {id: 4, name: 'Peach', count: 12},
+ {id: 5, name: 'Lemon', count: 15},
+])
+```
+
+
+
+```js
+get(): ClickhouseQueryResult;
+```
+Конструирует SQL-запрос, передаёт его на исполнение в СУБД и возвращает интерфейс [`ClickhouseQueryResult`](#clickhouse-query-result) доступа к результатам запроса.
+
+
+
+```js
+exportToCsv(path: string, ignoreHeader?: boolean): number;
+```
+Конструирует SQL-запрос, передаёт его на исполнение в СУБД и сохраняет результат в CSV формате в [`рабочей директории скрипта`](../appendix/glossary.md#script-dir) в файл `path`. Аргумент `ignoreHeader` устанавливает флаг игнорирования заголовка (`false` по умолчанию). Возвращает количество полученных строк.
+
+
+
+## Интерфейс ClickhouseQueryResult
+```ts
+interface ClickhouseQueryResult {
+ count(): number;
+ generator(): IterableIterator