kandra-core/io.kandra.core.schema/TableSchema

TableSchema

data class TableSchema(val entityClass: KClass<*>, val tableName: String, val partitionKeys: List<ColumnSchema>, val clusteringKeys: List<ColumnSchema>, val columns: List<ColumnSchema>, val lookupTables: List<LookupTableSchema>, val defaultTtl: Int? = null, val isCounterTable: Boolean = false, val createdAtColumn: ColumnSchema? = null, val updatedAtColumn: ColumnSchema? = null, val secondaryIndexes: List<ColumnSchema> = emptyList(), val versionColumn: ColumnSchema? = null, val isSoftDelete: Boolean = false, val softDeleteTtlSeconds: Int? = null, val softDeleteMarkerColumn: ColumnSchema? = null, val softDeleteMarkerTtlSeconds: Int? = null, val gcGraceSeconds: Int? = null, val cacheConfig: CacheResultConfig? = null, val generatedUuidColumns: List<ColumnSchema> = emptyList(), val reflection: EntityReflection, val keyspace: String? = null)

Constructors

TableSchema

constructor(entityClass: KClass<*>, tableName: String, partitionKeys: List<ColumnSchema>, clusteringKeys: List<ColumnSchema>, columns: List<ColumnSchema>, lookupTables: List<LookupTableSchema>, defaultTtl: Int? = null, isCounterTable: Boolean = false, createdAtColumn: ColumnSchema? = null, updatedAtColumn: ColumnSchema? = null, secondaryIndexes: List<ColumnSchema> = emptyList(), versionColumn: ColumnSchema? = null, isSoftDelete: Boolean = false, softDeleteTtlSeconds: Int? = null, softDeleteMarkerColumn: ColumnSchema? = null, softDeleteMarkerTtlSeconds: Int? = null, gcGraceSeconds: Int? = null, cacheConfig: CacheResultConfig? = null, generatedUuidColumns: List<ColumnSchema> = emptyList(), reflection: EntityReflection, keyspace: String? = null)

Properties

cacheConfig

val cacheConfig: CacheResultConfig? = null

clusteringKeys

val clusteringKeys: List<ColumnSchema>

columns

val columns: List<ColumnSchema>

createdAtColumn

val createdAtColumn: ColumnSchema? = null

defaultTtl

val defaultTtl: Int? = null

entityClass

val entityClass: KClass<*>

gcGraceSeconds

val gcGraceSeconds: Int? = null

generatedUuidColumns

val generatedUuidColumns: List<ColumnSchema>

Columns marked @GeneratedUuid, auto-populated on INSERT. Excludes @Transient columns.

isCounterTable

val isCounterTable: Boolean = false

isSoftDelete

val isSoftDelete: Boolean = false

keyspace

val keyspace: String? = null

Keyspace declared via @ScyllaTable(keyspace); null = the plugin's default keyspace.

lookupTables

val lookupTables: List<LookupTableSchema>

partitionKeys

val partitionKeys: List<ColumnSchema>

All partition key columns, ordered by @PartitionKey(index).

qualifiedTableName

val qualifiedTableName: String

tableName when keyspace is null, else "$keyspace.$tableName".

reflection

val reflection: EntityReflection

The reflection surface (copy function, property map, primary constructor) for entityClass, resolved once at registration time. kandra-runtime reads/writes entity fields through this instead of re-resolving via entity::class/entityClass on every call. See ISS-034.

secondaryIndexes

val secondaryIndexes: List<ColumnSchema>

softDeleteMarkerColumn

val softDeleteMarkerColumn: ColumnSchema? = null

The markerProperty column from @SoftDelete, if configured. Enables findActive().

softDeleteMarkerTtlSeconds

val softDeleteMarkerTtlSeconds: Int? = null

Resolved TTL (seconds) for the @SoftDelete marker column — always strictly greater than softDeleteTtlSeconds, already defaulted to softDeleteTtlSeconds + gcGraceSeconds by io.kandra.core.SchemaRegistry if @SoftDelete.markerTtlSeconds was left unset (GH #154). null whenever softDeleteMarkerColumn is null.

softDeleteTtlSeconds

val softDeleteTtlSeconds: Int? = null

tableName

val tableName: String

updatedAtColumn

val updatedAtColumn: ColumnSchema? = null

versionColumn

val versionColumn: ColumnSchema? = null