- java.lang.Object
-
- org.jooq.impl.SchemaImpl
-
- All Implemented Interfaces:
Serializable,Named,QueryPart,QueryPartInternal,Schema
@Internal public class SchemaImpl extends Object implements Schema
A common base class for database schemataThis type is for JOOQ INTERNAL USE only. Do not reference directly
- Author:
- Lukas Eder
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SchemaImpl(String name)SchemaImpl(String name, Catalog catalog)SchemaImpl(String name, Catalog catalog, String comment)SchemaImpl(Name name)SchemaImpl(Name name, Catalog catalog)SchemaImpl(Name name, Catalog catalog, Comment comment)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaccept(Context<?> ctx)voidbind(BindContext context)Deprecated.- 3.4.0 - [#2694] - UseQueryPartInternal.accept(Context)instead.Clause[]clauses(Context<?> ctx)TheClauses that are represented by this query part.protected DSLContextcreate()Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.protected DSLContextcreate(Configuration configuration)Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.protected DSLContextcreate(Context<?> ctx)Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.booleandeclaresCTE()Subclasses may override thisbooleandeclaresFields()Subclasses may override thisbooleandeclaresTables()Subclasses may override thisbooleandeclaresWindows()Subclasses may override thisbooleanequals(Object that)Check whether thisQueryPartcan be considered equal to anotherQueryPart.booleangeneratesCast()Subclasses may override thisCataloggetCatalog()The catalog of this schema.StringgetComment()The comment on this object.StringgetName()The unqualified name of this object.NamegetQualifiedName()The qualified name of this object.Sequence<?>getSequence(String sequenceName)Get a sequence by its name (case-sensitive) in this schema, ornullif no such sequence exists.List<Sequence<?>>getSequences()List all sequences contained in this schema.Table<?>getTable(String tableName)Get a table by its name (case-sensitive) in this schema, ornullif no such table exists.List<Table<?>>getTables()List all tables contained in this schema.UDT<?>getUDT(String udtName)Get a UDT by its name (case-sensitive) in this schema, ornullif no such UDT exists.List<UDT<?>>getUDTs()List all UDTs contained in this schema.NamegetUnqualifiedName()The unqualified name of this object.inthashCode()Generate a hash code from thisQueryPart.Stream<Sequence<?>>sequenceStream()Stream all sequences contained in this schema.Stream<Table<?>>tableStream()Stream all tables contained in this schema.voidtoSQL(RenderContext context)Deprecated.- 3.4.0 - [#2694] - UseQueryPartInternal.accept(Context)instead.StringtoString()Render a SQL string representation of thisQueryPart.protected DataAccessExceptiontranslate(String sql, SQLException e)Internal convenience methodStream<UDT<?>>udtStream()Stream all UDTs contained in this schema.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.jooq.Named
getComment, getName, getQualifiedName, getUnqualifiedName
-
-
-
-
Method Detail
-
getCatalog
public Catalog getCatalog()
Description copied from interface:SchemaThe catalog of this schema.- Specified by:
getCatalogin interfaceSchema
-
accept
public final void accept(Context<?> ctx)
Description copied from interface:QueryPartInternalThisQueryPartcanacceptaContextobject in order to render a SQL string or to bind its variables.- Specified by:
acceptin interfaceQueryPartInternal
-
clauses
public final Clause[] clauses(Context<?> ctx)
Description copied from interface:QueryPartInternalTheClauses that are represented by this query part.QueryParts can specify severalClauses for which an event will be emittedbefore(in forward order) andafter(in reverse order) visiting the the query part throughContext.visit(QueryPart)This method is for JOOQ INTERNAL USE only. Do not reference directly
- Specified by:
clausesin interfaceQueryPartInternal- Returns:
- The
Clauses represented by this query part ornullor an empty array if this query part does not represent a clause.
-
getTable
public final Table<?> getTable(String tableName)
Description copied from interface:SchemaGet a table by its name (case-sensitive) in this schema, ornullif no such table exists.
-
getUDT
public final UDT<?> getUDT(String udtName)
Description copied from interface:SchemaGet a UDT by its name (case-sensitive) in this schema, ornullif no such UDT exists.
-
getSequence
public final Sequence<?> getSequence(String sequenceName)
Description copied from interface:SchemaGet a sequence by its name (case-sensitive) in this schema, ornullif no such sequence exists.- Specified by:
getSequencein interfaceSchema
-
getTables
public List<Table<?>> getTables()
List all tables contained in this schema.Subclasses should override this method
-
getUDTs
public List<UDT<?>> getUDTs()
List all UDTs contained in this schema.Subclasses should override this method
-
getSequences
public List<Sequence<?>> getSequences()
List all sequences contained in this schema.Subclasses should override this method
- Specified by:
getSequencesin interfaceSchema
-
tableStream
public final Stream<Table<?>> tableStream()
Description copied from interface:SchemaStream all tables contained in this schema.- Specified by:
tableStreamin interfaceSchema
-
udtStream
public final Stream<UDT<?>> udtStream()
Description copied from interface:SchemaStream all UDTs contained in this schema.
-
sequenceStream
public final Stream<Sequence<?>> sequenceStream()
Description copied from interface:SchemaStream all sequences contained in this schema.- Specified by:
sequenceStreamin interfaceSchema
-
getName
public final String getName()
Description copied from interface:NamedThe unqualified name of this object.
-
getQualifiedName
public Name getQualifiedName()
Description copied from interface:NamedThe qualified name of this object.- Specified by:
getQualifiedNamein interfaceNamed
-
getUnqualifiedName
public final Name getUnqualifiedName()
Description copied from interface:NamedThe unqualified name of this object.- Specified by:
getUnqualifiedNamein interfaceNamed
-
getComment
public final String getComment()
Description copied from interface:NamedThe comment on this object.- Specified by:
getCommentin interfaceNamed
-
hashCode
public int hashCode()
Description copied from interface:QueryPartGenerate a hash code from thisQueryPart.In general,
QueryParthash codes are the same as the hash codes generated fromQueryPart.toString(). This guarantees consistent behaviour withQueryPart.equals(Object)Some
QueryPartimplementations may choose to override this behaviour for improved performance, asQueryPart.toString()is an expensive operation, if called many times.
-
equals
public boolean equals(Object that)
Description copied from interface:QueryPartCheck whether thisQueryPartcan be considered equal to anotherQueryPart.In general,
QueryPartequality is defined in terms ofQueryPart.toString()equality. In other words, two query parts are considered equal if their rendered SQL (with inlined bind variables) is equal. This means that the two query parts do not necessarily have to be of the same type.Some
QueryPartimplementations may choose to override this behaviour for improved performance, asQueryPart.toString()is an expensive operation, if called many times.
-
toSQL
@Deprecated public final void toSQL(RenderContext context)
Deprecated.- 3.4.0 - [#2694] - UseQueryPartInternal.accept(Context)instead.Description copied from interface:QueryPartInternalRender thisQueryPartto a SQL string contained incontext.sql(). Thecontextwill contain additional information about how to render thisQueryPart, e.g. whether thisQueryPartshould be rendered as a declaration or reference, whether thisQueryPart's contained bind variables should be inlined or replaced by'?', etc.- Specified by:
toSQLin interfaceQueryPartInternal
-
bind
@Deprecated public final void bind(BindContext context) throws DataAccessException
Deprecated.- 3.4.0 - [#2694] - UseQueryPartInternal.accept(Context)instead.Description copied from interface:QueryPartInternalBind all parameters of thisQueryPartto a PreparedStatementThis method is for JOOQ INTERNAL USE only. Do not reference directly
- Specified by:
bindin interfaceQueryPartInternal- Parameters:
context- The context holding the next bind index and other information for variable binding- Throws:
DataAccessException- If something went wrong while binding a variable
-
declaresFields
public boolean declaresFields()
Subclasses may override this- Specified by:
declaresFieldsin interfaceQueryPartInternal
-
declaresTables
public boolean declaresTables()
Subclasses may override this- Specified by:
declaresTablesin interfaceQueryPartInternal
-
declaresWindows
public boolean declaresWindows()
Subclasses may override this- Specified by:
declaresWindowsin interfaceQueryPartInternal
-
declaresCTE
public boolean declaresCTE()
Subclasses may override this- Specified by:
declaresCTEin interfaceQueryPartInternal
-
generatesCast
public boolean generatesCast()
Subclasses may override this- Specified by:
generatesCastin interfaceQueryPartInternal
-
toString
public String toString()
Description copied from interface:QueryPartRender a SQL string representation of thisQueryPart.For improved debugging, this renders a SQL string of this
QueryPartwith inlined bind variables. If thisQueryPartisAttachable, then the attachedConfigurationmay be used for rendering the SQL string, includingSQLDialectandSettings. Do note that mostQueryPartinstances are not attached to aConfiguration, and thus there is no guarantee that the SQL string will make sense in the context of a specific database.
-
create
@Deprecated protected final DSLContext create()
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.Internal convenience method
-
create
@Deprecated protected final DSLContext create(Configuration configuration)
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.Internal convenience method
-
create
@Deprecated protected final DSLContext create(Context<?> ctx)
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.Internal convenience method
-
translate
protected final DataAccessException translate(String sql, SQLException e)
Internal convenience method
-
-