tech.ydb.table.description

Class TableTtl

java.lang.Object

tech.ydb.table.description.TableTtl

public class TableTtl
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableTtl.TtlMode
static class	TableTtl.TtlUnit

Constructor Summary

Constructors

Constructor and Description
TableTtl() Deprecated.
TableTtl(TableTtl.TtlMode ttlMode, String dateTimeColumn, Integer expireAfterSeconds) Deprecated.

Method Summary

Modifier and Type	Method and Description
static TableTtl	dateTimeColumn(String columnName, int expireAfterSeconds) The row will be considered as expired at the moment of time, when the value stored in columnName is less than or equal to the current time (in epoch time format), and expireAfterSeconds has passed since that moment; i.e.
String	getDateTimeColumn()
Integer	getExpireAfterSeconds()
Integer	getRunIntervaelSeconds()
TableTtl.TtlMode	getTtlMode()
TableTtl.TtlUnit	getTtlUnit()
static TableTtl	notSet() Construct an empty TTL configuration
static TableTtl	valueSinceUnixEpoch(String columnName, TableTtl.TtlUnit unit, int expireAfterSeconds) The row will be considered as expired at the moment of time, when the value stored in columnName is less than or equal to the current time (in epoch time format), and expireAfterSeconds has passed since that moment; i.e.
TableTtl	withRunIntervalSeconds(int seconds)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableTtl

@Deprecated
public TableTtl(@Nonnull
                            TableTtl.TtlMode ttlMode,
                            @Nonnull
                            String dateTimeColumn,
                            @Nonnull
                            Integer expireAfterSeconds)

Deprecated.

TableTtl

@Deprecated
public TableTtl()

Deprecated.

Method Detail

getTtlMode

@Nonnull
public TableTtl.TtlMode getTtlMode()

getTtlUnit

@Nonnull
public TableTtl.TtlUnit getTtlUnit()

getDateTimeColumn

@Nonnull
public String getDateTimeColumn()

getExpireAfterSeconds

@Nonnull
public Integer getExpireAfterSeconds()

getRunIntervaelSeconds

@Nullable
public Integer getRunIntervaelSeconds()

withRunIntervalSeconds

public TableTtl withRunIntervalSeconds(int seconds)

notSet

public static TableTtl notSet()

Construct an empty TTL configuration

Returns:

instance of TTL configuration

dateTimeColumn

public static TableTtl dateTimeColumn(@Nonnull
                                      String columnName,
                                      int expireAfterSeconds)

The row will be considered as expired at the moment of time, when the value stored in columnName is less than or equal to the current time (in epoch time format), and expireAfterSeconds has passed since that moment; i.e. the expiration threshold is the value of columnNameplus expireAfterSeconds.

Parameters:

columnName - name of column with type Date, Datetime or Timestamp

expireAfterSeconds - number of seconds to add to the time in the column

Returns:

instance of TTL configuration

valueSinceUnixEpoch

public static TableTtl valueSinceUnixEpoch(@Nonnull
                                           String columnName,
                                           TableTtl.TtlUnit unit,
                                           int expireAfterSeconds)

The row will be considered as expired at the moment of time, when the value stored in columnName is less than or equal to the current time (in epoch time format), and expireAfterSeconds has passed since that moment; i.e. the expiration threshold is the value of columnNameplus expireAfterSeconds.

Parameters:

columnName - name of column with type UInt32, UInt64 or DyNumber

unit - time unit of column

expireAfterSeconds - number of seconds to add to the time in the column

Returns:

instance of TTL configuration