org.jooq.Row Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import org.jooq.impl.DSL;
import org.jooq.impl.QOM;
import org.jooq.impl.QOM.UnmodifiableList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.ApiStatus.Experimental;
/**
* A row value expression.
*
* Row value expressions are mainly useful for use in predicates, when comparing
* several values in one go, which can be more elegant than expanding the row
* value expression predicate in other equivalent syntaxes. This is especially
* true for non-equality predicates. For instance, the following two predicates
* are equivalent in SQL:
*
*
* (A, B) > (X, Y)
* (A > X) OR (A = X AND B > Y)
*
*
* Example:
*
*
* // Assuming import static org.jooq.impl.DSL.*;
*
* using(configuration)
* .select()
* .from(CUSTOMER)
* .where(row(CUSTOMER.FIRST_NAME, CUSTOMER.LAST_NAME).in(
* select(ACTOR.FIRST_NAME, ACTOR.LAST_NAME).from(ACTOR)
* ))
* .fetch();
*
*
* Note: Not all databases support row value expressions, but many row value
* expression operations can be emulated on all databases. See relevant row
* value expression method Javadocs for details.
*
* Instances can be created using {@link DSL#row(Object...)} and overloads.
*
* @author Lukas Eder
*/
public non-sealed interface Row
extends
Fields,
FieldOrRow,
FieldOrRowOrSelect
{
/**
* Get the degree of this row value expression.
*/
int size();
// ------------------------------------------------------------------------
// [NOT] NULL predicates
// ------------------------------------------------------------------------
/**
* Check if this row value expression contains only NULL
* values.
*
* Row NULL predicates can be emulated in those databases that do not
* support such predicates natively: (A, B) IS NULL is
* equivalent to A IS NULL AND B IS NULL
*/
@NotNull
@Support
Condition isNull();
/**
* Check if this row value expression contains no NULL values.
*
* Row NOT NULL predicates can be emulated in those databases that do not
* support such predicates natively: (A, B) IS NOT NULL is
* equivalent to A IS NOT NULL AND B IS NOT NULL
*
* Note that the two following predicates are NOT equivalent:
*
* (A, B) IS NOT NULL, which is the same as
* (A IS NOT NULL) AND (B IS NOT NULL)NOT((A, B) IS NULL), which is the same as
* (A IS NOT NULL) OR (B IS NOT NULL)
*/
@NotNull
@Support
Condition isNotNull();
// -------------------------------------------------------------------------
// XXX: Query Object Model
// -------------------------------------------------------------------------
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@NotNull UnmodifiableList> $fields();
}