--- metadata: - name: generator content: Diplodoc Platform v5.50.6 alternate: - https://ydb.tech/docs/en/recipes/ydb-sdk/ttl.md?version=main - https://ydb.tech/docs/ru/recipes/ydb-sdk/ttl.md?version=main sourcePath: ru/core/recipes/ydb-sdk/ttl.md --- > **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/ru/llms.txt # Настройка времени жизни строк (TTL) таблицы В этом разделе приведены примеры настройки TTL строковых и колоночных таблиц при помощи YDB SDK. ## Включение TTL для существующих строковых и колоночных таблиц {#enable-on-existent-table} В приведенном ниже примере строки таблицы `mytable` будут удаляться спустя час после наступления времени, записанного в колонке `created_at`: {% list tabs group=tool %} - C++ ```c++ session.AlterTable( "mytable", TAlterTableSettings() .BeginAlterTtlSettings() .Set("created_at", TDuration::Hours(1)) .EndAlterTtlSettings() ); ``` - Go ```go err := session.AlterTable(ctx, "mytable", options.WithSetTimeToLiveSettings( options.NewTTLSettings().ColumnDateType("created_at").ExpireAfter(time.Hour), ), ) ``` - Python ```python session.alter_table('mytable', set_ttl_settings=ydb.TtlSettings().with_date_type_column('created_at', 3600)) ``` - C# Функциональность на данный момент не поддерживается. - JavaScript Функциональность на данный момент не поддерживается. - Java ```java AlterTableSettings settings = new AlterTableSettings() .setTableTtl(TableTtl.dateTimeColumn("created_at", 3600)); session.alterTable("mytable", settings).join().expectSuccess(); ``` {% endlist %} Следующий пример демонстрирует использование колонки `modified_at` с числовым типом (`Uint32`) в качестве TTL-колонки. Значение колонки интерпретируется как секунды от Unix-эпохи: {% list tabs group=tool %} - C++ ```c++ session.AlterTable( "mytable", TAlterTableSettings() .BeginAlterTtlSettings() .Set("modified_at", TTtlSettings::EUnit::Seconds, TDuration::Hours(1)) .EndAlterTtlSettings() ); ``` - Go ```go err := session.AlterTable(ctx, "mytable", options.WithSetTimeToLiveSettings( options.NewTTLSettings().ColumnSeconds("modified_at").ExpireAfter(time.Hour), ), ) ``` - Python ```python session.alter_table('mytable', set_ttl_settings=ydb.TtlSettings().with_value_since_unix_epoch('modified_at', UNIT_SECONDS, 3600)) ``` - C# Функциональность на данный момент не поддерживается. - JavaScript Функциональность на данный момент не поддерживается. - Java ```java AlterTableSettings settings = new AlterTableSettings() .setTableTtl(TableTtl.valueSinceUnixEpoch( "modified_at", TableTtl.TtlUnit.SECONDS, 3600 )); session.alterTable("mytable", settings).join().expectSuccess(); ``` {% endlist %} ## Включение вытеснения во внешнее S3-совместимое хранилище {#enable-tiering-on-existing-tables} {% note warning %} Поддерживается только для [колоночных](https://ydb.tech/docs/ru/concepts/datamodel/table.md?version=main#column-oriented-tables) таблиц. Поддержка функциональности для [строковых](https://ydb.tech/docs/ru/concepts/datamodel/table.md?version=main#row-oriented-tables) таблиц находится в разработке. {% endnote %} Для включения вытеснения требуется объект [external data source](https://ydb.tech/docs/ru/concepts/datamodel/external_data_source.md?version=main), описывающий подключение к внешнему хранилищу. Создание объекта external data source возможно через [YQL](https://ydb.tech/docs/ru/yql/reference/recipes/ttl.md?version=main#enable-tiering-on-existing-tables) и YDB CLI. В следующем примере строки таблицы `mytable` будут переноситься в бакет, описанный во внешнем источнике данных `/Root/s3_cold_data`, спустя час после наступления времени, записанного в колонке `created_at`, а спустя 24 часа будут удаляться: {% list tabs group=tool %} - C++ ```c++ session.AlterTable( "mytable", TAlterTableSettings() .BeginAlterTtlSettings() .Set("created_at", { TTtlTierSettings(TDuration::Hours(1), TTtlEvictToExternalStorageAction("/Root/s3_cold_data")), TTtlTierSettings(TDuration::Hours(24), TTtlDeleteAction("/Root/s3_cold_data")) }) .EndAlterTtlSettings() ); ``` - JavaScript Функциональность на данный момент не поддерживается. - Go Функциональность на данный момент не поддерживается. - Python Функциональность на данный момент не поддерживается. - C# Функциональность на данный момент не поддерживается. - Java Функциональность на данный момент не поддерживается. {% endlist %} ## Включение TTL для вновь создаваемой таблицы {#enable-for-new-table} Для вновь создаваемой таблицы можно передать настройки TTL вместе с ее описанием: {% list tabs group=tool %} - C++ ```c++ session.CreateTable( "mytable", TTableBuilder() .AddNullableColumn("id", EPrimitiveType::Uint64) .AddNullableColumn("expire_at", EPrimitiveType::Timestamp) .SetPrimaryKeyColumn("id") .SetTtlSettings("expire_at") .Build() ); ``` - Go ```go err := session.CreateTable(ctx, "mytable", options.WithColumn("id", types.Optional(types.TypeUint64)), options.WithColumn("expire_at", types.Optional(types.TypeTimestamp)), options.WithTimeToLiveSettings( options.NewTTLSettings().ColumnDateType("expire_at"), ), ) ``` - Python ```python session.create_table( 'mytable', ydb.TableDescription() .with_column(ydb.Column('id', ydb.OptionalType(ydb.DataType.Uint64))) .with_column(ydb.Column('expire_at', ydb.OptionalType(ydb.DataType.Timestamp))) .with_primary_key('id') .with_ttl(ydb.TtlSettings().with_date_type_column('expire_at')) ) ``` - C# Функциональность на данный момент не поддерживается. - JavaScript Функциональность на данный момент не поддерживается. - Java TTL для таблицы задаётся в `TableDescription` при создании. Проверить настройки можно через `describeTable`. ```java import tech.ydb.core.grpc.GrpcTransport; import tech.ydb.table.TableClient; import tech.ydb.table.description.TableDescription; import tech.ydb.table.description.TableTtl; import tech.ydb.table.session.SessionRetryContext; import tech.ydb.table.values.PrimitiveType; public class TtlCreateTableExample { private static final String TABLE_NAME = "mytable"; public static void main(String[] args) { String connectionString = System.getenv().getOrDefault( "YDB_CONNECTION_STRING", "grpc://localhost:2136/local"); try (GrpcTransport transport = GrpcTransport.forConnectionString(connectionString).build(); TableClient tableClient = TableClient.newClient(transport).build()) { SessionRetryContext retryCtx = SessionRetryContext.create(tableClient).build(); String tablePath = transport.getDatabase() + "/" + TABLE_NAME; TableDescription description = TableDescription.newBuilder() .addNullableColumn("id", PrimitiveType.Uint64) .addNullableColumn("expire_at", PrimitiveType.Timestamp) .setPrimaryKey("id") .setTtlSettings(TableTtl.dateTimeColumn("expire_at", 0)) .build(); retryCtx.supplyStatus(session -> session.createTable(tablePath, description)) .join().expectSuccess("create table failed"); TableTtl ttl = retryCtx.supplyResult(session -> session.describeTable(tablePath)) .join().getValue().getTableDescription().getTableTtl(); System.out.println("TTL column: " + ttl.getColumnName()); } } } ``` {% endlist %} ## Выключение TTL {#disable} {% list tabs group=tool %} - C++ ```c++ session.AlterTable( "mytable", TAlterTableSettings() .BeginAlterTtlSettings() .Drop() .EndAlterTtlSettings() ); ``` - Go ```go err := session.AlterTable(ctx, "mytable", options.WithDropTimeToLive(), ) ``` - Python ```python session.alter_table('mytable', drop_ttl_settings=True) ``` - C# Функциональность на данный момент не поддерживается. - JavaScript Функциональность на данный момент не поддерживается. - Java ```java AlterTableSettings settings = new AlterTableSettings() .setTableTtl(TableTtl.notSet()); session.alterTable("mytable", settings).join().expectSuccess(); ``` {% endlist %} ## Получение настроек TTL {#describe} Текущие настройки TTL можно получить из описания таблицы: {% list tabs group=tool %} - C++ ```c++ auto desc = session.DescribeTable("mytable").GetValueSync().GetTableDescription(); auto ttl = desc.GetTtlSettings(); ``` - Go ```go desc, err := session.DescribeTable(ctx, "mytable") if err != nil { // process error } ttl := desc.TimeToLiveSettings ``` - Python ```python desc = session.describe_table('mytable') ttl = desc.ttl_settings ``` - C# Функциональность на данный момент не поддерживается. - JavaScript Функциональность на данный момент не поддерживается. - Java ```java import tech.ydb.core.grpc.GrpcTransport; import tech.ydb.table.TableClient; import tech.ydb.table.description.TableTtl; import tech.ydb.table.session.SessionRetryContext; public class TtlDescribeExample { public static void main(String[] args) { String connectionString = System.getenv().getOrDefault( "YDB_CONNECTION_STRING", "grpc://localhost:2136/local"); try (GrpcTransport transport = GrpcTransport.forConnectionString(connectionString).build(); TableClient tableClient = TableClient.newClient(transport).build()) { SessionRetryContext retryCtx = SessionRetryContext.create(tableClient).build(); String tablePath = transport.getDatabase() + "/mytable"; TableTtl ttl = retryCtx.supplyResult(session -> session.describeTable(tablePath)) .join().getValue().getTableDescription().getTableTtl(); System.out.println("TTL enabled: " + ttl.isEnabled()); System.out.println("TTL column: " + ttl.getColumnName()); } } } ``` {% endlist %}