kandra-runtime/io.kandra.runtime.repository/KandraRepository

KandraRepository

class KandraRepository<T : Any>(session: CqlSession, schema: TableSchema, entityClass: KClass<T>, batchEngine: BatchEngine)

Blocking repository for performing CRUD operations on a ScyllaDB table.

Parameters

the entity type annotated with @ScyllaTable

Constructors

KandraRepository

constructor(session: CqlSession, schema: TableSchema, entityClass: KClass<T>, batchEngine: BatchEngine)

Functions

append

fun <V> append(entity: T, field: KProperty1<T, Collection<V>?>, values: Collection<V>, consistency: KandraConsistency? = null)

decrement

fun decrement(field: KProperty1<T, Long?>, partitionKeys: Map<String, Any>, by: Long = 1, consistency: KandraConsistency? = null)

delete

fun delete(entity: T)

deleteAll

fun deleteAll(entities: List<T>)

deleteBy

fun deleteBy(block: QueryContext.() -> Unit)

deleteById

fun deleteById(vararg keyValues: Any)

exists

fun exists(consistency: KandraConsistency? = null, block: QueryContext.() -> Unit): Boolean

find

fun find(consistency: KandraConsistency? = null, block: QueryContext.() -> Unit): T?

findActive

fun findActive(allowFullScan: Boolean = false): List<T>

Returns all rows not yet soft-deleted. Requires @SoftDelete(markerProperty = "...") on T — throws KandraSchemaException otherwise.

findAll

fun findAll(limit: Int? = null, consistency: KandraConsistency? = null, block: QueryContext.() -> Unit): List<T>

findById

fun findById(vararg idValues: Any, consistency: KandraConsistency? = null): T?

findPage

fun findPage(pageSize: Int, pageToken: String? = null, consistency: KandraConsistency? = null, block: QueryContext.() -> Unit = {}): KandraPage<T>

increment

fun increment(field: KProperty1<T, Long?>, partitionKeys: Map<String, Any>, by: Long = 1, consistency: KandraConsistency? = null)

put

fun <K, V> put(entity: T, field: KProperty1<T, Map<K, V>?>, entries: Map<K, V>, consistency: KandraConsistency? = null)

raw

fun raw(cql: String, vararg params: Any?): List<Row>

rawQuery

fun rawQuery(query: KandraRawQuery): List<Row>

remove

fun <V> remove(entity: T, field: KProperty1<T, Collection<V>?>, values: Collection<V>, consistency: KandraConsistency? = null)

save

fun save(entity: T, ttlSeconds: Int? = null, timestampMicros: Long? = null, consistency: KandraConsistency? = null)

saveAll

fun saveAll(entities: List<T>, useBatch: Boolean = true, consistency: KandraConsistency? = null)

saveAndGet

fun saveAndGet(entity: T, ttlSeconds: Int? = null, timestampMicros: Long? = null, consistency: KandraConsistency? = null): T

Same write as save, but returns the entity actually persisted — including any @GeneratedUuid/@CreatedAt/@UpdatedAt/@Version values generated for the write, which save computes internally and then discards. Use this whenever the caller needs those generated values (e.g. to build an HTTP response) instead of the placeholder ones on the object it constructed — see GH #132 / ISS-096.

saveIfNotExists

fun saveIfNotExists(entity: T, serialConsistency: KandraConsistency = KandraConsistency.LOCAL_SERIAL): Boolean

saveIfNotExistsAndGet

fun saveIfNotExistsAndGet(entity: T, serialConsistency: KandraConsistency = KandraConsistency.LOCAL_SERIAL): T?

Same LWT write as saveIfNotExists, but returns the entity actually persisted — including any @GeneratedUuid/@CreatedAt/@UpdatedAt values generated for the write, which saveIfNotExists computes internally and then discards behind a bare Boolean. Returns null when the row already existed (the same case saveIfNotExists reports as false) — use this whenever the caller needs the real generated values on the success path, e.g. to build an HTTP response, instead of the placeholder ones on the object it constructed. See GH #138 (same root-cause shape as GH #132 / saveAndGet()).

saveWithNulls

fun saveWithNulls(entity: T, ttlSeconds: Int? = null, consistency: KandraConsistency? = null)

update

fun update(old: T, new: T, consistency: KandraConsistency? = null, ttlSeconds: Int? = null, serialConsistency: KandraConsistency = KandraConsistency.LOCAL_SERIAL)

Optimistic-locked update: UPDATE ... IF <version> = ? when the entity has an @Version column (otherwise a blind full-row overwrite — see the kandra-runtime skill doc).

updateAndGet

fun updateAndGet(old: T, new: T, consistency: KandraConsistency? = null, ttlSeconds: Int? = null, serialConsistency: KandraConsistency = KandraConsistency.LOCAL_SERIAL): T

Same write as update, but returns the entity actually persisted — including the post-update @Version (and @UpdatedAt) values update computes internally and then discards. Use this whenever the caller needs those generated values, e.g. to make a subsequent optimistic-locked update()/updateAndGet() call against the same row without risking a spurious io.kandra.core.exception.KandraOptimisticLockException from reusing the stale pre-update version it already had — see GH #136.

updateForce

fun updateForce(entity: T, consistency: KandraConsistency? = null)