Module org.jooq

Package org.jooq

Interface Meta

public interface Meta

A wrapping object for DatabaseMetaData or for other sources of database meta information (e.g. InformationSchema)

This object can be obtained through DSLContext.meta() in order to provide convenient access to your database meta data. This abstraction has two purposes:

1. To increase API convenience, as no checked SQLException is thrown, only the unchecked DataAccessException
2. To increase API convenience, as the returned objects are always jOOQ objects, not JDBC ResultSet objects with hard-to-remember API constraints

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
Catalog	getCatalog(String name)	Get a catalog object by name from the underlying meta data source, or null if no such object exists.
Catalog	getCatalog(Name name)	Get a catalog object by name from the underlying meta data source, or null if no such object exists.
List<Catalog>	getCatalogs()	Get all catalog objects from the underlying meta data source.
List<UniqueKey<?>>	getPrimaryKeys()	Get all primary keys from the underlying meta data source.
List<Schema>	getSchemas()	Get all schema objects from the underlying meta data source.
List<Schema>	getSchemas(String name)	Get all schema objects by name from the underlying meta data source.
List<Schema>	getSchemas(Name name)	Get all schema objects by name from the underlying meta data source.
List<Sequence<?>>	getSequences()	Get all sequence objects from the underlying meta data source.
List<Sequence<?>>	getSequences(String name)	Get all sequence objects by name from the underlying meta data source.
List<Sequence<?>>	getSequences(Name name)	Get all sequence objects by name from the underlying meta data source.
List<Table<?>>	getTables()	Get all table objects from the underlying meta data source.
List<Table<?>>	getTables(String name)	Get all table objects by name from the underlying meta data source.
List<Table<?>>	getTables(Name name)	Get all table objects by name from the underlying meta data source.

Method Detail

getCatalogs

@Support
List<Catalog> getCatalogs()
                   throws DataAccessException

Get all catalog objects from the underlying meta data source.

For those databases that don't really support JDBC meta data catalogs, a single empty catalog (named "") will be returned. In other words, there is always at least one catalog in a database.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getCatalog

@Support
Catalog getCatalog(String name)
            throws DataAccessException

Get a catalog object by name from the underlying meta data source, or null if no such object exists.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getCatalog

@Support
Catalog getCatalog(Name name)
            throws DataAccessException

Get a catalog object by name from the underlying meta data source, or null if no such object exists.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSchemas

@Support
List<Schema> getSchemas()
                 throws DataAccessException

Get all schema objects from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSchemas

@Support
List<Schema> getSchemas(String name)
                 throws DataAccessException

Get all schema objects by name from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSchemas

@Support
List<Schema> getSchemas(Name name)
                 throws DataAccessException

Get all schema objects by name from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getTables

@Support
List<Table<?>> getTables()
                  throws DataAccessException

Get all table objects from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getTables

@Support
List<Table<?>> getTables(String name)
                  throws DataAccessException

Get all table objects by name from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getTables

@Support
List<Table<?>> getTables(Name name)
                  throws DataAccessException

Get all table objects by name from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSequences

@Support({AURORA_POSTGRES,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,ORACLE,POSTGRES,SQLSERVER2012,SYBASE})
List<Sequence<?>> getSequences()
                        throws DataAccessException

Get all sequence objects from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSequences

@Support({AURORA_POSTGRES,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,ORACLE,POSTGRES,SQLSERVER2012,SYBASE})
List<Sequence<?>> getSequences(String name)
                        throws DataAccessException

Get all sequence objects by name from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSequences

@Support({AURORA_POSTGRES,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,ORACLE,POSTGRES,SQLSERVER2012,SYBASE})
List<Sequence<?>> getSequences(Name name)
                        throws DataAccessException

Get all sequence objects by name from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getPrimaryKeys

@Support
List<UniqueKey<?>> getPrimaryKeys()
                           throws DataAccessException

Get all primary keys from the underlying meta data source.

Throws:

DataAccessException - If something went wrong fetching the meta objects