org.eclipse.jpt.jpa.db
Interface Database

All Superinterfaces:

DatabaseObject, SchemaContainer

public interface Database
extends SchemaContainer

Database

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.db.DatabaseObject

DatabaseObject.DefaultComparator, DatabaseObject.IdentifierTransformer, DatabaseObject.NameTransformer

Field Summary

Fields inherited from interface org.eclipse.jpt.jpa.db.DatabaseObject

DEFAULT_COMPARATOR, IDENTIFIER_TRANSFORMER, NAME_TRANSFORMER

Method Summary

String	convertNameToIdentifier(String name) Convert the specified name to a database-appropriate SQL identifier (i.e. delimit the name as appropriate).
Catalog	getCatalogForIdentifier(String identifier) Return the catalog for the specified identifier.
Catalog	getCatalogNamed(String name) Return the catalog with the specified name.
Iterable<Catalog>	getCatalogs() Return the database's catalogs.
int	getCatalogsSize() Return the number of catalogs the database contains.
Catalog	getDefaultCatalog() Return the database's default catalog, as defined by the database vendor.
String	getDefaultCatalogIdentifier() Return the database's default catalog identifier.
org.eclipse.datatools.modelbase.sql.schema.Database	getDTPDatabase() Return the database's DTP database.
Iterable<String>	getSortedCatalogIdentifiers() Return the database's catalog identifiers, sorted by name.
Iterable<String>	getSortedCatalogNames() Return the database's catalog names, sorted.
String	getVendorName() Return the name of the database's vendor.
String	getVersion() Return the database's version.
Table	selectTableForIdentifier(Iterable<Table> tables, String identifier) Select and return from the specified list of tables the table identified by the specified identifier.
boolean	supportsCatalogs() Return whether the database supports catalogs.

Methods inherited from interface org.eclipse.jpt.jpa.db.SchemaContainer

getDefaultSchema, getDefaultSchemaIdentifier, getSchemaForIdentifier, getSchemaNamed, getSchemata, getSchemataSize, getSortedSchemaIdentifiers, getSortedSchemaNames

Methods inherited from interface org.eclipse.jpt.jpa.db.DatabaseObject

getConnectionProfile, getDatabase, getIdentifier, getIdentifier, getName, refresh

Method Detail

getDTPDatabase

org.eclipse.datatools.modelbase.sql.schema.Database getDTPDatabase()

Return the database's DTP database.

getVendorName

String getVendorName()

Return the name of the database's vendor.

getVersion

String getVersion()

Return the database's version.

supportsCatalogs

boolean supportsCatalogs()

Return whether the database supports catalogs. If it does, all database objects are contained by the database's catalogs; otherwise all database objects are contained by the database's schemata.
Practically speaking:

• If supportsCatalogs() returns true
  • getCatalogs() returns catalogs that contain the database's schemata
  • SchemaContainer.getSchemata() returns an empty iterable
• else
  • getCatalogs() returns an empty iterable
  • SchemaContainer.getSchemata() returns the database's schemata

This is complicated by the presence of a "default" catalog that clients can use to allow the specification of a catalog to be optional; but clients must manage this explicitly.

See Also:

getCatalogs(), SchemaContainer.getSchemata()

getCatalogs

Iterable<Catalog> getCatalogs()

Return the database's catalogs. Return an empty iterable if the database does not support catalogs.

See Also:

supportsCatalogs()

getCatalogsSize

int getCatalogsSize()

Return the number of catalogs the database contains. Return zero if the database does not support catalogs.

See Also:

supportsCatalogs()

getSortedCatalogNames

Iterable<String> getSortedCatalogNames()

Return the database's catalog names, sorted. Return an empty iterable if the database does not support catalogs. This is useful when the user is selecting a catalog from a read-only combo-box (e.g. in a wizard).

See Also:

getSortedCatalogIdentifiers(), getCatalogNamed(String)

getCatalogNamed

Catalog getCatalogNamed(String name)

Return the catalog with the specified name. The name must be an exact match of the catalog's name. Return null if the database does not support catalogs.

See Also:

supportsCatalogs(), getSortedCatalogNames(), getCatalogForIdentifier(String)

getSortedCatalogIdentifiers

Iterable<String> getSortedCatalogIdentifiers()

Return the database's catalog identifiers, sorted by name. Return an empty iterable if the database does not support catalogs. This is useful when the user is selecting an identifier that will be placed in a text file (e.g. in a Java annotation).

See Also:

getSortedCatalogNames(), getCatalogForIdentifier(String)

getCatalogForIdentifier

Catalog getCatalogForIdentifier(String identifier)

Return the catalog for the specified identifier. The identifier should be an SQL identifier (i.e. quoted when case-sensitive or containing special characters, unquoted otherwise). Return null if the database does not support catalogs.

See Also:

supportsCatalogs(), getSortedCatalogIdentifiers(), getCatalogNamed(String)

getDefaultCatalog

Catalog getDefaultCatalog()

Return the database's default catalog, as defined by the database vendor. In most cases the default catalog's name will match the user name. Return null if the database does not support catalogs or if the default catalog does not exist (e.g. the database has no catalog whose name matches the user name).

See Also:

supportsCatalogs(), getDefaultCatalogIdentifier()

getDefaultCatalogIdentifier

String getDefaultCatalogIdentifier()

Return the database's default catalog identifier. The database may or may not have a catalog with a matching name.

See Also:

supportsCatalogs(), getDefaultCatalog()

selectTableForIdentifier

Table selectTableForIdentifier(Iterable<Table> tables,
                               String identifier)

Select and return from the specified list of tables the table identified by the specified identifier. The identifier should be an SQL identifier (i.e. delimited as appropriate).

convertNameToIdentifier

String convertNameToIdentifier(String name)

Convert the specified name to a database-appropriate SQL identifier (i.e. delimit the name as appropriate).