AbstractDriver (Toolsverse API Reference 5.9)

Object
- com.toolsverse.etl.driver.AbstractDriver

All Implemented Interfaces:

Driver, ExtensionModule, Serializable, Comparable<ExtensionModule>

Direct Known Subclasses:

CallableDriver, SimpleDriver
```
public abstract class AbstractDriver
extends Object
implements Driver
```
The base abstract implementation of the Driver interface.

Since:

1.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Set<Character> ALLOWED_IDENT_CHARS
The ALLOWED identifier chars.
- Fields inherited from interface com.toolsverse.etl.driver.Driver
  BASE_CLASS_PATH, CASE_SENSITIVE_LOWER, CASE_SENSITIVE_LOWER_STR, CASE_SENSITIVE_UNDEFINED, CASE_SENSITIVE_UPPER, CASE_SENSITIVE_UPPER_STR, CMD_OPTIONS_PARAM, DB_PARAM, DDL_TYPE, ETL_CODE, FUNC_TYPE, PROC_TYPE, SERVER_PARAM, TABLE_TYPE
- Fields inherited from interface com.toolsverse.ext.ExtensionModule
  APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET

Fields
Modifier and Type	Field and Description
`static Set<Character>`	`ALLOWED_IDENT_CHARS` The ALLOWED identifier chars.

Constructor Summary

Constructors
Constructor and Description

AbstractDriver()

Constructors
Constructor and Description
`AbstractDriver()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`alwaysEncloseTableAndColumnsInQuotes()` Check if system should always enclose table and columns in quotes.
`Object`	`captureLog(Connection con)` Capture database log, for example provided by Oracle dbms_output.put_line
`int`	`compareTo(ExtensionModule ext)`
`boolean`	`externalToolRequiresRedirect()` Checks if external tool requires redirect of the output to the file.
`String`	`filter(String value)` Filters string.
`String`	`getAddColumnSql()` Gets the ADD COLUMN SQL.
`Set<Character>`	`getAllowedIdentifierChars()` Gets the allowed identifier chars.
`String`	`getAlterTableAddColumnSql(String name, FieldDef column, FieldsRepository fieldsRepository)` Gets the alter table add column sql.
`String`	`getAlterTableAddColumnSql(String name, FieldDef column, FieldsRepository fieldsRepository, boolean withNotNull)` Gets the alter table add column sql.
`Object`	`getAutotrace(ObjectStorage storage, Connection connection, Alias alias, String sql)` Executes sql and produces real execution plan.
`int`	`getCaseSensitive()` Gets the "case sensitive" flag.
`static String`	`getCmdOptions(Alias alias)` Gets the command line options.
`String`	`getColumns(String name, DataSet dataSet, String key, FieldsRepository fieldsRepository)` Gets the columns for "create table" sql.
`String`	`getConfigFileName()` Gets the path to the configuration file for the module.
`TypedKeyValue<String,String>`	`getConnectionFile(Alias alias)` Gets the connection aliases file for the database, for example tnsnames.ora.
`String`	`getDefaultNull()` Gets the "default null" value.
`String`	`getDeleteStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues, String tableName, String key)` Gets the delete statement.
`String`	`getDelimiter()` Gets the default delimiter.
`String`	`getDisplayName()` Gets the display name.
`String`	`getErrorLinePattern()` Gets the "error line" pattern".
`int`	`getExtensionRank()` Gets the extension rank.
`String`	`getHome(ObjectStorage storage)` Gets the home folder for the native database client.
`protected String`	`getIdentifierName(String name, int size)` Gets the identifier name.
`String`	`getIdentifierName(String name, String type)` Gets the identifier name.
`String`	`getInsertStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues, String tableName)` Gets the insert statement.
`String`	`getLicensePropertyName()` Gets the name of the license property.
`String`	`getLocalUnitClassPath()` If extension module is a "local" it must return the path to it's corresponding Unit.
`String`	`getMergeStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues, String tableName, String key)` Gets the merge statement.
`String`	`getNativeType(FieldDef fieldDef, String key, FieldsRepository fieldsRepository)` Gets the native field from native field type.
`String`	`getObjectCheckSql(String name)` Gets the sql used to check if object exists.
`Driver`	`getParentDriver()` Gets the parent driver.
`String`	`getPostDeclareSql()` This sql is added after all variables declared.
`String[]`	`getProperties()` Gets the properties.
`String`	`getSafeDelimiter()` Gets the safe delimiter which can be added to any sql statetement.
`String`	`getSafeSql(String sql)` Gets the safe sql.
`String`	`getSelectStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues, String tableName)` Gets the select statement.
`String`	`getSqlForAutotrace(ObjectStorage storage, String sql)` Gets the SQL for autotrace.
`String`	`getSqlForExplainPlan(String sql, SqlParser parser)` Gets the sql for the explain plan.
`String`	`getSqlKeywordsFileName()` Gets the sql keywords file name.
`String`	`getStartTransactionSql()` Get start transaction sql.
`int`	`getStringFieldSizeMultiplier()` Gets the string field size multiplier.
`String`	`getTableName(String name)` Gets the table name.
`String`	`getTablePrefixWhenAddingTable(String tableName)` Gets the table prefix when adding table.
`String`	`getType()` Gets the type of the extension module.
`String`	`getUpdateStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues, String tableName, String key)` Gets the update statement.
`boolean`	`isEqualDriver(Driver driver)` Checks if given driver equals to this driver.
`boolean`	`isMergeInNonCallableSupported()` Checks if "merge" statement can be not callable.
`boolean`	`needSeparateConnectionForDdl()` Check if driver requires separate connection for ddl statements.
`boolean`	`requiresExecuteQuery()` Checks if driver requires to run as st.executeQuery() in some cases.
`boolean`	`requiresRollbackAfterSqlError()` Returns true if database requires rollback after sql error.
`boolean`	`requiresSeparateConnectionForIndexes()` Checks if driver requires separate connection for indexes.
`void`	`setAlwaysEncloseTableAndColumnsInQuotes(boolean value)` Sets the value of the flag "always enclose table and columns in quotes".
`void`	`setCaseSensitive(int value)` Sets the case sensitive attribute.
`void`	`setStringFieldSizeMultiplier(int multiplier)` Sets the sclale string field size.
`void`	`setUpConnection(Connection con, boolean before)` Set the up connection to enbale database logging, for example dbms_output.enable()
`boolean`	`supportColonInFormatter()` Support colon in formatter.
`String`	`supportsAutotrace()` Checks if driver supports autotrace.
`boolean`	`supportsLogging()` Checks if drivers supports database logging such as Oracle dbms_output.
`boolean`	`supportsNotNullable()` Checks is driver supports not nullable collumns.
`boolean`	`supportsParallelExtract()` "Supports parallel extract" flag.
`boolean`	`supportsParallelLoad()` "Supports parallel load" flag.
`boolean`	`supportsParentDriver()` Used internally to make a disition is it possible to use a generic jdbc driver with a parent driver.
`boolean`	`supportsPreparedStatement()` Supports prepared statements.
`boolean`	`supportsPreparedStatementInParallelThreads()` Supports prepared statement in parallel threads.
`boolean`	`supportsPreparedStatementInTransaction()` Supports prepared statement in transaction.
`String`	`tableName2Name(String name)` Converts table name to name.
`boolean`	`typeHasSize(int type, String nativeDataType)` Returns `true` if `type` has size.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.toolsverse.etl.driver.Driver
convertStringForStorage, convertValueForStorage, deleteStagingBinary, disableMetadataOnWrite, getBegin, getBeginSplited, getBlob, getCallSql, getCharUsedForColumnsWithSpaces, getClob, getCmdForExternalTool, getCreateTableSql, getCursorLoopEndSql, getCursorLoopStartSql, getCursorRecAccessSql, getDeclare, getDeclareCursorEndSql, getDeclareCursorSql, getDeclareCursorVarSql, getDefaultFunctionClass, getDefaultType, getDestinationInfo, getDropSql, getEnd, getEndSplited, getExplainPlan, getExternalToolName, getIf, getIfBegin, getIfElse, getIfEnd, getInitSql, getIoProcessorClassName, getJdbcDriverClassName, getLinesLimit, getMaxCharSize, getMaxPrecision, getMaxScale, getMaxStringLiteralSize, getMaxVarcharSize, getMetadataClassName, getMetadataSelectClause, getMetadataWhereClause, getName, getObject, getOnException, getOnExceptionBegin, getOnExceptionEnd, getParamType, getParentDriverName, getPrecision, getPropsWizardResource, getSqlForExternalTool, getTempTableName, getTopSelectClause, getTopTrailClause, getTopWhereClause, getType, getUrlPattern, getVarDeclare, getVarName, getWrongScale, ifDoesNotExistSql, ifExistsSql, ignoreExceptionsDuringInit, openCloseConnectionOnDdl, replaceOnException, requiresSemicolonInMerge, setBlob, setClob, setInitSql, setLinesLimit, setMaxCharSize, setMaxPrecision, setMaxScale, setMaxStringLiteralSize, setMaxVarcharSize, setParentDriverName, supportedJoinTypes, supportedSetOperations, supportsAnonymousBlocks, supportsBinaryInProc, supportsCallableStatement, supportsExplainPlan, supportsExternalTool, supportsIndexes, supportsInnerFunctions, supportsParamsInAnonymousBlocks, supportsRollbackAfterDDL, supportsScripts, updateStagingBlob, updateStagingClob, value2StorageValue

Methods inherited from interface com.toolsverse.ext.ExtensionModule
getIconPath, getVendor, getVersion, getXmlConfigFileName

- Field Detail
  - ALLOWED_IDENT_CHARS
```
public static Set<Character> ALLOWED_IDENT_CHARS
```
    The ALLOWED identifier chars.
- Constructor Detail
  - AbstractDriver
```
public AbstractDriver()
```
- Method Detail
  - getCmdOptions
```
public static String getCmdOptions(Alias alias)
```
    Gets the command line options.
    
    Parameters:
    
    alias - the alias
    
    Returns:
    
    the command line options
  - captureLog
```
public Object captureLog(Connection con)
                  throws Exception
```
    Description copied from interface: Driver
    
    Capture database log, for example provided by Oracle dbms_output.put_line
    
    Specified by:
    
    captureLog in interface Driver
    
    Parameters:
    
    con - the connection
    
    Returns:
    
    the log, usually either String or RestlSet
    
    Throws:
    
    Exception - in case of any error
  - compareTo
```
public int compareTo(ExtensionModule ext)
```
    Specified by:
    
    compareTo in interface Comparable<ExtensionModule>
  - externalToolRequiresRedirect
```
public boolean externalToolRequiresRedirect()
```
    Description copied from interface: Driver
    
    Checks if external tool requires redirect of the output to the file.
    
    Specified by:
    
    externalToolRequiresRedirect in interface Driver
    
    Returns:
    
    true if external tool requires redirect of the output to the file
  - filter
```
public String filter(String value)
```
    Description copied from interface: Driver
    
    Filters string. Usually removes prohibited characters.
    
    Specified by:
    
    filter in interface Driver
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the string
  - getAllowedIdentifierChars
```
public Set<Character> getAllowedIdentifierChars()
```
    Description copied from interface: Driver
    
    Gets the allowed identifier chars.
    
    Specified by:
    
    getAllowedIdentifierChars in interface Driver
    
    Returns:
    
    the allowed identifier chars
  - getAutotrace
```
public Object getAutotrace(ObjectStorage storage,
                           Connection connection,
                           Alias alias,
                           String sql)
```
    Description copied from interface: Driver
    
    Executes sql and produces real execution plan.
    
    Specified by:
    
    getAutotrace in interface Driver
    
    Parameters:
    
    storage - the object storage
    
    connection - the connection
    
    alias - the alias
    
    sql - the sql
    
    Returns:
    
    the explain plan
    
    See Also:
    
    ObjectStorage
  - getCaseSensitive
```
public int getCaseSensitive()
```
    Description copied from interface: Driver
    
    Gets the "case sensitive" flag. Possible values: CASE_SENSITIVE_UNDEFINED, CASE_SENSITIVE_LOWER, CASE_SENSITIVE_UPPER. Depending on returning value driver will translate some types of identifiers to the lower case, UPPER case or leave it unchanged.
    
    Specified by:
    
    getCaseSensitive in interface Driver
    
    Returns:
    
    the "case sensitive" flag.
  - getConfigFileName
```
public String getConfigFileName()
```
    Description copied from interface: ExtensionModule
    
    Gets the path to the configuration file for the module. The configuration file contains module specific properties, resides inside package and deployed with the code in the jar file.
    
    Specified by:
    
    getConfigFileName in interface ExtensionModule
    
    Returns:
    
    the path to the configuration name
  - getConnectionFile
```
public TypedKeyValue<String,String> getConnectionFile(Alias alias)
```
    Description copied from interface: Driver
    
    Gets the connection aliases file for the database, for example tnsnames.ora. Most database don't have it.
    
    Specified by:
    
    getConnectionFile in interface Driver
    
    Parameters:
    
    alias - the alias
    
    Returns:
    
    the connection aliases file for the database
  - getDefaultNull
```
public String getDefaultNull()
```
    Description copied from interface: Driver
    
    Gets the "default null" value. Some databases require default "null", "not null" attributes when creating tables.
    
    Specified by:
    
    getDefaultNull in interface Driver
    
    Returns:
    
    the "default null" attribute
  - getDeleteStatement
```
public String getDeleteStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues,
                                 String tableName,
                                 String key)
```
    Description copied from interface: Driver
    
    Gets the delete statement.
    
    Specified by:
    
    getDeleteStatement in interface Driver
    
    Parameters:
    
    fieldsAndValues - the fields and values
    
    tableName - the table name
    
    key - the key field(s)
    
    Returns:
    
    the delete statement
  - getDelimiter
```
public String getDelimiter()
```
    Description copied from interface: Driver
    
    Gets the default delimiter.
    
    Specified by:
    
    getDelimiter in interface Driver
    
    Returns:
    
    the delimiter
  - getSafeDelimiter
```
public String getSafeDelimiter()
```
    Description copied from interface: Driver
    
    Gets the safe delimiter which can be added to any sql statetement.
    
    Specified by:
    
    getSafeDelimiter in interface Driver
    
    Returns:
    
    the safe delimiter
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ExtensionModule
    
    Gets the display name. This name will be used to display module in the various UI controls.
    
    Specified by:
    
    getDisplayName in interface ExtensionModule
    
    Returns:
    
    the display name
  - getErrorLinePattern
```
public String getErrorLinePattern()
```
    Description copied from interface: Driver
    
    Gets the "error line" pattern". Used to parse exception and find actual error line.
    
    Specified by:
    
    getErrorLinePattern in interface Driver
    
    Returns:
    
    the "error line" pattern
  - getExtensionRank
```
public int getExtensionRank()
```
    Description copied from interface: ExtensionModule
    
    Gets the extension rank.
    
    Specified by:
    
    getExtensionRank in interface ExtensionModule
    
    Returns:
    
    the extension rank
  - getHome
```
public String getHome(ObjectStorage storage)
```
    Description copied from interface: Driver
    
    Gets the home folder for the native database client.
    
    Specified by:
    
    getHome in interface Driver
    
    Parameters:
    
    storage - the object storage
    
    Returns:
    
    the home folder
    
    See Also:
    
    ObjectStorage
  - getIdentifierName
```
protected String getIdentifierName(String name,
                                   int size)
```
    Gets the identifier name.
    
    Parameters:
    
    name - the name
    
    size - the size
    
    Returns:
    
    the identifier name
  - getIdentifierName
```
public String getIdentifierName(String name,
                                String type)
```
    Description copied from interface: Driver
    
    Gets the identifier name.
    
    Specified by:
    
    getIdentifierName in interface Driver
    
    Parameters:
    
    name - the original object name
    
    type - the type. Possible values: PROC_TYPE, FUNC_TYPE, DDL_TYPE, TABLE_TYPE
    
    Returns:
    
    the identifier name
  - getInsertStatement
```
public String getInsertStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues,
                                 String tableName)
```
    Description copied from interface: Driver
    
    Gets the insert statement.
    
    Specified by:
    
    getInsertStatement in interface Driver
    
    Parameters:
    
    fieldsAndValues - the fields and values
    
    tableName - the table name
    
    Returns:
    
    the insert statement
  - getLicensePropertyName
```
public String getLicensePropertyName()
```
    Description copied from interface: ExtensionModule
    
    Gets the name of the license property. If not null the model is a subject of licensing.
    
    Specified by:
    
    getLicensePropertyName in interface ExtensionModule
    
    Returns:
    
    the name of the license property
  - getLocalUnitClassPath
```
public String getLocalUnitClassPath()
```
    Description copied from interface: ExtensionModule
    
    If extension module is a "local" it must return the path to it's corresponding Unit. Otherwise returns null. The "local" extensions is loaded for each session independently.
    
    Specified by:
    
    getLocalUnitClassPath in interface ExtensionModule
    
    Returns:
    
    the local unit class path
    
    See Also:
    
    Unit
  - getMergeStatement
```
public String getMergeStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues,
                                String tableName,
                                String key)
```
    Description copied from interface: Driver
    
    Gets the merge statement.
    
    Specified by:
    
    getMergeStatement in interface Driver
    
    Parameters:
    
    fieldsAndValues - the fields and values
    
    tableName - the table name
    
    key - the key field(s)
    
    Returns:
    
    the merge statement
  - getObjectCheckSql
```
public String getObjectCheckSql(String name)
```
    Description copied from interface: Driver
    
    Gets the sql used to check if object exists.
    
    Specified by:
    
    getObjectCheckSql in interface Driver
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the sql
  - getPostDeclareSql
```
public String getPostDeclareSql()
```
    Description copied from interface: Driver
    
    This sql is added after all variables declared.
    
    Specified by:
    
    getPostDeclareSql in interface Driver
    
    Returns:
    
    sql
  - getProperties
```
public String[] getProperties()
```
    Description copied from interface: Driver
    
    Gets the properties.
    
    Specified by:
    
    getProperties in interface Driver
    
    Returns:
    
    the properties
  - getSafeSql
```
public String getSafeSql(String sql)
```
    Description copied from interface: Driver
    Gets the safe sql. Some databases (Oracle for example) require that sql is executed inside special construct in order to catch exception.
```
 For example table abc does not exist
 
 delete from abc -- not safe
 EXECUTE IMMEDIATE 'delete from abc' -- safe
 
```
    Specified by:
    
    getSafeSql in interface Driver
    
    Parameters:
    
    sql - the name
    
    Returns:
    
    the safe sql
  - getSelectStatement
```
public String getSelectStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues,
                                 String tableName)
```
    Description copied from interface: Driver
    
    Gets the select statement.
    
    Specified by:
    
    getSelectStatement in interface Driver
    
    Parameters:
    
    fieldsAndValues - the fields and values
    
    tableName - the table name
    
    Returns:
    
    the select statement
  - getSqlForAutotrace
```
public String getSqlForAutotrace(ObjectStorage storage,
                                 String sql)
```
    Description copied from interface: Driver
    
    Gets the SQL for autotrace.
    
    Specified by:
    
    getSqlForAutotrace in interface Driver
    
    Parameters:
    
    storage - the storage
    
    sql - the sql
    
    Returns:
    
    SQL for autotrace
  - getSqlForExplainPlan
```
public String getSqlForExplainPlan(String sql,
                                   SqlParser parser)
```
    Description copied from interface: Driver
    
    Gets the sql for the explain plan.
    
    Specified by:
    
    getSqlForExplainPlan in interface Driver
    
    Parameters:
    
    sql - the original sql
    
    parser - the sql parser
    
    Returns:
    
    the sql for the explain plan
  - getSqlKeywordsFileName
```
public String getSqlKeywordsFileName()
```
    Description copied from interface: Driver
    
    Gets the sql keywords file name.
    
    Specified by:
    
    getSqlKeywordsFileName in interface Driver
    
    Returns:
    
    the sql keywords file name
  - getStartTransactionSql
```
public String getStartTransactionSql()
```
    Description copied from interface: Driver
    
    Get start transaction sql.
    
    Specified by:
    
    getStartTransactionSql in interface Driver
    
    Returns:
    
    the start transaction sql
  - getTableName
```
public String getTableName(String name)
```
    Description copied from interface: Driver
    
    Gets the table name.
    
    Specified by:
    
    getTableName in interface Driver
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the table name
  - getTablePrefixWhenAddingTable
```
public String getTablePrefixWhenAddingTable(String tableName)
```
    Description copied from interface: Driver
    
    Gets the table prefix when adding table.
    
    Specified by:
    
    getTablePrefixWhenAddingTable in interface Driver
    
    Parameters:
    
    tableName - the table name
    
    Returns:
    
    the table prefix when adding table
  - getType
```
public String getType()
```
    Description copied from interface: ExtensionModule
    
    Gets the type of the extension module.
    
    Specified by:
    
    getType in interface ExtensionModule
    
    Returns:
    
    the type
  - getNativeType
```
public String getNativeType(FieldDef fieldDef,
                            String key,
                            FieldsRepository fieldsRepository)
```
    Description copied from interface: Driver
    
    Gets the native field from native field type.
    
    Specified by:
    
    getNativeType in interface Driver
    
    Parameters:
    
    fieldDef - the field definition
    
    key - the key field(s)
    
    fieldsRepository - the fields repository
    
    Returns:
    
    the native field type
  - getUpdateStatement
```
public String getUpdateStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues,
                                 String tableName,
                                 String key)
```
    Description copied from interface: Driver
    
    Gets the update statement.
    
    Specified by:
    
    getUpdateStatement in interface Driver
    
    Parameters:
    
    fieldsAndValues - the fields and values
    
    tableName - the table name
    
    key - the key field(s)
    
    Returns:
    
    the update statement
  - isEqualDriver
```
public boolean isEqualDriver(Driver driver)
```
    Description copied from interface: Driver
    
    Checks if given driver equals to this driver.
    
    Specified by:
    
    isEqualDriver in interface Driver
    
    Parameters:
    
    driver - the driver
    
    Returns:
    
    true, if given driver equals to this driver
  - isMergeInNonCallableSupported
```
public boolean isMergeInNonCallableSupported()
```
    Description copied from interface: Driver
    
    Checks if "merge" statement can be not callable. Example: MERGRE INTO...
    
    Specified by:
    
    isMergeInNonCallableSupported in interface Driver
    
    Returns:
    
    true, if "merge" statement can be not callable
  - needSeparateConnectionForDdl
```
public boolean needSeparateConnectionForDdl()
```
    Description copied from interface: Driver
    
    Check if driver requires separate connection for ddl statements.
    
    Specified by:
    
    needSeparateConnectionForDdl in interface Driver
    
    Returns:
    
    true, if driver requires separate connection for ddl statements
  - requiresExecuteQuery
```
public boolean requiresExecuteQuery()
```
    Description copied from interface: Driver
    
    Checks if driver requires to run as st.executeQuery() in some cases.
    
    Specified by:
    
    requiresExecuteQuery in interface Driver
    
    Returns:
    
    true, if driver requires to run as st.executeQuery()
  - requiresRollbackAfterSqlError
```
public boolean requiresRollbackAfterSqlError()
```
    Description copied from interface: Driver
    
    Returns true if database requires rollback after sql error. Example - PostgreSQL.
    
    Specified by:
    
    requiresRollbackAfterSqlError in interface Driver
    
    Returns:
    
    true if database requires rollback after sql error
  - requiresSeparateConnectionForIndexes
```
public boolean requiresSeparateConnectionForIndexes()
```
    Description copied from interface: Driver
    
    Checks if driver requires separate connection for indexes.
    
    Specified by:
    
    requiresSeparateConnectionForIndexes in interface Driver
    
    Returns:
    
    true, if driver requires separate connection for indexes
  - setCaseSensitive
```
public void setCaseSensitive(int value)
```
    Description copied from interface: Driver
    
    Sets the case sensitive attribute.
    
    Specified by:
    
    setCaseSensitive in interface Driver
    
    Parameters:
    
    value - the new case sensitive attribute. Possible values: CASE_SENSITIVE_UNDEFINED, CASE_SENSITIVE_LOWER, CASE_SENSITIVE_UPPER
  - setUpConnection
```
public void setUpConnection(Connection con,
                            boolean before)
                     throws Exception
```
    Description copied from interface: Driver
    
    Set the up connection to enbale database logging, for example dbms_output.enable()
    
    Specified by:
    
    setUpConnection in interface Driver
    
    Parameters:
    
    con - the connection
    
    before - if true method executed before script, false - after
    
    Throws:
    
    Exception - in case of any error
  - supportColonInFormatter
```
public boolean supportColonInFormatter()
```
    Description copied from interface: Driver
    
    Support colon in formatter.
    
    Specified by:
    
    supportColonInFormatter in interface Driver
    
    Returns:
    
    true, if successful
  - supportsAutotrace
```
public String supportsAutotrace()
```
    Description copied from interface: Driver
    
    Checks if driver supports autotrace. Return native name for autotrace if it does.
    
    Specified by:
    
    supportsAutotrace in interface Driver
    
    Returns:
    
    native name for autotrace if driver supports autotrace
  - supportsLogging
```
public boolean supportsLogging()
```
    Description copied from interface: Driver
    
    Checks if drivers supports database logging such as Oracle dbms_output.
    
    Specified by:
    
    supportsLogging in interface Driver
    
    Returns:
    
    true, if drivers supports database logging
  - supportsNotNullable
```
public boolean supportsNotNullable()
```
    Description copied from interface: Driver
    
    Checks is driver supports not nullable collumns.
    
    Specified by:
    
    supportsNotNullable in interface Driver
    
    Returns:
    
    true, if successful
  - supportsParallelExtract
```
public boolean supportsParallelExtract()
```
    Description copied from interface: Driver
    
    "Supports parallel extract" flag.
    
    Specified by:
    
    supportsParallelExtract in interface Driver
    
    Returns:
    
    true, if driver supports parallel extract
  - supportsParallelLoad
```
public boolean supportsParallelLoad()
```
    Description copied from interface: Driver
    
    "Supports parallel load" flag.
    
    Specified by:
    
    supportsParallelLoad in interface Driver
    
    Returns:
    
    true, if driver supports parallel load
  - supportsParentDriver
```
public boolean supportsParentDriver()
```
    Description copied from interface: Driver
    
    Used internally to make a disition is it possible to use a generic jdbc driver with a parent driver.
    
    Specified by:
    
    supportsParentDriver in interface Driver
    
    Returns:
    
    true, if successful
  - tableName2Name
```
public String tableName2Name(String name)
```
    Description copied from interface: Driver
    
    Converts table name to name.
    
    Specified by:
    
    tableName2Name in interface Driver
    
    Parameters:
    
    name - the table name
    
    Returns:
    
    the string
  - typeHasSize
```
public boolean typeHasSize(int type,
                           String nativeDataType)
```
    Description copied from interface: Driver
    
    Returns true if type has size. For example: Types.VARCHAR has size, Types.INTEGER - doesn't.
    
    Specified by:
    
    typeHasSize in interface Driver
    
    Parameters:
    
    type - the type Types
    
    nativeDataType - the natice data type
    
    Returns:
    
    true, if type has size
  - supportsPreparedStatementInTransaction
```
public boolean supportsPreparedStatementInTransaction()
```
    Description copied from interface: Driver
    
    Supports prepared statement in transaction.
    
    Specified by:
    
    supportsPreparedStatementInTransaction in interface Driver
    
    Returns:
    
    true, if successful
  - supportsPreparedStatement
```
public boolean supportsPreparedStatement()
```
    Description copied from interface: Driver
    
    Supports prepared statements.
    
    Specified by:
    
    supportsPreparedStatement in interface Driver
    
    Returns:
    
    true, if successful
  - alwaysEncloseTableAndColumnsInQuotes
```
public boolean alwaysEncloseTableAndColumnsInQuotes()
```
    Description copied from interface: Driver
    
    Check if system should always enclose table and columns in quotes.
    
    Specified by:
    
    alwaysEncloseTableAndColumnsInQuotes in interface Driver
    
    Returns:
    
    true, if system should always enclose table and columns in quotes
  - setAlwaysEncloseTableAndColumnsInQuotes
```
public void setAlwaysEncloseTableAndColumnsInQuotes(boolean value)
```
    Description copied from interface: Driver
    
    Sets the value of the flag "always enclose table and columns in quotes".
    
    Specified by:
    
    setAlwaysEncloseTableAndColumnsInQuotes in interface Driver
    
    Parameters:
    
    value - the new always enclose table and columns in quotes
  - supportsPreparedStatementInParallelThreads
```
public boolean supportsPreparedStatementInParallelThreads()
```
    Description copied from interface: Driver
    
    Supports prepared statement in parallel threads.
    
    Specified by:
    
    supportsPreparedStatementInParallelThreads in interface Driver
    
    Returns:
    
    true, if successful
  - getParentDriver
```
public Driver getParentDriver()
```
    Description copied from interface: Driver
    
    Gets the parent driver.
    
    Specified by:
    
    getParentDriver in interface Driver
    
    Returns:
    
    the parent driver
  - getAddColumnSql
```
public String getAddColumnSql()
```
    Description copied from interface: Driver
    
    Gets the ADD COLUMN SQL. Used by getAlterTableAddColumnSql.
    
    Specified by:
    
    getAddColumnSql in interface Driver
    
    Returns:
    
    String
  - getAlterTableAddColumnSql
```
public String getAlterTableAddColumnSql(String name,
                                        FieldDef column,
                                        FieldsRepository fieldsRepository)
```
    Description copied from interface: Driver
    
    Gets the alter table add column sql.
    
    Specified by:
    
    getAlterTableAddColumnSql in interface Driver
    
    Parameters:
    
    name - the name
    
    column - the column
    
    fieldsRepository - the fields repository
    
    Returns:
    
    the alter table add column sql
  - getAlterTableAddColumnSql
```
public String getAlterTableAddColumnSql(String name,
                                        FieldDef column,
                                        FieldsRepository fieldsRepository,
                                        boolean withNotNull)
```
    Description copied from interface: Driver
    
    Gets the alter table add column sql.
    
    Specified by:
    
    getAlterTableAddColumnSql in interface Driver
    
    Parameters:
    
    name - the name
    
    column - the column
    
    fieldsRepository - the fields repository
    
    withNotNull - boolean, if true and the column is not nullable add NOT NULL constraint
    
    Returns:
    
    the alter table add column sql
  - getStringFieldSizeMultiplier
```
public int getStringFieldSizeMultiplier()
```
    Description copied from interface: Driver
    
    Gets the string field size multiplier. The if > 1 multiple string field size by the given multiplier
    
    Specified by:
    
    getStringFieldSizeMultiplier in interface Driver
    
    Returns:
    
    the multiplier
  - setStringFieldSizeMultiplier
```
public void setStringFieldSizeMultiplier(int multiplier)
```
    Description copied from interface: Driver
    
    Sets the sclale string field size. The if > 1 multiple string field size by the given multiplier
    
    Specified by:
    
    setStringFieldSizeMultiplier in interface Driver
    
    Parameters:
    
    multiplier - the new multiplier
  - getColumns
```
public String getColumns(String name,
                         DataSet dataSet,
                         String key,
                         FieldsRepository fieldsRepository)
```
    Description copied from interface: Driver
    
    Gets the columns for "create table" sql.
    
    Specified by:
    
    getColumns in interface Driver
    
    Parameters:
    
    name - the table name
    
    dataSet - the data set
    
    key - the key field(s)
    
    fieldsRepository - the fields repository
    
    Returns:
    
    the "create table" sql
    
    See Also:
    
    FieldsRepository

Class AbstractDriver

Field Summary

Fields inherited from interface com.toolsverse.etl.driver.Driver

Fields inherited from interface com.toolsverse.ext.ExtensionModule

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface com.toolsverse.etl.driver.Driver

Methods inherited from interface com.toolsverse.ext.ExtensionModule

Field Detail

ALLOWED_IDENT_CHARS

Constructor Detail

AbstractDriver

Method Detail

getCmdOptions

captureLog

compareTo

externalToolRequiresRedirect

filter

getAllowedIdentifierChars

getAutotrace

getCaseSensitive

getConfigFileName

getConnectionFile

getDefaultNull

getDeleteStatement

getDelimiter

getSafeDelimiter

getDisplayName

getErrorLinePattern

getExtensionRank

getHome

getIdentifierName

getIdentifierName

getInsertStatement

getLicensePropertyName

getLocalUnitClassPath

getMergeStatement

getObjectCheckSql

getPostDeclareSql

getProperties

getSafeSql

getSelectStatement

getSqlForAutotrace

getSqlForExplainPlan

getSqlKeywordsFileName

getStartTransactionSql

getTableName

getTablePrefixWhenAddingTable

getType

getNativeType

getUpdateStatement

isEqualDriver

isMergeInNonCallableSupported

needSeparateConnectionForDdl

requiresExecuteQuery

requiresRollbackAfterSqlError

requiresSeparateConnectionForIndexes

setCaseSensitive

setUpConnection

supportColonInFormatter

supportsAutotrace

supportsLogging

supportsNotNullable

supportsParallelExtract

supportsParallelLoad

supportsParentDriver

tableName2Name

typeHasSize

supportsPreparedStatementInTransaction

supportsPreparedStatement

alwaysEncloseTableAndColumnsInQuotes

setAlwaysEncloseTableAndColumnsInQuotes

supportsPreparedStatementInParallelThreads

getParentDriver

getAddColumnSql

getAlterTableAddColumnSql

getAlterTableAddColumnSql

getStringFieldSizeMultiplier

setStringFieldSizeMultiplier