org.pentaho.di.core.database

Class OracleRDBDatabaseMeta

java.lang.Object

org.pentaho.di.core.database.BaseDatabaseMeta

org.pentaho.di.core.database.OracleRDBDatabaseMeta

All Implemented Interfaces:

Cloneable, DatabaseInterface, DatabaseInterfaceExtended

public class OracleRDBDatabaseMeta
extends BaseDatabaseMeta
implements DatabaseInterface

Contains Oracle RDB specific information through static final members

Since:

27-jul-2006

Author:

Matt

Field Summary

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, poolingParameters, SELECT_COUNT_STATEMENT, SEQUENCE_FOR_BATCH_ID

Constructor Summary

Constructors

Constructor and Description
OracleRDBDatabaseMeta()

Method Summary

Modifier and Type	Method and Description
int[]	getAccessTypeList() Get the list of possible access types for a database.
String	getAddColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean use_autoinc, String pk, boolean semicolon) Generates the SQL statement to add a column to the specified table
String	getDriverClass() Obtain the name of the JDBC driver class that we need to use!
String	getDropColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean use_autoinc, String pk, boolean semicolon) Generates the SQL statement to drop a column from the specified table
String	getFieldDefinition(ValueMetaInterface v, String tk, String pk, boolean use_autoinc, boolean add_fieldname, boolean add_cr) Describe a Value as a field in the database.
String	getLimitClause(int nrRows)
String	getModifyColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean use_autoinc, String pk, boolean semicolon) Generates the SQL statement to modify a column in the specified table
String[]	getReservedWords()
String	getSQLColumnExists(String columnname, String tablename)
String	getSQLCurrentSequenceValue(String sequenceName) Get the current value of a database sequence
String	getSQLListOfSequences()
String	getSQLLockTables(String[] tableNames)
String	getSQLNextSequenceValue(String sequenceName) Get the SQL to get the next value of a sequence.
String	getSQLQueryColumnFields(String columnname, String tableName)
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	getSQLSequenceExists(String sequenceName) Check if a sequence exists.
String	getSQLTableExists(String tablename)
String	getSQLUnlockTables(String[] tableNames)
String	getURL(String hostname, String port, String databaseName)
String[]	getUsedLibraries()
boolean	supportsAutoInc()
boolean	supportsOptionsInURL() Oracle doesn't support options in the URL, we need to put these in a Properties object at connection time...
boolean	supportsSequences()
boolean	supportsSynonyms()
boolean	useSchemaNameForTableList()

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

addDefaultOptions, addExtraOption, canTest, checkIndexExists, clone, customizeValueFromSQLType, fullExceptionLog, generateColumnAlias, getAccessType, getAttributes, getBackwardsCompatibleSchemaTableCombination, getBackwardsCompatibleTable, getConnectionPoolingProperties, getConnectSQL, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultDatabasePort, getDefaultOptions, getDisplayName, getDropTableIfExistsStatement, getEndQuote, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getMaxColumnsInIndex, getMaximumPoolSize, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNextBatchId, getNextBatchIdUsingAutoIncSQL, getNextBatchIdUsingLockTables, getNextBatchIdUsingSequence, getNotFoundTK, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSQLInsertAutoIncUnknownDimensionRow, getSQLListOfProcedures, getSQLListOfSchemas, getSqlScriptStatements, getSQLValue, getStartQuote, getSynonymTypes, getTablespaceDDL, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, getXulOverlayFile, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isMySQLVariant, isPartitioned, isQuoteAllFields, isRequiringTransactionsOnQueries, isStreamingResults, isSystemTable, isUsingConnectionPool, isUsingDoubleDecimalAsSchemaTableSeparator, needsPlaceHolder, needsToLockAllTables, parseStatements, preserveReservedCase, quoteReservedWords, quoteSQLString, releaseSavepoint, requiresCastToVariousForIsNull, requiresCreateTablePrimaryKeyAppend, requiresName, setAccessType, setAttributes, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setMaximumPoolSize, setName, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoGeneratedKeys, supportsBatchUpdates, supportsBitmapIndex, supportsBooleanDataType, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsNewLinesInSQL, supportsPreparedStatementMetadataRetrieval, supportsRepository, supportsResultSetMetadataRetrievalOnly, supportsSchemas, supportsSequenceNoMaxValueOption, supportsSetCharacterStream, supportsSetLong, supportsSetMaxRows, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, supportsViews, useSafePoints

Methods inherited from class java.lang.Object

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

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

addDefaultOptions, addExtraOption, checkIndexExists, clone, customizeValueFromSQLType, generateColumnAlias, getAccessType, getAttributes, getConnectionPoolingProperties, getConnectSQL, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultDatabasePort, getDefaultOptions, getDisplayName, getEndQuote, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getMaxColumnsInIndex, getMaximumPoolSize, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNextBatchId, getNotFoundTK, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSQLInsertAutoIncUnknownDimensionRow, getSQLListOfProcedures, getSQLListOfSchemas, getSqlScriptStatements, getSQLValue, getStartQuote, getSynonymTypes, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, getXulOverlayFile, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isMySQLVariant, isPartitioned, isQuoteAllFields, isRequiringTransactionsOnQueries, isStreamingResults, isSystemTable, isUsingConnectionPool, isUsingDoubleDecimalAsSchemaTableSeparator, needsPlaceHolder, needsToLockAllTables, parseStatements, preserveReservedCase, quoteReservedWords, quoteSQLString, releaseSavepoint, requiresCastToVariousForIsNull, requiresCreateTablePrimaryKeyAppend, setAccessType, setAttributes, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setMaximumPoolSize, setName, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoGeneratedKeys, supportsBatchUpdates, supportsBitmapIndex, supportsBooleanDataType, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsNewLinesInSQL, supportsPreparedStatementMetadataRetrieval, supportsRepository, supportsResultSetMetadataRetrievalOnly, supportsSchemas, supportsSequenceNoMaxValueOption, supportsSetCharacterStream, supportsSetLong, supportsSetMaxRows, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, supportsViews, useSafePoints

Constructor Detail

OracleRDBDatabaseMeta

public OracleRDBDatabaseMeta()

Method Detail

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.

supportsAutoInc

public boolean supportsAutoInc()

Specified by:

supportsAutoInc in interface DatabaseInterface

Overrides:

supportsAutoInc in class BaseDatabaseMeta

Returns:

Whether or not the database can use auto increment type of fields (pk)

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

See Also:

DatabaseInterface.getLimitClause(int)

getSQLQueryFields

public String getSQLQueryFields(String tableName)

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.

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.

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.

getSQLQueryColumnFields

public String getSQLQueryColumnFields(String columnname,
                                      String tableName)

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)
              throws KettleDatabaseException

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.

Throws:

KettleDatabaseException - in case a configuration error is detected.

supportsOptionsInURL

public boolean supportsOptionsInURL()

Oracle doesn't support options in the URL, we need to put these in a Properties object at connection time...

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.

supportsSequences

public boolean supportsSequences()

Specified by:

supportsSequences in interface DatabaseInterface

Overrides:

supportsSequences in class BaseDatabaseMeta

Returns:

true if the database supports sequences

getSQLListOfSequences

public String getSQLListOfSequences()

Specified by:

getSQLListOfSequences in interface DatabaseInterface

Overrides:

getSQLListOfSequences in class BaseDatabaseMeta

Returns:

The SQL on this database to get a list of sequences.

getSQLSequenceExists

public String getSQLSequenceExists(String sequenceName)

Check if a sequence exists.

Specified by:

getSQLSequenceExists in interface DatabaseInterface

Overrides:

getSQLSequenceExists in class BaseDatabaseMeta

Parameters:

sequenceName - The sequence to check

Returns:

The SQL to get the name of the sequence back from the databases data dictionary

getSQLCurrentSequenceValue

public String getSQLCurrentSequenceValue(String sequenceName)

Get the current value of a database sequence

Specified by:

getSQLCurrentSequenceValue in interface DatabaseInterface

Overrides:

getSQLCurrentSequenceValue in class BaseDatabaseMeta

Parameters:

sequenceName - The sequence to check

Returns:

The current value of a database sequence

getSQLNextSequenceValue

public String getSQLNextSequenceValue(String sequenceName)

Get the SQL to get the next value of a sequence. (Oracle only)

Specified by:

getSQLNextSequenceValue in interface DatabaseInterface

Overrides:

getSQLNextSequenceValue in class BaseDatabaseMeta

Parameters:

sequenceName - The sequence name

Returns:

the SQL to get the next value of a sequence. (Oracle only)

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.

supportsSynonyms

public boolean supportsSynonyms()

Specified by:

supportsSynonyms in interface DatabaseInterface

Overrides:

supportsSynonyms in class BaseDatabaseMeta

Returns:

true if the database supports synonyms

getAddColumnStatement

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

Generates the SQL statement to add a column to the specified table

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

use_autoinc - 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

getDropColumnStatement

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

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

use_autoinc - 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

getModifyColumnStatement

public String getModifyColumnStatement(String tablename,
                                       ValueMetaInterface v,
                                       String tk,
                                       boolean use_autoinc,
                                       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

use_autoinc - 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 use_autoinc,
                                 boolean add_fieldname,
                                 boolean add_cr)

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

use_autoinc - Use autoincrement or not

add_fieldname - Add the fieldname to the definition or not

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

Returns:

a value described as a field in this database.

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...

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

getSQLUnlockTables

public String getSQLUnlockTables(String[] tableNames)

Specified by:

getSQLUnlockTables in interface DatabaseInterface

Overrides:

getSQLUnlockTables in class BaseDatabaseMeta

Parameters:

tableNames - 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

getUsedLibraries

public String[] getUsedLibraries()

Specified by:

getUsedLibraries in interface DatabaseInterface

Returns:

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