Package-level declarations

Types

Link copied to clipboard
object CurrentDate : Function<LocalDate>

Represents an SQL function that returns the current date, as LocalDate.

Link copied to clipboard

Represents an SQL function that returns the current date and time, as LocalDateTime.

Link copied to clipboard

Represents an SQL function that returns the current date and time, as Instant.

Link copied to clipboard
sealed class CurrentTimestampBase<T> : Function<T>

Represents the base SQL function that returns the current date and time, as determined by the specified columnType.

Link copied to clipboard

Represents an SQL function that returns the current date and time with time zone, as OffsetDateTime.

Link copied to clipboard
class Date<T : Temporal?>(val expr: Expression<T>) : Function<LocalDate>

Represents an SQL function that extracts the date part from a given temporal expr.

Link copied to clipboard
class Day<T : Temporal?>(val expr: Expression<T>) : Function<Int>

Represents an SQL function that extracts the day field from a given temporal expr.

Link copied to clipboard
class Hour<T : Temporal?>(val expr: Expression<T>) : Function<Int>

Represents an SQL function that extracts the hour field from a given temporal expr.

Link copied to clipboard
class JavaDurationColumnType : DurationColumnType<Duration>

Column for storing time-based amounts of time, as Duration.

Link copied to clipboard
class JavaInstantColumnType : InstantColumnType<Instant>

Column for storing dates and times without time zone, as Instant.

Link copied to clipboard
class JavaLocalDateColumnType : LocalDateColumnType<LocalDate>

Column for storing dates, as LocalDate.

Link copied to clipboard
class JavaLocalDateTimeColumnType : LocalDateTimeColumnType<LocalDateTime>

Column for storing dates and times without time zone, as LocalDateTime.

Link copied to clipboard
class JavaLocalTimeColumnType : LocalTimeColumnType<LocalTime>

Column for storing times, as LocalTime.

Link copied to clipboard
class JavaOffsetDateTimeColumnType : OffsetDateTimeColumnType<OffsetDateTime>

Column for storing dates and times with time zone, as OffsetDateTime.

Link copied to clipboard
class Minute<T : Temporal?>(val expr: Expression<T>) : Function<Int>

Represents an SQL function that extracts the minute field from a given temporal expr.

Link copied to clipboard
class Month<T : Temporal?>(val expr: Expression<T>) : Function<Int>

Represents an SQL function that extracts the month field from a given temporal expr.

Link copied to clipboard
class Second<T : Temporal?>(val expr: Expression<T>) : Function<Int>

Represents an SQL function that extracts the second field from a given temporal expr.

Link copied to clipboard
class Time<T : Temporal?>(val expr: Expression<T>) : Function<LocalTime>

Represents an SQL function that extracts the time part from a given temporal expr.

Link copied to clipboard
class Year<T : Temporal?>(val expr: Expression<T>) : Function<Int>

Represents an SQL function that extracts the year field from a given temporal expr.

Functions

Link copied to clipboard
fun CustomDateFunction(functionName: String, vararg params: Expression<*>): CustomFunction<LocalDate?>

Calls a custom SQL function with the specified functionName, that returns a date only, and passing params as its arguments.

Link copied to clipboard
fun CustomDateTimeFunction(functionName: String, vararg params: Expression<*>): CustomFunction<LocalDateTime?>

Calls a custom SQL function with the specified functionName, that returns both a date and a time, and passing params as its arguments.

Link copied to clipboard
fun CustomDurationFunction(functionName: String, vararg params: Expression<*>): CustomFunction<Duration?>

Calls a custom SQL function with the specified functionName, that returns a duration, and passing params as its arguments.

Link copied to clipboard
fun CustomTimeFunction(functionName: String, vararg params: Expression<*>): CustomFunction<LocalTime?>

Calls a custom SQL function with the specified functionName, that returns a time only, and passing params as its arguments.

Link copied to clipboard
fun CustomTimeStampFunction(functionName: String, vararg params: Expression<*>): CustomFunction<Instant?>

Calls a custom SQL function with the specified functionName, that returns a timestamp, and passing params as its arguments.

Link copied to clipboard
fun CustomTimestampWithTimeZoneFunction(functionName: String, vararg params: Expression<*>): CustomFunction<OffsetDateTime?>

Calls a custom SQL function with the specified functionName, that returns both a date and a time with time zone, and passing params as its arguments.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.date(): Date<T>

Returns the date from this temporal expression.

fun Table.date(name: String): Column<LocalDate>

A date column to store a date.

Link copied to clipboard
fun dateLiteral(value: LocalDate): LiteralOp<LocalDate>

Returns the specified value as a date literal.

Link copied to clipboard
fun dateParam(value: LocalDate): Expression<LocalDate>

Returns the specified value as a date query parameter.

Link copied to clipboard
fun Table.datetime(name: String): Column<LocalDateTime>

A datetime column to store both a date and a time without time zone.

Link copied to clipboard

Returns the specified value as a date with time literal.

Link copied to clipboard
fun dateTimeParam(value: LocalDateTime): Expression<LocalDateTime>

Returns the specified value as a date with time query parameter.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.day(): Day<T>

Returns the day from this temporal expression, as an integer between 1 and 31 inclusive.

Link copied to clipboard
fun Table.duration(name: String): Column<Duration>

A date column to store a duration.

Link copied to clipboard
fun durationLiteral(value: Duration): LiteralOp<Duration>

Returns the specified value as a duration literal.

Link copied to clipboard
fun durationParam(value: Duration): Expression<Duration>

Returns the specified value as a duration query parameter.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.hour(): Hour<T>

Returns the hour from this temporal expression, as an integer between 0 and 23 inclusive.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.minute(): Minute<T>

Returns the minute from this temporal expression, as an integer between 0 and 59 inclusive.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.month(): Month<T>

Returns the month from this temporal expression, as an integer between 1 and 12 inclusive.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.second(): Second<T>

Returns the second from this temporal expression, as an integer between 0 and 59 inclusive.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.time(): Time<T>

Returns the time from this temporal expression.

fun Table.time(name: String): Column<LocalTime>

A time column to store a time.

Link copied to clipboard
fun timeLiteral(value: LocalTime): LiteralOp<LocalTime>

Returns the specified value as a time literal.

Link copied to clipboard
fun timeParam(value: LocalTime): Expression<LocalTime>

Returns the specified value as a time query parameter.

Link copied to clipboard
fun Table.timestamp(name: String): Column<Instant>

A timestamp column to store both a date and a time without time zone.

Link copied to clipboard
fun timestampLiteral(value: Instant): LiteralOp<Instant>

Returns the specified value as a timestamp literal.

Link copied to clipboard
fun timestampParam(value: Instant): Expression<Instant>

Returns the specified value as a timestamp query parameter.

Link copied to clipboard
fun Table.timestampWithTimeZone(name: String): Column<OffsetDateTime>

A timestamp column to store both a date and a time with time zone.

Link copied to clipboard

Returns the specified value as a date with time and time zone literal.

Link copied to clipboard

Returns the specified value as a date with time and time zone query parameter.

Link copied to clipboard
fun <T : Temporal?> Expression<T>.year(): Year<T>

Returns the year from this datetime expression, as an integer.