org.datanucleus.store.schema

Class SchemaTool

java.lang.Object

org.datanucleus.store.schema.SchemaTool

public class SchemaTool
extends Object

SchemaTool providing an interface for the maintenance of schemas. These utilities include:-

• creation of tables representing classes specified in input data
• deletion of tables representing classes specified in input data
• validation of tables representing classes specified in input data
• details about the datastore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaTool.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected static Localiser	LOCALISER Localiser for messages.
static NucleusLogger	LOGGER
static int	SCHEMATOOL_CREATE_MODE create mode
static int	SCHEMATOOL_DATABASE_INFO_MODE database info mode
static int	SCHEMATOOL_DELETE_MODE delete mode
static int	SCHEMATOOL_DELETECREATE_MODE delete+create mode
static int	SCHEMATOOL_SCHEMA_INFO_MODE schema info mode
static int	SCHEMATOOL_VALIDATE_MODE validate mode

Constructor Summary

Constructors

Constructor and Description
SchemaTool() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	createSchema(SchemaAwareStoreManager storeMgr, Set<String> classNames)
void	deleteSchema(SchemaAwareStoreManager storeMgr, Set<String> classNames)
String	getApi() Acessor for the metadata API (JDO, JPA) in use (metadata definition)
boolean	getCompleteDdl()
String	getDdlFile() Accessor for the DDL filename
boolean	getIncludeAutoStart()
static NucleusContext	getNucleusContextForMode(SchemaTool.Mode mode, String api, Map userProps, String persistenceUnitName, String ddlFile, boolean verbose) Method to create a NucleusContext for the specified mode of SchemaTool
Properties	getPropertiesForSchemaTool() Method to generate the properties to be used by SchemaTool.
boolean	isVerbose()
static void	main(String[] args) Entry method when invoked from the command line.
SchemaTool	setApi(String api) Mutator for the metadata API (JDO, JPA)
SchemaTool	setCompleteDdl(boolean completeDdl) Mutator for the flag to output complete DDL (when using DDL file)
SchemaTool	setDdlFile(String file) Mutator for the DDL file
SchemaTool	setIncludeAutoStart(boolean include) Mutator for the flag to include auto-start mechanisms in schema updates
SchemaTool	setVerbose(boolean verbose)
void	validateSchema(SchemaAwareStoreManager storeMgr, Set<String> classNames)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localiser for messages.

SCHEMATOOL_CREATE_MODE

public static final int SCHEMATOOL_CREATE_MODE

create mode

See Also:

Constant Field Values

SCHEMATOOL_DELETE_MODE

public static final int SCHEMATOOL_DELETE_MODE

delete mode

See Also:

Constant Field Values

SCHEMATOOL_DELETECREATE_MODE

public static final int SCHEMATOOL_DELETECREATE_MODE

delete+create mode

See Also:

Constant Field Values

SCHEMATOOL_VALIDATE_MODE

public static final int SCHEMATOOL_VALIDATE_MODE

validate mode

See Also:

Constant Field Values

SCHEMATOOL_DATABASE_INFO_MODE

public static final int SCHEMATOOL_DATABASE_INFO_MODE

database info mode

See Also:

Constant Field Values

SCHEMATOOL_SCHEMA_INFO_MODE

public static final int SCHEMATOOL_SCHEMA_INFO_MODE

schema info mode

See Also:

Constant Field Values

LOGGER

public static final NucleusLogger LOGGER

Constructor Detail

SchemaTool

public SchemaTool()

Constructor

Method Detail

main

public static void main(String[] args)
                 throws Exception

Entry method when invoked from the command line.

Parameters:

args - List of options for processing by the available methods in this class.

Throws:

Exception

getPropertiesForSchemaTool

public Properties getPropertiesForSchemaTool()

Method to generate the properties to be used by SchemaTool. This includes whether to create DDL to a file, and whether to include any auto-start mechanism

Returns:

The properties to use with SchemaTool.

createSchema

public void createSchema(SchemaAwareStoreManager storeMgr,
                Set<String> classNames)

deleteSchema

public void deleteSchema(SchemaAwareStoreManager storeMgr,
                Set<String> classNames)

validateSchema

public void validateSchema(SchemaAwareStoreManager storeMgr,
                  Set<String> classNames)

getNucleusContextForMode

public static NucleusContext getNucleusContextForMode(SchemaTool.Mode mode,
                                      String api,
                                      Map userProps,
                                      String persistenceUnitName,
                                      String ddlFile,
                                      boolean verbose)

Method to create a NucleusContext for the specified mode of SchemaTool

Parameters:

mode - Mode of operation of SchemaTool

api - Persistence API

userProps - Map containing user provided properties (usually input via a file)

persistenceUnitName - Name of the persistence-unit (if any)

ddlFile - Name of a file to output DDL to

verbose - Verbose mode

Returns:

The NucleusContext to use

Throws:

NucleusException - Thrown if an error occurs in creating the required NucleusContext

getApi

public String getApi()

Acessor for the metadata API (JDO, JPA) in use (metadata definition)

Returns:

the API

setApi

public SchemaTool setApi(String api)

Mutator for the metadata API (JDO, JPA)

Parameters:

api - the API

Returns:

The SchemaTool instance

isVerbose

public boolean isVerbose()

Returns:

the verbose

setVerbose

public SchemaTool setVerbose(boolean verbose)

Parameters:

verbose - the verbose to set

Returns:

The SchemaTool instance

getDdlFile

public String getDdlFile()

Accessor for the DDL filename

Returns:

the file to use when outputing the DDL

setDdlFile

public SchemaTool setDdlFile(String file)

Mutator for the DDL file

Parameters:

file - the file to use when outputting the DDL

Returns:

The SchemaTool instance

setCompleteDdl

public SchemaTool setCompleteDdl(boolean completeDdl)

Mutator for the flag to output complete DDL (when using DDL file)

Parameters:

completeDdl - Whether to return complete DDL

Returns:

The SchemaTool instance

getCompleteDdl

public boolean getCompleteDdl()

Returns:

whether to use generate DDL (or just update DDL)

setIncludeAutoStart

public SchemaTool setIncludeAutoStart(boolean include)

Mutator for the flag to include auto-start mechanisms in schema updates

Parameters:

include - Whether to include the auto-start mechanism specified by persistence props

Returns:

The SchemaTool instance

getIncludeAutoStart

public boolean getIncludeAutoStart()

Returns:

whether to include auto-start mechanisms in schema updates