MsSqlDriver (Toolsverse API Reference 5.9)

Object
- com.toolsverse.etl.driver.AbstractDriver
- - com.toolsverse.etl.driver.CallableDriver
  - - com.toolsverse.etl.driver.sqlserver.MsSqlDriver

All Implemented Interfaces:

Driver, ExtensionModule, Serializable, Comparable<ExtensionModule>

Direct Known Subclasses:

AzureSynapseAnalyticsDriver, SybaseDriver
```
public class MsSqlDriver
extends CallableDriver
```
The Microsoft Sql server 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 String`	`BEGIN` The BEGIN sql.
`static String`	`BEGIN_SPLITED` The BEGIN_SPLITED sql.
`static String`	`DECLARE` The DECLARE sql.
`static String`	`END` The END sql.
`static String`	`END_SPLITED` The END_SPLITED sql.
`static String`	`EXCEPTIONS` The EXCEPTIONS sql.
`static String`	`IF` The IF sql.
`static String`	`IF_BEGIN` The IF_BEGIN sql.
`static String`	`IF_ELSE` The IF_ELSE sql.
`static String`	`IF_END` The IF_END sql.
`static String`	`INIT_SQL` The INIT sql.
`static int`	`LINES_LIMIT` The maximum number of lines allowed in the sql block.
`static int`	`MAX_CHAR_SIZE` The maximum char size.
`static int`	`MAX_NUMBER_PREC_SIZE` The maximum precision.
`static int`	`MAX_NUMBER_SCALE_SIZE` The maximum scale.
`static int`	`MAX_STRING_LITERAL_SIZE` The maximum string literal size.
`static int`	`MAX_VARCHAR_SIZE` The maximum varchar size.
`static String`	`MSSQL_HOME_PROP` The MSSQL client HOME property.
`static String`	`MSSQL_HOME_VAR` The MSSQL client HOME variable.
`static String`	`ON_EXCEPTION` The ON_EXCEPTION sql.
`static String`	`ON_EXCEPTION_BEGIN` The ON_EXCEPTION_BEGIN sql.
`static String`	`ON_EXCEPTION_END` The ON_EXCEPTION_END sql.

Fields inherited from class com.toolsverse.etl.driver.AbstractDriver
ALLOWED_IDENT_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

Constructor Summary

Constructors
Constructor and Description

MsSqlDriver()

Constructors
Constructor and Description
`MsSqlDriver()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`_getInitSql()` Gets init sql.
`protected int`	`_getLinesLimit()` Gets lines limit.
`protected int`	`_getMaxCharSize()` Gets max char size.
`protected int`	`_getMaxPrecision()` Gets max precision.
`protected int`	`_getMaxScale()` Gets the max scale.
`protected int`	`_getMaxStringLiteralSize()` Gets the max string literal size.
`protected int`	`_getMaxVarcharSize()` Gets the max varchar size.
`String`	`convertStringForStorage(String value)` Converts string so it can be used as s part of sql.
`String`	`convertValueForStorage(Object fieldValue, int fieldType, boolean isFromTable)` Converts value to string depending on `fieldType` so it can be used as s part of sql.
`String`	`getAddColumnSql()` Gets the ADD COLUMN SQL.
`Object`	`getAutotrace(ObjectStorage storage, Connection connection, Alias alias, String sql)` Executes sql and produces real execution plan.
`String`	`getBegin()` Gets the "begin" sql statement.
`String`	`getBeginSplited()` Gets the "begin" token for splited sql.
`String`	`getCallSql(String name)` Gets the "call" sql.
`String`	`getCmdForExternalTool(ObjectStorage storage, Alias alias, String sqlFile)` Gets the command line for the external tool.
`String`	`getCreateTableSql(String name, DataSet dataSet, boolean isTemporary, String key, FieldsRepository fieldsRepository)` Gets the "create table" sql.
`String`	`getCursorLoopEndSql(String name, DataSet dataSet)` Gets the "loop end" sql for the cursor.
`String`	`getCursorLoopStartSql(String name, String cursorSql, DataSet dataSet)` Gets the "loop start" sql for the cursor.
`String`	`getCursorRecAccessSql(String fieldName)` Gets the record access sql for the cursor.
`String`	`getCursorVarName(String field)` Gets the cursor variable name.
`protected String`	`getDateTimeStyle()` Gets the date+time style.
`static String`	`getDbName(Alias alias)` Gets the database name.
`String`	`getDeclare()` Gets the "declare" sql.
`String`	`getDeclareCursorEndSql()` Gets the "declare cursor end" sql.
`String`	`getDeclareCursorSql(String sql, String name, String cursorSql, DataSet dataSet)` Gets the "declare cursor" sql.
`String`	`getDeclareCursorVarSql(String sql, DataSet dataSet, String key, FieldsRepository fieldsRepository, Set<String> variables)` Gets the "declare cursor variable" sql.
`String`	`getDefaultFunctionClass()` Gets the default function class name.
`String`	`getDefaultType()` Gets the default database type.
`String`	`getDropSql(String type, String name)` Gets the "drop" sql.
`String`	`getEnd()` Gets the "end" sql.
`String`	`getEndSplited()` Gets the "end" token for the splited sql statement.
`Object`	`getExplainPlan(ObjectStorage storage, Connection connection, Alias alias, String sql)` Gets the explain plan for the sql.
`String`	`getExternalToolName()` Gets the external tool name.
`String`	`getFetchNextSql(String name, DataSet dataSet)` Gets the "fetch next" sql.
`String`	`getHome(ObjectStorage storage)` Gets the home folder for the native database client.
`String`	`getIconPath()` Gets the full path to the icon file.
`String`	`getIf()` Gets the "if" token.
`String`	`getIfBegin()` Gets the "if begin" token.
`String`	`getIfElse()` Gets the "if else" token.
`String`	`getIfEnd()` Gets the "if end" token.
`String`	`getJdbcDriverClassName()` Gets the jdbc driver class name.
`String`	`getLicensePropertyName()` Gets the name of the license property.
`String`	`getMergeStatement(TypedKeyValue<List<String>,List<Object>> fieldsAndValues, String tableName, String key)` Gets the merge statement.
`String`	`getMetadataClassName()` Gets the metadata driver class name.
`String`	`getMetadataSelectClause()` Gets the metadata "select" clause.
`String`	`getMetadataWhereClause()` Gets the metadata "where" clause.
`String`	`getName()` Gets the name of the driver.
`Object`	`getObject(ResultSet rs, int index, FieldDef fieldDef)` Gets the object from result set.
`String`	`getOnException(OnException onException)` Gets the "on exception" sql.
`String`	`getOnExceptionBegin(OnException onException, long row)` Gets the "on exception begin" sql.
`String`	`getOnExceptionEnd()` Gets the "on exception end" sql.
`int`	`getParamType(String type)` Gets the parameter type from the output variable type.
`String[]`	`getProperties()` Gets the properties.
`String`	`getPropsWizardResource(String connectionDriver)` Gets the name of the xml file used to create a wizard for editing properties.
`String`	`getSafeDelimiter()` Gets the safe delimiter which can be added to any sql statetement.
`String`	`getSafeSql(String sql)` Gets the safe sql.
`static String`	`getServer(Alias alias, String subst)` Gets the server name.
`String`	`getSqlForExternalTool(Alias alias, String sql, SqlParser parser)` Gets the sql for external tool.
`String`	`getSqlKeywordsFileName()` Gets the sql keywords file name.
`String`	`getTempTableName(String name)` Gets the temporary table name.
`String`	`getTopSelectClause(int top)` Gets the "top select" clause.
`String`	`getTopTrailClause(int top)` Gets the "top trail" clause.
`String`	`getTopWhereClause(int top)` Gets the "top where" clause.
`String`	`getType(FieldDef fieldDef, String key, FieldsRepository fieldsRepository)` Gets the native field type.
`String`	`getUrlPattern()` Gets the jdbc driver url pattern.
`String`	`getVarDeclare()` Gets the variable declare statement.
`String`	`getVarName(String name)` Gets the variable name.
`String`	`getVendor()` Gets the vendor.
`String`	`getVersion()` Gets the version of the extension module.
`String`	`getXmlConfigFileName()` Gets the path to the xml configuration file for the module.
`boolean`	`ignoreExceptionsDuringInit()` The "Ignore exceptions during initialization" flag.
`boolean`	`isMergeInNonCallableSupported()` Checks if "merge" statement can be not callable.
`String[]`	`supportedJoinTypes()` Returns supported join types, such as inner join, left outer join etc.
`String[]`	`supportedSetOperations()` Returns names of the supported set operations, such as union, union all, etc.
`boolean`	`supportsAnonymousBlocks()` "Supports anonymous blocks" flag.
`String`	`supportsAutotrace()` Checks if driver supports autotrace.
`boolean`	`supportsBinaryInProc()` "Supports binary data types in procedures" flag.
`boolean`	`supportsCallableStatement()` "Supports callable statement" flag.
`boolean`	`supportsExplainPlan()` "Supports explain plan" flag.
`boolean`	`supportsExternalTool()` "Supports external tool" flag.
`boolean`	`supportsInnerFunctions()` "Supports inner functions" flag.
`boolean`	`supportsParamsInAnonymousBlocks()` "Supports parameters in anonymous blocks" flag.
`boolean`	`supportsRollbackAfterDDL()` "Supports rollback after ddl" flag.

Methods inherited from class com.toolsverse.etl.driver.AbstractDriver
alwaysEncloseTableAndColumnsInQuotes, captureLog, compareTo, externalToolRequiresRedirect, filter, getAllowedIdentifierChars, getAlterTableAddColumnSql, getAlterTableAddColumnSql, getCaseSensitive, getCmdOptions, getColumns, getConfigFileName, getConnectionFile, getDefaultNull, getDeleteStatement, getDelimiter, getDisplayName, getErrorLinePattern, getExtensionRank, getIdentifierName, getIdentifierName, getInsertStatement, getLocalUnitClassPath, getNativeType, getObjectCheckSql, getParentDriver, getPostDeclareSql, getSelectStatement, getSqlForAutotrace, getSqlForExplainPlan, getStartTransactionSql, getStringFieldSizeMultiplier, getTableName, getTablePrefixWhenAddingTable, getType, getUpdateStatement, isEqualDriver, needSeparateConnectionForDdl, requiresExecuteQuery, requiresRollbackAfterSqlError, requiresSeparateConnectionForIndexes, setAlwaysEncloseTableAndColumnsInQuotes, setCaseSensitive, setStringFieldSizeMultiplier, setUpConnection, supportColonInFormatter, supportsLogging, supportsNotNullable, supportsParallelExtract, supportsParallelLoad, supportsParentDriver, supportsPreparedStatement, supportsPreparedStatementInParallelThreads, supportsPreparedStatementInTransaction, tableName2Name, typeHasSize

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
disableMetadataOnWrite, getIoProcessorClassName, getPrecision, ifDoesNotExistSql, ifExistsSql, openCloseConnectionOnDdl, requiresSemicolonInMerge

- Field Detail
  - MSSQL_HOME_VAR
```
public static final String MSSQL_HOME_VAR
```
    The MSSQL client HOME variable.
    
    See Also:
    
    Constant Field Values
  - MSSQL_HOME_PROP
```
public static final String MSSQL_HOME_PROP
```
    The MSSQL client HOME property.
    
    See Also:
    
    Constant Field Values
  - MAX_STRING_LITERAL_SIZE
```
public static int MAX_STRING_LITERAL_SIZE
```
    The maximum string literal size.
  - MAX_VARCHAR_SIZE
```
public static int MAX_VARCHAR_SIZE
```
    The maximum varchar size.
  - LINES_LIMIT
```
public static int LINES_LIMIT
```
    The maximum number of lines allowed in the sql block.
  - MAX_CHAR_SIZE
```
public static int MAX_CHAR_SIZE
```
    The maximum char size.
  - MAX_NUMBER_PREC_SIZE
```
public static int MAX_NUMBER_PREC_SIZE
```
    The maximum precision.
  - MAX_NUMBER_SCALE_SIZE
```
public static int MAX_NUMBER_SCALE_SIZE
```
    The maximum scale.
  - INIT_SQL
```
public static final String INIT_SQL
```
    The INIT sql.
    
    See Also:
    
    Constant Field Values
  - DECLARE
```
public static final String DECLARE
```
    The DECLARE sql.
    
    See Also:
    
    Constant Field Values
  - BEGIN
```
public static final String BEGIN
```
    The BEGIN sql.
    
    See Also:
    
    Constant Field Values
  - BEGIN_SPLITED
```
public static final String BEGIN_SPLITED
```
    The BEGIN_SPLITED sql.
    
    See Also:
    
    Constant Field Values
  - END
```
public static final String END
```
    The END sql.
    
    See Also:
    
    Constant Field Values
  - END_SPLITED
```
public static final String END_SPLITED
```
    The END_SPLITED sql.
    
    See Also:
    
    Constant Field Values
  - IF
```
public static final String IF
```
    The IF sql.
    
    See Also:
    
    Constant Field Values
  - IF_BEGIN
```
public static final String IF_BEGIN
```
    The IF_BEGIN sql.
    
    See Also:
    
    Constant Field Values
  - IF_ELSE
```
public static final String IF_ELSE
```
    The IF_ELSE sql.
    
    See Also:
    
    Constant Field Values
  - IF_END
```
public static final String IF_END
```
    The IF_END sql.
    
    See Also:
    
    Constant Field Values
  - EXCEPTIONS
```
public static final String EXCEPTIONS
```
    The EXCEPTIONS sql.
    
    See Also:
    
    Constant Field Values
  - ON_EXCEPTION_BEGIN
```
public static final String ON_EXCEPTION_BEGIN
```
    The ON_EXCEPTION_BEGIN sql.
    
    See Also:
    
    Constant Field Values
  - ON_EXCEPTION
```
public static final String ON_EXCEPTION
```
    The ON_EXCEPTION sql.
    
    See Also:
    
    Constant Field Values
  - ON_EXCEPTION_END
```
public static final String ON_EXCEPTION_END
```
    The ON_EXCEPTION_END sql.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MsSqlDriver
```
public MsSqlDriver()
```
- Method Detail
  - getDbName
```
public static String getDbName(Alias alias)
```
    Gets the database name.
    
    Parameters:
    
    alias - the alias
    
    Returns:
    
    the database name
  - getServer
```
public static String getServer(Alias alias,
                               String subst)
```
    Gets the server name.
    
    Parameters:
    
    alias - the alias
    
    subst - the substring
    
    Returns:
    
    the server name
  - _getInitSql
```
protected String _getInitSql()
```
    Description copied from class: CallableDriver
    
    Gets init sql.
    
    Specified by:
    
    _getInitSql in class CallableDriver
    
    Returns:
    
    the string
  - _getLinesLimit
```
protected int _getLinesLimit()
```
    Description copied from class: CallableDriver
    
    Gets lines limit.
    
    Specified by:
    
    _getLinesLimit in class CallableDriver
    
    Returns:
    
    the lines limit
  - _getMaxCharSize
```
protected int _getMaxCharSize()
```
    Description copied from class: CallableDriver
    
    Gets max char size.
    
    Specified by:
    
    _getMaxCharSize in class CallableDriver
    
    Returns:
    
    the max char size
  - _getMaxPrecision
```
protected int _getMaxPrecision()
```
    Description copied from class: CallableDriver
    
    Gets max precision.
    
    Specified by:
    
    _getMaxPrecision in class CallableDriver
    
    Returns:
    
    the max precision
  - _getMaxScale
```
protected int _getMaxScale()
```
    Description copied from class: CallableDriver
    
    Gets the max scale.
    
    Specified by:
    
    _getMaxScale in class CallableDriver
    
    Returns:
    
    the max scale
  - _getMaxStringLiteralSize
```
protected int _getMaxStringLiteralSize()
```
    Description copied from class: CallableDriver
    
    Gets the max string literal size.
    
    Specified by:
    
    _getMaxStringLiteralSize in class CallableDriver
    
    Returns:
    
    the max string literal size
  - _getMaxVarcharSize
```
protected int _getMaxVarcharSize()
```
    Description copied from class: CallableDriver
    
    Gets the max varchar size.
    
    Specified by:
    
    _getMaxVarcharSize in class CallableDriver
    
    Returns:
    
    the max varchar size
  - convertStringForStorage
```
public String convertStringForStorage(String value)
```
    Description copied from interface: Driver
    
    Converts string so it can be used as s part of sql. Typically adds "'". Example abc -> 'abc'
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the string
  - convertValueForStorage
```
public String convertValueForStorage(Object fieldValue,
                                     int fieldType,
                                     boolean isFromTable)
```
    Description copied from interface: Driver
    
    Converts value to string depending on fieldType so it can be used as s part of sql.
    
    Parameters:
    
    fieldValue - the field value
    
    fieldType - the field type Types}
    
    isFromTable - if true the value is coming from result set, otherwise - from the database cursor
    
    Returns:
    
    the string
  - 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
    
    Overrides:
    
    getAutotrace in class AbstractDriver
    
    Parameters:
    
    storage - the object storage
    
    connection - the connection
    
    alias - the alias
    
    sql - the sql
    
    Returns:
    
    the explain plan
    
    See Also:
    
    ObjectStorage
  - getBegin
```
public String getBegin()
```
    Description copied from interface: Driver
    
    Gets the "begin" sql statement.
    
    Returns:
    
    the "begin" sql statemnt
  - getBeginSplited
```
public String getBeginSplited()
```
    Description copied from interface: Driver
    
    Gets the "begin" token for splited sql.
    
    Returns:
    
    the the "begin" token for the splited sql
  - getCallSql
```
public String getCallSql(String name)
```
    Description copied from interface: Driver
    
    Gets the "call" sql. Example: "test" - > call test()
    
    Parameters:
    
    name - the name of the procedure
    
    Returns:
    
    the "call" sql
  - getCmdForExternalTool
```
public String getCmdForExternalTool(ObjectStorage storage,
                                    Alias alias,
                                    String sqlFile)
```
    Description copied from interface: Driver
    
    Gets the command line for the external tool.
    
    Parameters:
    
    storage - the object storage
    
    alias - the alias
    
    sqlFile - the sql file
    
    Returns:
    
    the command line for the external tool
    
    See Also:
    
    ObjectStorage
  - getCreateTableSql
```
public String getCreateTableSql(String name,
                                DataSet dataSet,
                                boolean isTemporary,
                                String key,
                                FieldsRepository fieldsRepository)
```
    Description copied from interface: Driver
    
    Gets the "create table" sql.
    
    Parameters:
    
    name - the table name
    
    dataSet - the data set
    
    isTemporary - if true the table is temporary
    
    key - the key field(s)
    
    fieldsRepository - the fields repository
    
    Returns:
    
    the "create table" sql
    
    See Also:
    
    FieldsRepository
  - getCursorLoopEndSql
```
public String getCursorLoopEndSql(String name,
                                  DataSet dataSet)
```
    Description copied from interface: Driver
    
    Gets the "loop end" sql for the cursor.
    
    Parameters:
    
    name - the name of the cusror
    
    dataSet - the data set
    
    Returns:
    
    the "loop end" sql for the cursor
  - 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
    
    Overrides:
    
    getSafeDelimiter in class AbstractDriver
    
    Returns:
    
    the safe delimiter
  - getCursorLoopStartSql
```
public String getCursorLoopStartSql(String name,
                                    String cursorSql,
                                    DataSet dataSet)
```
    Description copied from interface: Driver
    
    Gets the "loop start" sql for the cursor.
    
    Parameters:
    
    name - the name of the cursor
    
    cursorSql - the cursor sql
    
    dataSet - the data set
    
    Returns:
    
    the "loop end" sql for the cursor
  - getCursorRecAccessSql
```
public String getCursorRecAccessSql(String fieldName)
```
    Description copied from interface: Driver
    
    Gets the record access sql for the cursor.
    
    Parameters:
    
    fieldName - the field name
    
    Returns:
    
    the record access sql for the cursor
  - getCursorVarName
```
public String getCursorVarName(String field)
```
    Gets the cursor variable name.
    
    Parameters:
    
    field - the field
    
    Returns:
    
    the cursor variable name
  - getDateTimeStyle
```
protected String getDateTimeStyle()
```
    Gets the date+time style.
    
    Returns:
    
    the date+time style
  - getDeclare
```
public String getDeclare()
```
    Description copied from interface: Driver
    
    Gets the "declare" sql.
    
    Returns:
    
    the "declare" sql
  - getDeclareCursorEndSql
```
public String getDeclareCursorEndSql()
```
    Description copied from interface: Driver
    
    Gets the "declare cursor end" sql.
    
    Returns:
    
    the "declare cursor end" sql
  - getDeclareCursorSql
```
public String getDeclareCursorSql(String sql,
                                  String name,
                                  String cursorSql,
                                  DataSet dataSet)
```
    Description copied from interface: Driver
    
    Gets the "declare cursor" sql.
    
    Parameters:
    
    sql - the sql
    
    name - the name of the cursor
    
    cursorSql - the cursor sql
    
    dataSet - the data set
    
    Returns:
    
    the "declare cursor" sql
  - getDeclareCursorVarSql
```
public String getDeclareCursorVarSql(String sql,
                                     DataSet dataSet,
                                     String key,
                                     FieldsRepository fieldsRepository,
                                     Set<String> variables)
```
    Description copied from interface: Driver
    
    Gets the "declare cursor variable" sql.
    
    Parameters:
    
    sql - the sql
    
    dataSet - the data set
    
    key - the key field(s)
    
    fieldsRepository - the fields repository
    
    variables - the variables
    
    Returns:
    
    the "declare cursor variable" sql
    
    See Also:
    
    FieldsRepository
  - getDefaultFunctionClass
```
public String getDefaultFunctionClass()
```
    Description copied from interface: Driver
    
    Gets the default function class name.
    
    Returns:
    
    the default function class name
    
    See Also:
    
    Function
  - getDefaultType
```
public String getDefaultType()
```
    Description copied from interface: Driver
    
    Gets the default database type.
    
    Returns:
    
    the default database type
  - getDropSql
```
public String getDropSql(String type,
                         String name)
```
    Description copied from interface: Driver
    
    Gets the "drop" sql.
    
    Parameters:
    
    type - the object type. Possible values: PROC_TYPE, FUNC_TYPE, DDL_TYPE, TABLE_TYPE
    
    name - the object name
    
    Returns:
    
    the drop sql
  - getEnd
```
public String getEnd()
```
    Description copied from interface: Driver
    
    Gets the "end" sql.
    
    Returns:
    
    the "end" sql
  - getEndSplited
```
public String getEndSplited()
```
    Description copied from interface: Driver
    
    Gets the "end" token for the splited sql statement.
    
    Returns:
    
    the the "end" token for the splited sql statement
  - getExplainPlan
```
public Object getExplainPlan(ObjectStorage storage,
                             Connection connection,
                             Alias alias,
                             String sql)
```
    Description copied from interface: Driver
    
    Gets the explain plan for the sql.
    
    Parameters:
    
    storage - the object storage
    
    connection - the connection
    
    alias - the alias
    
    sql - the sql
    
    Returns:
    
    the explain plan
    
    See Also:
    
    ObjectStorage
  - getExternalToolName
```
public String getExternalToolName()
```
    Description copied from interface: Driver
    
    Gets the external tool name.
    
    Returns:
    
    the external tool name
  - getFetchNextSql
```
public String getFetchNextSql(String name,
                              DataSet dataSet)
```
    Gets the "fetch next" sql.
    
    Parameters:
    
    name - the cursor name
    
    dataSet - the data set
    
    Returns:
    
    the "fetch next" sql
  - 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
    
    Overrides:
    
    getHome in class AbstractDriver
    
    Parameters:
    
    storage - the object storage
    
    Returns:
    
    the home folder
    
    See Also:
    
    ObjectStorage
  - getIconPath
```
public String getIconPath()
```
    Description copied from interface: ExtensionModule
    
    Gets the full path to the icon file. The icon reside inside package and deployed with the code in jar file.
    
    Returns:
    
    the icon path
  - getIf
```
public String getIf()
```
    Description copied from interface: Driver
    
    Gets the "if" token.
    
    Returns:
    
    the "if" token
  - getIfBegin
```
public String getIfBegin()
```
    Description copied from interface: Driver
    
    Gets the "if begin" token.
    
    Returns:
    
    the "if begin" token
  - getIfElse
```
public String getIfElse()
```
    Description copied from interface: Driver
    
    Gets the "if else" token.
    
    Returns:
    
    the "if else" token
  - getIfEnd
```
public String getIfEnd()
```
    Description copied from interface: Driver
    
    Gets the "if end" token.
    
    Returns:
    
    the "if end" token
  - getJdbcDriverClassName
```
public String getJdbcDriverClassName()
```
    Description copied from interface: Driver
    
    Gets the jdbc driver class name.
    
    Returns:
    
    the jdbc driver class name
  - 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
    
    Overrides:
    
    getLicensePropertyName in class AbstractDriver
    
    Returns:
    
    the name of the license property
  - getMetadataClassName
```
public String getMetadataClassName()
```
    Description copied from interface: Driver
    
    Gets the metadata driver class name.
    
    Returns:
    
    the metadata driver class name
  - getMetadataSelectClause
```
public String getMetadataSelectClause()
```
    Description copied from interface: Driver
    
    Gets the metadata "select" clause.
    
    Returns:
    
    the metadata "select" clause
  - getMetadataWhereClause
```
public String getMetadataWhereClause()
```
    Description copied from interface: Driver
    
    Gets the metadata "where" clause.
    
    Returns:
    
    the metadata "where" clause
  - getName
```
public String getName()
```
    Description copied from interface: Driver
    
    Gets the name of the driver.
    
    Returns:
    
    the name of the driver
  - getObject
```
public Object getObject(ResultSet rs,
                        int index,
                        FieldDef fieldDef)
                 throws Exception
```
    Description copied from interface: Driver
    
    Gets the object from result set.
    
    Specified by:
    
    getObject in interface Driver
    
    Overrides:
    
    getObject in class CallableDriver
    
    Parameters:
    
    rs - the result set
    
    index - the index of the field
    
    fieldDef - the field type
    
    Returns:
    
    the object
    
    Throws:
    
    Exception - in case of any error
  - getOnException
```
public String getOnException(OnException onException)
```
    Description copied from interface: Driver
    
    Gets the "on exception" sql.
    
    Parameters:
    
    onException - the OnException
    
    Returns:
    
    the "on exception" sql
    
    See Also:
    
    OnException
  - getOnExceptionBegin
```
public String getOnExceptionBegin(OnException onException,
                                  long row)
```
    Description copied from interface: Driver
    
    Gets the "on exception begin" sql.
    
    Parameters:
    
    onException - the OnException
    
    row - the row
    
    Returns:
    
    the "on exception begin" sql
    
    See Also:
    
    OnException
  - getOnExceptionEnd
```
public String getOnExceptionEnd()
```
    Description copied from interface: Driver
    
    Gets the "on exception end" sql.
    
    Returns:
    
    the "on exception end" sql
  - getParamType
```
public int getParamType(String type)
```
    Description copied from interface: Driver
    
    Gets the parameter type from the output variable type.
    
    Parameters:
    
    type - the output variable type
    
    Returns:
    
    the parameter type
  - getProperties
```
public String[] getProperties()
```
    Description copied from interface: Driver
    
    Gets the properties.
    
    Specified by:
    
    getProperties in interface Driver
    
    Overrides:
    
    getProperties in class AbstractDriver
    
    Returns:
    
    the properties
  - getPropsWizardResource
```
public String getPropsWizardResource(String connectionDriver)
```
    Description copied from interface: Driver
    
    Gets the name of the xml file used to create a wizard for editing properties.
    
    Parameters:
    
    connectionDriver - the connection driver
    
    Returns:
    
    the name of the xml file
  - 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
    
    Overrides:
    
    getSafeSql in class AbstractDriver
    
    Parameters:
    
    sql - the name
    
    Returns:
    
    the safe sql
  - getSqlForExternalTool
```
public String getSqlForExternalTool(Alias alias,
                                    String sql,
                                    SqlParser parser)
```
    Description copied from interface: Driver
    
    Gets the sql for external tool.
    
    Parameters:
    
    alias - the alias
    
    sql - the original sql
    
    parser - the sql parser
    
    Returns:
    
    the sql for the external tool
  - getSqlKeywordsFileName
```
public String getSqlKeywordsFileName()
```
    Description copied from interface: Driver
    
    Gets the sql keywords file name.
    
    Specified by:
    
    getSqlKeywordsFileName in interface Driver
    
    Overrides:
    
    getSqlKeywordsFileName in class AbstractDriver
    
    Returns:
    
    the sql keywords file name
  - getTempTableName
```
public String getTempTableName(String name)
```
    Description copied from interface: Driver
    
    Gets the temporary table name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the temporary table name
  - getTopSelectClause
```
public String getTopSelectClause(int top)
```
    Description copied from interface: Driver
    
    Gets the "top select" clause. Used to select first n rows.
    
    Parameters:
    
    top - the maximum number of rows to select
    
    Returns:
    
    the "top select" clause
  - getTopTrailClause
```
public String getTopTrailClause(int top)
```
    Description copied from interface: Driver
    
    Gets the "top trail" clause. Used to select first n rows.
    
    Parameters:
    
    top - the maximum number of rows to select
    
    Returns:
    
    the "top trail" clause
  - getTopWhereClause
```
public String getTopWhereClause(int top)
```
    Description copied from interface: Driver
    
    Gets the "top where" clause. Used to select first n rows.
    
    Parameters:
    
    top - the maximum number of rows to select
    
    Returns:
    
    the "top where" clause
  - getType
```
public String getType(FieldDef fieldDef,
                      String key,
                      FieldsRepository fieldsRepository)
```
    Description copied from interface: Driver
    
    Gets the native field type.
    
    Parameters:
    
    fieldDef - the field definition
    
    key - the key field(s)
    
    fieldsRepository - the fields repository
    
    Returns:
    
    the native field type
  - getUrlPattern
```
public String getUrlPattern()
```
    Description copied from interface: Driver
    
    Gets the jdbc driver url pattern.
    
    Returns:
    
    the jdbc driver url pattern
  - getVarDeclare
```
public String getVarDeclare()
```
    Description copied from interface: Driver
    
    Gets the variable declare statement.
    
    Returns:
    
    the variable declare statement
  - getVarName
```
public String getVarName(String name)
```
    Description copied from interface: Driver
    
    Gets the variable name.
    
    Specified by:
    
    getVarName in interface Driver
    
    Overrides:
    
    getVarName in class CallableDriver
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the variable name
  - getVendor
```
public String getVendor()
```
    Description copied from interface: ExtensionModule
    
    Gets the vendor.
    
    Returns:
    
    the vendor
  - getVersion
```
public String getVersion()
```
    Description copied from interface: ExtensionModule
    
    Gets the version of the extension module.
    
    Returns:
    
    the version
  - getXmlConfigFileName
```
public String getXmlConfigFileName()
```
    Description copied from interface: ExtensionModule
    
    Gets the path to the xml configuration file for the module. The xml configuration file usually contains module specific UI elements, resides inside package and deployed with the code in the jar file.
    
    Returns:
    
    the path to the configuration name
  - ignoreExceptionsDuringInit
```
public boolean ignoreExceptionsDuringInit()
```
    Description copied from interface: Driver
    
    The "Ignore exceptions during initialization" flag.
    
    Returns:
    
    true, if any exception thrown during execution of the init sql should be ignored
  - 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
    
    Overrides:
    
    isMergeInNonCallableSupported in class AbstractDriver
    
    Returns:
    
    true, if "merge" statement can be not callable
  - 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
    
    Overrides:
    
    getMergeStatement in class AbstractDriver
    
    Parameters:
    
    fieldsAndValues - the fields and values
    
    tableName - the table name
    
    key - the key field(s)
    
    Returns:
    
    the merge statement
  - supportedJoinTypes
```
public String[] supportedJoinTypes()
```
    Description copied from interface: Driver
    
    Returns supported join types, such as inner join, left outer join etc.
    
    Returns:
    
    the supported join types
  - supportedSetOperations
```
public String[] supportedSetOperations()
```
    Description copied from interface: Driver
    
    Returns names of the supported set operations, such as union, union all, etc.
    
    Returns:
    
    the names of the supported set operations
  - supportsAnonymousBlocks
```
public boolean supportsAnonymousBlocks()
```
    Description copied from interface: Driver
    
    "Supports anonymous blocks" flag.
    
    Returns:
    
    true, if database supports anonymous sql blocks
  - 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
    
    Overrides:
    
    supportsAutotrace in class AbstractDriver
    
    Returns:
    
    native name for autotrace if driver supports autotrace
  - supportsBinaryInProc
```
public boolean supportsBinaryInProc()
```
    Description copied from interface: Driver
    
    "Supports binary data types in procedures" flag.
    
    Returns:
    
    true, if database supports binary data types in procedures
  - supportsCallableStatement
```
public boolean supportsCallableStatement()
```
    Description copied from interface: Driver
    
    "Supports callable statement" flag.
    
    Returns:
    
    true, if database supports callable statements
  - supportsExplainPlan
```
public boolean supportsExplainPlan()
```
    Description copied from interface: Driver
    
    "Supports explain plan" flag.
    
    Returns:
    
    true, if database supports explain plan
  - supportsExternalTool
```
public boolean supportsExternalTool()
```
    Description copied from interface: Driver
    
    "Supports external tool" flag.
    
    Returns:
    
    true, if database supports external tool
  - supportsInnerFunctions
```
public boolean supportsInnerFunctions()
```
    Description copied from interface: Driver
    
    "Supports inner functions" flag. Inner function is a function inside anonymous sql block.
    
    Returns:
    
    true, if database supports inner functions
  - supportsParamsInAnonymousBlocks
```
public boolean supportsParamsInAnonymousBlocks()
```
    Description copied from interface: Driver
    
    "Supports parameters in anonymous blocks" flag.
    
    Returns:
    
    true, if database supports parameters in anonymous blocks
  - supportsRollbackAfterDDL
```
public boolean supportsRollbackAfterDDL()
```
    Description copied from interface: Driver
    
    "Supports rollback after ddl" flag.
    
    Returns:
    
    true, if database supports rollback after ddl
  - getAddColumnSql
```
public String getAddColumnSql()
```
    Description copied from interface: Driver
    
    Gets the ADD COLUMN SQL. Used by getAlterTableAddColumnSql.
    
    Specified by:
    
    getAddColumnSql in interface Driver
    
    Overrides:
    
    getAddColumnSql in class AbstractDriver
    
    Returns:
    
    String

Class MsSqlDriver

Field Summary

Fields inherited from class com.toolsverse.etl.driver.AbstractDriver

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 com.toolsverse.etl.driver.CallableDriver

Methods inherited from class com.toolsverse.etl.driver.AbstractDriver

Methods inherited from class Object

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

Field Detail

MSSQL_HOME_VAR

MSSQL_HOME_PROP

MAX_STRING_LITERAL_SIZE

MAX_VARCHAR_SIZE

LINES_LIMIT

MAX_CHAR_SIZE

MAX_NUMBER_PREC_SIZE

MAX_NUMBER_SCALE_SIZE

INIT_SQL

DECLARE

BEGIN

BEGIN_SPLITED

END

END_SPLITED

IF

IF_BEGIN

IF_ELSE

IF_END

EXCEPTIONS

ON_EXCEPTION_BEGIN

ON_EXCEPTION

ON_EXCEPTION_END

Constructor Detail

MsSqlDriver

Method Detail

getDbName

getServer

_getInitSql

_getLinesLimit

_getMaxCharSize

_getMaxPrecision

_getMaxScale

_getMaxStringLiteralSize

_getMaxVarcharSize

convertStringForStorage

convertValueForStorage

getAutotrace

getBegin

getBeginSplited

getCallSql

getCmdForExternalTool

getCreateTableSql

getCursorLoopEndSql

getSafeDelimiter

getCursorLoopStartSql

getCursorRecAccessSql

getCursorVarName

getDateTimeStyle

getDeclare

getDeclareCursorEndSql

getDeclareCursorSql

getDeclareCursorVarSql

getDefaultFunctionClass

getDefaultType

getDropSql

getEnd

getEndSplited

getExplainPlan

getExternalToolName

getFetchNextSql

getHome

getIconPath

getIf

getIfBegin

getIfElse

getIfEnd

getJdbcDriverClassName

getLicensePropertyName