java.sql.DatabaseMetaData contract. THe intention is to insulate callers
from java.sql.DatabaseMetaData since on many databases there are better ways to get information from
the meta schema.
API Note
Concepts here taken largely from the MetaDataDialect class in Hibernate Tools.
| Modifier and Type | Method and Description |
|---|---|
| public boolean | Returns: true if the catalog does exist; false otherwiseThe name of the catalog to look for. catalog)Does the given catalog exist yet? |
| public Iterable | Returns: The extracted foreign-key informationThe table for which to locate foreign-keys tableInformation)Extract information about foreign keys defined on the given table (targeting or point-at other tables). |
| public Iterable | Returns: The extracted index informationThe table for which to locate indexes tableInformation)Extract information about indexes defined against the given table. |
| public PrimaryKeyInformation | Returns: The extracted primary key informationThe table for which to locate primary key information, tableInformation)Extract information about the given table's primary key. |
| public TableInformation | Returns: table info for the matching tableCan be catalog, Identifier null, indicating that any catalog may be considered a match. A
non-null value indicates that search should be limited to the passed catalog.Can be schema, Identifier null, indicating that any schema may be considered a match. A
non-null value indicates that search should be limited to the passed schema .The name of the table to look for. tableName)Look for a matching table. |
| public NameSpaceTablesInformation | Returns: aNameSpaceTablesInformationCan be catalog, Identifier null, indicating that any catalog may be considered a match. A
non-null value indicates that search should be limited to the passed catalog.Can be schema)null, indicating that any schema may be considered a match. A
non-null value indicates that search should be limited to the passed schema .Extract all the tables information. |
| public boolean | Returns: true if the schema does exist; false otherwiseThe name of the catalog to look in. catalog, Identifier The name of the schema to look for. schema)Does the given schema exist yet? |
| catalogExists | back to summary |
|---|---|
| public boolean catalogExists(Identifier catalog) Does the given catalog exist yet?
| |
| getForeignKeys | back to summary |
|---|---|
| public Iterable Extract information about foreign keys defined on the given table (targeting or point-at other tables). Typically called from the TableInformation itself as part of on-demand initialization of its state.
| |
| getIndexes | back to summary |
|---|---|
| public Iterable Extract information about indexes defined against the given table. Typically called from the TableInformation itself as part of on-demand initialization of its state.
| |
| getPrimaryKey | back to summary |
|---|---|
| public PrimaryKeyInformation getPrimaryKey(TableInformationImpl tableInformation) Extract information about the given table's primary key.
| |
| getTable | back to summary |
|---|---|
| public TableInformation getTable(Identifier catalog, Identifier schema, Identifier tableName) Look for a matching table.
| |
| getTables | back to summary |
|---|---|
| public NameSpaceTablesInformation getTables(Identifier catalog, Identifier schema) Extract all the tables information.
| |
| schemaExists | back to summary |
|---|---|
| public boolean schemaExists(Identifier catalog, Identifier schema) Does the given schema exist yet?
| |