xtdb-api/xtdb.api.query

Package-level declarations

Types

@Serializable

data class Basis(val atTx: TransactionKey? = null, val currentTime: Instant? = null) : ILookup, Seqable

XTDB queries are subject to a 'basis' - queries run again with the same basis are guaranteed to return the same results.

data class Binding(val binding: String, val expr: Expr)

interface Expr

object Exprs

@Serializable(with = IKeyFn.Serde::class)

fun interface IKeyFn<out V>

object Queries

interface Query

@Serializable

data class QueryOptions(val args: Map<String, *>? = null, val basis: Basis? = null, val afterTx: TransactionKey? = null, val txTimeout: Duration? = null, val defaultTz: ZoneId? = null, val explain: Boolean = false, val keyFn: IKeyFn<*>? = null) : ILookup, Seqable

@Serializable

data class SqlQuery(val sql: String) : Query

@Serializable(with = TemporalFilterSerializer::class)

interface TemporalFilter

TemporalFilters

object TemporalFilters

interface XtqlQuery : Query

Functions

fun queryOpts(): QueryOptions.Builder