com.toolsverse.etl.driver.snowflake

Class SnowflakeDriver

Object

com.toolsverse.etl.driver.AbstractDriver

com.toolsverse.etl.driver.SimpleDriver

com.toolsverse.etl.driver.snowflake.SnowflakeDriver

All Implemented Interfaces:

Driver, ExtensionModule, Serializable, Comparable<ExtensionModule>

public class SnowflakeDriver
extends SimpleDriver

Snowflake ETL driver.

Since:

5.0

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_NUMBER_PREC_SIZE The maximum precision size.
static int	MAX_NUMBER_SCALE_SIZE The maximum scale size.
static int	MAX_STRING_LITERAL_SIZE The MAX STRINg LITERAL SIZE.

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

DEF_FUNCTION_CLASS, END_ON_EXCEPTION, ON_EXCEPTION

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

Method Summary

Modifier and Type	Method and Description
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	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.
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	getIconPath() Gets the full path to the icon file.
String	getJdbcDriverClassName() Gets the jdbc driver class name.
String	getLicensePropertyName() Gets the name of the license property.
int	getMaxStringLiteralSize() Gets the maximum string literal size.
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	getName() Gets the name of the driver.
String	getPropsWizardResource(String connectionDriver) Gets the name of the xml file used to create a wizard for editing properties.
String	getSqlForExternalTool(Alias alias, String sql, SqlParser parser) Gets the sql for external tool.
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	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.
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	supportsIndexes() Supports indexes.
boolean	supportsScripts() If true the database supports extended sql, such as PLSQL, Transact SQL, etc.

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

convertStringForStorage, deleteStagingBinary, filter, getAddColumnSql, getAlterTableAddColumnSql, getBegin, getBeginSplited, getBlob, getCallSql, getCharUsedForColumnsWithSpaces, getClob, getCursorLoopEndSql, getCursorLoopStartSql, getCursorRecAccessSql, getDeclare, getDeclareCursorEndSql, getDeclareCursorSql, getDeclareCursorVarSql, getDefaultFunctionClass, getDefaultType, getDelimiter, getDestinationInfo, getDropSql, getEnd, getEndSplited, getIf, getIfBegin, getIfElse, getIfEnd, getInitSql, getLinesLimit, getMaxCharSize, getMaxPrecision, getMaxScale, getMaxVarcharSize, getMetadataSelectClause, getMetadataWhereClause, getObject, getOnException, getOnExceptionBegin, getOnExceptionEnd, getParamType, getParentDriver, getParentDriverName, getPrecision, getSafeDelimiter, getTempTableName, getVarDeclare, getVarName, getWrongScale, ignoreExceptionsDuringInit, isMergeInNonCallableSupported, needSeparateConnectionForDdl, replaceOnException, requiresRollbackAfterSqlError, setBlob, setClob, setInitSql, setLinesLimit, setMaxCharSize, setMaxPrecision, setMaxScale, setMaxStringLiteralSize, setMaxVarcharSize, setParentDriverName, supportsAnonymousBlocks, supportsBinaryInProc, supportsCallableStatement, supportsExplainPlan, supportsExternalTool, supportsInnerFunctions, supportsParamsInAnonymousBlocks, supportsRollbackAfterDDL, updateStagingBlob, updateStagingClob, value2StorageValue

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

alwaysEncloseTableAndColumnsInQuotes, captureLog, compareTo, externalToolRequiresRedirect, getAllowedIdentifierChars, getAlterTableAddColumnSql, getAutotrace, getCaseSensitive, getCmdOptions, getColumns, getConfigFileName, getConnectionFile, getDefaultNull, getDeleteStatement, getDisplayName, getErrorLinePattern, getExtensionRank, getHome, getIdentifierName, getIdentifierName, getInsertStatement, getLocalUnitClassPath, getNativeType, getObjectCheckSql, getPostDeclareSql, getProperties, getSafeSql, getSelectStatement, getSqlForAutotrace, getSqlForExplainPlan, getSqlKeywordsFileName, getStartTransactionSql, getStringFieldSizeMultiplier, getTableName, getTablePrefixWhenAddingTable, getType, getUpdateStatement, isEqualDriver, requiresExecuteQuery, requiresSeparateConnectionForIndexes, setAlwaysEncloseTableAndColumnsInQuotes, setCaseSensitive, setStringFieldSizeMultiplier, setUpConnection, supportColonInFormatter, supportsAutotrace, 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, ifDoesNotExistSql, ifExistsSql, openCloseConnectionOnDdl, requiresSemicolonInMerge

Field Detail

MAX_STRING_LITERAL_SIZE

public static int MAX_STRING_LITERAL_SIZE

The MAX STRINg LITERAL SIZE.

MAX_NUMBER_PREC_SIZE

public static int MAX_NUMBER_PREC_SIZE

The maximum precision size.

MAX_NUMBER_SCALE_SIZE

public static int MAX_NUMBER_SCALE_SIZE

The maximum scale size.

Constructor Detail

SnowflakeDriver

public SnowflakeDriver()

Method Detail

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

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

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

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

getMaxStringLiteralSize

public int getMaxStringLiteralSize()

Description copied from interface: Driver

Gets the maximum string literal size.

Specified by:

getMaxStringLiteralSize in interface Driver

Overrides:

getMaxStringLiteralSize in class SimpleDriver

Returns:

the maximum string literal size

getMetadataClassName

public String getMetadataClassName()

Description copied from interface: Driver

Gets the metadata driver class name.

Returns:

the metadata driver class name

getName

public String getName()

Description copied from interface: Driver

Gets the name of the driver.

Returns:

the name of the driver

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

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

getTopSelectClause

public String getTopSelectClause(int top)

Description copied from interface: Driver

Gets the "top select" clause. Used to select first n rows.

Specified by:

getTopSelectClause in interface Driver

Overrides:

getTopSelectClause in class SimpleDriver

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.

Specified by:

getTopTrailClause in interface Driver

Overrides:

getTopTrailClause in class SimpleDriver

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.

Specified by:

getTopWhereClause in interface Driver

Overrides:

getTopWhereClause in class SimpleDriver

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.

Specified by:

getType in interface Driver

Overrides:

getType in class SimpleDriver

Parameters:

fieldDef - the field definition

key - the key field(s)

fieldsRepository - the fields repository

Returns:

the native field type

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.

Specified by:

convertValueForStorage in interface Driver

Overrides:

convertValueForStorage in class SimpleDriver

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

getUrlPattern

public String getUrlPattern()

Description copied from interface: Driver

Gets the jdbc driver url pattern.

Returns:

the jdbc driver url pattern

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

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

supportsScripts

public boolean supportsScripts()

Description copied from interface: Driver

If true the database supports extended sql, such as PLSQL, Transact SQL, etc. Used by UI to disable/enable menu items.

Returns:

true, if database database supports extended sql

getCreateTableSql

public String getCreateTableSql(String name,
                                DataSet dataSet,
                                boolean isTemporary,
                                String key,
                                FieldsRepository fieldsRepository)

Description copied from interface: Driver

Gets the "create table" sql.

Specified by:

getCreateTableSql in interface Driver

Overrides:

getCreateTableSql in class SimpleDriver

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

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 SimpleDriver

Parameters:

fieldsAndValues - the fields and values

tableName - the table name

key - the key field(s)

Returns:

the merge statement

supportsIndexes

public boolean supportsIndexes()

Description copied from interface: Driver

Supports indexes.

Returns:

true, if database supports indexes