Package org.datanucleus.store.schema

Interface SchemaAwareStoreManager

public interface SchemaAwareStoreManager

Interface to be implemented by all store managers that manage a "schema". This interface makes the StoreManager usable with SchemaTool.

Method Summary

Modifier and Type	Method	Description
void	createDatabase(java.lang.String catalogName, java.lang.String schemaName, java.util.Properties props)	Method that will create a database (catalog/schema) in the datastore (if the datastore supports it).
void	createSchemaForClasses(java.util.Set<java.lang.String> classNames, java.util.Properties props)	Create the schema (tables/constraints) for the specified classes (if supported by this datastore).
void	deleteDatabase(java.lang.String catalogName, java.lang.String schemaName, java.util.Properties props)	Method that will delete a database (catalog/schema) from the datastore (if the datastore supports it).
void	deleteSchemaForClasses(java.util.Set<java.lang.String> classNames, java.util.Properties props)	Delete the schema (tables/constraints) for the specified classes (if supported by this datastore).
void	validateSchemaForClasses(java.util.Set<java.lang.String> classNames, java.util.Properties props)	Validate the schema (tables/constraints) for the specified classes (if supported by this datastore).

Method Detail

createDatabase

void createDatabase(java.lang.String catalogName,
                    java.lang.String schemaName,
                    java.util.Properties props)

Method that will create a database (catalog/schema) in the datastore (if the datastore supports it).

Parameters:

catalogName - Name of the catalog to create

schemaName - Name of the schema to create

props - Any optional properties

Throws:

java.lang.UnsupportedOperationException - If not supported

deleteDatabase

void deleteDatabase(java.lang.String catalogName,
                    java.lang.String schemaName,
                    java.util.Properties props)

Method that will delete a database (catalog/schema) from the datastore (if the datastore supports it).

Parameters:

catalogName - Name of the catalog to delete

schemaName - Name of the schema to delete

props - Any optional properties

Throws:

java.lang.UnsupportedOperationException - If not supported

createSchemaForClasses

void createSchemaForClasses(java.util.Set<java.lang.String> classNames,
                            java.util.Properties props)

Create the schema (tables/constraints) for the specified classes (if supported by this datastore).

Parameters:

classNames - Names of the classes

props - Any optional properties

Throws:

java.lang.UnsupportedOperationException - If not supported

deleteSchemaForClasses

void deleteSchemaForClasses(java.util.Set<java.lang.String> classNames,
                            java.util.Properties props)

Delete the schema (tables/constraints) for the specified classes (if supported by this datastore).

Parameters:

classNames - Names of the classes

props - Any optional properties

Throws:

java.lang.UnsupportedOperationException - If not supported

validateSchemaForClasses

void validateSchemaForClasses(java.util.Set<java.lang.String> classNames,
                              java.util.Properties props)

Validate the schema (tables/constraints) for the specified classes (if supported by this datastore).

Parameters:

classNames - Names of the classes

props - Any optional properties

Throws:

java.lang.UnsupportedOperationException - If not supported