exposed-core/org.jetbrains.exposed.v1.core/AbstractQuery

AbstractQuery

abstract class AbstractQuery<T : AbstractQuery<T>>(targets: List<Table>) : Statement<ResultApi>

Base class representing an SQL query that returns a database result when executed.

Constructors

AbstractQuery

constructor(targets: List<Table>)

Types

CommentPosition

enum CommentPosition : Enum<AbstractQuery.CommentPosition>

Represents the position at which an SQL comment will be added in a SELECT query.

Properties

comments

var comments: Map<AbstractQuery.CommentPosition, String>

The stored comments and their CommentPositions in this SELECT query.

distinct

var distinct: Boolean

Whether only distinct results should be retrieved by this SELECT query.

distinctOn

var distinctOn: List<Column<*>>?

List of columns on which the query should be distinct.

fetchSize

var fetchSize: Int?

The number of results that should be fetched when this query is executed.

groupedByColumns

var groupedByColumns: List<Expression<*>>

The stored list of columns for a GROUP BY clause in this SELECT query.

having

var having: Op<Boolean>?

The stored condition for a HAVING clause in this SELECT query.

limit

var limit: Int?

The stored value for a LIMIT clause in this query.

offset

var offset: Long

The stored value for an OFFSET clause in this query.

orderByExpressions

var orderByExpressions: List<Pair<Expression<*>, SortOrder>>

The stored list of columns and their SortOrder for an ORDER BY clause in this query.

set

abstract val set: FieldSet

The set of columns on which a query should be executed, contained by a ColumnSet.

targets

val targets: List<Table>

type

val type: StatementType

where

var where: Op<Boolean>?

The stored condition for a WHERE clause in this SELECT query.

Functions

adjustComments

fun adjustComments(position: AbstractQuery.CommentPosition, content: String? = null): T

Changes the content of the comments field at the specified position in this query.

adjustHaving

fun adjustHaving(body: Op<Boolean>?.() -> Op<Boolean>): T

Changes the having field of this query.

arguments

open override fun arguments(): List<List<Pair<IColumnType<*>, Any?>>>

Returns all mappings of columns and expression types to their values needed to prepare an SQL statement.

comment

fun comment(content: String, position: AbstractQuery.CommentPosition = CommentPosition.FRONT): T

Appends an SQL comment, with content wrapped by /* */, at the specified CommentPosition in this SELECT query.

copyTo

open fun copyTo(other: T)

Copies all stored properties of this SELECT query into the properties of other.

fetchSize

fun fetchSize(n: Int): T

Modifies the number of results that should be fetched when this query is executed.

groupBy

fun groupBy(vararg columns: Expression<*>): T

Appends a GROUP BY clause with the specified columns to this SELECT query.

hasCustomForUpdateState

fun hasCustomForUpdateState(): Boolean

Whether this SELECT query already has a stored value option for performing locking reads.

having

fun having(op: () -> Op<Boolean>): T

Appends a HAVING clause with the specified op condition to this SELECT query.

isForUpdate

fun isForUpdate(): Boolean

Whether this SELECT query will perform a locking read.

prepareSQL

open fun prepareSQL(builder: QueryBuilder): String

Returns the string representation of an SQL query, generated by appending SQL expressions to a QueryBuilder.

open override fun prepareSQL(transaction: Transaction, prepared: Boolean): String

Returns the string representation of an SQL statement.

withDistinct

open fun withDistinct(value: Boolean = true): T

Modifies this query to retrieve only distinct results if value is set to true.

withDistinctOn

fun withDistinctOn(vararg columns: Column<*>): T

Specifies that the SELECT query should retrieve distinct results based on the given list of columns.