Module io.github.mmm.orm

Package io.github.mmm.orm.metadata

Interface DbMetaData

public interface DbMetaData

Meta-information about the database (DDL).

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
DbName	getCurrentCatalog()
DbName	getCurrentSchema()
DbTable	getTable(DbName name)
DbTable	getTable(DbQualifiedName name)
DbTable	getTable(DbTableData tableData)
default Iterable<DbTableData>	getTables()
Iterable<DbTableData>	getTables(String name)
Iterable<DbTableData>	getTables(String catalog, String schema, String name)

Method Details

getTables

default Iterable<DbTableData> getTables()

Returns:

an Iterable with the DbTableData of all tables in the current catalog/schema.

getTables

Iterable<DbTableData> getTables(String name)

Parameters:

name - the name or name-pattern of the tables.

Returns:

an Iterable with the DbTableData of the matching tables in the current catalog/schema.

getTables

Iterable<DbTableData> getTables(String catalog,
 String schema,
 String name)

Parameters:

catalog - the catalog. May be null.

schema - the schema. May be null.

name - the name or name-pattern of the tables.

Returns:

an Iterable with the DbTableData of the matching tables.

getTable

DbTable getTable(DbQualifiedName name)

Parameters:

name - the qualified table name.

Returns:

the DbTable with the given name or null if no such table exists.

getTable

DbTable getTable(DbName name)

Parameters:

name - the qualified table name.

Returns:

the DbTable with the given name or null if no such table exists.

getTable

DbTable getTable(DbTableData tableData)

Parameters:

tableData - the DbTableData (from getTables(String, String, String)).

Returns:

the DbTable populated with additional information.

getCurrentCatalog

DbName getCurrentCatalog()

Returns:

the current catalog.

getCurrentSchema

DbName getCurrentSchema()

Returns:

the current schema.