Package org.mybatis.dynamic.sql

Interface SqlBuilder

public interface SqlBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SqlBuilder.CastFinisher
static class	SqlBuilder.InsertIntoNextStep

Method Summary

Modifier and Type	Method	Description
static <T> Add<T>	add(BindableColumn<T> firstColumn, BasicColumn secondColumn, BasicColumn... subsequentColumns)
static AndOrCriteriaGroup	and(List<AndOrCriteriaGroup> subCriteria)
static <T> AndOrCriteriaGroup	and(BindableColumn<T> column, RenderableCondition<T> condition, AndOrCriteriaGroup... subCriteria)
static AndOrCriteriaGroup	and(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria)
static AndOrCriteriaGroup	and(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria)
static <T> OperatorFunction<T>	applyOperator(String operator, BindableColumn<T> firstColumn, BasicColumn secondColumn, BasicColumn... subsequentColumns)
static <T> Avg<T>	avg(BindableColumn<T> column)
static SearchedCaseDSL	case_()
static <T> SimpleCaseDSL<T>	case_(BindableColumn<T> column)
static SqlBuilder.CastFinisher	cast(Double value)
static SqlBuilder.CastFinisher	cast(String value)
static SqlBuilder.CastFinisher	cast(BasicColumn column)
static <T> Concat<T>	concat(BindableColumn<T> firstColumn, BasicColumn... subsequentColumns)	Concatenate function that renders as "concat(x, y, z)".
static <T> Concatenate<T>	concatenate(BindableColumn<T> firstColumn, BasicColumn secondColumn, BasicColumn... subsequentColumns)	Concatenate function that renders as "(x || y || z)".
static <T> Constant<T>	constant(String constant)
static CountAll	count()
static Count	count(BasicColumn column)
static CountDSL.FromGatherer<SelectModel>	countColumn(BasicColumn column)	Renders as select count(column) from table...
static CountDistinct	countDistinct(BasicColumn column)
static CountDSL.FromGatherer<SelectModel>	countDistinctColumn(BasicColumn column)	Renders as select count(distinct column) from table...
static CountDSL<SelectModel>	countFrom(SqlTable table)	Renders as select count(*) from table...
static DeleteDSL<DeleteModel>	deleteFrom(SqlTable table)
static DeleteDSL<DeleteModel>	deleteFrom(SqlTable table, String tableAlias)
static <T> Divide<T>	divide(BindableColumn<T> firstColumn, BasicColumn secondColumn, BasicColumn... subsequentColumns)
static <T> IsEqualToColumn<T>	equalTo(BindableColumn<T> column)	Deprecated, for removal: This API element is subject to removal in a future version. since 2.0.0.
static <T> IsEqualTo<T>	equalTo(T value)	Deprecated, for removal: This API element is subject to removal in a future version. since 2.0.0.
static ExistsPredicate	exists(Buildable<SelectModel> selectModelBuilder)
static CriteriaGroup	group(List<AndOrCriteriaGroup> subCriteria)
static <T> CriteriaGroup	group(BindableColumn<T> column, RenderableCondition<T> condition, List<AndOrCriteriaGroup> subCriteria)
static <T> CriteriaGroup	group(BindableColumn<T> column, RenderableCondition<T> condition, AndOrCriteriaGroup... subCriteria)
static CriteriaGroup	group(ExistsPredicate existsPredicate, List<AndOrCriteriaGroup> subCriteria)
static CriteriaGroup	group(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria)
static CriteriaGroup	group(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria)
static CriteriaGroup	group(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria)
static <T> HavingDSL.StandaloneHavingFinisher	having(BindableColumn<T> column, RenderableCondition<T> condition, AndOrCriteriaGroup... subCriteria)
static HavingDSL.StandaloneHavingFinisher	having(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria)
static <T> InsertDSL.IntoGatherer<T>	insert(T row)
static <T> BatchInsertDSL.IntoGatherer<T>	insertBatch(Collection<T> records)	Insert a Batch of records.
static <T> BatchInsertDSL.IntoGatherer<T>	insertBatch(T... records)	Insert a Batch of records.
static SqlBuilder.InsertIntoNextStep	insertInto(SqlTable table)
static <T> MultiRowInsertDSL.IntoGatherer<T>	insertMultiple(Collection<T> records)	Insert multiple records in a single statement.
static <T> MultiRowInsertDSL.IntoGatherer<T>	insertMultiple(T... records)	Insert multiple records in a single statement.
static <T> IsBetween.Builder<T>	isBetween(Supplier<@NonNull T> valueSupplier1)
static <T> IsBetween.Builder<T>	isBetween(T value1)
static <T> IsBetweenWhenPresent.Builder<T>	isBetweenWhenPresent(@Nullable T value1)
static <T> IsBetweenWhenPresent.Builder<T>	isBetweenWhenPresent(Supplier<@Nullable T> valueSupplier1)
static <T> IsEqualTo<T>	isEqualTo(Supplier<T> valueSupplier)
static <T> IsEqualToColumn<T>	isEqualTo(BasicColumn column)
static <T> IsEqualToWithSubselect<T>	isEqualTo(Buildable<SelectModel> selectModelBuilder)
static <T> IsEqualTo<T>	isEqualTo(T value)
static <T> IsEqualToWhenPresent<T>	isEqualToWhenPresent(@Nullable T value)
static <T> IsEqualToWhenPresent<T>	isEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)
static IsEqualTo<Boolean>	isFalse()
static <T> IsGreaterThan<T>	isGreaterThan(Supplier<T> valueSupplier)
static <T> IsGreaterThanColumn<T>	isGreaterThan(BasicColumn column)
static <T> IsGreaterThanWithSubselect<T>	isGreaterThan(Buildable<SelectModel> selectModelBuilder)
static <T> IsGreaterThan<T>	isGreaterThan(T value)
static <T> IsGreaterThanOrEqualTo<T>	isGreaterThanOrEqualTo(Supplier<T> valueSupplier)
static <T> IsGreaterThanOrEqualToColumn<T>	isGreaterThanOrEqualTo(BasicColumn column)
static <T> IsGreaterThanOrEqualToWithSubselect<T>	isGreaterThanOrEqualTo(Buildable<SelectModel> selectModelBuilder)
static <T> IsGreaterThanOrEqualTo<T>	isGreaterThanOrEqualTo(T value)
static <T> IsGreaterThanOrEqualToWhenPresent<T>	isGreaterThanOrEqualToWhenPresent(@Nullable T value)
static <T> IsGreaterThanOrEqualToWhenPresent<T>	isGreaterThanOrEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsGreaterThanWhenPresent<T>	isGreaterThanWhenPresent(@Nullable T value)
static <T> IsGreaterThanWhenPresent<T>	isGreaterThanWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsIn<T>	isIn(@NonNull T... values)
static <T> IsIn<T>	isIn(Collection<@NonNull T> values)
static <T> IsInWithSubselect<T>	isIn(Buildable<SelectModel> selectModelBuilder)
static IsInCaseInsensitive<String>	isInCaseInsensitive(String... values)
static IsInCaseInsensitive<String>	isInCaseInsensitive(Collection<String> values)
static IsInCaseInsensitiveWhenPresent<String>	isInCaseInsensitiveWhenPresent(@Nullable String... values)
static IsInCaseInsensitiveWhenPresent<String>	isInCaseInsensitiveWhenPresent(@Nullable Collection<@Nullable String> values)
static <T> IsInWhenPresent<T>	isInWhenPresent(@Nullable T... values)
static <T> IsInWhenPresent<T>	isInWhenPresent(@Nullable Collection<@Nullable T> values)
static <T> IsLessThan<T>	isLessThan(Supplier<T> valueSupplier)
static <T> IsLessThanColumn<T>	isLessThan(BasicColumn column)
static <T> IsLessThanWithSubselect<T>	isLessThan(Buildable<SelectModel> selectModelBuilder)
static <T> IsLessThan<T>	isLessThan(T value)
static <T> IsLessThanOrEqualTo<T>	isLessThanOrEqualTo(Supplier<T> valueSupplier)
static <T> IsLessThanOrEqualToColumn<T>	isLessThanOrEqualTo(BasicColumn column)
static <T> IsLessThanOrEqualToWithSubselect<T>	isLessThanOrEqualTo(Buildable<SelectModel> selectModelBuilder)
static <T> IsLessThanOrEqualTo<T>	isLessThanOrEqualTo(T value)
static <T> IsLessThanOrEqualToWhenPresent<T>	isLessThanOrEqualToWhenPresent(@Nullable T value)
static <T> IsLessThanOrEqualToWhenPresent<T>	isLessThanOrEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsLessThanWhenPresent<T>	isLessThanWhenPresent(@Nullable T value)
static <T> IsLessThanWhenPresent<T>	isLessThanWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsLike<T>	isLike(Supplier<T> valueSupplier)
static <T> IsLike<T>	isLike(T value)
static IsLikeCaseInsensitive<String>	isLikeCaseInsensitive(String value)
static IsLikeCaseInsensitive<String>	isLikeCaseInsensitive(Supplier<String> valueSupplier)
static IsLikeCaseInsensitiveWhenPresent<String>	isLikeCaseInsensitiveWhenPresent(@Nullable String value)
static IsLikeCaseInsensitiveWhenPresent<String>	isLikeCaseInsensitiveWhenPresent(Supplier<@Nullable String> valueSupplier)
static <T> IsLikeWhenPresent<T>	isLikeWhenPresent(@Nullable T value)
static <T> IsLikeWhenPresent<T>	isLikeWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsNotBetween.Builder<T>	isNotBetween(Supplier<@NonNull T> valueSupplier1)
static <T> IsNotBetween.Builder<T>	isNotBetween(T value1)
static <T> IsNotBetweenWhenPresent.Builder<T>	isNotBetweenWhenPresent(@Nullable T value1)
static <T> IsNotBetweenWhenPresent.Builder<T>	isNotBetweenWhenPresent(Supplier<@Nullable T> valueSupplier1)
static <T> IsNotEqualTo<T>	isNotEqualTo(Supplier<T> valueSupplier)
static <T> IsNotEqualToColumn<T>	isNotEqualTo(BasicColumn column)
static <T> IsNotEqualToWithSubselect<T>	isNotEqualTo(Buildable<SelectModel> selectModelBuilder)
static <T> IsNotEqualTo<T>	isNotEqualTo(T value)
static <T> IsNotEqualToWhenPresent<T>	isNotEqualToWhenPresent(@Nullable T value)
static <T> IsNotEqualToWhenPresent<T>	isNotEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsNotIn<T>	isNotIn(@NonNull T... values)
static <T> IsNotIn<T>	isNotIn(Collection<@NonNull T> values)
static <T> IsNotInWithSubselect<T>	isNotIn(Buildable<SelectModel> selectModelBuilder)
static IsNotInCaseInsensitive<String>	isNotInCaseInsensitive(String... values)
static IsNotInCaseInsensitive<String>	isNotInCaseInsensitive(Collection<String> values)
static IsNotInCaseInsensitiveWhenPresent<String>	isNotInCaseInsensitiveWhenPresent(@Nullable String... values)
static IsNotInCaseInsensitiveWhenPresent<String>	isNotInCaseInsensitiveWhenPresent(@Nullable Collection<@Nullable String> values)
static <T> IsNotInWhenPresent<T>	isNotInWhenPresent(@Nullable T... values)
static <T> IsNotInWhenPresent<T>	isNotInWhenPresent(@Nullable Collection<@Nullable T> values)
static <T> IsNotLike<T>	isNotLike(Supplier<T> valueSupplier)
static <T> IsNotLike<T>	isNotLike(T value)
static IsNotLikeCaseInsensitive<String>	isNotLikeCaseInsensitive(String value)
static IsNotLikeCaseInsensitive<String>	isNotLikeCaseInsensitive(Supplier<String> valueSupplier)
static IsNotLikeCaseInsensitiveWhenPresent<String>	isNotLikeCaseInsensitiveWhenPresent(@Nullable String value)
static IsNotLikeCaseInsensitiveWhenPresent<String>	isNotLikeCaseInsensitiveWhenPresent(Supplier<@Nullable String> valueSupplier)
static <T> IsNotLikeWhenPresent<T>	isNotLikeWhenPresent(@Nullable T value)
static <T> IsNotLikeWhenPresent<T>	isNotLikeWhenPresent(Supplier<@Nullable T> valueSupplier)
static <T> IsNotNull<T>	isNotNull()
static <T> IsNull<T>	isNull()
static IsEqualTo<Boolean>	isTrue()
static <T> Lower<T>	lower(BindableColumn<T> column)
static <T> Max<T>	max(BindableColumn<T> column)
static <T> Min<T>	min(BindableColumn<T> column)
static <T> Multiply<T>	multiply(BindableColumn<T> firstColumn, BasicColumn secondColumn, BasicColumn... subsequentColumns)
static MultiSelectDSL	multiSelect(Buildable<SelectModel> selectModelBuilder)
static NotCriterion	not(List<AndOrCriteriaGroup> subCriteria)
static <T> NotCriterion	not(BindableColumn<T> column, RenderableCondition<T> condition, List<AndOrCriteriaGroup> subCriteria)
static <T> NotCriterion	not(BindableColumn<T> column, RenderableCondition<T> condition, AndOrCriteriaGroup... subCriteria)
static NotCriterion	not(ExistsPredicate existsPredicate, List<AndOrCriteriaGroup> subCriteria)
static NotCriterion	not(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria)
static NotCriterion	not(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria)
static NotCriterion	not(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria)
static ExistsPredicate	notExists(Buildable<SelectModel> selectModelBuilder)
static <T> ColumnAndConditionCriterion<T>	on(BindableColumn<T> joinColumn, RenderableCondition<T> joinCondition)
static AndOrCriteriaGroup	or(List<AndOrCriteriaGroup> subCriteria)
static <T> AndOrCriteriaGroup	or(BindableColumn<T> column, RenderableCondition<T> condition, AndOrCriteriaGroup... subCriteria)
static AndOrCriteriaGroup	or(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria)
static AndOrCriteriaGroup	or(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria)
static QueryExpressionDSL.FromGatherer<SelectModel>	select(Collection<? extends BasicColumn> selectList)
static QueryExpressionDSL.FromGatherer<SelectModel>	select(BasicColumn... selectList)
static QueryExpressionDSL.FromGatherer<SelectModel>	selectDistinct(Collection<? extends BasicColumn> selectList)
static QueryExpressionDSL.FromGatherer<SelectModel>	selectDistinct(BasicColumn... selectList)
static SortSpecification	sortColumn(String name)	Creates a sort specification based on a String.
static SortSpecification	sortColumn(String tableAlias, SqlColumn<?> column)	Creates a sort specification based on a column and a table alias.
static StringConstant	stringConstant(String constant)
static SubQueryColumn	subQuery(Buildable<SelectModel> subQuery)
static <T> Substring<T>	substring(BindableColumn<T> column, int offset, int length)
static <T> Subtract<T>	subtract(BindableColumn<T> firstColumn, BasicColumn secondColumn, BasicColumn... subsequentColumns)
static Sum<Object>	sum(BasicColumn column)
static <T> Sum<T>	sum(BindableColumn<T> column)
static <T> Sum<T>	sum(BindableColumn<T> column, RenderableCondition<T> condition)
static UpdateDSL<UpdateModel>	update(SqlTable table)
static UpdateDSL<UpdateModel>	update(SqlTable table, String tableAlias)
static <T> Upper<T>	upper(BindableColumn<T> column)
static <T> BoundValue<T>	value(T value)
static WhereDSL.StandaloneWhereFinisher	where()
static <T> WhereDSL.StandaloneWhereFinisher	where(BindableColumn<T> column, RenderableCondition<T> condition, AndOrCriteriaGroup... subCriteria)
static WhereDSL.StandaloneWhereFinisher	where(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria)
static WhereDSL.StandaloneWhereFinisher	where(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria)

Method Details

countDistinctColumn

static CountDSL.FromGatherer<SelectModel> countDistinctColumn(BasicColumn column)

Renders as select count(distinct column) from table...

Parameters:

column - the column to count

Returns:

the next step in the DSL

countColumn

static CountDSL.FromGatherer<SelectModel> countColumn(BasicColumn column)

Renders as select count(column) from table...

Parameters:

column - the column to count

Returns:

the next step in the DSL

countFrom

static CountDSL<SelectModel> countFrom(SqlTable table)

Renders as select count(*) from table...

Parameters:

table - the table to count

Returns:

the next step in the DSL

deleteFrom

static DeleteDSL<DeleteModel> deleteFrom(SqlTable table)

deleteFrom

static DeleteDSL<DeleteModel> deleteFrom(SqlTable table,
 String tableAlias)

insert

static <T> InsertDSL.IntoGatherer<T> insert(T row)

insertBatch

@SafeVarargs
static <T> BatchInsertDSL.IntoGatherer<T> insertBatch(T... records)

Insert a Batch of records. The model object is structured to support bulk inserts with JDBC batch support.

Type Parameters:

T - the type of record to insert

Parameters:

records - records to insert

Returns:

the next step in the DSL

insertBatch

static <T> BatchInsertDSL.IntoGatherer<T> insertBatch(Collection<T> records)

Insert a Batch of records. The model object is structured to support bulk inserts with JDBC batch support.

Type Parameters:

T - the type of record to insert

Parameters:

records - records to insert

Returns:

the next step in the DSL

insertMultiple

@SafeVarargs
static <T> MultiRowInsertDSL.IntoGatherer<T> insertMultiple(T... records)

Insert multiple records in a single statement. The model object is structured as a single insert statement with multiple values clauses. This statement is suitable for use with a small number of records. It is not suitable for large bulk inserts as it is possible to exceed the limit of parameter markers in a prepared statement.

For large bulk inserts, see insertBatch(Object[])

Type Parameters:

T - the type of record to insert

Parameters:

records - records to insert

Returns:

the next step in the DSL

insertMultiple

static <T> MultiRowInsertDSL.IntoGatherer<T> insertMultiple(Collection<T> records)

Insert multiple records in a single statement. The model object is structured as a single insert statement with multiple values clauses. This statement is suitable for use with a small number of records. It is not suitable for large bulk inserts as it is possible to exceed the limit of parameter markers in a prepared statement.

For large bulk inserts, see insertBatch(Collection)

Type Parameters:

T - the type of record to insert

Parameters:

records - records to insert

Returns:

the next step in the DSL

insertInto

static SqlBuilder.InsertIntoNextStep insertInto(SqlTable table)

select

static QueryExpressionDSL.FromGatherer<SelectModel> select(BasicColumn... selectList)

select

static QueryExpressionDSL.FromGatherer<SelectModel> select(Collection<? extends BasicColumn> selectList)

selectDistinct

static QueryExpressionDSL.FromGatherer<SelectModel> selectDistinct(BasicColumn... selectList)

selectDistinct

static QueryExpressionDSL.FromGatherer<SelectModel> selectDistinct(Collection<? extends BasicColumn> selectList)

multiSelect

static MultiSelectDSL multiSelect(Buildable<SelectModel> selectModelBuilder)

update

static UpdateDSL<UpdateModel> update(SqlTable table)

update

static UpdateDSL<UpdateModel> update(SqlTable table,
 String tableAlias)

where

static WhereDSL.StandaloneWhereFinisher where()

where

static <T> WhereDSL.StandaloneWhereFinisher where(BindableColumn<T> column,
 RenderableCondition<T> condition,
 AndOrCriteriaGroup... subCriteria)

where

static WhereDSL.StandaloneWhereFinisher where(SqlCriterion initialCriterion,
 AndOrCriteriaGroup... subCriteria)

where

static WhereDSL.StandaloneWhereFinisher where(ExistsPredicate existsPredicate,
 AndOrCriteriaGroup... subCriteria)

having

static <T> HavingDSL.StandaloneHavingFinisher having(BindableColumn<T> column,
 RenderableCondition<T> condition,
 AndOrCriteriaGroup... subCriteria)

having

static HavingDSL.StandaloneHavingFinisher having(SqlCriterion initialCriterion,
 AndOrCriteriaGroup... subCriteria)

group

static <T> CriteriaGroup group(BindableColumn<T> column,
 RenderableCondition<T> condition,
 AndOrCriteriaGroup... subCriteria)

group

static <T> CriteriaGroup group(BindableColumn<T> column,
 RenderableCondition<T> condition,
 List<AndOrCriteriaGroup> subCriteria)

group

static CriteriaGroup group(ExistsPredicate existsPredicate,
 AndOrCriteriaGroup... subCriteria)

group

static CriteriaGroup group(ExistsPredicate existsPredicate,
 List<AndOrCriteriaGroup> subCriteria)

group

static CriteriaGroup group(SqlCriterion initialCriterion,
 AndOrCriteriaGroup... subCriteria)

group

static CriteriaGroup group(SqlCriterion initialCriterion,
 List<AndOrCriteriaGroup> subCriteria)

group

static CriteriaGroup group(List<AndOrCriteriaGroup> subCriteria)

not

static <T> NotCriterion not(BindableColumn<T> column,
 RenderableCondition<T> condition,
 AndOrCriteriaGroup... subCriteria)

not

static <T> NotCriterion not(BindableColumn<T> column,
 RenderableCondition<T> condition,
 List<AndOrCriteriaGroup> subCriteria)

not

static NotCriterion not(ExistsPredicate existsPredicate,
 AndOrCriteriaGroup... subCriteria)

not

static NotCriterion not(ExistsPredicate existsPredicate,
 List<AndOrCriteriaGroup> subCriteria)

not

static NotCriterion not(SqlCriterion initialCriterion,
 AndOrCriteriaGroup... subCriteria)

not

static NotCriterion not(SqlCriterion initialCriterion,
 List<AndOrCriteriaGroup> subCriteria)

not

static NotCriterion not(List<AndOrCriteriaGroup> subCriteria)

or

static <T> AndOrCriteriaGroup or(BindableColumn<T> column,
 RenderableCondition<T> condition,
 AndOrCriteriaGroup... subCriteria)

or

static AndOrCriteriaGroup or(ExistsPredicate existsPredicate,
 AndOrCriteriaGroup... subCriteria)

or

static AndOrCriteriaGroup or(SqlCriterion initialCriterion,
 AndOrCriteriaGroup... subCriteria)

or

static AndOrCriteriaGroup or(List<AndOrCriteriaGroup> subCriteria)

and

static <T> AndOrCriteriaGroup and(BindableColumn<T> column,
 RenderableCondition<T> condition,
 AndOrCriteriaGroup... subCriteria)

and

static AndOrCriteriaGroup and(ExistsPredicate existsPredicate,
 AndOrCriteriaGroup... subCriteria)

and

static AndOrCriteriaGroup and(SqlCriterion initialCriterion,
 AndOrCriteriaGroup... subCriteria)

and

static AndOrCriteriaGroup and(List<AndOrCriteriaGroup> subCriteria)

on

static <T> ColumnAndConditionCriterion<T> on(BindableColumn<T> joinColumn,
 RenderableCondition<T> joinCondition)

equalTo

@Deprecated(since="2.0.0",
            forRemoval=true)
static <T> IsEqualToColumn<T> equalTo(BindableColumn<T> column)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0. Please replace with isEqualTo(column)

Starting in version 2.0.0, this function is a synonym for isEqualTo(BasicColumn).

Type Parameters:

T - the column type

Parameters:

column - the column

Returns:

an IsEqualToColumn condition

equalTo

@Deprecated(since="2.0.0",
            forRemoval=true)
static <T> IsEqualTo<T> equalTo(T value)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0. Please replace with isEqualTo(value)

Starting in version 2.0.0, this function is a synonym for isEqualTo(Object).

Type Parameters:

T - the column type

Parameters:

value - the value

Returns:

an IsEqualTo condition

case_

static <T> SimpleCaseDSL<T> case_(BindableColumn<T> column)

case_

static SearchedCaseDSL case_()

count

static CountAll count()

count

static Count count(BasicColumn column)

countDistinct

static CountDistinct countDistinct(BasicColumn column)

subQuery

static SubQueryColumn subQuery(Buildable<SelectModel> subQuery)

max

static <T> Max<T> max(BindableColumn<T> column)

min

static <T> Min<T> min(BindableColumn<T> column)

avg

static <T> Avg<T> avg(BindableColumn<T> column)

sum

static <T> Sum<T> sum(BindableColumn<T> column)

sum

static Sum<Object> sum(BasicColumn column)

sum

static <T> Sum<T> sum(BindableColumn<T> column,
 RenderableCondition<T> condition)

constant

static <T> Constant<T> constant(String constant)

stringConstant

static StringConstant stringConstant(String constant)

value

static <T> BoundValue<T> value(T value)

add

static <T> Add<T> add(BindableColumn<T> firstColumn,
 BasicColumn secondColumn,
 BasicColumn... subsequentColumns)

divide

static <T> Divide<T> divide(BindableColumn<T> firstColumn,
 BasicColumn secondColumn,
 BasicColumn... subsequentColumns)

multiply

static <T> Multiply<T> multiply(BindableColumn<T> firstColumn,
 BasicColumn secondColumn,
 BasicColumn... subsequentColumns)

subtract

static <T> Subtract<T> subtract(BindableColumn<T> firstColumn,
 BasicColumn secondColumn,
 BasicColumn... subsequentColumns)

cast

static SqlBuilder.CastFinisher cast(String value)

cast

static SqlBuilder.CastFinisher cast(Double value)

cast

static SqlBuilder.CastFinisher cast(BasicColumn column)

concatenate

static <T> Concatenate<T> concatenate(BindableColumn<T> firstColumn,
 BasicColumn secondColumn,
 BasicColumn... subsequentColumns)

Concatenate function that renders as "(x || y || z)". This will not work on some databases like MySql. In that case, use concat(BindableColumn, BasicColumn...)

Type Parameters:

T - type of column

Parameters:

firstColumn - first column

secondColumn - second column

subsequentColumns - subsequent columns

Returns:

a Concatenate instance

concat

static <T> Concat<T> concat(BindableColumn<T> firstColumn,
 BasicColumn... subsequentColumns)

Concatenate function that renders as "concat(x, y, z)". This version works on more databases than concatenate(BindableColumn, BasicColumn, BasicColumn...)

Type Parameters:

T - type of column

Parameters:

firstColumn - first column

subsequentColumns - subsequent columns

Returns:

a Concat instance

applyOperator

static <T> OperatorFunction<T> applyOperator(String operator,
 BindableColumn<T> firstColumn,
 BasicColumn secondColumn,
 BasicColumn... subsequentColumns)

lower

static <T> Lower<T> lower(BindableColumn<T> column)

substring

static <T> Substring<T> substring(BindableColumn<T> column,
 int offset,
 int length)

upper

static <T> Upper<T> upper(BindableColumn<T> column)

exists

static ExistsPredicate exists(Buildable<SelectModel> selectModelBuilder)

notExists

static ExistsPredicate notExists(Buildable<SelectModel> selectModelBuilder)

isNull

static <T> IsNull<T> isNull()

isNotNull

static <T> IsNotNull<T> isNotNull()

isEqualTo

static <T> IsEqualTo<T> isEqualTo(T value)

isEqualTo

static <T> IsEqualTo<T> isEqualTo(Supplier<T> valueSupplier)

isEqualTo

static <T> IsEqualToWithSubselect<T> isEqualTo(Buildable<SelectModel> selectModelBuilder)

isEqualTo

static <T> IsEqualToColumn<T> isEqualTo(BasicColumn column)

isEqualToWhenPresent

static <T> IsEqualToWhenPresent<T> isEqualToWhenPresent(@Nullable T value)

isEqualToWhenPresent

static <T> IsEqualToWhenPresent<T> isEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)

isNotEqualTo

static <T> IsNotEqualTo<T> isNotEqualTo(T value)

isNotEqualTo

static <T> IsNotEqualTo<T> isNotEqualTo(Supplier<T> valueSupplier)

isNotEqualTo

static <T> IsNotEqualToWithSubselect<T> isNotEqualTo(Buildable<SelectModel> selectModelBuilder)

isNotEqualTo

static <T> IsNotEqualToColumn<T> isNotEqualTo(BasicColumn column)

isNotEqualToWhenPresent

static <T> IsNotEqualToWhenPresent<T> isNotEqualToWhenPresent(@Nullable T value)

isNotEqualToWhenPresent

static <T> IsNotEqualToWhenPresent<T> isNotEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)

isGreaterThan

static <T> IsGreaterThan<T> isGreaterThan(T value)

isGreaterThan

static <T> IsGreaterThan<T> isGreaterThan(Supplier<T> valueSupplier)

isGreaterThan

static <T> IsGreaterThanWithSubselect<T> isGreaterThan(Buildable<SelectModel> selectModelBuilder)

isGreaterThan

static <T> IsGreaterThanColumn<T> isGreaterThan(BasicColumn column)

isGreaterThanWhenPresent

static <T> IsGreaterThanWhenPresent<T> isGreaterThanWhenPresent(@Nullable T value)

isGreaterThanWhenPresent

static <T> IsGreaterThanWhenPresent<T> isGreaterThanWhenPresent(Supplier<@Nullable T> valueSupplier)

isGreaterThanOrEqualTo

static <T> IsGreaterThanOrEqualTo<T> isGreaterThanOrEqualTo(T value)

isGreaterThanOrEqualTo

static <T> IsGreaterThanOrEqualTo<T> isGreaterThanOrEqualTo(Supplier<T> valueSupplier)

isGreaterThanOrEqualTo

static <T> IsGreaterThanOrEqualToWithSubselect<T> isGreaterThanOrEqualTo(Buildable<SelectModel> selectModelBuilder)

isGreaterThanOrEqualTo

static <T> IsGreaterThanOrEqualToColumn<T> isGreaterThanOrEqualTo(BasicColumn column)

isGreaterThanOrEqualToWhenPresent

static <T> IsGreaterThanOrEqualToWhenPresent<T> isGreaterThanOrEqualToWhenPresent(@Nullable T value)

isGreaterThanOrEqualToWhenPresent

static <T> IsGreaterThanOrEqualToWhenPresent<T> isGreaterThanOrEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)

isLessThan

static <T> IsLessThan<T> isLessThan(T value)

isLessThan

static <T> IsLessThan<T> isLessThan(Supplier<T> valueSupplier)

isLessThan

static <T> IsLessThanWithSubselect<T> isLessThan(Buildable<SelectModel> selectModelBuilder)

isLessThan

static <T> IsLessThanColumn<T> isLessThan(BasicColumn column)

isLessThanWhenPresent

static <T> IsLessThanWhenPresent<T> isLessThanWhenPresent(@Nullable T value)

isLessThanWhenPresent

static <T> IsLessThanWhenPresent<T> isLessThanWhenPresent(Supplier<@Nullable T> valueSupplier)

isLessThanOrEqualTo

static <T> IsLessThanOrEqualTo<T> isLessThanOrEqualTo(T value)

isLessThanOrEqualTo

static <T> IsLessThanOrEqualTo<T> isLessThanOrEqualTo(Supplier<T> valueSupplier)

isLessThanOrEqualTo

static <T> IsLessThanOrEqualToWithSubselect<T> isLessThanOrEqualTo(Buildable<SelectModel> selectModelBuilder)

isLessThanOrEqualTo

static <T> IsLessThanOrEqualToColumn<T> isLessThanOrEqualTo(BasicColumn column)

isLessThanOrEqualToWhenPresent

static <T> IsLessThanOrEqualToWhenPresent<T> isLessThanOrEqualToWhenPresent(@Nullable T value)

isLessThanOrEqualToWhenPresent

static <T> IsLessThanOrEqualToWhenPresent<T> isLessThanOrEqualToWhenPresent(Supplier<@Nullable T> valueSupplier)

isIn

@SafeVarargs
static <T> IsIn<T> isIn(@NonNull T... values)

isIn

static <T> IsIn<T> isIn(Collection<@NonNull T> values)

isIn

static <T> IsInWithSubselect<T> isIn(Buildable<SelectModel> selectModelBuilder)

isInWhenPresent

@SafeVarargs
static <T> IsInWhenPresent<T> isInWhenPresent(@Nullable T... values)

isInWhenPresent

static <T> IsInWhenPresent<T> isInWhenPresent(@Nullable Collection<@Nullable T> values)

isNotIn

@SafeVarargs
static <T> IsNotIn<T> isNotIn(@NonNull T... values)

isNotIn

static <T> IsNotIn<T> isNotIn(Collection<@NonNull T> values)

isNotIn

static <T> IsNotInWithSubselect<T> isNotIn(Buildable<SelectModel> selectModelBuilder)

isNotInWhenPresent

@SafeVarargs
static <T> IsNotInWhenPresent<T> isNotInWhenPresent(@Nullable T... values)

isNotInWhenPresent

static <T> IsNotInWhenPresent<T> isNotInWhenPresent(@Nullable Collection<@Nullable T> values)

isBetween

static <T> IsBetween.Builder<T> isBetween(T value1)

isBetween

static <T> IsBetween.Builder<T> isBetween(Supplier<@NonNull T> valueSupplier1)

isBetweenWhenPresent

static <T> IsBetweenWhenPresent.Builder<T> isBetweenWhenPresent(@Nullable T value1)

isBetweenWhenPresent

static <T> IsBetweenWhenPresent.Builder<T> isBetweenWhenPresent(Supplier<@Nullable T> valueSupplier1)

isNotBetween

static <T> IsNotBetween.Builder<T> isNotBetween(T value1)

isNotBetween

static <T> IsNotBetween.Builder<T> isNotBetween(Supplier<@NonNull T> valueSupplier1)

isNotBetweenWhenPresent

static <T> IsNotBetweenWhenPresent.Builder<T> isNotBetweenWhenPresent(@Nullable T value1)

isNotBetweenWhenPresent

static <T> IsNotBetweenWhenPresent.Builder<T> isNotBetweenWhenPresent(Supplier<@Nullable T> valueSupplier1)

isLike

static <T> IsLike<T> isLike(T value)

isLike

static <T> IsLike<T> isLike(Supplier<T> valueSupplier)

isLikeWhenPresent

static <T> IsLikeWhenPresent<T> isLikeWhenPresent(@Nullable T value)

isLikeWhenPresent

static <T> IsLikeWhenPresent<T> isLikeWhenPresent(Supplier<@Nullable T> valueSupplier)

isNotLike

static <T> IsNotLike<T> isNotLike(T value)

isNotLike

static <T> IsNotLike<T> isNotLike(Supplier<T> valueSupplier)

isNotLikeWhenPresent

static <T> IsNotLikeWhenPresent<T> isNotLikeWhenPresent(@Nullable T value)

isNotLikeWhenPresent

static <T> IsNotLikeWhenPresent<T> isNotLikeWhenPresent(Supplier<@Nullable T> valueSupplier)

isTrue

static IsEqualTo<Boolean> isTrue()

isFalse

static IsEqualTo<Boolean> isFalse()

isLikeCaseInsensitive

static IsLikeCaseInsensitive<String> isLikeCaseInsensitive(String value)

isLikeCaseInsensitive

static IsLikeCaseInsensitive<String> isLikeCaseInsensitive(Supplier<String> valueSupplier)

isLikeCaseInsensitiveWhenPresent

static IsLikeCaseInsensitiveWhenPresent<String> isLikeCaseInsensitiveWhenPresent(@Nullable String value)

isLikeCaseInsensitiveWhenPresent

static IsLikeCaseInsensitiveWhenPresent<String> isLikeCaseInsensitiveWhenPresent(Supplier<@Nullable String> valueSupplier)

isNotLikeCaseInsensitive

static IsNotLikeCaseInsensitive<String> isNotLikeCaseInsensitive(String value)

isNotLikeCaseInsensitive

static IsNotLikeCaseInsensitive<String> isNotLikeCaseInsensitive(Supplier<String> valueSupplier)

isNotLikeCaseInsensitiveWhenPresent

static IsNotLikeCaseInsensitiveWhenPresent<String> isNotLikeCaseInsensitiveWhenPresent(@Nullable String value)

isNotLikeCaseInsensitiveWhenPresent

static IsNotLikeCaseInsensitiveWhenPresent<String> isNotLikeCaseInsensitiveWhenPresent(Supplier<@Nullable String> valueSupplier)

isInCaseInsensitive

static IsInCaseInsensitive<String> isInCaseInsensitive(String... values)

isInCaseInsensitive

static IsInCaseInsensitive<String> isInCaseInsensitive(Collection<String> values)

isInCaseInsensitiveWhenPresent

static IsInCaseInsensitiveWhenPresent<String> isInCaseInsensitiveWhenPresent(@Nullable String... values)

isInCaseInsensitiveWhenPresent

static IsInCaseInsensitiveWhenPresent<String> isInCaseInsensitiveWhenPresent(@Nullable Collection<@Nullable String> values)

isNotInCaseInsensitive

static IsNotInCaseInsensitive<String> isNotInCaseInsensitive(String... values)

isNotInCaseInsensitive

static IsNotInCaseInsensitive<String> isNotInCaseInsensitive(Collection<String> values)

isNotInCaseInsensitiveWhenPresent

static IsNotInCaseInsensitiveWhenPresent<String> isNotInCaseInsensitiveWhenPresent(@Nullable String... values)

isNotInCaseInsensitiveWhenPresent

static IsNotInCaseInsensitiveWhenPresent<String> isNotInCaseInsensitiveWhenPresent(@Nullable Collection<@Nullable String> values)

sortColumn

static SortSpecification sortColumn(String name)

Creates a sort specification based on a String. This is useful when a column has been aliased in the select list. For example:

     select(foo.as("bar"))
     .from(baz)
     .orderBy(sortColumn("bar"))
 

Parameters:

name - the string to use as a sort specification

Returns:

a sort specification

sortColumn

static SortSpecification sortColumn(String tableAlias,
 SqlColumn<?> column)

Creates a sort specification based on a column and a table alias. This can be useful in a join where the desired sort order is based on a column not in the select list. This will likely fail in union queries depending on database support.

Parameters:

tableAlias - the table alias

column - the column

Returns:

a sort specification