org.pentaho.di.core.database

Class KettleDatabaseMeta

java.lang.Object

org.pentaho.di.core.database.BaseDatabaseMeta

org.pentaho.di.core.database.KettleDatabaseMeta

All Implemented Interfaces:

Cloneable, DatabaseInterface

public class KettleDatabaseMeta
extends BaseDatabaseMeta
implements DatabaseInterface

Contains the wrapper for the Kettle Think JDBC driver database connection information through static final members

Since:

9-jul-2012

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
KettleDatabaseMeta()

Method Summary

Methods

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	getExtraOptionIndicator()
String	getExtraOptionSeparator()
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	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	getURL(String hostname, String port, String databaseName)
String[]	getUsedLibraries()
boolean	isFetchSizeSupported() Checks whether or not the command setFetchSize() is supported by the JDBC driver...
boolean	supportsBitmapIndex()
boolean	supportsBooleanDataType()
boolean	supportsCatalogs()
boolean	supportsNewLinesInSQL()
boolean	supportsOptionsInURL()
boolean	supportsPreparedStatementMetadataRetrieval() Most databases allow you to retrieve result metadata by preparing a SELECT statement.
boolean	supportsRepository()
boolean	supportsSchemas()
boolean	supportsSetMaxRows()
boolean	supportsSynonyms()
boolean	supportsViews()

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

addExtraOption, checkIndexExists, clone, generateColumnAlias, getAccessType, getAttributes, getBackwardsCompatibleSchemaTableCombination, getBackwardsCompatibleTable, getConnectionPoolingProperties, getConnectSQL, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultDatabasePort, getDropColumnStatement, getEndQuote, getExtraOptions, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getLimitClause, getMaxColumnsInIndex, getMaximumPoolSize, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNextBatchId, getNextBatchIdUsingAutoIncSQL, getNextBatchIdUsingLockTables, getNextBatchIdUsingSequence, getNotFoundTK, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getReservedWords, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getServername, getSQLColumnExists, getSQLCurrentSequenceValue, getSQLInsertAutoIncUnknownDimensionRow, getSQLListOfProcedures, getSQLListOfSchemas, getSQLListOfSequences, getSQLLockTables, getSQLNextSequenceValue, getSQLQueryFields, getSqlScriptStatements, getSQLSequenceExists, getSQLTableExists, getSQLUnlockTables, getSQLValue, getStartQuote, getSynonymTypes, getTablespaceDDL, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, getXulOverlayFile, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isExplorable, 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, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setMaximumPoolSize, setName, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoInc, supportsBatchUpdates, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsResultSetMetadataRetrievalOnly, supportsSequenceNoMaxValueOption, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, useSafePoints, useSchemaNameForTableList

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

addExtraOption, checkIndexExists, clone, generateColumnAlias, getAccessType, getAttributes, getConnectionPoolingProperties, getConnectSQL, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultDatabasePort, getDropColumnStatement, getEndQuote, getExtraOptions, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getLimitClause, getMaxColumnsInIndex, getMaximumPoolSize, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNextBatchId, getNotFoundTK, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getReservedWords, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getServername, getSQLColumnExists, getSQLCurrentSequenceValue, getSQLInsertAutoIncUnknownDimensionRow, getSQLListOfProcedures, getSQLListOfSchemas, getSQLListOfSequences, getSQLLockTables, getSQLNextSequenceValue, getSQLQueryFields, getSqlScriptStatements, getSQLSequenceExists, getSQLTableExists, getSQLUnlockTables, getSQLValue, getStartQuote, getSynonymTypes, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, getXulOverlayFile, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isExplorable, 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, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setMaximumPoolSize, setName, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoInc, supportsBatchUpdates, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsResultSetMetadataRetrievalOnly, supportsSequenceNoMaxValueOption, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, useSafePoints, useSchemaNameForTableList

Constructor Detail

KettleDatabaseMeta

public KettleDatabaseMeta()

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.

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.

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.

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

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 ; )

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!

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.

supportsBitmapIndex

public boolean supportsBitmapIndex()

Specified by:

supportsBitmapIndex in interface DatabaseInterface

Overrides:

supportsBitmapIndex in class BaseDatabaseMeta

Returns:

true if the database supports bitmap indexes

supportsSchemas

public boolean supportsSchemas()

Specified by:

supportsSchemas in interface DatabaseInterface

Overrides:

supportsSchemas in class BaseDatabaseMeta

Returns:

true if the database supports schemas

supportsSynonyms

public boolean supportsSynonyms()

Specified by:

supportsSynonyms in interface DatabaseInterface

Overrides:

supportsSynonyms in class BaseDatabaseMeta

Returns:

true if the database supports synonyms

supportsCatalogs

public boolean supportsCatalogs()

Specified by:

supportsCatalogs in interface DatabaseInterface

Overrides:

supportsCatalogs in class BaseDatabaseMeta

Returns:

true if the database supports catalogs

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.

supportsViews

public boolean supportsViews()

Specified by:

supportsViews in interface DatabaseInterface

Overrides:

supportsViews in class BaseDatabaseMeta

Returns:

true if the database supports views

supportsRepository

public boolean supportsRepository()

Specified by:

supportsRepository in interface DatabaseInterface

Overrides:

supportsRepository in class BaseDatabaseMeta

Returns:

true if Kettle can create a repository on this type of database.

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.

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.

getAddColumnStatement

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

Description copied from interface: DatabaseInterface

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

getModifyColumnStatement

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

Description copied from interface: DatabaseInterface

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

getUsedLibraries

public String[] getUsedLibraries()

Specified by:

getUsedLibraries in interface DatabaseInterface

Returns:

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

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.