xtdb-core/xtdb.api/Xtdb/Statement

Statement

interface Statement : AdbcStatement

A statement on a Connection.

DML run here is submitted as a transaction against Connection.dbName, with no per-statement override, so it resolves tables only within that database — a narrower scope than a query on the same connection, and one the SQL text doesn't distinguish. See Connection.

Properties

abstract val columnNames: List<FieldName>

open val maxProgress: Double

parameterSchema

open val parameterSchema: Schema?

open val progress: Double

abstract val warnings: List<String>

Functions

open fun bind(root: VectorSchemaRoot?)

open fun bind(rel: RelationReader)

open fun cancel()

abstract fun close()

executePartitioned

open fun executePartitioned(): AdbcStatement.PartitionResult?

abstract fun executeQuery(): AdbcStatement.QueryResult?

open fun executeSchema(): Schema?

abstract fun executeSchema(paramFields: List<Field>): Schema

abstract fun executeUpdate(): AdbcStatement.UpdateResult?

open fun <T : Any?> getOption(key: TypedKey<T?>?): T?

abstract fun openQuery(): ResultCursor

abstract fun openQuery(opts: QueryOpts): ResultCursor

pollPartitioned

open fun pollPartitioned(): Iterator<AdbcStatement.PartitionResult?>?

abstract fun prepare()

open fun <T : Any?> setOption(key: TypedKey<T?>?, value: T?)

open fun ~~setOption~~(key: String?, value: Any?)

open fun setSqlQuery(query: String?)

setSubstraitPlan

open fun setSubstraitPlan(plan: ByteBuffer?)