org.jooq.DerivedColumnList2 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
*
* https://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 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import static org.jooq.SQLDialect.*;
import org.jetbrains.annotations.NotNull;
/**
* A derived column list.
*
* Thist type models a table name and an optional "derived column list", which
* can be used to name both tables and columns in one go, e.g. when aliasing a
* derived table or a {@link CommonTableExpression}.
*
* Example:
*
*
* // Assuming import static org.jooq.impl.DSL.*;
*
* Table<?> t = name("t").fields("v").as(select(one()));
* // ^^^^^^^^^^^^^^^^^^^^^ -- DerivedColumnList
*
* using(configuration)
* .select()
* .from(t)
* .fetch();
*
*
* Instances can be created using {@link Name#fields(String...)} and overloads.
*
* @author Lukas Eder
*/
public interface DerivedColumnList2 extends QueryPart {
/**
* Specify a subselect to refer to by the DerivedColumnList to
* form a common table expression.
*/
@NotNull
@Support
> CommonTableExpression as(ResultQuery query);
/**
* Specify a materialized subselect to refer to by the
* DerivedColumnList to form a common table expression.
*
* This adds the PostgreSQL 12 MATERIALIZED hint to the common
* table expression definition, or silently ignores it, if the hint is not
* supported.
*/
@NotNull
@Support
> CommonTableExpression asMaterialized(ResultQuery query);
/**
* Specify a non-materialized subselect to refer to by the
* DerivedColumnList to form a common table expression.
*
* This adds the PostgreSQL 12 NOT MATERIALIZED hint to the
* common table expression definition, or silently ignores it, if the hint
* is not supported.
*/
@NotNull
@Support
> CommonTableExpression asNotMaterialized(ResultQuery query);
}