oracle.javatools.db
Interface DDLGenerator

Deprecated. - replaced by DDLGenerator

@Deprecated
public interface DDLGenerator

The DDLGenerator interface defines an API for retrieving the neccessary DDL statements for creating, updating, and deleting objects.

Since:

9.0.5

Method Summary

Ddl	getCreateDDL(Schema schema) Deprecated. Retrieves the DDL for creating a new Schema
Ddl	getCreateDDL(SchemaObject[] object, boolean replace, boolean cascade) Deprecated. Retrieves the DDL for creating the specified objects.
Ddl	getCreateDDL(SchemaObject object, boolean replace, boolean cascade) Deprecated. Retrieves the DDL for creating the specified object.
Ddl	getDeleteDDL(Schema schema, boolean cascade) Deprecated.
Ddl	getDeleteDDL(SchemaObject[] object, boolean cascade) Deprecated. Retrieves the DDL for deleting an array of objects.
Ddl	getDeleteDDL(SchemaObject object, boolean cascade) Deprecated. Retrieves the DDL for deleting an object.
Ddl[]	getUpdateDDL(ResultSet resultSet, boolean replace, boolean cascade) Deprecated. Retrieves the DDL for updating the definition of an object.
Ddl[]	getUpdateDDL(SchemaObject[] oldObjects, SchemaObject[] newObjects) Deprecated. Retrieves DDL to update an array of SchemaObject objects.
Ddl[]	getUpdateDDL(SchemaObject oldObject, SchemaObject newObject) Deprecated. Retrieves the DDL for updating the definition of an object.

Method Detail

getCreateDDL

Ddl getCreateDDL(SchemaObject object,
                 boolean replace,
                 boolean cascade)

Deprecated.

Retrieves the DDL for creating the specified object.

If the replace option is specified, and the object exists in the provider, DDL is create to drop the object. (except views, where CREATE OR REPLACE is generated)

Parameters:

object - the object for which DDL is required

replace - whether an existing object should be replaced

cascade - whether any DROP associated with replace should be cascaded

Returns:

a string array containing the DDL statements necessary to create the object

getCreateDDL

Ddl getCreateDDL(SchemaObject[] object,
                 boolean replace,
                 boolean cascade)

Deprecated.

Retrieves the DDL for creating the specified objects.

If the replace option is specified, DDL is generated to drop all the Foreign Keys in the tables in the specified objects. DDL is then generated to drop all of the specified objects (except views) which exist in the provider.

Parameters:

objects - the objects for which DDL is required

replace - whether an existing object should be replaced

cascade - whether any DROP associated with replace should be cascaded

Returns:

a string array containing the DDL statements necessary to create the objects

getUpdateDDL

Ddl[] getUpdateDDL(SchemaObject oldObject,
                   SchemaObject newObject)

Deprecated.

Retrieves the DDL for updating the definition of an object.

Parameters:

oldObject - the original version of the object

newObject - the updated data model

Returns:

a array of objects containing the DDL statements that will update the old object to the new model

Throws:

DBException - if legal DDL cannot be generated

getUpdateDDL

Ddl[] getUpdateDDL(SchemaObject[] oldObjects,
                   SchemaObject[] newObjects)

Deprecated.

Retrieves DDL to update an array of SchemaObject objects.

The generated DDL will modified the dbUpdatable objects to match the dbMaster objects.

Parameters:

oldObjects - the original versions of the objects

newObjects - the updated data model

Returns:

an array of objects containing the DDL statements that will update the old objects to the new model

Throws:

DBException - if legal DDL cannot be generated

getUpdateDDL

Ddl[] getUpdateDDL(ResultSet resultSet,
                   boolean replace,
                   boolean cascade)

Deprecated.

Retrieves the DDL for updating the definition of an object.

Parameters:

resultSet - description of the differences between two objects

replace - whether to replace any existing objects being created

cascade - whether to cascade the delete of any objects

Returns:

the DDL statements that will update the old object to the new model

Throws:

DBException - if legal DDL cannot be generated

getDeleteDDL

Ddl getDeleteDDL(SchemaObject object,
                 boolean cascade)

Deprecated.

Retrieves the DDL for deleting an object.

Parameters:

object - the object to be deleted

cascade - a boolean value indicating whether a cascade delete should be performed, if appropriate for the object type

Returns:

a string array containing the DDL statements for deleting the object

getDeleteDDL

Ddl getDeleteDDL(SchemaObject[] object,
                 boolean cascade)

Deprecated.

Retrieves the DDL for deleting an array of objects.

Parameters:

objects - the objects to be deleted

cascade - a boolean value indicating whether a cascade delete should be performed, if appropriate for the object type

Returns:

a string array containing the DDL statements for deleting the object

getCreateDDL

Ddl getCreateDDL(Schema schema)

Deprecated.

Retrieves the DDL for creating a new Schema

Parameters:

schema - the Schema for which the DDL is required

Returns:

an array of the DDL statements for creating the new Schema

getDeleteDDL

Ddl getDeleteDDL(Schema schema,
                 boolean cascade)

Deprecated.