client/io.github.octaviusframework.client.query

Package-level declarations

Types

CteClause

internal class CteClause

The WITH clause, which every builder here can carry and none of them renders differently.

DeleteQuery

class DeleteQuery @PublishedApi constructor(provider: SessionProvider, table: String) : RunnableQuery<DeleteQuery>

A DELETE under construction.

InsertQuery

class InsertQuery @PublishedApi constructor(provider: SessionProvider, table: String) : RunnableQuery<InsertQuery>

An INSERT under construction.

LockWaitMode

enum LockWaitMode : Enum<LockWaitMode>

What to do about rows a FOR UPDATE finds already locked.

OnConflictClause

class OnConflictClause @PublishedApi constructor

The ON CONFLICT clause of an InsertQuery, configured inside InsertQuery.onConflict.

QueryFragment

class QueryFragment(val sql: String, val params: Map<String, Any?> = emptyMap())

A piece of SQL and the parameters it names, kept together so that neither can be dropped on the way.

RawQuery

class RawQuery @PublishedApi constructor(provider: SessionProvider, sql: String) : RunnableQuery<RawQuery>

SQL written by hand, with @name parameters, carrying the same terminal methods every builder carries.

ResultQuery

class ResultQuery @PublishedApi constructor(val query: RunnableQuery<*>)

The same query, with every terminal handing back a DataResult instead of throwing.

RunnableQuery

abstract class RunnableQuery<T : RunnableQuery<T>> @PublishedApi constructor(val queryProvider: SessionProvider)

Something that knows how to produce a query, and can therefore be run.

SelectQuery

class SelectQuery @PublishedApi constructor(provider: SessionProvider, selectClause: String) : RunnableQuery<SelectQuery>

A SELECT under construction.

UpdateQuery

class UpdateQuery @PublishedApi constructor(provider: SessionProvider, table: String) : RunnableQuery<UpdateQuery>

An UPDATE under construction.

Functions

appendClause

internal fun StringBuilder.appendClause(keyword: String, body: String?)

Appends a clause where its body carries anything, and does nothing where it does not.

join

fun List<QueryFragment>.join(separator: String, prefix: String = "", postfix: String = "", addParenthesis: Boolean = true): QueryFragment

Joins the fragments that carry anything, merging their parameters.

requireBuildable

internal inline fun requireBuildable(value: Boolean, message: () -> String)

Refuses a query the builder cannot render, naming what is missing.

withParam

infix fun String.withParam(param: Pair<String, Any?>): QueryFragment

Pairs this SQL text with one parameter it names.

withParams

infix fun String.withParams(params: Map<String, Any?>): QueryFragment

Pairs this SQL text with the parameters it names.