Interface Variable<T>

All Superinterfaces:

Field<T>, FieldOrConstraint, FieldOrRow, FieldOrRowOrSelect, GroupField, Named, OrderField<T>, ParamOrVariable<T>, QueryPart, SelectField<T>, SelectFieldOrAsterisk, Serializable, TableElement, Typed<T>

All Known Subinterfaces:

Parameter<T>

@Pro
public interface Variable<T>
extends ParamOrVariable<T>

A local variable reference.

In procedural languages, local variables are essential to make values reusable to a program or block.

Example:

// Assuming import static org.jooq.impl.DSL.*;

Variable<Integer> i = var("i", SQLDataType.INTEGER);
using(configuration)
   .begin(
       declare(i).set(1),
       insertInto(TABLE).columns(TABLE.COL1).values(i),
       i.set(i.plus(1)),
       insertInto(TABLE).columns(TABLE.COL1).values(i)
   )
   .execute();

Instances can be created using DSL.var(Name, DataType) and overloads.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull Statement	set(Field<T> value)	Assign a value to this variable.
@NotNull Statement	set(Select<? extends Record1<T>> value)	Assign a value to this variable.
@NotNull Statement	set(T value)	Assign a value to this variable.
@NotNull Statement	setNull()	Assign null to this variable.

Methods inherited from interface Field

add, add, as, as, as, as, asc, ascii, between, between, between, between, betweenSymmetric, betweenSymmetric, betweenSymmetric, betweenSymmetric, binaryLike, binaryLike, binaryLike, bitAnd, bitAnd, bitLength, bitNand, bitNand, bitNor, bitNor, bitNot, bitOr, bitOr, bitXNor, bitXNor, bitXor, bitXor, cast, cast, cast, changed, charLength, coalesce, coalesce, coerce, coerce, coerce, collate, collate, collate, comment, comment, compare, compare, compare, compare, concat, concat, concat, contains, contains, containsIgnoreCase, containsIgnoreCase, convert, convert, convert, convertFrom, convertFrom, convertTo, convertTo, decode, decode, decode, decode, desc, div, div, divide, divide, endsWith, endsWith, endsWithIgnoreCase, endsWithIgnoreCase, eq, eq, eq, eq, equal, equal, equal, equal, equalIgnoreCase, equalIgnoreCase, equals, field, from, ge, ge, ge, ge, get, getComment, getName, getValue, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterThan, greaterThan, greaterThan, greaterThan, gt, gt, gt, gt, in, in, in, in, in, isDistinctFrom, isDistinctFrom, isDistinctFrom, isDocument, isFalse, isJson, isNotDistinctFrom, isNotDistinctFrom, isNotDistinctFrom, isNotDocument, isNotJson, isNotNull, isNull, isTrue, le, le, le, le, length, lessOrEqual, lessOrEqual, lessOrEqual, lessOrEqual, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeRegex, likeRegex, lower, lpad, lpad, lpad, lpad, lt, lt, lt, lt, ltrim, minus, minus, mod, mod, modulo, modulo, mul, mul, multiply, multiply, ne, ne, ne, ne, neg, notBetween, notBetween, notBetween, notBetween, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notBinaryLike, notBinaryLike, notBinaryLike, notContains, notContains, notContainsIgnoreCase, notContainsIgnoreCase, notEqual, notEqual, notEqual, notEqual, notEqualIgnoreCase, notEqualIgnoreCase, notIn, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notLike, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeRegex, notLikeRegex, notSimilarTo, notSimilarTo, notSimilarTo, notSimilarTo, notSimilarTo, nullif, nullif, nullsFirst, nullsLast, nvl, nvl, nvl2, nvl2, octetLength, original, plus, plus, plus, position, position, pow, pow, power, power, rem, rem, repeat, repeat, replace, replace, replace, replace, reset, rpad, rpad, rpad, rpad, rtrim, shl, shl, shr, shr, similarTo, similarTo, similarTo, similarTo, similarTo, sort, sort, sortAsc, sortAsc, sortDefault, sortDesc, sortDesc, startsWith, startsWith, startsWithIgnoreCase, startsWithIgnoreCase, sub, sub, substring, substring, substring, substring, subtract, subtract, times, times, touched, trim, unaryMinus, unaryPlus, upper

Methods inherited from interface Named

$name, getCommentPart, getQualifiedName, getUnqualifiedName

Methods inherited from interface QueryPart

$replace, $replace, $traverse, $traverse, hashCode, toString

Methods inherited from interface Typed

$dataType, getBinding, getConverter, getDataType, getDataType, getType

Method Details

set

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,MARIADB,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TRINO,YUGABYTEDB})
@NotNull Statement set(T value)

Assign a value to this variable.

set

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,MARIADB,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TRINO,YUGABYTEDB})
@NotNull Statement set(Field<T> value)

Assign a value to this variable.

set

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,MARIADB,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TRINO,YUGABYTEDB})
@NotNull Statement set(Select<? extends Record1<T>> value)

Assign a value to this variable.

setNull

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,MARIADB,MYSQL,ORACLE,POSTGRES,SNOWFLAKE,SQLDATAWAREHOUSE,SQLSERVER,TRINO,YUGABYTEDB})
@NotNull Statement setNull()

Assign null to this variable.

This method is convenience for calling set(Object), without the necessity of casting the Java null literal to (T).