Module org.jooq

Package org.jooq.impl

Class SchemaImpl

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 schemata

This 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

Modifier and Type	Method	Description
void	accept(Context<?> ctx)	This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
void	bind(BindContext context)	Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
Clause[]	clauses(Context<?> ctx)	The Clauses that are represented by this query part.
protected DSLContext	create()	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
protected DSLContext	create(Configuration configuration)	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
protected DSLContext	create(Context<?> ctx)	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
boolean	declaresCTE()	Subclasses may override this
boolean	declaresFields()	Subclasses may override this
boolean	declaresTables()	Subclasses may override this
boolean	declaresWindows()	Subclasses may override this
Stream<Domain<?>>	domainStream()	Stream all domains contained in this schema.
boolean	equals(Object that)	Check whether this QueryPart can be considered equal to another QueryPart.
boolean	generatesCast()	Subclasses may override this
Catalog	getCatalog()	The catalog of this schema.
String	getComment()	The comment on this object.
Comment	getCommentPart()	The comment on this object as a QueryPart.
Domain<?>	getDomain(String name)	Get a domain by its name (case-sensitive) in this schema, or null if no such domain exists.
Domain<?>	getDomain(Name name)	Get a domain by its qualified or unqualified name in this schema, or null if no such domain exists.
List<Domain<?>>	getDomains()	List all domains contained in this schema.
String	getName()	The unqualified name of this object.
Name	getQualifiedName()	The qualified name of this object.
Sequence<?>	getSequence(String name)	Get a sequence by its name (case-sensitive) in this schema, or null if no such sequence exists.
Sequence<?>	getSequence(Name name)	Get a sequence by its qualified or unqualified name in this schema, or null if no such sequence exists.
List<Sequence<?>>	getSequences()	List all sequences contained in this schema.
Table<?>	getTable(String name)	Get a table by its name (case-sensitive) in this schema, or null if no such table exists.
Table<?>	getTable(Name name)	Get a table by its qualified or unqualified name in this schema, or null if no such table exists.
List<Table<?>>	getTables()	List all tables contained in this schema.
UDT<?>	getUDT(String name)	Get a UDT by its name (case-sensitive) in this schema, or null if no such UDT exists.
UDT<?>	getUDT(Name name)	Get a UDT by its qualified or unqualified name in this schema, or null if no such UDT exists.
List<UDT<?>>	getUDTs()	List all UDTs contained in this schema.
Name	getUnqualifiedName()	The unqualified name of this object.
int	hashCode()	Generate a hash code from this QueryPart.
boolean	rendersContent(Context<?> ctx)	Subclasses may override this
Stream<Sequence<?>>	sequenceStream()	Stream all sequences contained in this schema.
Stream<Table<?>>	tableStream()	Stream all tables contained in this schema.
void	toSQL(RenderContext context)	Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
String	toString()	Render a SQL string representation of this QueryPart.
protected DataAccessException	translate(String sql, SQLException e)	Internal convenience method
Stream<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, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

hashCode, toString

Constructor Detail

SchemaImpl

public SchemaImpl(String name)

SchemaImpl

public SchemaImpl(String name,
                  Catalog catalog)

SchemaImpl

public SchemaImpl(String name,
                  Catalog catalog,
                  String comment)

SchemaImpl

public SchemaImpl(Name name)

SchemaImpl

public SchemaImpl(Name name,
                  Catalog catalog)

SchemaImpl

public SchemaImpl(Name name,
                  Catalog catalog,
                  Comment comment)

Method Detail

getCatalog

public Catalog getCatalog()

Description copied from interface: Schema

The catalog of this schema.

Specified by:

getCatalog in interface Schema

accept

public final void accept(Context<?> ctx)

Description copied from interface: QueryPartInternal

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.

Specified by:

accept in interface QueryPartInternal

clauses

public final Clause[] clauses(Context<?> ctx)

Description copied from interface: QueryPartInternal

The Clauses that are represented by this query part.

QueryParts can specify several Clauses for which an event will be emitted before (in forward order) and after (in reverse order) visiting the the query part through Context.visit(QueryPart)

This method is for JOOQ INTERNAL USE only. Do not reference directly

Specified by:

clauses in interface QueryPartInternal

Returns:

The Clauses represented by this query part or null or an empty array if this query part does not represent a clause.

getTable

public final Table<?> getTable(String name)

Description copied from interface: Schema

Get a table by its name (case-sensitive) in this schema, or null if no such table exists.

Specified by:

getTable in interface Schema

getTable

public final Table<?> getTable(Name name)

Description copied from interface: Schema

Get a table by its qualified or unqualified name in this schema, or null if no such table exists.

Specified by:

getTable in interface Schema

getUDT

public final UDT<?> getUDT(String name)

Description copied from interface: Schema

Get a UDT by its name (case-sensitive) in this schema, or null if no such UDT exists.

Specified by:

getUDT in interface Schema

getUDT

public final UDT<?> getUDT(Name name)

Description copied from interface: Schema

Get a UDT by its qualified or unqualified name in this schema, or null if no such UDT exists.

Specified by:

getUDT in interface Schema

getDomain

public final Domain<?> getDomain(String name)

Description copied from interface: Schema

Get a domain by its name (case-sensitive) in this schema, or null if no such domain exists.

Specified by:

getDomain in interface Schema

getDomain

public final Domain<?> getDomain(Name name)

Description copied from interface: Schema

Get a domain by its qualified or unqualified name in this schema, or null if no such domain exists.

Specified by:

getDomain in interface Schema

getSequence

public final Sequence<?> getSequence(String name)

Description copied from interface: Schema

Get a sequence by its name (case-sensitive) in this schema, or null if no such sequence exists.

Specified by:

getSequence in interface Schema

getSequence

public final Sequence<?> getSequence(Name name)

Description copied from interface: Schema

Get a sequence by its qualified or unqualified name in this schema, or null if no such sequence exists.

Specified by:

getSequence in interface Schema

getTables

public List<Table<?>> getTables()

List all tables contained in this schema.

Subclasses should override this method

Specified by:

getTables in interface Schema

getUDTs

public List<UDT<?>> getUDTs()

List all UDTs contained in this schema.

Subclasses should override this method

Specified by:

getUDTs in interface Schema

getDomains

public List<Domain<?>> getDomains()

List all domains contained in this schema.

Subclasses should override this method

Specified by:

getDomains in interface Schema

getSequences

public List<Sequence<?>> getSequences()

List all sequences contained in this schema.

Subclasses should override this method

Specified by:

getSequences in interface Schema

tableStream

public final Stream<Table<?>> tableStream()

Description copied from interface: Schema

Stream all tables contained in this schema.

Specified by:

tableStream in interface Schema

udtStream

public final Stream<UDT<?>> udtStream()

Description copied from interface: Schema

Stream all UDTs contained in this schema.

Specified by:

udtStream in interface Schema

domainStream

public final Stream<Domain<?>> domainStream()

Description copied from interface: Schema

Stream all domains contained in this schema.

Specified by:

domainStream in interface Schema

sequenceStream

public final Stream<Sequence<?>> sequenceStream()

Description copied from interface: Schema

Stream all sequences contained in this schema.

Specified by:

sequenceStream in interface Schema

equals

public boolean equals(Object that)

Description copied from interface: QueryPart

Check whether this QueryPart can be considered equal to another QueryPart.

In general, QueryPart equality is defined in terms of QueryPart.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 QueryPart implementations may choose to override this behaviour for improved performance, as QueryPart.toString() is an expensive operation, if called many times.

Specified by:

equals in interface QueryPart

Parameters:

that - The other QueryPart

Returns:

Whether the two query parts are equal

getName

public final String getName()

Description copied from interface: Named

The unqualified name of this object.

Specified by:

getName in interface Named

getQualifiedName

public Name getQualifiedName()

Description copied from interface: Named

The qualified name of this object.

Specified by:

getQualifiedName in interface Named

getUnqualifiedName

public final Name getUnqualifiedName()

Description copied from interface: Named

The unqualified name of this object.

Specified by:

getUnqualifiedName in interface Named

getComment

public final String getComment()

Description copied from interface: Named

The comment on this object.

This is the same as calling Named.getCommentPart() and then Comment.getComment().

Specified by:

getComment in interface Named

getCommentPart

public final Comment getCommentPart()

Description copied from interface: Named

The comment on this object as a QueryPart.

Specified by:

getCommentPart in interface Named

hashCode

public int hashCode()

Description copied from interface: QueryPart

Generate a hash code from this QueryPart.

In general, QueryPart hash codes are the same as the hash codes generated from QueryPart.toString(). This guarantees consistent behaviour with QueryPart.equals(Object)

Some QueryPart implementations may choose to override this behaviour for improved performance, as QueryPart.toString() is an expensive operation, if called many times.

Specified by:

hashCode in interface QueryPart

Returns:

The QueryPart hash code

toSQL

@Deprecated
public final void toSQL(RenderContext context)

Deprecated.

- 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.

Description copied from interface: QueryPartInternal

Render this QueryPart to a SQL string contained in context.sql(). The context will contain additional information about how to render this QueryPart, e.g. whether this QueryPart should be rendered as a declaration or reference, whether this QueryPart's contained bind variables should be inlined or replaced by '?', etc.

Specified by:

toSQL in interface QueryPartInternal

bind

@Deprecated
public final void bind(BindContext context)
                throws DataAccessException

Deprecated.

- 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.

Description copied from interface: QueryPartInternal

Bind all parameters of this QueryPart to a PreparedStatement

This method is for JOOQ INTERNAL USE only. Do not reference directly

Specified by:

bind in interface QueryPartInternal

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

rendersContent

public boolean rendersContent(Context<?> ctx)

Subclasses may override this

Specified by:

rendersContent in interface QueryPartInternal

declaresFields

public boolean declaresFields()

Subclasses may override this

Specified by:

declaresFields in interface QueryPartInternal

declaresTables

public boolean declaresTables()

Subclasses may override this

Specified by:

declaresTables in interface QueryPartInternal

declaresWindows

public boolean declaresWindows()

Subclasses may override this

Specified by:

declaresWindows in interface QueryPartInternal

declaresCTE

public boolean declaresCTE()

Subclasses may override this

Specified by:

declaresCTE in interface QueryPartInternal

generatesCast

public boolean generatesCast()

Subclasses may override this

Specified by:

generatesCast in interface QueryPartInternal

toString

public String toString()

Description copied from interface: QueryPart

Render a SQL string representation of this QueryPart.

For improved debugging, this renders a SQL string of this QueryPart with inlined bind variables. If this QueryPart is Attachable, then the attached Configuration may be used for rendering the SQL string, including SQLDialect and Settings. Do note that most QueryPart instances are not attached to a Configuration, and thus there is no guarantee that the SQL string will make sense in the context of a specific database.

Specified by:

toString in interface QueryPart

Overrides:

toString in class Object

Returns:

A SQL string representation of this QueryPart

create

@Deprecated
protected final DSLContext create()

Deprecated.

- 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.

Internal convenience method

create

@Deprecated
protected final DSLContext create(Configuration configuration)

Deprecated.

- 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.

Internal convenience method

create

@Deprecated
protected final DSLContext create(Context<?> ctx)

Deprecated.

- 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.

Internal convenience method

translate

protected final DataAccessException translate(String sql,
                                              SQLException e)

Internal convenience method