Package org.apache.hop.databases.clickhouse

Class ClickhouseDatabaseMeta

java.lang.Object

org.apache.hop.core.database.BaseDatabaseMeta

org.apache.hop.databases.clickhouse.ClickhouseDatabaseMeta

All Implemented Interfaces:

Cloneable, IDatabase

@DatabaseMetaPlugin(type="CLICKHOUSE",
                    typeDescription="ClickHouse",
                    documentationUrl="/database/databases/clickhouse.html")
@GuiPlugin(id="GUI-ClickhouseDatabaseMeta")
public class ClickhouseDatabaseMeta
extends BaseDatabaseMeta
implements IDatabase

Contains Clickhouse specific information through static final members

https://clickhouse.tech/docs/en/sql-reference/

Field Summary

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

Method Summary

Modifier and Type	Method	Description
int[]	getAccessTypeList()
String	getAddColumnStatement(String tableName, IValueMeta v, String tk, boolean useAutoinc, String pk, boolean semicolon)
int	getDefaultDatabasePort()
String	getDriverClass()
String	getDropColumnStatement(String tableName, IValueMeta v, String tk, boolean useAutoinc, String pk, boolean semicolon)
String	getExtraOptionIndicator()
String	getExtraOptionSeparator()
String	getExtraOptionsHelpText()
String	getFieldDefinition(IValueMeta v, String surrogateKey, String primaryKey, boolean useAutoinc, boolean addFieldName, boolean addCr)
String	getLimitClause(int nrRows)
String	getModifyColumnStatement(String tableName, IValueMeta v, String tk, boolean useAutoinc, String pk, boolean semicolon)
String[]	getReservedWords()
String	getSqlColumnExists(String columnname, String tableName)
String	getSqlDeleteStmt(String tableName)	Get the DELETE statement for the current database given the table name
String	getSqlInsertAutoIncUnknownDimensionRow(String schemaTable, String keyField, String versionField)
String	getSqlQueryColumnFields(String columnname, String tableName)
String	getSqlQueryFields(String tableName)	Returns the minimal SQL to launch in order to determine the layout of the resultset for a given database table
String	getSqlTableExists(String tableName)
String	getSqlUpdateStmt(String tableName)	Get the UPDATE statement for the current database given the table name
String	getURL(String hostName, String port, String databaseName)
boolean	isQuoteAllFields()
boolean	isReleaseSavepoint()
boolean	isRequiresName()
boolean	isRequiringTransactionsOnQueries()
boolean	isSupportsBooleanDataType()
boolean	isSupportsCustomDeleteStmt()
boolean	isSupportsCustomUpdateStmt()
boolean	IsSupportsErrorHandlingOnBatchUpdates()
boolean	isSupportsSchemas()
boolean	isSupportsSequences()
boolean	isSupportsSynonyms()
boolean	isSupportsTimeStampToDateConversion()
boolean	isSupportsTransactions()
boolean	isSupportsViews()
String	quoteSqlString(String string)
boolean	useSchemaNameForTableList()

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, getEndQuote, getExtraOptions, getExtraOptionValueSeparator, getFieldnameProtector, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getManualUrl, getMaxColumnsInIndex, getMaxTextFieldLength, getMaxVARCHARLength, getNotFoundTK, getPassword, getPluginId, getPluginName, getPort, getPreferredSchemaName, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSqlCurrentSequenceValue, getSqlInsertClauseBeforeFields, getSqlListOfProcedures, getSqlListOfSchemas, getSqlListOfSequences, getSqlLockTables, getSqlNextSequenceValue, getSqlScriptStatements, getSqlSequenceExists, getSqlUnlockTables, getSqlValue, getStartQuote, getSynonymTypes, getTablespaceDDL, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, hasIndex, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isDuckDbVariant, isExasolVariant, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isFullExceptionLog, isInformixVariant, isMsSqlServerNativeVariant, isMsSqlServerVariant, isMySqlVariant, isNeedsPlaceHolder, isNeoviewVariant, isNetezzaVariant, isOracleVariant, isPostgresVariant, isPreserveReservedCase, isQuoteReservedWords, isRequiresCastToVariousForIsNull, isRequiresCreateTablePrimaryKeyAppend, isSqliteVariant, isStreamingResults, isStrictBigNumberInterpretation, isSupportsAutoGeneratedKeys, isSupportsAutoInc, isSupportsBatchUpdates, isSupportsBitmapIndex, isSupportsCatalogs, isSupportsEmptyTransactions, isSupportsErrorHandling, isSupportsFloatRoundingOnUpdate, isSupportsGetBlob, isSupportsNewLinesInSql, isSupportsOptionsInURL, isSupportsPreparedStatementMetadataRetrieval, isSupportsResultSetMetadataRetrievalOnly, isSupportsSequenceNoMaxValueOption, isSupportsSetCharacterStream, isSupportsSetLong, isSupportsSetMaxRows, isSupportsTimestampDataType, isSybaseIQVariant, isSybaseVariant, isSystemTable, isTeradataVariant, isUseSafePoints, 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

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, getEndQuote, getExtraOptions, getExtraOptionValueSeparator, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getLegacyColumnName, getManualUrl, getMaxColumnsInIndex, getMaxTextFieldLength, getMaxVARCHARLength, getNotFoundTK, getPassword, getPluginId, getPluginName, getPort, getPreferredSchemaName, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSqlCurrentSequenceValue, getSqlInsertClauseBeforeFields, getSqlListOfProcedures, getSqlListOfSchemas, getSqlListOfSequences, getSqlLockTables, getSqlNextSequenceValue, getSqlScriptStatements, getSqlSequenceExists, getSqlUnlockTables, getSqlValue, getStartQuote, getSynonymTypes, getTableTypes, getTruncateTableStatement, getUnsupportedTableOutputMessage, getUsername, getValueFromResultSet, getViewTypes, hasIndex, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isDuckDbVariant, isExasolVariant, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isFullExceptionLog, isInformixVariant, isMsSqlServerNativeVariant, isMsSqlServerVariant, isMySqlVariant, isNeedsPlaceHolder, isNeoviewVariant, isNetezzaVariant, isOracleVariant, isPostgresVariant, isPreserveReservedCase, isQuoteReservedWords, isRequiresCastToVariousForIsNull, isRequiresCreateTablePrimaryKeyAppend, isSqliteVariant, isStreamingResults, isStrictBigNumberInterpretation, isSupportsAutoGeneratedKeys, isSupportsAutoInc, isSupportsBatchUpdates, isSupportsBitmapIndex, isSupportsCatalogs, isSupportsEmptyTransactions, isSupportsErrorHandling, isSupportsFloatRoundingOnUpdate, isSupportsGetBlob, isSupportsNewLinesInSql, isSupportsOptionsInURL, isSupportsPreparedStatementMetadataRetrieval, isSupportsResultSetMetadataRetrievalOnly, isSupportsSequenceNoMaxValueOption, isSupportsSetCharacterStream, isSupportsSetLong, isSupportsSetMaxRows, isSupportsTimestampDataType, isSybaseIQVariant, isSybaseVariant, isSystemTable, isTeradataVariant, isUseSafePoints, 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

Constructor Detail

ClickhouseDatabaseMeta

public ClickhouseDatabaseMeta()

Method Detail

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

isSupportsCustomDeleteStmt

public boolean isSupportsCustomDeleteStmt()

Specified by:

isSupportsCustomDeleteStmt in interface IDatabase

Overrides:

isSupportsCustomDeleteStmt in class BaseDatabaseMeta

isSupportsCustomUpdateStmt

public boolean isSupportsCustomUpdateStmt()

Specified by:

isSupportsCustomUpdateStmt in interface IDatabase

Overrides:

isSupportsCustomUpdateStmt in class BaseDatabaseMeta

getSqlDeleteStmt

public String getSqlDeleteStmt(String tableName)

Get the DELETE statement for the current database given the table name

Specified by:

getSqlDeleteStmt in interface IDatabase

Overrides:

getSqlDeleteStmt in class BaseDatabaseMeta

Parameters:

tableName -

Returns:

getSqlUpdateStmt

public String getSqlUpdateStmt(String tableName)

Get the UPDATE statement for the current database given the table name

Specified by:

getSqlUpdateStmt in interface IDatabase

Overrides:

getSqlUpdateStmt in class BaseDatabaseMeta

Parameters:

tableName -

Returns:

getURL

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

Specified by:

getURL in interface IDatabase

getAddColumnStatement

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

Specified by:

getAddColumnStatement in interface IDatabase

getDropColumnStatement

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

Specified by:

getDropColumnStatement in interface IDatabase

Overrides:

getDropColumnStatement in class BaseDatabaseMeta

getModifyColumnStatement

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

Specified by:

getModifyColumnStatement in interface IDatabase

getFieldDefinition

public String getFieldDefinition(IValueMeta v,
                                 String surrogateKey,
                                 String primaryKey,
                                 boolean useAutoinc,
                                 boolean addFieldName,
                                 boolean addCr)

Specified by:

getFieldDefinition in interface IDatabase

getLimitClause

public String getLimitClause(int nrRows)

Specified by:

getLimitClause in interface IDatabase

Overrides:

getLimitClause in class BaseDatabaseMeta

getSqlQueryFields

public String getSqlQueryFields(String tableName)

Returns the minimal SQL to launch in order to determine the layout of the resultset for a given database table

Specified by:

getSqlQueryFields in interface IDatabase

Overrides:

getSqlQueryFields in class BaseDatabaseMeta

Parameters:

tableName - The name of the table to determine the layout for

Returns:

The SQL to launch.

getSqlTableExists

public String getSqlTableExists(String tableName)

Specified by:

getSqlTableExists in interface 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)

getExtraOptionSeparator

public String getExtraOptionSeparator()

Specified by:

getExtraOptionSeparator in interface IDatabase

Overrides:

getExtraOptionSeparator in class BaseDatabaseMeta

Returns:

The extra option separator in database URL for this platform (usually this is semicolon ; )

isQuoteAllFields

public boolean isQuoteAllFields()

Specified by:

isQuoteAllFields in interface IDatabase

Overrides:

isQuoteAllFields in class BaseDatabaseMeta

Returns:

true if all fields should always be quoted in db

getExtraOptionIndicator

public String getExtraOptionIndicator()

Specified by:

getExtraOptionIndicator in interface IDatabase

Overrides:

getExtraOptionIndicator in class BaseDatabaseMeta

Returns:

This indicator separates the normal URL from the options

isSupportsSchemas

public boolean isSupportsSchemas()

Specified by:

isSupportsSchemas in interface IDatabase

Overrides:

isSupportsSchemas in class BaseDatabaseMeta

Returns:

true if the database supports schemas

isSupportsTransactions

public boolean isSupportsTransactions()

Specified by:

isSupportsTransactions in interface IDatabase

Overrides:

isSupportsTransactions in class BaseDatabaseMeta

Returns:

true if the database supports transactions.

isSupportsViews

public boolean isSupportsViews()

Specified by:

isSupportsViews in interface IDatabase

Overrides:

isSupportsViews in class BaseDatabaseMeta

Returns:

true if the database supports views

isSupportsSequences

public boolean isSupportsSequences()

Specified by:

isSupportsSequences in interface IDatabase

Overrides:

isSupportsSequences in class BaseDatabaseMeta

isSupportsSynonyms

public boolean isSupportsSynonyms()

Specified by:

isSupportsSynonyms in interface IDatabase

Overrides:

isSupportsSynonyms in class BaseDatabaseMeta

isSupportsBooleanDataType

public boolean isSupportsBooleanDataType()

Specified by:

isSupportsBooleanDataType in interface IDatabase

Overrides:

isSupportsBooleanDataType in class BaseDatabaseMeta

IsSupportsErrorHandlingOnBatchUpdates

public boolean IsSupportsErrorHandlingOnBatchUpdates()

Specified by:

IsSupportsErrorHandlingOnBatchUpdates in interface IDatabase

Overrides:

IsSupportsErrorHandlingOnBatchUpdates in class BaseDatabaseMeta

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

getSqlInsertAutoIncUnknownDimensionRow

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

Specified by:

getSqlInsertAutoIncUnknownDimensionRow in interface IDatabase

Overrides:

getSqlInsertAutoIncUnknownDimensionRow in class BaseDatabaseMeta

quoteSqlString

public String quoteSqlString(String string)

Specified by:

quoteSqlString in interface IDatabase

Overrides:

quoteSqlString in class BaseDatabaseMeta

isReleaseSavepoint

public boolean isReleaseSavepoint()

Specified by:

isReleaseSavepoint in interface IDatabase

Overrides:

isReleaseSavepoint in class BaseDatabaseMeta

isRequiringTransactionsOnQueries

public boolean isRequiringTransactionsOnQueries()

Specified by:

isRequiringTransactionsOnQueries in interface IDatabase

Overrides:

isRequiringTransactionsOnQueries in class BaseDatabaseMeta

isRequiresName

public boolean isRequiresName()

Specified by:

isRequiresName in interface IDatabase

Overrides:

isRequiresName in class BaseDatabaseMeta

useSchemaNameForTableList

public boolean useSchemaNameForTableList()

Specified by:

useSchemaNameForTableList in interface IDatabase

Overrides:

useSchemaNameForTableList in class BaseDatabaseMeta

Returns:

true if we need to supply the schema-name to getTables in order to get a correct list of items.

isSupportsTimeStampToDateConversion

public boolean isSupportsTimeStampToDateConversion()

Specified by:

isSupportsTimeStampToDateConversion in interface IDatabase

Overrides:

isSupportsTimeStampToDateConversion in class BaseDatabaseMeta

Returns:

true if the database resultsets support getTimeStamp() to retrieve date-time. (Date)