Package org.jooq
Interface Meta
-
public interface Meta
A wrapping object forDatabaseMetaData
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:- To increase API convenience, as no checked
SQLException
is thrown, only the uncheckedDataAccessException
- 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
- To increase API convenience, as no checked
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Catalog
getCatalog(java.lang.String name)
Get a catalog object by name from the underlying meta data source, ornull
if no such object exists.Catalog
getCatalog(Name name)
Get a catalog object by name from the underlying meta data source, ornull
if no such object exists.java.util.List<Catalog>
getCatalogs()
Get all catalog objects from the underlying meta data source.java.util.List<UniqueKey<?>>
getPrimaryKeys()
Get all primary keys from the underlying meta data source.java.util.List<Schema>
getSchemas()
Get all schema objects from the underlying meta data source.java.util.List<Schema>
getSchemas(java.lang.String name)
Get all schema objects by name from the underlying meta data source.java.util.List<Schema>
getSchemas(Name name)
Get all schema objects by name from the underlying meta data source.java.util.List<Sequence<?>>
getSequences()
Get all sequence objects from the underlying meta data source.java.util.List<Sequence<?>>
getSequences(java.lang.String name)
Get all sequence objects by name from the underlying meta data source.java.util.List<Sequence<?>>
getSequences(Name name)
Get all sequence objects by name from the underlying meta data source.java.util.List<Table<?>>
getTables()
Get all table objects from the underlying meta data source.java.util.List<Table<?>>
getTables(java.lang.String name)
Get all table objects by name from the underlying meta data source.java.util.List<Table<?>>
getTables(Name name)
Get all table objects by name from the underlying meta data source.
-
-
-
Method Detail
-
getCatalogs
@Support java.util.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(java.lang.String name) throws DataAccessException
Get a catalog object by name from the underlying meta data source, ornull
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, ornull
if no such object exists.- 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 meta data source.- Throws:
DataAccessException
- If something went wrong fetching the meta objects
-
getSchemas
@Support java.util.List<Schema> getSchemas(java.lang.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 java.util.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 java.util.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 java.util.List<Table<?>> getTables(java.lang.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 java.util.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}) java.util.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}) java.util.List<Sequence<?>> getSequences(java.lang.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}) java.util.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 java.util.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
-
-