|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.empire.commons.ErrorObject
org.apache.empire.db.DBDatabaseDriver
org.apache.empire.db.mysql.DBDatabaseDriverMySQL
public class DBDatabaseDriverMySQL
This class provides support for the MySQL database system.
Nested Class Summary | |
---|---|
static class |
DBDatabaseDriverMySQL.DBCommandMySQL
Defines the MySQL command type. |
Nested classes/interfaces inherited from class org.apache.empire.db.DBDatabaseDriver |
---|
DBDatabaseDriver.DBSeqTable, DBDatabaseDriver.DBSetGenKeys |
Nested classes/interfaces inherited from class org.apache.empire.commons.ErrorObject |
---|
ErrorObject.ObjectErrorInfo |
Field Summary |
---|
Constructor Summary | |
---|---|
DBDatabaseDriverMySQL()
Constructor for the MySQL database driver. |
Method Summary | |
---|---|
protected boolean |
alterTable(DBTableColumn col,
DBCmdType type,
DBSQLScript script)
Creates an alter table dll statement for adding, modifiying or droping a column. |
protected boolean |
appendColumnDesc(DBTableColumn c,
java.lang.StringBuilder sql)
Appends a table column definition to a ddl statement |
boolean |
attachDatabase(DBDatabase db,
java.sql.Connection conn)
Called when a database is opened |
DBCommand |
createCommand(DBDatabase db)
Creates a new MySQL command object. |
protected boolean |
createDatabase(DBDatabase db,
DBSQLScript script,
boolean createSchema)
|
protected boolean |
createRelation(DBRelation r,
DBSQLScript script)
Returns true if the relation has been created successfully. |
protected boolean |
createTable(DBTable t,
DBSQLScript script)
Returns true if the table has been created successfully. |
protected boolean |
createView(DBView v,
DBSQLScript script)
Returns true if the view has been created successfully. |
protected boolean |
dropObject(java.lang.String name,
java.lang.String objType,
DBSQLScript script)
Returns true if the object has been dropped successfully. |
java.lang.String |
getConvertPhrase(DataType destType,
DataType srcType,
java.lang.Object format)
Returns a data type convertion phrase template for this driver The returned template must contain a '?' which will be replaced by a column expression. |
java.lang.String |
getDatabaseName()
returns the name for the database / schema |
boolean |
getDDLScript(DBCmdType type,
DBObject dbo,
DBSQLScript script)
gets an SQL command for creating, modifying or deleting objects in the database (tables, columns, constraints, etc.) |
java.lang.String |
getEngine()
Get the table engine that is used when creating new tables |
java.lang.Object |
getNextSequenceValue(DBDatabase db,
java.lang.String seqName,
int minValue,
java.sql.Connection conn)
Returns the next value of a named sequence The numbers are used for fields of type DBExpr.DT_AUTOINC. If a driver supports this function it must return true for isSupported(DBDriverFeature.SEQUENCES). |
java.lang.String |
getSequenceTableName()
returns the name of the sequence table |
java.lang.String |
getSQLPhrase(int phrase)
Gets an sql phrase template for this database system. |
java.sql.Timestamp |
getUpdateTimestamp(java.sql.Connection conn)
Overridden. |
boolean |
isSupported(DBDriverFeature type)
Returns whether or not a particular feature is supported by this driver |
boolean |
isUseSequenceTable()
returns whether a sequence table is used for record identiy management. Default is false. |
void |
setDatabaseName(java.lang.String databaseName)
Sets the name for the database / schema This names is required for creating a database. When a name is set, the driver will automatically execute 'USE dbname' when the database is opened. |
void |
setEngine(java.lang.String engine)
Set the table engine that is used when creating new tables |
void |
setSequenceTableName(java.lang.String sequenceTableName)
Sets the name of the sequence table. |
void |
setUseSequenceTable(boolean useSequenceTable)
If set to true a special table is used for sequence number generation. Otherwise the AutoIncrement feature of MySQL is used identiy fields. |
Methods inherited from class org.apache.empire.db.DBDatabaseDriver |
---|
appendElementName, appendElementName, appendTextValue, checkDatabase, close, detachDatabase, detectQuoteName, executeQuery, executeSQL, extractErrorMessage, getColumnAutoValue, getDateTimeString, getResultValue, getValueString, isDDLColumnDefaults, prepareStatement, setDDLColumnDefaults |
Methods inherited from class org.apache.empire.commons.ErrorObject |
---|
clearError, clearErrorInfo, error, error, error, error, error, error, error, getErrorInfo, getErrorMessage, getErrorParams, getErrorSource, getErrorType, getMessage, hasError, internalSetError, isExceptionsEnabled, setExceptionsEnabled, success |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DBDatabaseDriverMySQL()
Method Detail |
---|
public java.lang.String getDatabaseName()
public void setDatabaseName(java.lang.String databaseName)
databaseName
- the name of the databasepublic java.lang.String getEngine()
public void setEngine(java.lang.String engine)
engine
- the table enginepublic boolean isUseSequenceTable()
public void setUseSequenceTable(boolean useSequenceTable)
useSequenceTable
- true to use a sequence table or false otherwise.public java.lang.String getSequenceTableName()
public void setSequenceTableName(java.lang.String sequenceTableName)
sequenceTableName
- the name of the table used for sequence number generationpublic boolean attachDatabase(DBDatabase db, java.sql.Connection conn)
DBDatabaseDriver
attachDatabase
in class DBDatabaseDriver
public DBCommand createCommand(DBDatabase db)
createCommand
in class DBDatabaseDriver
db
- the database for which to create a command object for
public boolean isSupported(DBDriverFeature type)
isSupported
in class DBDatabaseDriver
type
- type of requrested feature. @see DBDriverFeature
public java.lang.String getSQLPhrase(int phrase)
getSQLPhrase
in class DBDatabaseDriver
phrase
- the identifier of the phrase
DBDatabaseDriver.getSQLPhrase(int)
public java.lang.String getConvertPhrase(DataType destType, DataType srcType, java.lang.Object format)
DBDatabaseDriver
getConvertPhrase
in class DBDatabaseDriver
destType
- the target data typesrcType
- the source data typeformat
- additional formatting information (optional)
DBDatabaseDriver.getConvertPhrase(DataType, DataType, Object)
public java.lang.Object getNextSequenceValue(DBDatabase db, java.lang.String seqName, int minValue, java.sql.Connection conn)
DBDatabaseDriver
getNextSequenceValue
in class DBDatabaseDriver
db
- the databaseseqName
- the name of the sequenceminValue
- the minmum value of the sequenceconn
- a valid database connection
DBDatabaseDriver.getNextSequenceValue(DBDatabase, String, int, Connection)
public boolean getDDLScript(DBCmdType type, DBObject dbo, DBSQLScript script)
DBDatabaseDriver
getDDLScript
in class DBDatabaseDriver
type
- the command typedbo
- the databse objectscript
- the script to complete
DBDatabaseDriver.getDDLScript(DBCmdType, DBObject, DBSQLScript)
public java.sql.Timestamp getUpdateTimestamp(java.sql.Connection conn)
getUpdateTimestamp
in class DBDatabaseDriver
conn
- the connection that might be used
protected boolean createDatabase(DBDatabase db, DBSQLScript script, boolean createSchema)
protected boolean createTable(DBTable t, DBSQLScript script)
protected boolean appendColumnDesc(DBTableColumn c, java.lang.StringBuilder sql)
c
- the column which description to appendsql
- the sql builder object
protected boolean createRelation(DBRelation r, DBSQLScript script)
protected boolean alterTable(DBTableColumn col, DBCmdType type, DBSQLScript script)
col
- the column which to add, modify or droptype
- the type of operation to performbuf
- buffer to which to append the sql statement to
protected boolean createView(DBView v, DBSQLScript script)
protected boolean dropObject(java.lang.String name, java.lang.String objType, DBSQLScript script)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |