Top Description Methods
org.hibernate.tool.schema.extract.spi

public Interface DatabaseInformation

Known Direct Implementers
org.hibernate.tool.schema.extract.internal.DatabaseInformationImpl
Annotations
@Incubating
Imports
org.hibernate.Incubating, org.hibernate.boot.model.naming.Identifier, org.hibernate.boot.model.relational.Namespace, .QualifiedSequenceName, .QualifiedTableName
Provides access to information about existing schema objects (tables, sequences etc) of existing database.
Authors
Christoph Sturm, Teodor Danciu, Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true indicates a catalog with the given name already exists
catalogExists(Identifier
The catalog name
catalog)

Check to see if the given catalog already exists.

public void
cleanup()

public SequenceInformation

Returns:

The sequence information. May return null if not found.
getSequenceInformation(Identifier
The name of the catalog which contains the schema which the sequence belongs to
catalogName, Identifier
The name of the schema the sequence belongs to
schemaName, Identifier
The sequence name
sequenceName)

Obtain reference to the named SequenceInformation

public SequenceInformation

Returns:

The sequence information. May return null if not found.
getSequenceInformation(Namespace.Name
The name of the schema the table belongs to
schemaName, Identifier
The sequence name
sequenceName)

Obtain reference to the named SequenceInformation

public SequenceInformation

Returns:

The sequence information. May return null if not found.
getSequenceInformation(QualifiedSequenceName
The qualified sequence name
sequenceName)

Obtain reference to the named SequenceInformation

public TableInformation

Returns:

The table information. May return null if not found.
getTableInformation(Identifier
The name of the catalog which contains the schema which the table belongs to
catalogName, Identifier
The name of the schema the table belongs to
schemaName, Identifier
The table name
tableName)

Obtain reference to the named TableInformation

public TableInformation

Returns:

The table information. May return null if not found.
getTableInformation(Namespace.Name
The name of the schema the table belongs to
schemaName, Identifier
The table name
tableName)

Obtain reference to the named TableInformation

public TableInformation

Returns:

The table information. May return null if not found.
getTableInformation(QualifiedTableName
The qualified table name
tableName)

Obtain reference to the named TableInformation

public NameSpaceTablesInformation

Returns:

a NameSpaceTablesInformation
getTablesInformation(Namespace
The Namespace which contains the TableInformation
namespace)

Obtain reference to all the TableInformation for a given Namespace

public boolean

Returns:

true indicates a schema with the given name already exists
schemaExists(Namespace.Name
The schema name
schema)

Check to see if the given schema already exists.

Method Detail

catalogExistsback to summary
public boolean catalogExists(Identifier catalog)

Check to see if the given catalog already exists.

Parameters
catalog:Identifier

The catalog name

Returns:boolean

true indicates a catalog with the given name already exists

cleanupback to summary
public void cleanup()
getSequenceInformationback to summary
public SequenceInformation getSequenceInformation(Identifier catalogName, Identifier schemaName, Identifier sequenceName)

Obtain reference to the named SequenceInformation

Parameters
catalogName:Identifier

The name of the catalog which contains the schema which the sequence belongs to

schemaName:Identifier

The name of the schema the sequence belongs to

sequenceName:Identifier

The sequence name

Returns:SequenceInformation

The sequence information. May return null if not found.

getSequenceInformationback to summary
public SequenceInformation getSequenceInformation(Namespace.Name schemaName, Identifier sequenceName)

Obtain reference to the named SequenceInformation

Parameters
schemaName:Namespace.Name

The name of the schema the table belongs to

sequenceName:Identifier

The sequence name

Returns:SequenceInformation

The sequence information. May return null if not found.

getSequenceInformationback to summary
public SequenceInformation getSequenceInformation(QualifiedSequenceName sequenceName)

Obtain reference to the named SequenceInformation

Parameters
sequenceName:QualifiedSequenceName

The qualified sequence name

Returns:SequenceInformation

The sequence information. May return null if not found.

getTableInformationback to summary
public TableInformation getTableInformation(Identifier catalogName, Identifier schemaName, Identifier tableName)

Obtain reference to the named TableInformation

Parameters
catalogName:Identifier

The name of the catalog which contains the schema which the table belongs to

schemaName:Identifier

The name of the schema the table belongs to

tableName:Identifier

The table name

Returns:TableInformation

The table information. May return null if not found.

getTableInformationback to summary
public TableInformation getTableInformation(Namespace.Name schemaName, Identifier tableName)

Obtain reference to the named TableInformation

Parameters
schemaName:Namespace.Name

The name of the schema the table belongs to

tableName:Identifier

The table name

Returns:TableInformation

The table information. May return null if not found.

getTableInformationback to summary
public TableInformation getTableInformation(QualifiedTableName tableName)

Obtain reference to the named TableInformation

Parameters
tableName:QualifiedTableName

The qualified table name

Returns:TableInformation

The table information. May return null if not found.

getTablesInformationback to summary
public NameSpaceTablesInformation getTablesInformation(Namespace namespace)

Obtain reference to all the TableInformation for a given Namespace

Parameters
namespace:Namespace

The Namespace which contains the TableInformation

Returns:NameSpaceTablesInformation

a NameSpaceTablesInformation

schemaExistsback to summary
public boolean schemaExists(Namespace.Name schema)

Check to see if the given schema already exists.

Parameters
schema:Namespace.Name

The schema name

Returns:boolean

true indicates a schema with the given name already exists