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 and Description
java.util.List<Catalog>	getCatalogs() Get all catalog objects from the underlying DatabaseMetaData.
java.util.List<UniqueKey<?>>	getPrimaryKeys() Get all primary keys from the underlying DatabaseMetaData.
java.util.List<Schema>	getSchemas() Get all schema objects from the underlying DatabaseMetaData.
java.util.List<Sequence<?>>	getSequences() Get all sequence objects from the underlying DatabaseMetaData.
java.util.List<Table<?>>	getTables() Get all table objects from the underlying DatabaseMetaData.

Method Detail

getCatalogs

@Support
java.util.List<Catalog> getCatalogs()
                                       throws DataAccessException

Get all catalog objects from the underlying DatabaseMetaData.

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.

NOTE: Catalogs are experimental in jOOQ 3.0

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSchemas

@Support
java.util.List<Schema> getSchemas()
                                     throws DataAccessException

Get all schema objects from the underlying DatabaseMetaData.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getTables

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

Get all table objects from the underlying DatabaseMetaData.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getSequences

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

Get all sequence objects from the underlying DatabaseMetaData.

Throws:

DataAccessException - If something went wrong fetching the meta objects

getPrimaryKeys

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

Get all primary keys from the underlying DatabaseMetaData.

Throws:

DataAccessException - If something went wrong fetching the meta objects