org.jooq.QualifiedAsterisk 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.QOM;
import org.jooq.impl.QOM.UnmodifiableList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.ApiStatus.Experimental;
/**
* A qualified asterisk.
*
* Asterisks (qualified and unqualified) are expressions that can be used
* exclusively in SELECT clauses and a few other clauses that
* explicitly allow for asterisks, including RETURNING on DML
* statements. Asterisks are syntax sugar in SQL, which are expanded to a column
* list by the parser once all the columns in the FROM clause are
* known.
*
* Example:
*
*
* // Assuming import static org.jooq.impl.DSL.*;
*
* using(configuration)
* .select(ACTOR.asterisk())
* .from(ACTOR)
* .fetch();
*
*
* Instances can be created using {@link Table#asterisk()}.
*
* @author Lukas Eder
*/
public non-sealed interface QualifiedAsterisk extends SelectFieldOrAsterisk {
/**
* The qualifier.
*/
@NotNull
Table qualifier();
/**
* The qualified asterisk (t.* EXCEPT (fields)) expression to
* be used in SELECT clauses.
*
* This expression is a convenient way to select "all but some fields". Some
* dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
* other dialects, jOOQ expands the asterisk if possible.
*/
@NotNull
@Support
QualifiedAsterisk except(String... fieldNames);
/**
* The qualified asterisk (t.* EXCEPT (fields)) expression to
* be used in SELECT clauses.
*
* This expression is a convenient way to select "all but some fields". Some
* dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
* other dialects, jOOQ expands the asterisk if possible.
*/
@NotNull
@Support
QualifiedAsterisk except(Name... fieldNames);
/**
* The qualified asterisk (t.* EXCEPT (fields)) expression to
* be used in SELECT clauses.
*
* This expression is a convenient way to select "all but some fields". Some
* dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
* other dialects, jOOQ expands the asterisk if possible.
*/
@NotNull
@Support
QualifiedAsterisk except(Field... fields);
// -------------------------------------------------------------------------
// 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 Table $table();
/**
* 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> $except();
}