summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbazeltsev <[email protected]>2022-10-28 17:30:24 +0300
committerbazeltsev <[email protected]>2022-10-28 17:30:24 +0300
commita2ebf2fd23270451bdc97599eff54fb5c1cd7596 (patch)
tree77a2015eee4f53a668a9817f5540dac95e139cc4
parentc1c8aaadc75c9104cc3f02bfb39d428053cbc7c1 (diff)
Added ydb table ttl docs
updated
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md4
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/table-ttl-drop.md30
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/table-ttl-set.md42
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml4
4 files changed, 78 insertions, 2 deletions
diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
index 4fcc6146dd8..94669b6b393 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
@@ -60,8 +60,8 @@ table drop | Удаление таблицы
[table query execute](../table-query-execute.md) | Исполнение YQL-запроса
[table query explain](../commands/explain-plan.md) | План исполнения YQL-запроса
[table readtable](../commands/readtable.md) | Потоковое чтение таблицы
-table ttl drop | Удаление параметров TTL
-table ttl set | Установка параметров TTL
+[table ttl set](../table-ttl-set.md) | Установка параметров TTL
+[table ttl drop](../table-ttl-drop.md) | Удаление параметров TTL
tools copy | Копирование таблиц
[tools dump](../export_import/tools_dump.md) | Выгрузка директории или таблицы в файловую систему
[tools rename](../commands/tools/rename.md) | Переименование таблиц
diff --git a/ydb/docs/ru/core/reference/ydb-cli/table-ttl-drop.md b/ydb/docs/ru/core/reference/ydb-cli/table-ttl-drop.md
new file mode 100644
index 00000000000..cc8a91ff0c4
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/table-ttl-drop.md
@@ -0,0 +1,30 @@
+# Удаление параметров TTL
+
+С помощью подкоманды `table ttl drop` вы можете удалить [TTL](../../concepts/ttl.md) для указанной таблицы.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] table ttl drop [options...] <table path>
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+* `table path` — путь таблицы.
+
+Посмотрите описание команды удаления TTL:
+
+```bash
+{{ ydb-cli }} table ttl drop --help
+```
+
+## Примеры {examples}
+
+{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
+
+Удалите TTL для таблицы `series`:
+
+```bash
+{{ ydb-cli }} -p db1 table ttl drop \
+ series
+```
diff --git a/ydb/docs/ru/core/reference/ydb-cli/table-ttl-set.md b/ydb/docs/ru/core/reference/ydb-cli/table-ttl-set.md
new file mode 100644
index 00000000000..e57a8d2a7ce
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/table-ttl-set.md
@@ -0,0 +1,42 @@
+# Установка параметров TTL
+
+С помощью подкоманды `table ttl set` вы можете установить [TTL](../../concepts/ttl.md) для указанной таблицы.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] table ttl set [options...] <table path>
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+* `table path` — путь таблицы.
+
+Посмотрите описание команды установки TTL:
+
+```bash
+{{ ydb-cli }} table ttl set --help
+```
+
+## Параметры подкоманды {#options}
+
+Имя | Описание
+---|---
+`--column` | Имя колонки, которая будет использована для вычисления времени жизни строк. Колонка должна иметь тип [числовой](../../yql/reference/types/primitive.md#numeric) или [дата и время](../../yql/reference/types/primitive.md#datetime).<br>В случае числового типа значение будет интерпретироваться как время, прошедшее с начала [эпохи Unix](https://ru.wikipedia.org/wiki/Unix-время). Единицы измерения должны быть заданы в параметре `--unit`.
+`--expire-after` | Дополнительное время до удаления, которое должно пройти после истечения времени жизни строки. Указывается в секундах.<br>Значение по умолчанию — `0`.
+`--unit` | Единицы измерения значений колонки, которая указана в параметре `--column`. Обязателен, если колонка имеет [числовой](../../yql/reference/types/primitive.md#numeric) тип.<br>Возможные значения:<ul><li>`seconds (s, sec)` — секунды;</li><li>`milliseconds (ms, msec)` — миллисекунды;</li><li>`microseconds (us, usec)` — микросекунды;</li><li>`nanoseconds (ns, nsec)` — наносекунды.</li></ul>
+`--run-interval` | Интервал запуска операции удаления строк с истекшим TTL. Указывается в секундах. Настройки БД по умолчанию не позволяют задать интервал меньше 15 минут (900 секунд).<br>Значение по умолчанию — `3600`.
+
+## Примеры {examples}
+
+{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
+
+Установите TTL для таблицы `series`
+
+```bash
+{{ ydb-cli }} -p db1 table ttl set \
+ --column createtime \
+ --expire-after 3600 \
+ --run-interval 1200 \
+ series
+```
diff --git a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
index 469f0be2573..e6b4c0319af 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -21,6 +21,10 @@ items:
href: commands/secondary_index.md
- name: Переименование таблиц
href: commands/tools/rename.md
+ - name: Установка параметров TTL
+ href: table-ttl-set.md
+ - name: Удаление параметров TTL
+ href: table-ttl-drop.md
- name: Работа с данными
items:
- name: Получение плана исполнения запроса и AST