org.jooq.TableLike 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 license 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.H2;
// ...
import static org.jooq.SQLDialect.MARIADB;
import static org.jooq.SQLDialect.MYSQL;
// ...
import static org.jooq.SQLDialect.POSTGRES;
import static org.jooq.SQLDialect.SQLITE;
// ...
// ...
import static org.jooq.SQLDialect.YUGABYTEDB;
import java.util.Collection;
import java.util.function.BiFunction;
import java.util.function.Function;
import org.jooq.impl.DSL;
import org.jetbrains.annotations.NotNull;
/**
* An object that can behave like a table (a table-like object).
*
* Instances of this type cannot be created directly, only of its subtypes.
*
* @param The record type
* @author Lukas Eder
*/
public sealed interface TableLike
extends
Fields,
QueryPart
permits
Select,
Table,
Path
{
/**
* Turn this {@link TableLike} expression into a
* {@link DSL#multiset(TableLike)}.
*/
@NotNull
@Support({ H2, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
Field> asMultiset();
/**
* Turn this {@link TableLike} expression into a
* {@link DSL#multiset(TableLike)}.
*/
@NotNull
@Support({ H2, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
Field> asMultiset(String alias);
/**
* Turn this {@link TableLike} expression into a
* {@link DSL#multiset(TableLike)}.
*/
@NotNull
@Support({ H2, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
Field> asMultiset(Name alias);
/**
* Turn this {@link TableLike} expression into a
* {@link DSL#multiset(TableLike)}.
*/
@NotNull
@Support({ H2, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
Field> asMultiset(Field alias);
/**
* The underlying table representation of this object.
*
* This method is useful for things like
* SELECT * FROM (SELECT * FROM x WHERE x.a = '1') WHERE …
*/
@NotNull
@Support
Table asTable();
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(String)
*/
@NotNull
@Support
Table asTable(String alias);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(String, String...)
*/
@NotNull
@Support
Table asTable(String alias, String... fieldAliases);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(String, Collection)
*/
@NotNull
@Support
Table asTable(String alias, Collection fieldAliases);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(Name)
*/
@NotNull
@Support
Table asTable(Name alias);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(Name, Name...)
*/
@NotNull
@Support
Table asTable(Name alias, Name... fieldAliases);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(Name, Collection)
*/
@NotNull
@Support
Table asTable(Name alias, Collection fieldAliases);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(Table)
*/
@NotNull
@Support
Table asTable(Table alias);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(Table, Field...)
*/
@NotNull
@Support
Table asTable(Table alias, Field... fieldAliases);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(Table, Collection)
*/
@NotNull
@Support
Table asTable(Table alias, Collection> fieldAliases);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(String, Function)
* @deprecated - 3.14.0 - [#10156] - These methods will be removed without
* replacement from a future jOOQ. They offer convenience that
* is unidiomatic for jOOQ's DSL, without offering functionality
* that would not be possible otherwise - yet they add
* complexity in jOOQ's internals.
*/
@Deprecated(forRemoval = true, since = "3.14")
@NotNull
@Support
Table asTable(String alias, Function, ? extends String> aliasFunction);
/**
* The underlying aliased table representation of this object.
*
* @see Table#as(String, BiFunction)
* @deprecated - 3.14.0 - [#10156] - These methods will be removed without
* replacement from a future jOOQ. They offer convenience that
* is unidiomatic for jOOQ's DSL, without offering functionality
* that would not be possible otherwise - yet they add
* complexity in jOOQ's internals.
*/
@Deprecated(forRemoval = true, since = "3.14")
@NotNull
@Support
Table asTable(String alias, BiFunction, ? super Integer, ? extends String> aliasFunction);
}