-
- All Superinterfaces:
Named
,QueryPart
,Serializable
- All Known Implementing Classes:
CatalogImpl
,LazyCatalog
public interface Catalog extends Named
A catalog.Standard SQL object identifiers come in 3 parts:
[catalog].[schema].[object]
. The catalog is an object that groups a set ofSchema
instances, which again group a set of objects, where objects can beTable
,Sequence
,Routine
and many other types of objects.If your RDBMS supports catalogs, and jOOQ supports using catalogs with your RDBMS, then generated catalog references can be used to fully qualify objects
Example:
// Assuming import static org.jooq.impl.DSL.*; using(configuration) .select(CATALOG.SCHEMA.ACTOR.FIRST_NAME, CATALOG.SCHEMA.ACTOR.LAST_NAME) .from(CATALOG.SCHEMA.ACTOR) .fetch();
Compatibility:
jOOQ supports catalogs in
SQLDialect.SQLSERVER
and related dialects, such asSQLDialect.SQLDATAWAREHOUSE
. Database products likeSQLDialect.MYSQL
and related dialects, such asSQLDialect.MARIADB
use catalogs ("databases") instead of schemas, and lack schema support. For historic reasons, jOOQ treats MySQL catalogs as schemas and does not support any catalog qualifier in MySQL.Instances can be created using
DSL.catalog(Name)
and overloads.- Author:
- Lukas Eder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable Schema
getSchema(String name)
Get a schema by its name (case-sensitive) in this catalog, ornull
if no such schema exists.@Nullable Schema
getSchema(Name name)
Get a schema by its qualified or unqualified name in this catalog, ornull
if no such schema exists.@NotNull List<Schema>
getSchemas()
List all schemas contained in this catalog.@NotNull Stream<Schema>
schemaStream()
Stream all schemas contained in this catalog.-
Methods inherited from interface org.jooq.Named
getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName
-
-
-
-
Method Detail
-
getSchema
@Nullable @Nullable Schema getSchema(String name)
Get a schema by its name (case-sensitive) in this catalog, ornull
if no such schema exists.
-
getSchema
@Nullable @Nullable Schema getSchema(Name name)
Get a schema by its qualified or unqualified name in this catalog, ornull
if no such schema exists.
-
-