org.apache.manifoldcf.core.database
Class DBInterfaceMySQL

java.lang.Object
  org.apache.manifoldcf.core.database.Database
      org.apache.manifoldcf.core.database.DBInterfaceMySQL

All Implemented Interfaces:

IDBInterface

public class DBInterfaceMySQL
extends Database
implements IDBInterface

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.manifoldcf.core.database.Database

Database.ExecuteQueryThread, Database.QueryCacheExecutor

Field Summary

static java.lang.String	_rcsid
protected java.lang.String	cacheKey
protected IThreadContext	context

Fields inherited from class org.apache.manifoldcf.core.database.Database

_TRANSACTION_, cacheManager, connection, databaseName, delayedTransactionDepth, doRollback, jdbcDriverClass, jdbcUrl, password, random, th, userName

Fields inherited from interface org.apache.manifoldcf.core.interfaces.IDBInterface

TRANSACTION_ENCLOSING, TRANSACTION_READCOMMITTED, TRANSACTION_SERIALIZED

Constructor Summary

DBInterfaceMySQL(IThreadContext tc, java.lang.String databaseName, java.lang.String userName, java.lang.String password)

Method Summary

void	addTableIndex(java.lang.String tableName, boolean unique, java.util.ArrayList columnList) Add an index to a table.
void	analyzeTable(java.lang.String tableName) Analyze a table.
void	beginTransaction() Begin a database transaction.
void	beginTransaction(int transactionType) Begin a database transaction.
void	closeDatabase() Uninitialize.
protected void	commitCurrentTransaction() Abstract method to commit a transaction
java.lang.String	constructDistinctOnClause(java.util.ArrayList outputParameters, java.lang.String baseQuery, java.util.ArrayList baseParameters, java.lang.String[] distinctFields, java.util.Map otherFields) Construct a 'distinct on (x)' filter.
java.lang.String	constructOffsetLimitClause(int offset, int limit) Construct an offset/limit clause.
java.lang.String	constructRegexpClause(java.lang.String column, java.lang.String regularExpression, boolean caseInsensitive) Construct a regular-expression match clause.
java.lang.String	constructSubstringClause(java.lang.String column, java.lang.String regularExpression, boolean caseInsensitive) Construct a regular-expression substring clause.
void	createUserAndDatabase(java.lang.String adminUserName, java.lang.String adminPassword, StringSet invalidateKeys) Create user and database.
void	dropUserAndDatabase(java.lang.String adminUserName, java.lang.String adminPassword, StringSet invalidateKeys) Drop user and database.
StringSet	getAllTables(StringSet cacheKeys, java.lang.String queryClass) Get a database's tables.
java.lang.String	getDatabaseCacheKey() Get the database general cache key.
int	getMaxInClause() Obtain the maximum number of individual items that should be present in an IN clause.
int	getMaxOrClause() Obtain the maximum number of individual clauses that should be present in a sequence of OR clauses.
java.util.Map	getTableIndexes(java.lang.String tableName, StringSet cacheKeys, java.lang.String queryClass) Get a table's indexes.
java.util.Map	getTableSchema(java.lang.String tableName, StringSet cacheKeys, java.lang.String queryClass) Get a table's schema.
void	openDatabase() Initialize.
void	performAddIndex(java.lang.String indexName, java.lang.String tableName, IndexDescription description) Add an index to a table.
void	performAlter(java.lang.String tableName, java.util.Map columnMap, java.util.Map columnModifyMap, java.util.ArrayList columnDeleteList, StringSet invalidateKeys) Perform a table alter operation.
void	performCreate(java.lang.String tableName, java.util.Map columnMap, StringSet invalidateKeys) Perform a table creation operation.
void	performDelete(java.lang.String tableName, java.lang.String whereClause, java.util.ArrayList whereParameters, StringSet invalidateKeys) Perform a delete operation.
void	performDrop(java.lang.String tableName, StringSet invalidateKeys) Perform a table drop operation.
void	performInsert(java.lang.String tableName, java.util.Map parameterMap, StringSet invalidateKeys) Perform an insert operation.
void	performLock(java.lang.String tableName) Perform a table lock operation.
void	performModification(java.lang.String query, java.util.ArrayList params, StringSet invalidateKeys) Perform a general database modification query.
IResultSet	performQuery(java.lang.String query, java.util.ArrayList params, StringSet cacheKeys, java.lang.String queryClass) Perform a general "data fetch" query.
IResultSet	performQuery(java.lang.String query, java.util.ArrayList params, StringSet cacheKeys, java.lang.String queryClass, int maxResults, ILimitChecker returnLimit) Perform a general "data fetch" query.
IResultSet	performQuery(java.lang.String query, java.util.ArrayList params, StringSet cacheKeys, java.lang.String queryClass, int maxResults, ResultSpecification resultSpec, ILimitChecker returnLimit) Perform a general "data fetch" query.
void	performRemoveIndex(java.lang.String indexName) Remove an index.
void	performUpdate(java.lang.String tableName, java.util.Map parameterMap, java.lang.String whereClause, java.util.ArrayList whereParameters, StringSet invalidateKeys) Perform an update operation.
void	reindexTable(java.lang.String tableName) Reindex a table.
protected void	rollbackCurrentTransaction() Abstract method to roll back a transaction
protected void	startATransaction() Abstract method to start a transaction

Methods inherited from class org.apache.manifoldcf.core.database.Database

cleanupParameters, endTransaction, execute, executeQuery, executeUncachedQuery, executeViaThread, explainQuery, findColumn, getBLOB, getCurrentTransactionType, getData, getDatabaseName, getObject, getSleepAmt, getTransactionID, internalTransactionBegin, isBinary, isBLOB, loadPS, mapColumnName, noteModifications, signalRollback, sleepFor, synchronizeTransactions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.manifoldcf.core.interfaces.IDBInterface

endTransaction, getDatabaseName, getSleepAmt, getTransactionID, noteModifications, signalRollback, sleepFor

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

context

protected IThreadContext context

cacheKey

protected java.lang.String cacheKey

Constructor Detail

DBInterfaceMySQL

public DBInterfaceMySQL(IThreadContext tc,
                        java.lang.String databaseName,
                        java.lang.String userName,
                        java.lang.String password)
                 throws ManifoldCFException

Throws:

ManifoldCFException

Method Detail

openDatabase

public void openDatabase()
                  throws ManifoldCFException

Initialize. This method is called once per JVM instance, in order to set up database communication.

Specified by:

openDatabase in interface IDBInterface

Throws:

ManifoldCFException

closeDatabase

public void closeDatabase()
                   throws ManifoldCFException

Uninitialize. This method is called during JVM shutdown, in order to close all database communication.

Specified by:

closeDatabase in interface IDBInterface

Throws:

ManifoldCFException

getDatabaseCacheKey

public java.lang.String getDatabaseCacheKey()

Get the database general cache key.

Specified by:

getDatabaseCacheKey in interface IDBInterface

Returns:

the general cache key for the database.

performLock

public void performLock(java.lang.String tableName)
                 throws ManifoldCFException

Perform a table lock operation.

Specified by:

performLock in interface IDBInterface

Parameters:

tableName - is the name of the table.

Throws:

ManifoldCFException

performInsert

public void performInsert(java.lang.String tableName,
                          java.util.Map parameterMap,
                          StringSet invalidateKeys)
                   throws ManifoldCFException

Perform an insert operation.

Specified by:

performInsert in interface IDBInterface

Parameters:

tableName - is the name of the table.

invalidateKeys - are the cache keys that should be invalidated.

parameterMap - is the map of column name/values to write.

Throws:

ManifoldCFException

performUpdate

public void performUpdate(java.lang.String tableName,
                          java.util.Map parameterMap,
                          java.lang.String whereClause,
                          java.util.ArrayList whereParameters,
                          StringSet invalidateKeys)
                   throws ManifoldCFException

Perform an update operation.

Specified by:

performUpdate in interface IDBInterface

Parameters:

tableName - is the name of the table.

invalidateKeys - are the cache keys that should be invalidated.

parameterMap - is the map of column name/values to write.

whereClause - is the where clause describing the match (including the WHERE), or null if none.

whereParameters - are the parameters that come with the where clause, if any.

Throws:

ManifoldCFException

performDelete

public void performDelete(java.lang.String tableName,
                          java.lang.String whereClause,
                          java.util.ArrayList whereParameters,
                          StringSet invalidateKeys)
                   throws ManifoldCFException

Perform a delete operation.

Specified by:

performDelete in interface IDBInterface

Parameters:

tableName - is the name of the table to delete from.

invalidateKeys - are the cache keys that should be invalidated.

whereClause - is the where clause describing the match (including the WHERE), or null if none.

whereParameters - are the parameters that come with the where clause, if any.

Throws:

ManifoldCFException

performCreate

public void performCreate(java.lang.String tableName,
                          java.util.Map columnMap,
                          StringSet invalidateKeys)
                   throws ManifoldCFException

Perform a table creation operation.

Specified by:

performCreate in interface IDBInterface

Parameters:

tableName - is the name of the table to create.

columnMap - is the map describing the columns and types. NOTE that these are abstract types, which will be mapped to the proper types for the actual database inside this layer.

invalidateKeys - are the cache keys that should be invalidated, if any.

Throws:

ManifoldCFException

performAlter

public void performAlter(java.lang.String tableName,
                         java.util.Map columnMap,
                         java.util.Map columnModifyMap,
                         java.util.ArrayList columnDeleteList,
                         StringSet invalidateKeys)
                  throws ManifoldCFException

Perform a table alter operation.

Specified by:

performAlter in interface IDBInterface

Parameters:

tableName - is the name of the table to alter.

columnMap - is the map describing the columns and types to add. These are in the same form as for performCreate.

columnModifyMap - is the map describing the columns to be changed. The key is the existing column name, and the value is the new type of the column. Data will be copied from the old column to the new.

columnDeleteList - is the list of column names to delete.

invalidateKeys - are the cache keys that should be invalidated, if any.

Throws:

ManifoldCFException

addTableIndex

public void addTableIndex(java.lang.String tableName,
                          boolean unique,
                          java.util.ArrayList columnList)
                   throws ManifoldCFException

Add an index to a table.

Specified by:

addTableIndex in interface IDBInterface

Parameters:

tableName - is the name of the table to add the index for.

unique - is a boolean that if true describes a unique index.

columnList - is the list of columns that need to be included in the index, in order.

Throws:

ManifoldCFException

performAddIndex

public void performAddIndex(java.lang.String indexName,
                            java.lang.String tableName,
                            IndexDescription description)
                     throws ManifoldCFException

Add an index to a table.

Specified by:

performAddIndex in interface IDBInterface

Parameters:

tableName - is the name of the table to add the index for.

indexName - is the optional name of the table index. If null, a name will be chosen automatically.

description - is the index description.

Throws:

ManifoldCFException

performRemoveIndex

public void performRemoveIndex(java.lang.String indexName)
                        throws ManifoldCFException

Remove an index.

Specified by:

performRemoveIndex in interface IDBInterface

Parameters:

indexName - is the name of the index to remove.

Throws:

ManifoldCFException

analyzeTable

public void analyzeTable(java.lang.String tableName)
                  throws ManifoldCFException

Analyze a table.

Specified by:

analyzeTable in interface IDBInterface

Parameters:

tableName - is the name of the table to analyze/calculate statistics for.

Throws:

ManifoldCFException

reindexTable

public void reindexTable(java.lang.String tableName)
                  throws ManifoldCFException

Reindex a table.

Specified by:

reindexTable in interface IDBInterface

Parameters:

tableName - is the name of the table to rebuild indexes for.

Throws:

ManifoldCFException

performDrop

public void performDrop(java.lang.String tableName,
                        StringSet invalidateKeys)
                 throws ManifoldCFException

Perform a table drop operation.

Specified by:

performDrop in interface IDBInterface

Parameters:

tableName - is the name of the table to drop.

invalidateKeys - are the cache keys that should be invalidated, if any.

Throws:

ManifoldCFException

createUserAndDatabase

public void createUserAndDatabase(java.lang.String adminUserName,
                                  java.lang.String adminPassword,
                                  StringSet invalidateKeys)
                           throws ManifoldCFException

Create user and database.

Specified by:

createUserAndDatabase in interface IDBInterface

Parameters:

adminUserName - is the admin user name.

adminPassword - is the admin password.

invalidateKeys - are the cache keys that should be invalidated, if any.

Throws:

ManifoldCFException

dropUserAndDatabase

public void dropUserAndDatabase(java.lang.String adminUserName,
                                java.lang.String adminPassword,
                                StringSet invalidateKeys)
                         throws ManifoldCFException

Drop user and database.

Specified by:

dropUserAndDatabase in interface IDBInterface

Parameters:

adminUserName - is the admin user name.

adminPassword - is the admin password.

invalidateKeys - are the cache keys that should be invalidated, if any.

Throws:

ManifoldCFException

performModification

public void performModification(java.lang.String query,
                                java.util.ArrayList params,
                                StringSet invalidateKeys)
                         throws ManifoldCFException

Perform a general database modification query.

Specified by:

performModification in interface IDBInterface

Parameters:

query - is the query string.

params - are the parameterized values, if needed.

invalidateKeys - are the cache keys to invalidate.

Throws:

ManifoldCFException

getTableSchema

public java.util.Map getTableSchema(java.lang.String tableName,
                                    StringSet cacheKeys,
                                    java.lang.String queryClass)
                             throws ManifoldCFException

Get a table's schema.

Specified by:

getTableSchema in interface IDBInterface

Parameters:

tableName - is the name of the table.

cacheKeys - are the keys against which to cache the query, or null.

queryClass - is the name of the query class, or null.

Returns:

a map of column names and ColumnDescription objects, describing the schema.

Throws:

ManifoldCFException

getTableIndexes

public java.util.Map getTableIndexes(java.lang.String tableName,
                                     StringSet cacheKeys,
                                     java.lang.String queryClass)
                              throws ManifoldCFException

Get a table's indexes.

Specified by:

getTableIndexes in interface IDBInterface

Parameters:

tableName - is the name of the table.

cacheKeys - are the keys against which to cache the query, or null.

queryClass - is the name of the query class, or null.

Returns:

a map of index names and IndexDescription objects, describing the indexes.

Throws:

ManifoldCFException

getAllTables

public StringSet getAllTables(StringSet cacheKeys,
                              java.lang.String queryClass)
                       throws ManifoldCFException

Get a database's tables.

Specified by:

getAllTables in interface IDBInterface

Parameters:

cacheKeys - are the cache keys for the query, or null.

queryClass - is the name of the query class, or null.

Returns:

the set of tables.

Throws:

ManifoldCFException

performQuery

public IResultSet performQuery(java.lang.String query,
                               java.util.ArrayList params,
                               StringSet cacheKeys,
                               java.lang.String queryClass)
                        throws ManifoldCFException

Perform a general "data fetch" query.

Specified by:

performQuery in interface IDBInterface

Parameters:

query - is the query string.

params - are the parameterized values, if needed.

cacheKeys - are the cache keys, if needed (null if no cache desired).

queryClass - is the LRU class name against which this query would be cached, or null if no LRU behavior desired.

Returns:

a resultset.

Throws:

ManifoldCFException

performQuery

public IResultSet performQuery(java.lang.String query,
                               java.util.ArrayList params,
                               StringSet cacheKeys,
                               java.lang.String queryClass,
                               int maxResults,
                               ILimitChecker returnLimit)
                        throws ManifoldCFException

Perform a general "data fetch" query.

Specified by:

performQuery in interface IDBInterface

Parameters:

query - is the query string.

params - are the parameterized values, if needed.

cacheKeys - are the cache keys, if needed (null if no cache desired).

queryClass - is the LRU class name against which this query would be cached, or null if no LRU behavior desired.

maxResults - is the maximum number of results returned (-1 for all).

returnLimit - is a description of how to limit the return result, or null if no limit.

Returns:

a resultset.

Throws:

ManifoldCFException

performQuery

public IResultSet performQuery(java.lang.String query,
                               java.util.ArrayList params,
                               StringSet cacheKeys,
                               java.lang.String queryClass,
                               int maxResults,
                               ResultSpecification resultSpec,
                               ILimitChecker returnLimit)
                        throws ManifoldCFException

Perform a general "data fetch" query.

Specified by:

performQuery in interface IDBInterface

Parameters:

query - is the query string.

params - are the parameterized values, if needed.

cacheKeys - are the cache keys, if needed (null if no cache desired).

queryClass - is the LRU class name against which this query would be cached, or null if no LRU behavior desired.

maxResults - is the maximum number of results returned (-1 for all).

resultSpec - is a result specification, or null for the standard treatment.

returnLimit - is a description of how to limit the return result, or null if no limit.

Returns:

a resultset.

Throws:

ManifoldCFException

constructRegexpClause

public java.lang.String constructRegexpClause(java.lang.String column,
                                              java.lang.String regularExpression,
                                              boolean caseInsensitive)

Construct a regular-expression match clause. This method builds both the text part of a regular-expression match.

Specified by:

constructRegexpClause in interface IDBInterface

Parameters:

column - is the column specifier string.

regularExpression - is the properly-quoted regular expression string, or "?" if a parameterized value is to be used.

caseInsensitive - is true of the regular expression match is to be case insensitive.

Returns:

the query chunk needed, not padded with spaces on either side.

constructSubstringClause

public java.lang.String constructSubstringClause(java.lang.String column,
                                                 java.lang.String regularExpression,
                                                 boolean caseInsensitive)

Construct a regular-expression substring clause. This method builds an expression that extracts a specified string section from a field, based on a regular expression.

Specified by:

constructSubstringClause in interface IDBInterface

Parameters:

column - is the column specifier string.

regularExpression - is the properly-quoted regular expression string, or "?" if a parameterized value is to be used.

caseInsensitive - is true if the regular expression match is to be case insensitive.

Returns:

the expression chunk needed, not padded with spaces on either side.

constructOffsetLimitClause

public java.lang.String constructOffsetLimitClause(int offset,
                                                   int limit)

Construct an offset/limit clause. This method constructs an offset/limit clause in the proper manner for the database in question.

Specified by:

constructOffsetLimitClause in interface IDBInterface

Parameters:

offset - is the starting offset number.

limit - is the limit of result rows to return.

Returns:

the proper clause, with no padding spaces on either side.

constructDistinctOnClause

public java.lang.String constructDistinctOnClause(java.util.ArrayList outputParameters,
                                                  java.lang.String baseQuery,
                                                  java.util.ArrayList baseParameters,
                                                  java.lang.String[] distinctFields,
                                                  java.util.Map otherFields)

Construct a 'distinct on (x)' filter. This filter wraps a query and returns a new query whose results are similar to POSTGRESQL's DISTINCT-ON feature. Specifically, for each combination of the specified distinct fields in the result, only the first such row is included in the final result.

Specified by:

constructDistinctOnClause in interface IDBInterface

Parameters:

outputParameters - is a blank arraylist into which to put parameters. Null may be used if the baseParameters parameter is null.

baseQuery - is the base query, which is another SELECT statement, without parens, e.g. "SELECT ..."

baseParameters - are the parameters corresponding to the baseQuery.

distinctFields - are the fields to consider to be distinct. These should all be keys in otherFields below.

otherFields - are the rest of the fields to return, keyed by the AS name, value being the base query column value, e.g. "value AS key"

Returns:

a revised query that performs the necessary DISTINCT ON operation. The arraylist outputParameters will also be appropriately filled in.

getMaxInClause

public int getMaxInClause()

Obtain the maximum number of individual items that should be present in an IN clause. Exceeding this amount will potentially cause the query performance to drop.

Specified by:

getMaxInClause in interface IDBInterface

Returns:

the maximum number of IN clause members.

getMaxOrClause

public int getMaxOrClause()

Obtain the maximum number of individual clauses that should be present in a sequence of OR clauses. Exceeding this amount will potentially cause the query performance to drop.

Specified by:

getMaxOrClause in interface IDBInterface

Returns:

the maximum number of OR clause members.

beginTransaction

public void beginTransaction()
                      throws ManifoldCFException

Begin a database transaction. This method call MUST be paired with an endTransaction() call, or database handles will be lost. If the transaction should be rolled back, then signalRollback() should be called before the transaction is ended. It is strongly recommended that the code that uses transactions be structured so that a try block starts immediately after this method call. The body of the try block will contain all direct or indirect calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().

Specified by:

beginTransaction in interface IDBInterface

Throws:

ManifoldCFException

beginTransaction

public void beginTransaction(int transactionType)
                      throws ManifoldCFException

Begin a database transaction. This method call MUST be paired with an endTransaction() call, or database handles will be lost. If the transaction should be rolled back, then signalRollback() should be called before the transaction is ended. It is strongly recommended that the code that uses transactions be structured so that a try block starts immediately after this method call. The body of the try block will contain all direct or indirect calls to executeQuery(). After this should be a catch for every exception type, including Error, which should call the signalRollback() method, and rethrow the exception. Then, after that a finally{} block which calls endTransaction().

Specified by:

beginTransaction in interface IDBInterface

Overrides:

beginTransaction in class Database

Parameters:

transactionType - is the kind of transaction desired.

Throws:

ManifoldCFException

startATransaction

protected void startATransaction()
                          throws ManifoldCFException

Abstract method to start a transaction

Overrides:

startATransaction in class Database

Throws:

ManifoldCFException

commitCurrentTransaction

protected void commitCurrentTransaction()
                                 throws ManifoldCFException

Abstract method to commit a transaction

Overrides:

commitCurrentTransaction in class Database

Throws:

ManifoldCFException

rollbackCurrentTransaction

protected void rollbackCurrentTransaction()
                                   throws ManifoldCFException

Abstract method to roll back a transaction

Overrides:

rollbackCurrentTransaction in class Database

Throws:

ManifoldCFException