InformixDatabaseMeta (PDI Core 9.1.0.0-317 API)

java.lang.Object
- org.pentaho.di.core.database.BaseDatabaseMeta
- - org.pentaho.di.core.database.InformixDatabaseMeta

All Implemented Interfaces:

Cloneable, DatabaseInterface, DatabaseInterfaceExtended
```
public class InformixDatabaseMeta
extends BaseDatabaseMeta
implements DatabaseInterface
```
Contains Informix specific information through static final members

Since:

11-mrt-2005

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

Constructor Summary

Constructors
Constructor and Description

InformixDatabaseMeta()

Constructors
Constructor and Description
`InformixDatabaseMeta()`

Method Summary

All Methods Instance Methods Concrete 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 useAutoinc, String pk, boolean semicolon)` Generates the SQL statement to add a column to the specified table
`int`	`getDefaultDatabasePort()`
`String`	`getDriverClass()` Obtain the name of the JDBC driver class that we need to use!
`String`	`getFieldDefinition(ValueMetaInterface v, String tk, String pk, boolean useAutoinc, boolean addFieldName, boolean addCr)` Describe a Value as a field in the database.
`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`	`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`	`getSQLLockTables(String[] tableNames)`
`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`	`getSQLTableExists(String tablename)`
`String`	`getSQLUnlockTables(String[] tableNames)`
`String`	`getURL(String hostname, String port, String databaseName)`
`String[]`	`getUsedLibraries()`
`boolean`	`needsPlaceHolder()` Indicates the need to insert a placeholder (0) for auto increment fields.
`boolean`	`needsToLockAllTables()`

Methods inherited from class org.pentaho.di.core.database.BaseDatabaseMeta
addAttribute, addDefaultOptions, addExtraOption, canTest, checkIndexExists, clone, customizeValueFromSQLType, fullExceptionLog, generateColumnAlias, getAccessType, getAttribute, getAttributes, getBackwardsCompatibleSchemaTableCombination, getBackwardsCompatibleTable, getConnectionPoolingProperties, getConnectSQL, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultOptions, getDisplayName, getDropColumnStatement, getDropTableIfExistsStatement, getEndQuote, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFieldnameProtector, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getInitialPoolSizeString, getLimitClause, getMaxColumnsInIndex, getMaximumPoolSize, getMaximumPoolSizeString, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNamedCluster, getNextBatchId, getNextBatchIdUsingAutoIncSQL, getNextBatchIdUsingLockTables, getNextBatchIdUsingSequence, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getReservedWords, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSQLCurrentSequenceValue, getSQLListOfProcedures, getSQLListOfSchemas, getSQLListOfSequences, getSQLNextSequenceValue, getSqlScriptStatements, getSQLSequenceExists, 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, onlySpaces, parseStatements, preserveReservedCase, quoteReservedWords, quoteSQLString, releaseSavepoint, requiresCastToVariousForIsNull, requiresCreateTablePrimaryKeyAppend, requiresName, setAccessType, setAttributes, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setInitialPoolSizeString, setMaximumPoolSize, setMaximumPoolSizeString, setName, setNamedCluster, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoGeneratedKeys, supportsAutoInc, supportsBatchUpdates, supportsBitmapIndex, supportsBooleanDataType, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsNewLinesInSQL, supportsOptionsInURL, supportsPreparedStatementMetadataRetrieval, supportsRepository, supportsResultSetMetadataRetrievalOnly, supportsSchemas, supportsSequenceNoMaxValueOption, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsSetMaxRows, supportsSynonyms, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, supportsViews, useSafePoints, useSchemaNameForTableList

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
addAttribute, addDefaultOptions, addExtraOption, checkIndexExists, clone, createSqlScriptParser, customizeValueFromSQLType, generateColumnAlias, getAccessType, getAttribute, getAttributes, getConnectionPoolingProperties, getConnectSQL, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultOptions, getDisplayName, getDropColumnStatement, getEndQuote, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getInitialPoolSizeString, getLegacyColumnName, getLimitClause, getMaxColumnsInIndex, getMaximumPoolSize, getMaximumPoolSizeString, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNamedCluster, getNamedClusterList, getNextBatchId, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getReservedWords, getSafeFieldname, getSchemas, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSQLCurrentSequenceValue, getSQLListOfProcedures, getSQLListOfSchemas, getSQLListOfSequences, getSQLNextSequenceValue, getSqlScriptStatements, getSQLSequenceExists, getSQLValue, getStartQuote, getSynonymTypes, getTables, getTableTypes, getTruncateTableStatement, getUnsupportedTableOutputMessage, getUsername, getValueFromResultSet, getViewTypes, getXulOverlayFile, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isMySQLVariant, isPartitioned, isQuoteAllFields, isRequiringTransactionsOnQueries, isStreamingResults, isSystemTable, isUsingConnectionPool, isUsingDoubleDecimalAsSchemaTableSeparator, parseStatements, preserveReservedCase, putOptionalOptions, quoteReservedWords, quoteSQLString, releaseSavepoint, requiresCastToVariousForIsNull, requiresCreateTablePrimaryKeyAppend, setAccessType, setAttributes, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setInitialPoolSizeString, setMaximumPoolSize, setMaximumPoolSizeString, setName, setNamedCluster, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoGeneratedKeys, supportsAutoInc, supportsBatchUpdates, supportsBitmapIndex, supportsBooleanDataType, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsIndexes, supportsNewLinesInSQL, supportsOptionsInURL, supportsPreparedStatementMetadataRetrieval, supportsRepository, supportsResultSetMetadataRetrievalOnly, supportsSchemas, supportsSequenceNoMaxValueOption, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsSetMaxRows, supportsStandardTableOutput, supportsSynonyms, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, supportsViews, useSafePoints, useSchemaNameForTableList

- Constructor Detail
  - InformixDatabaseMeta
```
public InformixDatabaseMeta()
```
- 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.
  - getDefaultDatabasePort
```
public int getDefaultDatabasePort()
```
    Specified by:
    
    getDefaultDatabasePort in interface DatabaseInterface
    
    Overrides:
    
    getDefaultDatabasePort in class BaseDatabaseMeta
    
    Returns:
    
    the default database port number
  - 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.
  - needsPlaceHolder
```
public boolean needsPlaceHolder()
```
    Indicates the need to insert a placeholder (0) for auto increment fields.
    
    Specified by:
    
    needsPlaceHolder in interface DatabaseInterface
    
    Overrides:
    
    needsPlaceHolder in class BaseDatabaseMeta
    
    Returns:
    
    true if we need a placeholder for auto increment fields in insert statements.
  - 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)
  - 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.
  - 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)
```
  - 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
    
    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.
  - 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.
  - 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.

Class InformixDatabaseMeta

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InformixDatabaseMeta

Method Detail

getAccessTypeList

getDefaultDatabasePort

getNotFoundTK

getDriverClass

getURL

needsPlaceHolder

needsToLockAllTables

getSQLQueryFields

getSQLTableExists

getSQLColumnExists

getSQLQueryColumnFields

getAddColumnStatement

getModifyColumnStatement

getFieldDefinition

getSQLLockTables

getSQLUnlockTables

getUsedLibraries

getSQLInsertAutoIncUnknownDimensionRow