Package org.apache.hop.databases.mssql

Class MsSqlServerDatabaseMeta

java.lang.Object

org.apache.hop.core.database.BaseDatabaseMeta

org.apache.hop.databases.mssql.MsSqlServerDatabaseMeta

All Implemented Interfaces:

Cloneable, IDatabase

@DatabaseMetaPlugin(type="MSSQL",
                    typeDescription="MS SQL Server",
                    documentationUrl="/database/databases/mssql.html")
@GuiPlugin(id="GUI-MSSQLServerDatabaseMeta")
public class MsSqlServerDatabaseMeta
extends BaseDatabaseMeta
implements IDatabase

Contains MS SQL specific information through static final members

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONST_ALTER_TABLE

Fields inherited from class org.apache.hop.core.database.BaseDatabaseMeta

accessType, ATTRIBUTE_FORCE_IDENTIFIERS_TO_LOWERCASE, ATTRIBUTE_FORCE_IDENTIFIERS_TO_UPPERCASE, ATTRIBUTE_MSSQL_DOUBLE_DECIMAL_SEPARATOR, ATTRIBUTE_PREFERRED_SCHEMA_NAME, ATTRIBUTE_PREFIX_EXTRA_OPTION, ATTRIBUTE_PRESERVE_RESERVED_WORD_CASE, ATTRIBUTE_QUOTE_ALL_FIELDS, ATTRIBUTE_SQL_CONNECT, ATTRIBUTE_SUPPORTS_BOOLEAN_DATA_TYPE, ATTRIBUTE_SUPPORTS_TIMESTAMP_DATA_TYPE, ATTRIBUTE_USE_RESULT_STREAMING, attributes, AUTOINCREMENT_SQL_FOR_BATCH_ID, databaseName, dataTablespace, hostname, ID_PASSWORD_LABEL, ID_PASSWORD_WIDGET, ID_USERNAME_LABEL, ID_USERNAME_WIDGET, indexTablespace, manualUrl, password, pluginId, pluginName, port, releaseSavepoint, SELECT_COUNT_STATEMENT, SEQUENCE_FOR_BATCH_ID, servername, username

Constructor Summary

Constructors

Constructor	Description
MsSqlServerDatabaseMeta()

Method Summary

Modifier and Type	Method	Description
int[]	getAccessTypeList()
String	getAddColumnStatement(String tableName, IValueMeta v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to add a column to the specified table
int	getDefaultDatabasePort()
String	getDriverClass()
String	getDropColumnStatement(String tableName, IValueMeta v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to drop a column from the specified table
String	getEndQuote()
String	getExtraOptionsHelpText()
String	getFieldDefinition(IValueMeta v, String tk, String pk, boolean useAutoinc, boolean addFieldName, boolean addCr)
String	getInstanceName()
int	getMaxVARCHARLength()
String	getModifyColumnStatement(String tableName, IValueMeta v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to modify a column in the specified table
String[]	getReservedWords()
String	getSchemaTableCombination(String schemaName, String tablePart)
String	getSqlColumnExists(String columnname, String tableName)
String	getSqlCurrentSequenceValue(String sequenceName)
String	getSqlInsertAutoIncUnknownDimensionRow(String schemaTable, String keyField, String versionField)	Get the SQL to insert a new empty unknown record in a dimension.
String	getSqlListOfProcedures()
String	getSqlListOfSchemas()
String	getSqlListOfSequences()
String	getSqlLockTables(String[] tableNames)
String	getSqlNextSequenceValue(String sequenceName)
String	getSqlQueryColumnFields(String columnname, String tableName)
String	getSqlQueryFields(String tableName)
String	getSqlSequenceExists(String sequenceName)
String	getSqlTableExists(String tableName)
String	getStartQuote()
String	getURL(String hostname, String port, String databaseName)	The URL format for jTDS is:
boolean	hasIndex(Database database, String schemaName, String tableName, String[] idxFields)	Verifies on the specified database connection if an index exists on the fields with the specified name.
boolean	isMsSqlServerVariant()
boolean	isSupportsBitmapIndex()
boolean	isSupportsCatalogs()
boolean	IsSupportsErrorHandlingOnBatchUpdates()
boolean	isSupportsSchemas()
boolean	isSupportsSequenceNoMaxValueOption()
boolean	isSupportsSequences()
boolean	isSupportsSynonyms()
boolean	isUseSafePoints()
boolean	isUsingDoubleDigit()	Gets usingDoubleDigit
String	quoteSqlString(String string)
void	setInstanceName(String instanceName)
void	setUsingDoubleDigit(boolean usingDoubleDigit)

Methods inherited from class org.apache.hop.core.database.BaseDatabaseMeta

addAttribute, addDefaultOptions, addExtraOption, canTest, clone, customizeValueFromSqlType, generateColumnAlias, getAccessType, getAttribute, getAttributeProperty, getAttributeProperty, getAttributes, getConnectSql, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDataTablespace, getDataTablespaceDDL, getDefaultOptions, getDropTableIfExistsStatement, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionValueSeparator, getFieldnameProtector, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getLimitClause, getManualUrl, getMaxColumnsInIndex, getMaxTextFieldLength, getNotFoundTK, getPassword, getPluginId, getPluginName, getPort, getPreferredSchemaName, getSafeFieldname, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSqlDeleteStmt, getSqlInsertClauseBeforeFields, getSqlScriptStatements, getSqlUnlockTables, getSqlUpdateStmt, getSqlValue, getSynonymTypes, getTablespaceDDL, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isDuckDbVariant, isExasolVariant, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isFullExceptionLog, isInformixVariant, isMsSqlServerNativeVariant, isMySqlVariant, isNeedsPlaceHolder, isNeoviewVariant, isNetezzaVariant, isOracleVariant, isPostgresVariant, isPreserveReservedCase, isQuoteAllFields, isQuoteReservedWords, isReleaseSavepoint, isRequiresCastToVariousForIsNull, isRequiresCreateTablePrimaryKeyAppend, isRequiresName, isRequiringTransactionsOnQueries, isSqliteVariant, isStreamingResults, isStrictBigNumberInterpretation, isSupportsAutoGeneratedKeys, isSupportsAutoInc, isSupportsBatchUpdates, isSupportsBooleanDataType, isSupportsCustomDeleteStmt, isSupportsCustomUpdateStmt, isSupportsEmptyTransactions, isSupportsErrorHandling, isSupportsFloatRoundingOnUpdate, isSupportsGetBlob, isSupportsNewLinesInSql, isSupportsOptionsInURL, isSupportsPreparedStatementMetadataRetrieval, isSupportsResultSetMetadataRetrievalOnly, isSupportsSetCharacterStream, isSupportsSetLong, isSupportsSetMaxRows, isSupportsTimestampDataType, isSupportsTimeStampToDateConversion, isSupportsTransactions, isSupportsViews, isSybaseIQVariant, isSybaseVariant, isSystemTable, isTeradataVariant, isUsingDoubleDecimalAsSchemaTableSeparator, onlySpaces, parseStatements, setAccessType, setAttributes, setChanged, setConnectSql, setDatabaseName, setDataTablespace, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setManualUrl, setPassword, setPluginId, setPluginName, setPort, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingDoubleDecimalAsSchemaTableSeparator, useSchemaNameForTableList

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hop.core.database.IDatabase

addAttribute, addDefaultOptions, addExtraOption, clone, createSqlScriptParser, customizeValueFromSqlType, generateColumnAlias, getAccessType, getAttribute, getAttributes, getConnectSql, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDataTablespace, getDataTablespaceDDL, getDefaultOptions, getDropTableIfExistsStatement, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getLegacyColumnName, getLimitClause, getManualUrl, getMaxColumnsInIndex, getMaxTextFieldLength, getNotFoundTK, getPassword, getPluginId, getPluginName, getPort, getPreferredSchemaName, getSafeFieldname, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSqlDeleteStmt, getSqlInsertClauseBeforeFields, getSqlScriptStatements, getSqlUnlockTables, getSqlUpdateStmt, getSqlValue, getSynonymTypes, getTableTypes, getTruncateTableStatement, getUnsupportedTableOutputMessage, getUsername, getValueFromResultSet, getViewTypes, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isDuckDbVariant, isExasolVariant, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isFullExceptionLog, isInformixVariant, isMsSqlServerNativeVariant, isMySqlVariant, isNeedsPlaceHolder, isNeoviewVariant, isNetezzaVariant, isOracleVariant, isPostgresVariant, isPreserveReservedCase, isQuoteAllFields, isQuoteReservedWords, isReleaseSavepoint, isRequiresCastToVariousForIsNull, isRequiresCreateTablePrimaryKeyAppend, isRequiresName, isRequiringTransactionsOnQueries, isSqliteVariant, isStreamingResults, isStrictBigNumberInterpretation, isSupportsAutoGeneratedKeys, isSupportsAutoInc, isSupportsBatchUpdates, isSupportsBooleanDataType, isSupportsCustomDeleteStmt, isSupportsCustomUpdateStmt, isSupportsEmptyTransactions, isSupportsErrorHandling, isSupportsFloatRoundingOnUpdate, isSupportsGetBlob, isSupportsNewLinesInSql, isSupportsOptionsInURL, isSupportsPreparedStatementMetadataRetrieval, isSupportsResultSetMetadataRetrievalOnly, isSupportsSetCharacterStream, isSupportsSetLong, isSupportsSetMaxRows, isSupportsTimestampDataType, isSupportsTimeStampToDateConversion, isSupportsTransactions, isSupportsViews, isSybaseIQVariant, isSybaseVariant, isSystemTable, isTeradataVariant, isUsingDoubleDecimalAsSchemaTableSeparator, parseStatements, setAccessType, setAttributes, setChanged, setConnectSql, setDatabaseName, setDataTablespace, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setManualUrl, setPassword, setPluginId, setPluginName, setPort, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingDoubleDecimalAsSchemaTableSeparator, supportsStandardTableOutput, useSchemaNameForTableList

Field Details

CONST_ALTER_TABLE

public static final String CONST_ALTER_TABLE

See Also:

• Constant Field Values

Constructor Details

MsSqlServerDatabaseMeta

public MsSqlServerDatabaseMeta()

Method Details

getInstanceName

public String getInstanceName()

setInstanceName

public void setInstanceName(String instanceName)

isUsingDoubleDigit

public boolean isUsingDoubleDigit()

Gets usingDoubleDigit

Returns:

value of usingDoubleDigit

setUsingDoubleDigit

public void setUsingDoubleDigit(boolean usingDoubleDigit)

Parameters:

usingDoubleDigit - The usingDoubleDigit to set

isSupportsCatalogs

public boolean isSupportsCatalogs()

Specified by:

isSupportsCatalogs in interface IDatabase

Overrides:

isSupportsCatalogs in class BaseDatabaseMeta

getAccessTypeList

public int[] getAccessTypeList()

Specified by:

getAccessTypeList in interface IDatabase

Specified by:

getAccessTypeList in class BaseDatabaseMeta

getDefaultDatabasePort

public int getDefaultDatabasePort()

Specified by:

getDefaultDatabasePort in interface IDatabase

Overrides:

getDefaultDatabasePort in class BaseDatabaseMeta

getDriverClass

public String getDriverClass()

Specified by:

getDriverClass in interface IDatabase

getURL

public String getURL(String hostname,
 String port,
 String databaseName)

The URL format for jTDS is:

jdbc:jtds:<server_type>://<server>[:<port>][/<database>][;<property>=<value>[;...]]

Specified by:

getURL in interface IDatabase

getSchemaTableCombination

public String getSchemaTableCombination(String schemaName,
 String tablePart)

Specified by:

getSchemaTableCombination in interface IDatabase

Overrides:

getSchemaTableCombination in class BaseDatabaseMeta

isSupportsBitmapIndex

public boolean isSupportsBitmapIndex()

Specified by:

isSupportsBitmapIndex in interface IDatabase

Overrides:

isSupportsBitmapIndex in class BaseDatabaseMeta

Returns:

true if the database supports bitmap indexes

isSupportsSynonyms

public boolean isSupportsSynonyms()

Specified by:

isSupportsSynonyms in interface IDatabase

Overrides:

isSupportsSynonyms in class BaseDatabaseMeta

Returns:

true if the database supports synonyms

getSqlQueryFields

public String getSqlQueryFields(String tableName)

Specified by:

getSqlQueryFields in interface IDatabase

Overrides:

getSqlQueryFields in class BaseDatabaseMeta

getSqlTableExists

public String getSqlTableExists(String tableName)

Specified by:

getSqlTableExists in interface IDatabase

Overrides:

getSqlTableExists in class BaseDatabaseMeta

getSqlColumnExists

public String getSqlColumnExists(String columnname,
 String tableName)

Specified by:

getSqlColumnExists in interface IDatabase

Overrides:

getSqlColumnExists in class BaseDatabaseMeta

getSqlQueryColumnFields

public String getSqlQueryColumnFields(String columnname,
 String tableName)

getSqlLockTables

public String getSqlLockTables(String[] tableNames)

Specified by:

getSqlLockTables in interface IDatabase

Overrides:

getSqlLockTables in class BaseDatabaseMeta

Parameters:

tableNames - The names of the tables to lock

Returns:

The SQL command to lock database tables for write purposes. null is returned in case locking is not supported on the target database. null is the default value

getAddColumnStatement

public String getAddColumnStatement(String tableName,
 IValueMeta v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Generates the SQL statement to add a column to the specified table

Specified by:

getAddColumnStatement in interface IDatabase

Parameters:

tableName - The table to add

v - The column defined as a value

tk - the name of the technical key field

useAutoinc - whether or not this field uses auto increment

pk - the name of the primary key field

semicolon - whether or not to add a semi-colon behind the statement.

Returns:

the SQL statement to add a column to the specified table

getModifyColumnStatement

public String getModifyColumnStatement(String tableName,
 IValueMeta v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Generates the SQL statement to modify a column in the specified table

Specified by:

getModifyColumnStatement in interface IDatabase

Parameters:

tableName - The table to add

v - The column defined as a value

tk - the name of the technical key field

useAutoinc - whether or not this field uses auto increment

pk - the name of the primary key field

semicolon - whether or not to add a semi-colon behind the statement.

Returns:

the SQL statement to modify a column in the specified table

getDropColumnStatement

public String getDropColumnStatement(String tableName,
 IValueMeta v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Generates the SQL statement to drop a column from the specified table

Specified by:

getDropColumnStatement in interface IDatabase

Overrides:

getDropColumnStatement in class BaseDatabaseMeta

Parameters:

tableName - The table to add

v - The column defined as a value

tk - the name of the technical key field

useAutoinc - whether or not this field uses auto increment

pk - the name of the primary key field

semicolon - whether or not to add a semi-colon behind the statement.

Returns:

the SQL statement to drop a column from the specified table

getFieldDefinition

public String getFieldDefinition(IValueMeta v,
 String tk,
 String pk,
 boolean useAutoinc,
 boolean addFieldName,
 boolean addCr)

Specified by:

getFieldDefinition in interface IDatabase

getSqlListOfProcedures

public String getSqlListOfProcedures()

Specified by:

getSqlListOfProcedures in interface IDatabase

Overrides:

getSqlListOfProcedures in class BaseDatabaseMeta

Returns:

The SQL on this database to get a list of stored procedures.

getReservedWords

public String[] getReservedWords()

Specified by:

getReservedWords in interface IDatabase

Overrides:

getReservedWords in class BaseDatabaseMeta

getExtraOptionsHelpText

public String getExtraOptionsHelpText()

Specified by:

getExtraOptionsHelpText in interface IDatabase

Overrides:

getExtraOptionsHelpText in class BaseDatabaseMeta

hasIndex

public boolean hasIndex(Database database,
 String schemaName,
 String tableName,
 String[] idxFields)
                 throws HopDatabaseException

Verifies on the specified database connection if an index exists on the fields with the specified name.

Specified by:

hasIndex in interface IDatabase

Overrides:

hasIndex in class BaseDatabaseMeta

Parameters:

database - a connected database

schemaName -

tableName -

idxFields -

Returns:

true if the index exists, false if it doesn't.

Throws:

HopDatabaseException

getSqlListOfSchemas

public String getSqlListOfSchemas()

Specified by:

getSqlListOfSchemas in interface IDatabase

Overrides:

getSqlListOfSchemas in class BaseDatabaseMeta

isSupportsSchemas

public boolean isSupportsSchemas()

Specified by:

isSupportsSchemas in interface IDatabase

Overrides:

isSupportsSchemas in class BaseDatabaseMeta

getSqlInsertAutoIncUnknownDimensionRow

public String getSqlInsertAutoIncUnknownDimensionRow(String schemaTable,
 String keyField,
 String versionField)

Get the SQL to insert a new empty unknown record in a dimension.

Specified by:

getSqlInsertAutoIncUnknownDimensionRow in interface IDatabase

Overrides:

getSqlInsertAutoIncUnknownDimensionRow in class BaseDatabaseMeta

Parameters:

schemaTable - the schema-table name to insert into

keyField - The key field

versionField - the version field

Returns:

the SQL to insert the unknown record into the SCD.

getSqlNextSequenceValue

public String getSqlNextSequenceValue(String sequenceName)

Specified by:

getSqlNextSequenceValue in interface IDatabase

Overrides:

getSqlNextSequenceValue in class BaseDatabaseMeta

getSqlCurrentSequenceValue

public String getSqlCurrentSequenceValue(String sequenceName)

Specified by:

getSqlCurrentSequenceValue in interface IDatabase

Overrides:

getSqlCurrentSequenceValue in class BaseDatabaseMeta

getSqlSequenceExists

public String getSqlSequenceExists(String sequenceName)

Specified by:

getSqlSequenceExists in interface IDatabase

Overrides:

getSqlSequenceExists in class BaseDatabaseMeta

isSupportsSequences

public boolean isSupportsSequences()

Specified by:

isSupportsSequences in interface IDatabase

Overrides:

isSupportsSequences in class BaseDatabaseMeta

isSupportsSequenceNoMaxValueOption

public boolean isSupportsSequenceNoMaxValueOption()

Specified by:

isSupportsSequenceNoMaxValueOption in interface IDatabase

Overrides:

isSupportsSequenceNoMaxValueOption in class BaseDatabaseMeta

getSqlListOfSequences

public String getSqlListOfSequences()

Specified by:

getSqlListOfSequences in interface IDatabase

Overrides:

getSqlListOfSequences in class BaseDatabaseMeta

quoteSqlString

public String quoteSqlString(String string)

Specified by:

quoteSqlString in interface IDatabase

Overrides:

quoteSqlString in class BaseDatabaseMeta

Parameters:

string -

Returns:

A string that is properly quoted for use in an Oracle SQL statement (insert, update, delete, etc)

isUseSafePoints

public boolean isUseSafePoints()

Specified by:

isUseSafePoints in interface IDatabase

Overrides:

isUseSafePoints in class BaseDatabaseMeta

IsSupportsErrorHandlingOnBatchUpdates

public boolean IsSupportsErrorHandlingOnBatchUpdates()

Specified by:

IsSupportsErrorHandlingOnBatchUpdates in interface IDatabase

Overrides:

IsSupportsErrorHandlingOnBatchUpdates in class BaseDatabaseMeta

getMaxVARCHARLength

public int getMaxVARCHARLength()

Specified by:

getMaxVARCHARLength in interface IDatabase

Overrides:

getMaxVARCHARLength in class BaseDatabaseMeta

isMsSqlServerVariant

public boolean isMsSqlServerVariant()

Specified by:

isMsSqlServerVariant in interface IDatabase

Overrides:

isMsSqlServerVariant in class BaseDatabaseMeta

getStartQuote

public String getStartQuote()

Specified by:

getStartQuote in interface IDatabase

Overrides:

getStartQuote in class BaseDatabaseMeta

getEndQuote

public String getEndQuote()

Specified by:

getEndQuote in interface IDatabase

Overrides:

getEndQuote in class BaseDatabaseMeta