Package-level declarations
Types
Base class representing an SQL query that returns a ResultSet when executed.
Represents a logical operator that performs an and
operation between all the specified expressions.
Multi-dimensional array column type for storing a collection of nested elements.
Auto-increment column type.
Represents an SQL function that returns the average (arithmetic mean) of all non-null input values, or null
if there are no non-null values.
Binary column for storing binary strings of variable and unlimited length.
Extension of CompositeColumn that consists of two columns, column1 and column2.
Binary column for storing binary strings of a specific length.
Binary column for storing BLOBs.
Boolean column for storing boolean values.
Numeric column for storing 1-byte integers.
Represents an SQL function that allows the comparison of value to chained conditional clauses.
Represents an SQL function that allows the comparison of value to chained conditional clauses.
Represents an SQL function that steps through conditions, and either returns a value when the first condition is met or returns elseResult if all conditions are false
.
Represents an SQL function that specifies a conversion from one data type to another.
Character column for storing single characters.
Represents a check constraint.
Represents an SQL function that returns the first of its arguments that is not null.
Represents a column.
An interface defining the transformation between a source column type and a target type.
Standard column type.
A class that handles the transformation between a source column type and a target type.
Marker interface which indicates that expression should be wrapped with braces when used in compound operators
Composite column represents multiple tightly related standard columns, which behave like a single column for the user
Class representing one or more SqlLoggers.
Represent a logical operator that performs an operation between all the specified expressions. This is the base class for the and
and or
operators:
Represents an SQL function that returns the number of input rows for which the value of expr is not null.
Represents an SQL function that Returns the cumulative distribution, that is (number of partition rows preceding or peers with current row) / (total partition rows). The value thus ranges from 1/N to 1. scale represents decimal digits count in the fractional part of result.
Represents an SQL window function frame bound that is CURRENT ROW or one of FOLLOWING forms.
Represents an SQL window function frame bound that is CURRENT ROW or one of PRECEDING forms.
Represents an CURRENT ROW window function frame bound.
Represents a custom SQL function.
Represents a custom SQL binary operator.
A configuration class for a Database.
Represents an ExposedConnection that is loaded whenever a connection is accessed by a Database instance.
Represents an SQL function that returns the rank of the current row, without gaps; this function effectively counts peer groups.
Numeric column for storing 8-byte (double precision) floating-point numbers.
Represents a SizedIterable that is empty and cannot be iterated over.
Identity column type for storing unique EntityID values.
Enumeration column for storing enums of type klass by their ordinal.
Enumeration column for storing enums of type klass by their name.
Represents an SQL operation that returns the distinct results of firstStatement that are not common to secondStatement.
Represents an SQL operator that checks if query returns at least one row.
API marked with this annotation is experimental. Any behavior associated with its use is not guaranteed to be stable.
API marked with this annotation is experimental. Any behavior associated with its use is not guaranteed to be stable.
Represents the SQL query that obtains information about a statement execution plan.
Represents an SQL expression of type T.
Represents an SQL expression of type T, but with a specific column type.
A conditional expression used as a filter when creating a partial index.
Represents an SQL function that returns expr evaluated at the row that is the first row of the window frame.
Numeric column for storing 4-byte (single precision) floating-point numbers.
Represents a foreign key constraint.
Represents an SQL function.
Interface common to all column types.
Marker interface for date/datetime related column types.
Numeric column for storing 4-byte integers.
API marked with this annotation is internal and should not be used outside Exposed. It may be changed or removed in the future without notice. Using it outside Exposed may result in undefined and unexpected behaviour.
Represents an SQL operation that returns only the common rows from two query results, without any duplicates.
Represents an SQL operator that checks if expression1 is not equal to expression2, with null
treated as a comparable value. This comparison never returns null.
Represents an SQL operator that checks if expression1 is equal to expression2, with null
treated as a comparable value. This comparison never returns null.
Represents an SQL operator that checks if the specified expr is not null.
Represents an SQL operator that checks if the specified expr is null.
Represents all the operators available when building SQL expressions.
Pair of expressions used to match rows from two joined tables.
Marker interface for json/jsonb related column types.
Represents an SQL function that returns value evaluated at the row that is offset rows before the current row within the partition; if there is no such row, instead returns defaultValue.
Represents an SQL function that returns expr evaluated at the row that is the last row of the window frame.
Represents a SizedIterable whose elements are only loaded on first access.
Represents the iterable elements of a database result, which are stored once loaded on first access.
Represents an SQL function that returns value evaluated at the row that is offset rows after the current row within the partition; if there is no such row, instead returns defaultValue.
Represents a pattern used for the comparison of string expressions.
Represents the specified value as an SQL literal, using the specified columnType to convert the value.
Numeric column for storing 8-byte integers.
Represents an SQL function that returns the maximum value of expr across all non-null input values, or null
if there are no non-null values.
Represents an SQL function that returns the minimum value of expr across all non-null input values, or null
if there are no non-null values.
Represents an SQL operator that doesn't perform any operation. This is mainly used to change between column types.
Represents an SQL operator that checks if query doesn't returns any row.
Represents a logical operator that inverts the specified boolean expr.
Returns an integer ranging from 1 to the argument value, dividing the partition as equally as possible.
A class that handles the transformation between a source column type and a target type, but also supports transformations involving null
values.
Represents offset FOLLOWING window function frame bound.
Represents offset PRECEDING window function frame bound.
Represents an SQL operator.
Represents a logical operator that performs an or
operation between all the specified expressions.
Represents an SQL function that returns the relative rank of the current row, that is (rank - 1) / (total partition rows - 1). The value thus ranges from 0 to 1 inclusive. scale represents decimal digits count in the fractional part of result.
An object to which SQL expressions and values can be appended.
Represents an SQL function that returns the rank of the current row, with gaps; that is, the row_number of the first row in its peer group.
Represents referential actions used by ON UPDATE
or ON DELETE
subclauses of a FOREIGN KEY
constraint clause.
Represents an SQL function that returns the number of the current row within its partition, counting from 1.
Utility functions that assist with creating, altering, and dropping database schema objects.
Represents an SQL operation that combines the results of multiple queries into a single result.
Numeric column for storing 2-byte integers.
Represents a SizedIterable that defers to the specified delegate collection.
Represents the iterable elements of a database result.
Class representing a provider of log messages at DEBUG level.
Builder object for creating SQL expressions.
Represents an SQL function that returns the population standard deviation of the non-null input values, or null
if there are no non-null values.
Represents an SQL function that returns the sample standard deviation of the non-null input values, or null
if there are no non-null values.
Class representing a provider of log messages sent to standard output stream.
Base character column for storing strings using the specified text collate type.
Represents an SQL function that returns the sum of expr across all non-null input values, or null
if there are no non-null values.
Character column for storing strings of arbitrary length using the specified collate type.
Class representing a unit block of work that is performed on a database.
Numeric column for storing unsigned 1-byte integers.
Numeric column for storing unsigned 4-byte integers.
Numeric column for storing unsigned 8-byte integers.
Represents UNBOUNDED FOLLOWING window function frame bound.
Represents UNBOUNDED PRECEDING window function frame bound.
Represents UNBOUNDED PRECEDING or FOLLOWING window function frame bound. direction specifies whether first or last partition row will be used.
Represents an SQL operation that combines all results from two queries, without any duplicates.
Represents an SQL operation that combines all results from two queries, with duplicates included.
Class for storing transaction data that should remain available to the transaction scope even after the transaction is committed.
Numeric column for storing unsigned 2-byte integers.
Binary column for storing UUID.
Represents an SQL function that returns the population variance of the non-null input values (square of the population standard deviation), or null
if there are no non-null values.
Represents an SQL function that returns the sample variance of the non-null input values (square of the sample standard deviation), or null
if there are no non-null values.
Represents an SQL window function frame start and end bound.
Represents window function frame bound direction.
Represents an SQL window function frame clause
Represents an SQL window function frame unit (also called mode).
Interface for functions that can be used as window functions.
Represents an SQL window function with window definition.
Properties
Returns this column's type cast as AutoIncColumnType or null
if the cast fails.
Returns a org.slf4j.Logger named specifically for Exposed log messages.
Returns true
if this is an auto-increment column, false
otherwise.
Returns the most recent QueryAlias instance used to create this join relation, or null
if a query was not joined.
Functions
Returns this subquery wrapped in the ALL
operator. This function is not supported by the SQLite dialect.
Returns this expression wrapped in the ALL
operator. This function is only supported by PostgreSQL and H2 dialects.
Returns this table wrapped in the ALL
operator. This function is only supported by MySQL, PostgreSQL, and H2 dialects.
Returns this array of data wrapped in the ALL
operator. This function is only supported by PostgreSQL and H2 dialects.
Returns this list of data wrapped in the ALL
operator. This function is only supported by PostgreSQL and H2 dialects.
Returns the result of performing a logical and
operation between this expression and the op.
Returns the result of performing a logical and
operation between this expression and the negate op.
Returns this subquery wrapped in the ANY
operator. This function is not supported by the SQLite dialect.
Returns this expression wrapped in the ANY
operator. This function is only supported by PostgreSQL and H2 dialects.
Returns this table wrapped in the ANY
operator. This function is only supported by MySQL, PostgreSQL, and H2 dialects.
Returns this array of data wrapped in the ANY
operator. This function is only supported by PostgreSQL and H2 dialects.
Returns this list of data wrapped in the ANY
operator. This function is only supported by PostgreSQL and H2 dialects.
Appends all arguments to this QueryBuilder.
Returns the specified value as an array literal, with elements parsed by the delegateType if provided.
Returns the specified value as an array query parameter, with elements parsed by the delegateType if provided.
Represents the SQL statement that batch inserts new rows into a table.
Represents the SQL statement that either batch inserts new rows into a table, or, if insertions violate unique constraints, first deletes the existing rows before inserting new rows.
Represents the SQL statement that either batch inserts new rows into a table, or updates the existing rows if insertions violate unique constraints.
Returns the specified value as a blob query parameter.
Returns the specified value as a boolean literal.
Returns the specified value as a boolean query parameter.
Returns the specified value as a byte literal.
Specifies a conversion from one data type to another.
Returns the length of this string expression, measured in characters, or null
if this expression is null.
Returns the number of input rows for which the value of this expression is not null.
Returns the number of distinct input rows for which the value of this expression is not null.
Creates a cross join relation with otherTable using onColumn and otherColumn equality and/or additionalConstraint as the join condition.
Calls a custom SQL function with the specified functionName, that returns a long, and passing params as its arguments.
Calls a custom SQL function with the specified functionName, that returns a string, and passing params as its arguments.
Returns the specified value as a decimal literal.
Returns the specified value as a decimal query parameter.
Represents the SQL statement that deletes all rows from a table in a join relation.
Represents the SQL statement that deletes rows from a table in a join relation.
Represents the SQL statement that deletes all rows in a table and returns specified data from the deleted rows.
Represents the SQL statement that deletes rows in a table and returns specified data from the deleted rows.
Returns the specified value as a double literal.
Returns the specified value as a double query parameter.
Returns an EmptySizedIterable.
Returns an SQL operator that checks if query returns at least one row.
Creates an ExplainQuery using the EXPLAIN
keyword, which obtains information about a statement execution plan.
Returns the specified value as a float literal.
Returns the specified value as a float query parameter.
Creates a full outer join relation with otherTable using onColumn and otherColumn equality and/or additionalConstraint as the join condition.
Calls a custom SQL function with the specified functionName and passes this expression as its only argument.
Creates an inner join relation with otherTable using onColumn and otherColumn equality and/or additionalConstraint as the join condition.
Represents the SQL statement that inserts a new row into a table.
Represents the SQL statement that uses data retrieved from a selectQuery to insert new rows into a table.
Represents the SQL statement that inserts a new row into a table, while ignoring any possible errors that occur during the process.
Represents the SQL statement that uses data retrieved from a selectQuery to insert new rows into a table, while ignoring any possible errors that occur during the process.
Represents the SQL statement that inserts new rows into a table and returns specified data from the inserted rows.
Returns the specified value as an int literal.
Creates a join relation with a query.
Creates a join relation between this table and a query.
Creates a left outer join relation with otherTable using onColumn and otherColumn equality and/or additionalConstraint as the join condition.
Returns the specified value as a long literal.
Returns a SizedIterable containing the lazily evaluated results of applying the function f to each original element.
Performs an SQL MERGE operation to insert, update, or delete records in the target table based on a comparison with a source table.
Performs an SQL MERGE operation to insert, update, or delete records in the target table based on a comparison with a select query source.
Advances this sequence and returns the new value.
Advances this sequence and returns the new value.
Returns an SQL operator that checks if query doesn't returns any row.
Returns the result of performing a logical or
operation between this expression and the op.
Returns the result of performing a logical or
operation between this expression and the negate op.
Represents the SQL statement that either inserts a new row into a table, or, if insertion would violate a unique constraint, first deletes the existing row before inserting a new row.
Represents the SQL statement that uses data retrieved from a selectQuery to either insert a new row into a table, or, if insertion would violate a unique constraint, first delete the existing row before inserting a new row.
Returns the ColumnType commonly associated with storing values of type T, or the defaultType if a mapping does not exist for type T.
Creates a right outer join relation with otherTable using onColumn and otherColumn equality and/or additionalConstraint as the join condition.
Returns the specified value as a short literal.
Returns the specified value as a short query parameter.
Returns the sample standard deviation of the non-null input values, or null
if there are no non-null values.
Returns the specified value as a string literal.
Returns the specified value as a string query parameter.
Returns the list of tables to which the columns in this column set belong.
Returns the specified value as a unsigned byte literal.
Returns the specified value as a unsigned byte query parameter.
Returns the specified value as a unsigned int literal.
Returns the specified value as a unsigned long literal.
Returns the specified value as a unsigned long query parameter.
Represents the SQL statement that updates all rows of a table.
Represents the SQL statement that updates all rows of a join relation.
Represents the SQL statement that updates rows of a table.
Represents the SQL statement that updates rows of a join relation.
Represents the SQL statement that updates all rows of a table and returns specified data from the updated rows.
Represents the SQL statement that updates rows of a table and returns specified data from the updated rows.
Represents the SQL statement that either inserts a new row into a table, or updates the existing row if insertion would violate a unique constraint.
Represents the SQL statement that either inserts a new row into a table, or updates the existing row if insertion would violate a unique constraint, and also returns specified data from the modified rows.
Returns the specified value as a unsigned short literal.
Returns the specified value as a unsigned short query parameter.
Wraps a query as an Expression so that it can be used as part of an SQL statement or in another query clause.