Package org.ofbiz.core.entity.jdbc

Class DatabaseUtil

java.lang.Object

org.ofbiz.core.entity.jdbc.DatabaseUtil

public class DatabaseUtil
extends Object

Utilities for Entity Database Maintenance

Since:

2.0

Version:

$Revision: 1.3 $

Author:

David E. Jones

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseUtil.ColumnCheckInfo
static class	DatabaseUtil.ReferenceCheckInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected final DatasourceInfo	datasourceInfo
protected final String	helperName
protected final ModelFieldTypeReader	modelFieldTypeReader
static final String	module
protected final SqlEscapeHelper	sqlEscapeHelper

Constructor Summary

Constructors

Constructor	Description
DatabaseUtil(String helperName)	Constructs with the name of a helper that is used to load DatasourceInfo from EntityConfigUtil and uses the static ConnectionFactory for connections.

Method Summary

Modifier and Type	Method	Description
String	addColumn(ModelEntity entity, ModelField field)
String	addVirtualColumn(ModelEntity entity, ModelFunctionBasedIndex index)
void	checkDb(Map<String,? extends ModelEntity> modelEntities, Collection<String> messages, boolean addMissing)	Does a gzillion things to upgrade the database to the entitymodel by adding tables etc.
void	checkDb(Map<String,? extends ModelEntity> modelEntities, Collection<String> messages, boolean addMissing, boolean promote, boolean widen)	Does a gzillion things to upgrade the database to the entitymodel by adding tables etc.
String	createDeclaredIndex(ModelEntity entity, ModelIndex modelIndex)
String	createDeclaredIndices(ModelEntity entity)	Creates a database index for every declared index on the given entity.
String	createForeignKey(ModelEntity entity, ModelRelation modelRelation, ModelEntity relModelEntity, int constraintNameClipLength, String fkStyle, boolean useFkInitiallyDeferred)
String	createForeignKeyIndex(ModelEntity entity, ModelRelation modelRelation, int constraintNameClipLength)
String	createForeignKeyIndices(ModelEntity entity, int constraintNameClipLength)
String	createForeignKeys(ModelEntity entity, Map<String,? extends ModelEntity> modelEntities, int constraintNameClipLength, String fkStyle, boolean useFkInitiallyDeferred)
String	createFunctionBasedIndex(ModelEntity entity, ModelFunctionBasedIndex fbIndex)
String	createFunctionBasedIndices(ModelEntity entity)	Creates a function based index for every declared index on the given entity.
String	createTable(ModelEntity entity, Map<String,? extends ModelEntity> modelEntities, boolean addFks, boolean usePkConstraintNames, int constraintNameClipLength, String fkStyle, boolean useFkInitiallyDeferred)
String	deleteDeclaredIndex(ModelEntity entity, ModelIndex modelIndex)
String	deleteDeclaredIndices(ModelEntity entity)
String	deleteForeignKey(ModelEntity entity, ModelRelation modelRelation, ModelEntity relModelEntity, int constraintNameClipLength)
String	deleteForeignKeyIndex(ModelEntity entity, ModelRelation modelRelation, int constraintNameClipLength)
String	deleteForeignKeyIndices(ModelEntity entity, int constraintNameClipLength)
String	deleteForeignKeys(ModelEntity entity, Map<String,? extends ModelEntity> modelEntities, int constraintNameClipLength)
Map<String,List<DatabaseUtil.ColumnCheckInfo>>	getColumnInfo(Set<String> tableNames, Collection<String> messages)
Connection	getConnection()	Uses the configured ConnectionProvider to get a Connection based on the configured helper name.
Map<String,Set<String>>	getIndexInfo(Set<String> tableNames, Collection<String> messages)
Map<String,Set<String>>	getIndexInfo(Set<String> tableNames, Collection<String> messages, boolean includeUnique)	Gets index information from the database for the given table names only, optionally including unique indexes.
Map<String,Map<String,DatabaseUtil.ReferenceCheckInfo>>	getReferenceInfo(Set<String> tableNames, Collection<String> messages)
static String	getSchemaPattern(DatabaseMetaData dbData, String schemaName)	Lookup schema name according do database metadata see JIRA-28526 this method needs to be coherent with convertToSchemaTableName(String, java.sql.DatabaseMetaData) and ModelEntity.getTableName(org.ofbiz.core.entity.config.DatasourceInfo)
TreeSet<String>	getTableNames(Collection<String> messages)
List<ModelEntity>	induceModelFromDb(Collection<String> messages)	Creates a list of ModelEntity objects based on metadata from the database
String	makeFkConstraintClause(ModelEntity entity, ModelRelation modelRelation, ModelEntity relModelEntity, int constraintNameClipLength, String fkStyle, boolean useFkInitiallyDeferred)
String	makeFkConstraintName(ModelRelation modelRelation, int constraintNameClipLength)
String	makeFkIndexClause(ModelEntity entity, ModelRelation modelRelation, int constraintNameClipLength)
String	makeFunctionBasedIndexClause(ModelEntity entity, ModelFunctionBasedIndex fbIndex, DatabaseType databaseType)
String	makeIndexClause(ModelEntity entity, ModelIndex modelIndex)

Methods inherited from class java.lang.Object

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

Field Details

module

public static final String module

helperName

protected final String helperName

modelFieldTypeReader

protected final ModelFieldTypeReader modelFieldTypeReader

datasourceInfo

protected final DatasourceInfo datasourceInfo

sqlEscapeHelper

protected final SqlEscapeHelper sqlEscapeHelper

Constructor Details

DatabaseUtil

public DatabaseUtil(String helperName)

Constructs with the name of a helper that is used to load DatasourceInfo from EntityConfigUtil and uses the static ConnectionFactory for connections.

Parameters:

helperName -

Method Details

getConnection

public Connection getConnection()
                         throws SQLException,
GenericEntityException

Uses the configured ConnectionProvider to get a Connection based on the configured helper name.

Returns:

the Connection

Throws:

SQLException

GenericEntityException

checkDb

public void checkDb(Map<String,? extends ModelEntity> modelEntities,
 Collection<String> messages,
 boolean addMissing)

Does a gzillion things to upgrade the database to the entitymodel by adding tables etc.

Parameters:

modelEntities - Model entity names to ModelEntity objects.

messages - a thing to collect errors.

addMissing - if true, will attempt to add tables and columns, fks, indices etc are added always.

checkDb

public void checkDb(Map<String,? extends ModelEntity> modelEntities,
 Collection<String> messages,
 boolean addMissing,
 boolean promote,
 boolean widen)

Does a gzillion things to upgrade the database to the entitymodel by adding tables etc.

Parameters:

modelEntities - Model entity names to ModelEntity objects.

messages - a thing to collect errors.

addMissing - if true, will attempt to add tables and columns, fks, indices etc are added always.

promote - if true, will attempt to promote types to wider types, as defined in allowedFieldTypePromotions.

widen - if true, will attempt to widen types with size (only widen, never shorten)

induceModelFromDb

public List<ModelEntity> induceModelFromDb(Collection<String> messages)

Creates a list of ModelEntity objects based on metadata from the database

getTableNames

public TreeSet<String> getTableNames(Collection<String> messages)

getSchemaPattern

public static String getSchemaPattern(DatabaseMetaData dbData,
 String schemaName)
                               throws SQLException

Lookup schema name according do database metadata see JIRA-28526 this method needs to be coherent with convertToSchemaTableName(String, java.sql.DatabaseMetaData) and ModelEntity.getTableName(org.ofbiz.core.entity.config.DatasourceInfo)

Throws:

SQLException

getColumnInfo

public Map<String,List<DatabaseUtil.ColumnCheckInfo>> getColumnInfo(Set<String> tableNames,
 Collection<String> messages)

getReferenceInfo

public Map<String,Map<String,DatabaseUtil.ReferenceCheckInfo>> getReferenceInfo(Set<String> tableNames,
 Collection<String> messages)

getIndexInfo

public Map<String,Set<String>> getIndexInfo(Set<String> tableNames,
 Collection<String> messages)

getIndexInfo

public Map<String,Set<String>> getIndexInfo(Set<String> tableNames,
 Collection<String> messages,
 boolean includeUnique)

Gets index information from the database for the given table names only, optionally including unique indexes.

Parameters:

tableNames - the names of tables to get indexes for.

messages - a collector of errors.

includeUnique - if true, the index info will include unique indexes which could include pk indexes.

Returns:

a map of table names to sets of index names or null on failure.

createTable

public String createTable(ModelEntity entity,
 Map<String,? extends ModelEntity> modelEntities,
 boolean addFks,
 boolean usePkConstraintNames,
 int constraintNameClipLength,
 String fkStyle,
 boolean useFkInitiallyDeferred)

addColumn

public String addColumn(ModelEntity entity,
 ModelField field)

addVirtualColumn

public String addVirtualColumn(ModelEntity entity,
 ModelFunctionBasedIndex index)

makeFkConstraintName

public String makeFkConstraintName(ModelRelation modelRelation,
 int constraintNameClipLength)

createForeignKeys

public String createForeignKeys(ModelEntity entity,
 Map<String,? extends ModelEntity> modelEntities,
 int constraintNameClipLength,
 String fkStyle,
 boolean useFkInitiallyDeferred)

createForeignKey

public String createForeignKey(ModelEntity entity,
 ModelRelation modelRelation,
 ModelEntity relModelEntity,
 int constraintNameClipLength,
 String fkStyle,
 boolean useFkInitiallyDeferred)

makeFkConstraintClause

public String makeFkConstraintClause(ModelEntity entity,
 ModelRelation modelRelation,
 ModelEntity relModelEntity,
 int constraintNameClipLength,
 String fkStyle,
 boolean useFkInitiallyDeferred)

deleteForeignKeys

public String deleteForeignKeys(ModelEntity entity,
 Map<String,? extends ModelEntity> modelEntities,
 int constraintNameClipLength)

deleteForeignKey

public String deleteForeignKey(ModelEntity entity,
 ModelRelation modelRelation,
 ModelEntity relModelEntity,
 int constraintNameClipLength)

createDeclaredIndices

public String createDeclaredIndices(ModelEntity entity)

Creates a database index for every declared index on the given entity.

Parameters:

entity -

Returns:

an error message if there is an error, or null if it worked.

createDeclaredIndex

public String createDeclaredIndex(ModelEntity entity,
 ModelIndex modelIndex)

makeIndexClause

public String makeIndexClause(ModelEntity entity,
 ModelIndex modelIndex)

deleteDeclaredIndices

public String deleteDeclaredIndices(ModelEntity entity)

deleteDeclaredIndex

public String deleteDeclaredIndex(ModelEntity entity,
 ModelIndex modelIndex)

createForeignKeyIndices

public String createForeignKeyIndices(ModelEntity entity,
 int constraintNameClipLength)

createForeignKeyIndex

public String createForeignKeyIndex(ModelEntity entity,
 ModelRelation modelRelation,
 int constraintNameClipLength)

makeFkIndexClause

public String makeFkIndexClause(ModelEntity entity,
 ModelRelation modelRelation,
 int constraintNameClipLength)

deleteForeignKeyIndices

public String deleteForeignKeyIndices(ModelEntity entity,
 int constraintNameClipLength)

deleteForeignKeyIndex

public String deleteForeignKeyIndex(ModelEntity entity,
 ModelRelation modelRelation,
 int constraintNameClipLength)

createFunctionBasedIndices

public String createFunctionBasedIndices(ModelEntity entity)

Creates a function based index for every declared index on the given entity.

Parameters:

entity -

Returns:

an error message if there is an error, or null if it worked.

createFunctionBasedIndex

public String createFunctionBasedIndex(ModelEntity entity,
 ModelFunctionBasedIndex fbIndex)

makeFunctionBasedIndexClause

public String makeFunctionBasedIndexClause(ModelEntity entity,
 ModelFunctionBasedIndex fbIndex,
 DatabaseType databaseType)