Module org.jooq

Package org.jooq

Interface DerivedColumnList

All Superinterfaces:

QueryPart, Serializable

public interface DerivedColumnList
extends QueryPart

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 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 Name.fields(String...) and overloads.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull QOM.UnmodifiableList<? extends Name>	$columnNames()	Experimental query object model accessor method, see also QOM.
@NotNull Name	$tableName()	Experimental query object model accessor method, see also QOM.
<R extends Record> @NotNull CommonTableExpression<R>	as(ResultQuery<R> query)	Specify a subselect to refer to by the DerivedColumnList to form a common table expression.
<R extends Record> @NotNull CommonTableExpression<R>	asMaterialized(ResultQuery<R> query)	Specify a materialized subselect to refer to by the DerivedColumnList to form a common table expression.
<R extends Record> @NotNull CommonTableExpression<R>	asNotMaterialized(ResultQuery<R> query)	Specify a non-materialized subselect to refer to by the DerivedColumnList to form a common table expression.

Methods inherited from interface org.jooq.QueryPart

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

Method Details

as

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HSQLDB,INFORMIX,MARIADB,MYSQL_8_0,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
<R extends Record>
@NotNull CommonTableExpression<R> as(ResultQuery<R> query)

Specify a subselect to refer to by the DerivedColumnList to form a common table expression.

A common table expression renders itself differently, depending on Context.declareCTE(). There are two rendering modes:

• Declaration: The common table expression renders its CTE name (this) along with the AS (query) clause. This typically happens in WITH clauses.
• Reference: The common table expression renders its alias identifier. This happens everywhere else.

asMaterialized

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HSQLDB,INFORMIX,MARIADB,MYSQL_8_0,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
<R extends Record>
@NotNull CommonTableExpression<R> asMaterialized(ResultQuery<R> 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.

A common table expression renders itself differently, depending on Context.declareCTE(). There are two rendering modes:

• Declaration: The common table expression renders its CTE name (this) along with the AS (query) clause. This typically happens in WITH clauses.
• Reference: The common table expression renders its alias identifier. This happens everywhere else.

asNotMaterialized

@NotNull
@Support({AURORA_POSTGRES,BIGQUERY,COCKROACHDB,DB2,EXASOL,FIREBIRD,H2,HSQLDB,INFORMIX,MARIADB,MYSQL_8_0,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,VERTICA,YUGABYTEDB})
<R extends Record>
@NotNull CommonTableExpression<R> asNotMaterialized(ResultQuery<R> 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.

A common table expression renders itself differently, depending on Context.declareCTE(). There are two rendering modes:

• Declaration: The common table expression renders its CTE name (this) along with the AS (query) clause. This typically happens in WITH clauses.
• Reference: The common table expression renders its alias identifier. This happens everywhere else.

$tableName

@Experimental
@NotNull
@NotNull Name $tableName()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

$columnNames

@Experimental
@NotNull
@NotNull QOM.UnmodifiableList<? extends Name> $columnNames()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.