Package org.pentaho.di.core.database

Class GenericDatabaseMeta

java.lang.Object

org.pentaho.di.core.database.BaseDatabaseMeta

org.pentaho.di.core.database.GenericDatabaseMeta

All Implemented Interfaces:

Cloneable, DatabaseInterface, DatabaseInterfaceExtended

Direct Known Subclasses:

RemedyActionRequestSystemDatabaseMeta

public class GenericDatabaseMeta
extends BaseDatabaseMeta
implements DatabaseInterface

Contains Generic Database Connection information through static final members

Since:

11-mrt-2005

Author:

Matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATRRIBUTE_CUSTOM_DRIVER_CLASS
static final String	ATRRIBUTE_CUSTOM_URL
static final String	DATABASE_DIALECT_ID

Fields inherited from class org.pentaho.di.core.database.BaseDatabaseMeta

ATTRIBUTE_CLUSTER_DBNAME_PREFIX, ATTRIBUTE_CLUSTER_HOSTNAME_PREFIX, ATTRIBUTE_CLUSTER_PASSWORD_PREFIX, ATTRIBUTE_CLUSTER_PORT_PREFIX, ATTRIBUTE_CLUSTER_USERNAME_PREFIX, ATTRIBUTE_FORCE_IDENTIFIERS_TO_LOWERCASE, ATTRIBUTE_FORCE_IDENTIFIERS_TO_UPPERCASE, ATTRIBUTE_INITIAL_POOL_SIZE, ATTRIBUTE_IS_CLUSTERED, ATTRIBUTE_MAXIMUM_POOL_SIZE, ATTRIBUTE_MSSQL_DOUBLE_DECIMAL_SEPARATOR, ATTRIBUTE_POOLING_PARAMETER_PREFIX, ATTRIBUTE_PORT_NUMBER, ATTRIBUTE_PREFERRED_SCHEMA_NAME, ATTRIBUTE_PREFIX_EXTRA_OPTION, ATTRIBUTE_PRESERVE_RESERVED_WORD_CASE, ATTRIBUTE_QUOTE_ALL_FIELDS, ATTRIBUTE_SQL_CONNECT, ATTRIBUTE_SUPPORTS_BOOLEAN_DATA_TYPE, ATTRIBUTE_SUPPORTS_TIMESTAMP_DATA_TYPE, ATTRIBUTE_USE_POOLING, ATTRIBUTE_USE_RESULT_STREAMING, AUTOINCREMENT_SQL_FOR_BATCH_ID, NAMED_CLUSTER_ID, poolingParameters, releaseSavepoint, SELECT_COUNT_STATEMENT, SEQUENCE_FOR_BATCH_ID

Constructor Summary

Constructors

Constructor	Description
GenericDatabaseMeta()

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String attributeId, String value)	Add extra attribute on this connection
void	addExtraOption(String databaseTypeCode, String option, String value)	Add an extra option to the attributes list
ValueMetaInterface	customizeValueFromSQLType(ValueMetaInterface v, ResultSetMetaData rm, int index)	Customizes the ValueMetaInterface defined in the base
String	generateColumnAlias(int columnIndex, String suggestedName)	Generate a column alias given the column index and suggested name.
int[]	getAccessTypeList()	Get the list of possible access types for a database.
String	getAddColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to add a column to the specified table For this generic type, i set it to the most common possibility.
String	getCreateTableStatement()	Customizes the ValueMetaInterface defined in the base
String	getDatabaseDialect()
protected DatabaseInterface	getDatabaseDialectInternal()
Map<String,String>	getDefaultOptions()
String	getDriverClass()	Obtain the name of the JDBC driver class that we need to use!
String	getDropColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to drop a column from the specified table
String	getEndQuote()
String	getExtraOptionIndicator()
Map<String,String>	getExtraOptions()
String	getExtraOptionSeparator()
String	getExtraOptionsHelpText()
String	getExtraOptionValueSeparator()
String	getFieldDefinition(ValueMetaInterface v, String tk, String pk, boolean useAutoinc, boolean addFieldName, boolean addCr)	Describe a Value as a field in the database.
String	getFunctionAverage()
String	getFunctionCount()
String	getFunctionMaximum()
String	getFunctionMinimum()
String	getFunctionSum()
String	getLimitClause(int nrRows)
int	getMaxColumnsInIndex()
int	getMaxTextFieldLength()	Get the maximum length of a text field for this database connection.
int	getMaxVARCHARLength()	Get the maximum length of a text field (VARCHAR) for this database connection.
String	getModifyColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to modify a column in the specified table
int	getNotFoundTK(boolean useAutoinc)	Get the not found technical key.
String[]	getReservedWords()
String	getSafeFieldname(String fieldName)	Sanitize a string for usage as a field name Append an underscore to any field name that matches a reserved word Replaces spaces with underscores Prefixes a string with underscore that begins with a number
String	getSchemaTableCombination(String schemaName, String tablePart)	Get the schema-table combination to query the right table.
String	getSelectCountStatement(String tableName)	Build the SQL to count the number of rows in the passed table.
String	getSequenceNoMaxValueOption()
String	getSQLColumnExists(String columnname, String tablename)
String	getSQLInsertAutoIncUnknownDimensionRow(String schemaTable, String keyField, String versionField)	Get the SQL to insert a new empty unknown record in a dimension.
String	getSQLListOfSchemas()
String	getSQLLockTables(String[] tableNames)
String	getSQLQueryFields(String tableName)	Returns the minimal SQL to launch in order to determine the layout of the resultset for a given database table
String	getSQLTableExists(String tableName)
String	getSQLUnlockTables(String[] tableName)
String	getSQLValue(ValueMetaInterface valueMeta, Object valueData, String dateFormat)	Convert a value in the SQL equivalent.
String	getStartQuote()
String[]	getSynonymTypes()
String[]	getTableTypes()
String	getTruncateTableStatement(String tableName)
String	getURL(String hostname, String port, String databaseName)
String[]	getUsedLibraries()
String[]	getViewTypes()
boolean	isDefaultingToUppercase()
boolean	isDisplaySizeTwiceThePrecision()
boolean	isExplorable()
boolean	isFetchSizeSupported()	Checks whether or not the command setFetchSize() is supported by the JDBC driver...
boolean	isForcingIdentifiersToLowerCase()
boolean	isForcingIdentifiersToUpperCase()
boolean	isMySQLVariant()
boolean	isQuoteAllFields()
boolean	isStreamingResults()
boolean	isSystemTable(String tableName)
boolean	isUsingDoubleDecimalAsSchemaTableSeparator()
boolean	needsToLockAllTables()
boolean	preserveReservedCase()
boolean	quoteReservedWords()
String	quoteSQLString(String string)	Adds quotes around the string according to the database dialect and also escapes special characters like CR, LF and the quote character itself.
boolean	requiresCastToVariousForIsNull()
boolean	requiresCreateTablePrimaryKeyAppend()
protected void	resolveDialect(String dialectName)
void	setDatabaseDialect(String databaseDialect)
void	setForcingIdentifiersToLowerCase(boolean forceUpperCase)
void	setForcingIdentifiersToUpperCase(boolean forceUpperCase)
void	setPreserveReservedCase(boolean b)
void	setQuoteAllFields(boolean quoteAllFields)
void	setStreamingResults(boolean useStreaming)
void	setSupportsBooleanDataType(boolean b)
void	setSupportsTimestampDataType(boolean b)
void	setUsingDoubleDecimalAsSchemaTableSeparator(boolean useDoubleDecimalSeparator)
boolean	supportsAutoGeneratedKeys()
boolean	supportsBatchUpdates()
boolean	supportsBitmapIndex()
boolean	supportsBooleanDataType()
boolean	supportsFloatRoundingOnUpdate()	Most databases round number(7,2) 17.29999999 to 17.30, but some don't.
boolean	supportsGetBlob()
boolean	supportsNewLinesInSQL()
boolean	supportsOptionsInURL()
boolean	supportsPreparedStatementMetadataRetrieval()	Most databases allow you to retrieve result metadata by preparing a SELECT statement.
boolean	supportsResultSetMetadataRetrievalOnly()
boolean	supportsSequenceNoMaxValueOption()
boolean	supportsSetMaxRows()
boolean	supportsSynonyms()
boolean	supportsTimestampDataType()
boolean	supportsTimeStampToDateConversion()
boolean	supportsViews()
boolean	useSchemaNameForTableList()

Methods inherited from class org.pentaho.di.core.database.BaseDatabaseMeta

addDefaultOptions, canTest, checkIndexExists, clone, fullExceptionLog, getAccessType, getAttribute, getAttributes, getBackwardsCompatibleSchemaTableCombination, getBackwardsCompatibleTable, getConnectionPoolingProperties, getConnectSQL, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultDatabasePort, getDisplayName, getDropTableIfExistsStatement, getFieldnameProtector, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getInitialPoolSizeString, getMaximumPoolSize, getMaximumPoolSizeString, getName, getNamedCluster, getNextBatchId, getNextBatchIdUsingAutoIncSQL, getNextBatchIdUsingLockTables, getNextBatchIdUsingSequence, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getServername, getSQLCurrentSequenceValue, getSQLListOfProcedures, getSQLListOfSequences, getSQLNextSequenceValue, getSqlScriptStatements, getSQLSequenceExists, getTablespaceDDL, getUsername, getValueFromResultSet, getXulOverlayFile, isChanged, isPartitioned, isRequiringTransactionsOnQueries, isUsingConnectionPool, needsPlaceHolder, onlySpaces, parseStatements, releaseSavepoint, requiresName, setAccessType, setAttributes, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setHostname, setIndexTablespace, setInitialPoolSize, setInitialPoolSizeString, setMaximumPoolSize, setMaximumPoolSizeString, setName, setNamedCluster, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setServername, setUsername, setUsingConnectionPool, supportsAutoInc, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsRepository, supportsSchemas, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsTransactions, useSafePoints

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.core.database.DatabaseInterface

addDefaultOptions, checkIndexExists, clone, createSqlScriptParser, getAccessType, getAttribute, getAttributes, getConnectionPoolingProperties, getConnectSQL, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultDatabasePort, getDisplayName, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getInitialPoolSizeString, getLegacyColumnName, getMaximumPoolSize, getMaximumPoolSizeString, getName, getNamedCluster, getNamedClusterList, getNextBatchId, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getSchemas, getServername, getSQLCurrentSequenceValue, getSQLListOfProcedures, getSQLListOfSchemas, getSQLListOfSequences, getSQLNextSequenceValue, getSqlScriptStatements, getSQLSequenceExists, getTables, getUnsupportedTableOutputMessage, getUsername, getValueFromResultSet, getXulOverlayFile, isChanged, isPartitioned, isRequiringTransactionsOnQueries, isUsingConnectionPool, needsPlaceHolder, parseStatements, putOptionalOptions, releaseSavepoint, setAccessType, setAttributes, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setHostname, setIndexTablespace, setInitialPoolSize, setInitialPoolSizeString, setMaximumPoolSize, setMaximumPoolSizeString, setName, setNamedCluster, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setServername, setUsername, setUsingConnectionPool, supportsAutoInc, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsIndexes, supportsRepository, supportsSchemas, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsStandardTableOutput, supportsTransactions, useSafePoints

Field Details

ATRRIBUTE_CUSTOM_URL

public static final String ATRRIBUTE_CUSTOM_URL

See Also:

• Constant Field Values

ATRRIBUTE_CUSTOM_DRIVER_CLASS

public static final String ATRRIBUTE_CUSTOM_DRIVER_CLASS

See Also:

• Constant Field Values

DATABASE_DIALECT_ID

public static final String DATABASE_DIALECT_ID

See Also:

• Constant Field Values

Constructor Details

GenericDatabaseMeta

public GenericDatabaseMeta()

Method Details

addAttribute

public void addAttribute(String attributeId,
 String value)

Description copied from interface: DatabaseInterface

Add extra attribute on this connection

Specified by:

addAttribute in interface DatabaseInterface

Overrides:

addAttribute in class BaseDatabaseMeta

Parameters:

attributeId - the attribute identifier

value - the value of the attribute

getAccessTypeList

public int[] getAccessTypeList()

Description copied from interface: DatabaseInterface

Get the list of possible access types for a database.

Specified by:

getAccessTypeList in interface DatabaseInterface

Specified by:

getAccessTypeList in class BaseDatabaseMeta

Returns:

the list of possible access types for a database.

getNotFoundTK

public int getNotFoundTK(boolean useAutoinc)

Description copied from interface: DatabaseInterface

Get the not found technical key.

Specified by:

getNotFoundTK in interface DatabaseInterface

Overrides:

getNotFoundTK in class BaseDatabaseMeta

Parameters:

useAutoinc - Whether or not we want to use an auto increment field

Returns:

the lowest possible technical key to be used as the NOT FOUND row in a slowly changing dimension.

See Also:

• DatabaseInterface.getNotFoundTK(boolean)

getDriverClass

public String getDriverClass()

Description copied from interface: DatabaseInterface

Obtain the name of the JDBC driver class that we need to use!

Specified by:

getDriverClass in interface DatabaseInterface

Returns:

the name of the JDBC driver class for the specific database

getURL

public String getURL(String hostname,
 String port,
 String databaseName)

Specified by:

getURL in interface DatabaseInterface

Parameters:

hostname - the hostname

port - the port as a string

databaseName - the database name

Returns:

the URL to use for connecting to the database.

isFetchSizeSupported

public boolean isFetchSizeSupported()

Checks whether or not the command setFetchSize() is supported by the JDBC driver...

Specified by:

isFetchSizeSupported in interface DatabaseInterface

Overrides:

isFetchSizeSupported in class BaseDatabaseMeta

Returns:

true is setFetchSize() is supported!

supportsBitmapIndex

public boolean supportsBitmapIndex()

Specified by:

supportsBitmapIndex in interface DatabaseInterface

Overrides:

supportsBitmapIndex in class BaseDatabaseMeta

Returns:

true if the database supports bitmap indexes

getTruncateTableStatement

public String getTruncateTableStatement(String tableName)

Specified by:

getTruncateTableStatement in interface DatabaseInterface

Overrides:

getTruncateTableStatement in class BaseDatabaseMeta

Parameters:

tableName - The table to be truncated.

Returns:

The SQL statement to truncate a table: remove all rows from it without a transaction

getAddColumnStatement

public String getAddColumnStatement(String tablename,
 ValueMetaInterface v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Generates the SQL statement to add a column to the specified table For this generic type, i set it to the most common possibility.

Specified by:

getAddColumnStatement in interface DatabaseInterface

Parameters:

tablename - The table to add

v - The column defined as a value

tk - the name of the technical key field

useAutoinc - whether or not this field uses auto increment

pk - the name of the primary key field

semicolon - whether or not to add a semi-colon behind the statement.

Returns:

the SQL statement to add a column to the specified table

getModifyColumnStatement

public String getModifyColumnStatement(String tablename,
 ValueMetaInterface v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Generates the SQL statement to modify a column in the specified table

Specified by:

getModifyColumnStatement in interface DatabaseInterface

Parameters:

tablename - The table to add

v - The column defined as a value

tk - the name of the technical key field

useAutoinc - whether or not this field uses auto increment

pk - the name of the primary key field

semicolon - whether or not to add a semi-colon behind the statement.

Returns:

the SQL statement to modify a column in the specified table

getFieldDefinition

public String getFieldDefinition(ValueMetaInterface v,
 String tk,
 String pk,
 boolean useAutoinc,
 boolean addFieldName,
 boolean addCr)

Description copied from interface: DatabaseInterface

Describe a Value as a field in the database.

Specified by:

getFieldDefinition in interface DatabaseInterface

Parameters:

v - The value to describe

tk - The field that's going to be the technical key

pk - The field that's going to be the primary key

useAutoinc - Use autoincrement or not

addFieldName - Add the fieldname to the definition or not

addCr - Add a cariage return at the end of the definition or not.

Returns:

a value described as a field in this database.

getUsedLibraries

public String[] getUsedLibraries()

Specified by:

getUsedLibraries in interface DatabaseInterface

Returns:

the required libraries (in lib) for this database connection.

supportsPreparedStatementMetadataRetrieval

public boolean supportsPreparedStatementMetadataRetrieval()

Most databases allow you to retrieve result metadata by preparing a SELECT statement.

Specified by:

supportsPreparedStatementMetadataRetrieval in interface DatabaseInterface

Overrides:

supportsPreparedStatementMetadataRetrieval in class BaseDatabaseMeta

Returns:

true if the database supports retrieval of query metadata from a prepared statement. False if the query needs to be executed first.

getSQLInsertAutoIncUnknownDimensionRow

public String getSQLInsertAutoIncUnknownDimensionRow(String schemaTable,
 String keyField,
 String versionField)

Get the SQL to insert a new empty unknown record in a dimension.

Specified by:

getSQLInsertAutoIncUnknownDimensionRow in interface DatabaseInterface

Overrides:

getSQLInsertAutoIncUnknownDimensionRow in class BaseDatabaseMeta

Parameters:

schemaTable - the schema-table name to insert into

keyField - The key field

versionField - the version field

Returns:

the SQL to insert the unknown record into the SCD.

setDatabaseDialect

public void setDatabaseDialect(String databaseDialect)

getDatabaseDialect

public String getDatabaseDialect()

getDatabaseDialectInternal

protected DatabaseInterface getDatabaseDialectInternal()

resolveDialect

protected void resolveDialect(String dialectName)

getReservedWords

public String[] getReservedWords()

Specified by:

getReservedWords in interface DatabaseInterface

Overrides:

getReservedWords in class BaseDatabaseMeta

Returns:

an array of reserved words for the database type...

getEndQuote

public String getEndQuote()

Specified by:

getEndQuote in interface DatabaseInterface

Overrides:

getEndQuote in class BaseDatabaseMeta

Returns:

The end quote sequence, mostly just double quote, but sometimes ], ...

getFunctionSum

public String getFunctionSum()

Specified by:

getFunctionSum in interface DatabaseInterface

Overrides:

getFunctionSum in class BaseDatabaseMeta

Returns:

the function for SUM agrregate

getFunctionAverage

public String getFunctionAverage()

Specified by:

getFunctionAverage in interface DatabaseInterface

Overrides:

getFunctionAverage in class BaseDatabaseMeta

Returns:

the function for Average agrregate

getFunctionMinimum

public String getFunctionMinimum()

Specified by:

getFunctionMinimum in interface DatabaseInterface

Overrides:

getFunctionMinimum in class BaseDatabaseMeta

Returns:

the function for Minimum agrregate

getFunctionMaximum

public String getFunctionMaximum()

Specified by:

getFunctionMaximum in interface DatabaseInterface

Overrides:

getFunctionMaximum in class BaseDatabaseMeta

Returns:

the function for Maximum agrregate

getFunctionCount

public String getFunctionCount()

Specified by:

getFunctionCount in interface DatabaseInterface

Overrides:

getFunctionCount in class BaseDatabaseMeta

Returns:

the function for Count agrregate

getSQLQueryFields

public String getSQLQueryFields(String tableName)

Description copied from class: BaseDatabaseMeta

Returns the minimal SQL to launch in order to determine the layout of the resultset for a given database table

Specified by:

getSQLQueryFields in interface DatabaseInterface

Overrides:

getSQLQueryFields in class BaseDatabaseMeta

Parameters:

tableName - The name of the table to determine the layout for

Returns:

The SQL to launch.

getSQLColumnExists

public String getSQLColumnExists(String columnname,
 String tablename)

Specified by:

getSQLColumnExists in interface DatabaseInterface

Overrides:

getSQLColumnExists in class BaseDatabaseMeta

Parameters:

columnname - The column to verify the existance for

tablename - The table to verify the existance for

Returns:

The SQL to execute to verify if the given table exists. If an Exception is thrown for this SQL, we don't have the column.

getSQLTableExists

public String getSQLTableExists(String tableName)

Specified by:

getSQLTableExists in interface DatabaseInterface

Overrides:

getSQLTableExists in class BaseDatabaseMeta

Parameters:

tableName - The table to verify the existance for

Returns:

The SQL to execute to verify if the given table exists. If an Exception is thrown for this SQL, we don't have the table.

getLimitClause

public String getLimitClause(int nrRows)

Specified by:

getLimitClause in interface DatabaseInterface

Overrides:

getLimitClause in class BaseDatabaseMeta

Parameters:

nrRows - The number of rows to which we want to limit the result of the query.

Returns:

the clause after a select statement to limit the number of rows

getSelectCountStatement

public String getSelectCountStatement(String tableName)

Description copied from class: BaseDatabaseMeta

Build the SQL to count the number of rows in the passed table.

Specified by:

getSelectCountStatement in interface DatabaseInterface

Overrides:

getSelectCountStatement in class BaseDatabaseMeta

Returns:

getSQLUnlockTables

public String getSQLUnlockTables(String[] tableName)

Specified by:

getSQLUnlockTables in interface DatabaseInterface

Overrides:

getSQLUnlockTables in class BaseDatabaseMeta

Parameters:

tableName - The names of the tables to unlock

Returns:

The SQL command to unlock database tables. null is returned in case locking is not supported on the target database. null is the default value

getSequenceNoMaxValueOption

public String getSequenceNoMaxValueOption()

Specified by:

getSequenceNoMaxValueOption in interface DatabaseInterface

Overrides:

getSequenceNoMaxValueOption in class BaseDatabaseMeta

Returns:

string with the no max value sequence option.

useSchemaNameForTableList

public boolean useSchemaNameForTableList()

Specified by:

useSchemaNameForTableList in interface DatabaseInterface

Overrides:

useSchemaNameForTableList in class BaseDatabaseMeta

Returns:

true if we need to supply the schema-name to getTables in order to get a correct list of items.

supportsViews

public boolean supportsViews()

Specified by:

supportsViews in interface DatabaseInterface

Overrides:

supportsViews in class BaseDatabaseMeta

Returns:

true if the database supports views

supportsTimeStampToDateConversion

public boolean supportsTimeStampToDateConversion()

Specified by:

supportsTimeStampToDateConversion in interface DatabaseInterface

Overrides:

supportsTimeStampToDateConversion in class BaseDatabaseMeta

Returns:

true if the database supports timestamp to date conversion. For example Interbase doesn't support this!

getCreateTableStatement

public String getCreateTableStatement()

Description copied from class: BaseDatabaseMeta

Customizes the ValueMetaInterface defined in the base

Specified by:

getCreateTableStatement in interface DatabaseInterface

Overrides:

getCreateTableStatement in class BaseDatabaseMeta

Returns:

String the create table statement

supportsAutoGeneratedKeys

public boolean supportsAutoGeneratedKeys()

Specified by:

supportsAutoGeneratedKeys in interface DatabaseInterface

Overrides:

supportsAutoGeneratedKeys in class BaseDatabaseMeta

Returns:

true if the database supports autoGeneratedKeys

getSafeFieldname

public String getSafeFieldname(String fieldName)

Description copied from class: BaseDatabaseMeta

Sanitize a string for usage as a field name

• Append an underscore to any field name that matches a reserved word
• Replaces spaces with underscores
• Prefixes a string with underscore that begins with a number

Specified by:

getSafeFieldname in interface DatabaseInterface

Overrides:

getSafeFieldname in class BaseDatabaseMeta

Parameters:

fieldName - value to sanitize

Returns:

a String safe for usage as a column name without the need for quoting

setSupportsTimestampDataType

public void setSupportsTimestampDataType(boolean b)

Specified by:

setSupportsTimestampDataType in interface DatabaseInterface

Overrides:

setSupportsTimestampDataType in class BaseDatabaseMeta

Parameters:

b - Set to true if the database supports the Timestamp data type (nanosecond precision and all)

supportsTimestampDataType

public boolean supportsTimestampDataType()

Specified by:

supportsTimestampDataType in interface DatabaseInterface

Overrides:

supportsTimestampDataType in class BaseDatabaseMeta

Returns:

true if the database supports the Timestamp data type (nanosecond precision and all)

supportsResultSetMetadataRetrievalOnly

public boolean supportsResultSetMetadataRetrievalOnly()

Specified by:

supportsResultSetMetadataRetrievalOnly in interface DatabaseInterface

Overrides:

supportsResultSetMetadataRetrievalOnly in class BaseDatabaseMeta

Returns:

true if this database only supports metadata retrieval on a result set, never on a statement (even if the statement has been executed)

getSQLValue

public String getSQLValue(ValueMetaInterface valueMeta,
 Object valueData,
 String dateFormat)
                   throws KettleValueException

Description copied from interface: DatabaseInterface

Convert a value in the SQL equivalent. For example, convert String "Pentaho" into 'Pentaho' or into Oracle date format TO_DATE('2012/08/16 15:36:59', 'YYYY/MM/DD HH24:MI:SS')

Specified by:

getSQLValue in interface DatabaseInterface

Overrides:

getSQLValue in class BaseDatabaseMeta

Parameters:

valueMeta - The description of the value. The date format used is taken from this value unless dateFormat is specified (not null or empty)

valueData - The data to convert.

Returns:

The value SQL clause

Throws:

KettleValueException - in case there is a data conversion error.

customizeValueFromSQLType

public ValueMetaInterface customizeValueFromSQLType(ValueMetaInterface v,
 ResultSetMetaData rm,
 int index)
                                             throws SQLException

Description copied from class: BaseDatabaseMeta

Customizes the ValueMetaInterface defined in the base

Specified by:

customizeValueFromSQLType in interface DatabaseInterface

Overrides:

customizeValueFromSQLType in class BaseDatabaseMeta

Parameters:

v - the determined valueMetaInterface

rm - the sql result

index - the index to the column

Returns:

ValueMetaInterface customized with the data base specific types

Throws:

SQLException

isMySQLVariant

public boolean isMySQLVariant()

Specified by:

isMySQLVariant in interface DatabaseInterface

Overrides:

isMySQLVariant in class BaseDatabaseMeta

Returns:

true if the database is a MySQL variant, like MySQL 5.1, InfiniDB, InfoBright, and so on.

generateColumnAlias

public String generateColumnAlias(int columnIndex,
 String suggestedName)

Description copied from interface: DatabaseInterface

Generate a column alias given the column index and suggested name.

Specified by:

generateColumnAlias in interface DatabaseInterface

Overrides:

generateColumnAlias in class BaseDatabaseMeta

Parameters:

columnIndex - Index of column in query

suggestedName - Suggested column name

Returns:

Column alias that is valid for this database

quoteSQLString

public String quoteSQLString(String string)

Description copied from interface: DatabaseInterface

Adds quotes around the string according to the database dialect and also escapes special characters like CR, LF and the quote character itself.

Specified by:

quoteSQLString in interface DatabaseInterface

Overrides:

quoteSQLString in class BaseDatabaseMeta

Returns:

A string that is properly quoted for use in a SQL statement (insert, update, delete, etc)

isExplorable

public boolean isExplorable()

Specified by:

isExplorable in interface DatabaseInterface

Overrides:

isExplorable in class BaseDatabaseMeta

Returns:

true if this is a relational database you can explore. Return false for SAP, PALO, etc.

getMaxColumnsInIndex

public int getMaxColumnsInIndex()

Specified by:

getMaxColumnsInIndex in interface DatabaseInterface

Overrides:

getMaxColumnsInIndex in class BaseDatabaseMeta

Returns:

The maximum number of columns in a database, <=0 means: no known limit

getSQLListOfSchemas

public String getSQLListOfSchemas()

Specified by:

getSQLListOfSchemas in interface DatabaseInterface

Overrides:

getSQLListOfSchemas in class BaseDatabaseMeta

Returns:

the SQL to retrieve the list of schemas or null if the JDBC metadata needs to be used.

supportsNewLinesInSQL

public boolean supportsNewLinesInSQL()

Specified by:

supportsNewLinesInSQL in interface DatabaseInterface

Overrides:

supportsNewLinesInSQL in class BaseDatabaseMeta

Returns:

true if the database supports newlines in a SQL statements.

isSystemTable

public boolean isSystemTable(String tableName)

Specified by:

isSystemTable in interface DatabaseInterface

Overrides:

isSystemTable in class BaseDatabaseMeta

Returns:

true if the specified table is a system table

isDisplaySizeTwiceThePrecision

public boolean isDisplaySizeTwiceThePrecision()

Specified by:

isDisplaySizeTwiceThePrecision in interface DatabaseInterface

Overrides:

isDisplaySizeTwiceThePrecision in class BaseDatabaseMeta

Returns:

Handles the special case of DB2 where the display size returned is twice the precision. In that case, the length is the precision.

requiresCastToVariousForIsNull

public boolean requiresCastToVariousForIsNull()

Specified by:

requiresCastToVariousForIsNull in interface DatabaseInterface

Overrides:

requiresCastToVariousForIsNull in class BaseDatabaseMeta

Returns:

true if the database requires you to cast a parameter to varchar before comparing to null. Only required for DB2 and Vertica

requiresCreateTablePrimaryKeyAppend

public boolean requiresCreateTablePrimaryKeyAppend()

Specified by:

requiresCreateTablePrimaryKeyAppend in interface DatabaseInterface

Overrides:

requiresCreateTablePrimaryKeyAppend in class BaseDatabaseMeta

Returns:

true if we need to append the PRIMARY KEY block in the create table block after the fields, required for Cache.

supportsSequenceNoMaxValueOption

public boolean supportsSequenceNoMaxValueOption()

Specified by:

supportsSequenceNoMaxValueOption in interface DatabaseInterface

Overrides:

supportsSequenceNoMaxValueOption in class BaseDatabaseMeta

Returns:

true if the database supports the NOMAXVALUE sequence option. The default is false, AS/400 and DB2 support this.

setUsingDoubleDecimalAsSchemaTableSeparator

public void setUsingDoubleDecimalAsSchemaTableSeparator(boolean useDoubleDecimalSeparator)

Specified by:

setUsingDoubleDecimalAsSchemaTableSeparator in interface DatabaseInterface

Overrides:

setUsingDoubleDecimalAsSchemaTableSeparator in class BaseDatabaseMeta

Parameters:

useDoubleDecimalSeparator - true if we should use a double decimal separator to specify schema/table combinations on MS-SQL server

isUsingDoubleDecimalAsSchemaTableSeparator

public boolean isUsingDoubleDecimalAsSchemaTableSeparator()

Specified by:

isUsingDoubleDecimalAsSchemaTableSeparator in interface DatabaseInterface

Overrides:

isUsingDoubleDecimalAsSchemaTableSeparator in class BaseDatabaseMeta

Returns:

true if we use a double decimal separator to specify schema/table combinations on MS-SQL server

setForcingIdentifiersToUpperCase

public void setForcingIdentifiersToUpperCase(boolean forceUpperCase)

Specified by:

setForcingIdentifiersToUpperCase in interface DatabaseInterface

Overrides:

setForcingIdentifiersToUpperCase in class BaseDatabaseMeta

Parameters:

forceUpperCase - true if all identifiers should be forced to upper case

isForcingIdentifiersToUpperCase

public boolean isForcingIdentifiersToUpperCase()

Specified by:

isForcingIdentifiersToUpperCase in interface DatabaseInterface

Overrides:

isForcingIdentifiersToUpperCase in class BaseDatabaseMeta

Returns:

true if all identifiers should be forced to upper case

setForcingIdentifiersToLowerCase

public void setForcingIdentifiersToLowerCase(boolean forceUpperCase)

Specified by:

setForcingIdentifiersToLowerCase in interface DatabaseInterface

Overrides:

setForcingIdentifiersToLowerCase in class BaseDatabaseMeta

Parameters:

forceUpperCase - true if all identifiers should be forced to lower case

isForcingIdentifiersToLowerCase

public boolean isForcingIdentifiersToLowerCase()

Specified by:

isForcingIdentifiersToLowerCase in interface DatabaseInterface

Overrides:

isForcingIdentifiersToLowerCase in class BaseDatabaseMeta

Returns:

true if all identifiers should be forced to lower case

setQuoteAllFields

public void setQuoteAllFields(boolean quoteAllFields)

Specified by:

setQuoteAllFields in interface DatabaseInterface

Overrides:

setQuoteAllFields in class BaseDatabaseMeta

Parameters:

quoteAllFields - true if we want the database to stream results (normally this is an option just for MySQL).

isQuoteAllFields

public boolean isQuoteAllFields()

Specified by:

isQuoteAllFields in interface DatabaseInterface

Overrides:

isQuoteAllFields in class BaseDatabaseMeta

Returns:

true if all fields should always be quoted in db

setStreamingResults

public void setStreamingResults(boolean useStreaming)

Specified by:

setStreamingResults in interface DatabaseInterface

Overrides:

setStreamingResults in class BaseDatabaseMeta

Parameters:

useStreaming - true if we want the database to stream results (normally this is an option just for MySQL).

isStreamingResults

public boolean isStreamingResults()

Specified by:

isStreamingResults in interface DatabaseInterface

Overrides:

isStreamingResults in class BaseDatabaseMeta

Returns:

true if the database is streaming results (normally this is an option just for MySQL).

needsToLockAllTables

public boolean needsToLockAllTables()

Specified by:

needsToLockAllTables in interface DatabaseInterface

Overrides:

needsToLockAllTables in class BaseDatabaseMeta

Returns:

true if the database needs all repository tables to be locked, not just one ref table (R_REPOSITORY_LOG)

supportsSetMaxRows

public boolean supportsSetMaxRows()

Specified by:

supportsSetMaxRows in interface DatabaseInterface

Overrides:

supportsSetMaxRows in class BaseDatabaseMeta

Returns:

true if the database supports setting the maximum number of return rows in a resultset.

supportsGetBlob

public boolean supportsGetBlob()

Specified by:

supportsGetBlob in interface DatabaseInterface

Overrides:

supportsGetBlob in class BaseDatabaseMeta

Returns:

true if the database JDBC driver supports getBlob on the resultset. If not we must use getBytes() to get the data.

isDefaultingToUppercase

public boolean isDefaultingToUppercase()

Specified by:

isDefaultingToUppercase in interface DatabaseInterface

Overrides:

isDefaultingToUppercase in class BaseDatabaseMeta

Returns:

true if the database defaults to naming tables and fields in uppercase. True for most databases except for stuborn stuff like Postgres ;-)

setPreserveReservedCase

public void setPreserveReservedCase(boolean b)

Specified by:

setPreserveReservedCase in interface DatabaseInterface

Overrides:

setPreserveReservedCase in class BaseDatabaseMeta

Parameters:

b - Set to true if reserved words' case should be preserved

preserveReservedCase

public boolean preserveReservedCase()

Specified by:

preserveReservedCase in interface DatabaseInterface

Overrides:

preserveReservedCase in class BaseDatabaseMeta

Returns:

true if reserved words' case should be preserved

setSupportsBooleanDataType

public void setSupportsBooleanDataType(boolean b)

Specified by:

setSupportsBooleanDataType in interface DatabaseInterface

Overrides:

setSupportsBooleanDataType in class BaseDatabaseMeta

Parameters:

b - Set to true if the database supports a boolean, bit, logical, ... datatype

supportsBooleanDataType

public boolean supportsBooleanDataType()

Specified by:

supportsBooleanDataType in interface DatabaseInterface

Overrides:

supportsBooleanDataType in class BaseDatabaseMeta

Returns:

true if the database supports a boolean, bit, logical, ... datatype The default is false: map to a string.

supportsBatchUpdates

public boolean supportsBatchUpdates()

Specified by:

supportsBatchUpdates in interface DatabaseInterface

Overrides:

supportsBatchUpdates in class BaseDatabaseMeta

Returns:

true if the database JDBC driver supports batch updates For example Interbase doesn't support this!

getSQLLockTables

public String getSQLLockTables(String[] tableNames)

Specified by:

getSQLLockTables in interface DatabaseInterface

Overrides:

getSQLLockTables in class BaseDatabaseMeta

Parameters:

tableNames - The names of the tables to lock

Returns:

The SQL command to lock database tables for write purposes. null is returned in case locking is not supported on the target database. null is the default value

supportsFloatRoundingOnUpdate

public boolean supportsFloatRoundingOnUpdate()

Description copied from class: BaseDatabaseMeta

Most databases round number(7,2) 17.29999999 to 17.30, but some don't.

Specified by:

supportsFloatRoundingOnUpdate in interface DatabaseInterface

Overrides:

supportsFloatRoundingOnUpdate in class BaseDatabaseMeta

Returns:

true if the database supports roundinf of floating point data on update/insert

supportsSynonyms

public boolean supportsSynonyms()

Specified by:

supportsSynonyms in interface DatabaseInterface

Overrides:

supportsSynonyms in class BaseDatabaseMeta

Returns:

true if the database supports synonyms

getSynonymTypes

public String[] getSynonymTypes()

Specified by:

getSynonymTypes in interface DatabaseInterface

Overrides:

getSynonymTypes in class BaseDatabaseMeta

Returns:

a list of table types to retrieve synonyms for the database

getViewTypes

public String[] getViewTypes()

Specified by:

getViewTypes in interface DatabaseInterface

Overrides:

getViewTypes in class BaseDatabaseMeta

Returns:

a list of table types to retrieve views for the database

getTableTypes

public String[] getTableTypes()

Specified by:

getTableTypes in interface DatabaseInterface

Overrides:

getTableTypes in class BaseDatabaseMeta

Returns:

a list of table types to retrieve tables for the database

getStartQuote

public String getStartQuote()

Specified by:

getStartQuote in interface DatabaseInterface

Overrides:

getStartQuote in class BaseDatabaseMeta

Returns:

The start quote sequence, mostly just double quote, but sometimes [, ...

quoteReservedWords

public boolean quoteReservedWords()

Specified by:

quoteReservedWords in interface DatabaseInterface

Overrides:

quoteReservedWords in class BaseDatabaseMeta

Returns:

true if reserved words need to be double quoted ("password", "select", ...)

getDropColumnStatement

public String getDropColumnStatement(String tablename,
 ValueMetaInterface v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Description copied from class: BaseDatabaseMeta

Generates the SQL statement to drop a column from the specified table

Specified by:

getDropColumnStatement in interface DatabaseInterface

Overrides:

getDropColumnStatement in class BaseDatabaseMeta

Parameters:

tablename - The table to add

v - The column defined as a value

tk - the name of the technical key field

useAutoinc - whether or not this field uses auto increment

pk - the name of the primary key field

semicolon - whether or not to add a semi-colon behind the statement.

Returns:

the SQL statement to drop a column from the specified table

getMaxVARCHARLength

public int getMaxVARCHARLength()

Description copied from class: BaseDatabaseMeta

Get the maximum length of a text field (VARCHAR) for this database connection. If this size is exceeded use a CLOB.

Specified by:

getMaxVARCHARLength in interface DatabaseInterface

Overrides:

getMaxVARCHARLength in class BaseDatabaseMeta

Returns:

The maximum VARCHAR field length for this database type. (mostly identical to getMaxTextFieldLength() - CLOB_LENGTH)

getMaxTextFieldLength

public int getMaxTextFieldLength()

Description copied from class: BaseDatabaseMeta

Get the maximum length of a text field for this database connection. This includes optional CLOB, Memo and Text fields. (the maximum!)

Specified by:

getMaxTextFieldLength in interface DatabaseInterface

Overrides:

getMaxTextFieldLength in class BaseDatabaseMeta

Returns:

The maximum text field length for this database type. (mostly CLOB_LENGTH)

getSchemaTableCombination

public String getSchemaTableCombination(String schemaName,
 String tablePart)

Description copied from class: BaseDatabaseMeta

Get the schema-table combination to query the right table. Usually that is SCHEMA.TABLENAME, however there are exceptions to this rule...

Specified by:

getSchemaTableCombination in interface DatabaseInterface

Overrides:

getSchemaTableCombination in class BaseDatabaseMeta

Parameters:

schemaName - The schema name

tablePart - The tablename

Returns:

the schema-table combination to query the right table.

getDefaultOptions

public Map<String,String> getDefaultOptions()

Specified by:

getDefaultOptions in interface DatabaseInterface

Overrides:

getDefaultOptions in class BaseDatabaseMeta

Returns:

default extra Options

getExtraOptions

public Map<String,String> getExtraOptions()

Specified by:

getExtraOptions in interface DatabaseInterface

Overrides:

getExtraOptions in class BaseDatabaseMeta

Returns:

all the extra options that are set to be used for the database URL

addExtraOption

public void addExtraOption(String databaseTypeCode,
 String option,
 String value)

Description copied from class: BaseDatabaseMeta

Add an extra option to the attributes list

Specified by:

addExtraOption in interface DatabaseInterface

Overrides:

addExtraOption in class BaseDatabaseMeta

Parameters:

databaseTypeCode - The database type code for which the option applies

option - The option to set

value - The value of the option

getExtraOptionSeparator

public String getExtraOptionSeparator()

Specified by:

getExtraOptionSeparator in interface DatabaseInterface

Overrides:

getExtraOptionSeparator in class BaseDatabaseMeta

Returns:

The extra option separator in database URL for this platform (usually this is semicolon ; )

getExtraOptionValueSeparator

public String getExtraOptionValueSeparator()

Specified by:

getExtraOptionValueSeparator in interface DatabaseInterface

Overrides:

getExtraOptionValueSeparator in class BaseDatabaseMeta

Returns:

The extra option value separator in database URL for this platform (usually this is the equal sign = )

getExtraOptionIndicator

public String getExtraOptionIndicator()

Specified by:

getExtraOptionIndicator in interface DatabaseInterface

Overrides:

getExtraOptionIndicator in class BaseDatabaseMeta

Returns:

This indicator separates the normal URL from the options

supportsOptionsInURL

public boolean supportsOptionsInURL()

Specified by:

supportsOptionsInURL in interface DatabaseInterface

Overrides:

supportsOptionsInURL in class BaseDatabaseMeta

Returns:

true if the database supports connection options in the URL, false if they are put in a Properties object.

getExtraOptionsHelpText

public String getExtraOptionsHelpText()

Specified by:

getExtraOptionsHelpText in interface DatabaseInterface

Overrides:

getExtraOptionsHelpText in class BaseDatabaseMeta

Returns:

extra help text on the supported options on the selected database platform.