Package org.pentaho.di.core.database

Class AthenaDatabaseMeta

java.lang.Object

org.pentaho.di.core.database.BaseDatabaseMeta

org.pentaho.di.core.database.AthenaDatabaseMeta

All Implemented Interfaces:

Cloneable, DatabaseInterface, DatabaseInterfaceExtended

public class AthenaDatabaseMeta
extends BaseDatabaseMeta

https://docs.aws.amazon.com/athena/latest/ug/jdbc-v3-driver.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AthenaDatabaseMeta.AuthType

Field Summary

Fields inherited from class org.pentaho.di.core.database.BaseDatabaseMeta

ATTRIBUTE_CLUSTER_DBNAME_PREFIX, ATTRIBUTE_CLUSTER_HOSTNAME_PREFIX, ATTRIBUTE_CLUSTER_PASSWORD_PREFIX, ATTRIBUTE_CLUSTER_PORT_PREFIX, ATTRIBUTE_CLUSTER_USERNAME_PREFIX, ATTRIBUTE_FORCE_IDENTIFIERS_TO_LOWERCASE, ATTRIBUTE_FORCE_IDENTIFIERS_TO_UPPERCASE, ATTRIBUTE_INITIAL_POOL_SIZE, ATTRIBUTE_IS_CLUSTERED, ATTRIBUTE_MAXIMUM_POOL_SIZE, ATTRIBUTE_MSSQL_DOUBLE_DECIMAL_SEPARATOR, ATTRIBUTE_POOLING_PARAMETER_PREFIX, ATTRIBUTE_PORT_NUMBER, 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_POOLING, ATTRIBUTE_USE_RESULT_STREAMING, AUTOINCREMENT_SQL_FOR_BATCH_ID, NAMED_CLUSTER_ID, poolingParameters, releaseSavepoint, SELECT_COUNT_STATEMENT, SEQUENCE_FOR_BATCH_ID

Constructor Summary

Constructors

Constructor	Description
AthenaDatabaseMeta()

Method Summary

Modifier and Type	Method	Description
int[]	getAccessTypeList()	Get the list of possible access types for a database.
String	getAddColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to add a column to the specified table
Optional<String>	getAttribute(String name)
AthenaDatabaseMeta.AuthType	getAuthType()
String	getCatalog()
int	getDefaultDatabasePort()
String	getDriverClass()	Obtain the name of the JDBC driver class that we need to use!
String	getEndQuote()
String	getFieldDefinition(ValueMetaInterface v, String tk, String pk, boolean useAutoinc, boolean addFieldName, boolean addCr)	Describe a Value as a field in the database.
String	getLimitClause(int nrRows)
String	getModifyColumnStatement(String tablename, ValueMetaInterface v, String tk, boolean useAutoinc, String pk, boolean semicolon)	Generates the SQL statement to modify a column in the specified table
String	getOutputLocation()
Optional<String>	getProfileName()
String	getRegion()
String[]	getReservedWords()
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	getStartQuote()
String	getURL(String hostname, String port, String databaseName)
String[]	getUsedLibraries()
String	getWorkGroup()
String	getXulOverlayFile()
void	setAttributes(Properties attributes)	Set extra attributes on this database connection
void	setAuthType(AthenaDatabaseMeta.AuthType AuthType)
void	setCatalog(String catalog)
void	setConnectionSpecificInfoFromAttributes(Map<String,String> attributes)	Sets connection-specific information from the provided attributes map in the overridden methods.
void	setOutputLocation(String outputLocation)
void	setProfileName(String profileName)
void	setRegion(String region)
void	setWorkGroup(String workgroup)

Methods inherited from class org.pentaho.di.core.database.BaseDatabaseMeta

addAttribute, addDefaultOptions, addExtraOption, canTest, checkIndexExists, clone, customizeValueFromSQLType, fullExceptionLog, generateColumnAlias, getAccessType, getAttribute, getAttributes, getBackwardsCompatibleSchemaTableCombination, getBackwardsCompatibleTable, getConnectionPoolingProperties, getConnectSQL, getCreateTableStatement, getDatabaseFactoryName, getDatabaseName, getDatabasePortNumberString, getDataTablespace, getDataTablespaceDDL, getDefaultOptions, getDisplayName, getDropColumnStatement, getDropTableIfExistsStatement, getExtraOptionIndicator, getExtraOptions, getExtraOptionSeparator, getExtraOptionsHelpText, getExtraOptionValueSeparator, getFieldnameProtector, getFunctionAverage, getFunctionCount, getFunctionMaximum, getFunctionMinimum, getFunctionSum, getHostname, getIndexTablespace, getIndexTablespaceDDL, getInitialPoolSize, getInitialPoolSizeString, getMaxColumnsInIndex, getMaximumPoolSize, getMaximumPoolSizeString, getMaxTextFieldLength, getMaxVARCHARLength, getName, getNamedCluster, getNextBatchId, getNextBatchIdUsingAutoIncSQL, getNextBatchIdUsingLockTables, getNextBatchIdUsingSequence, getNotFoundTK, getObjectId, getPartitioningInformation, getPassword, getPluginId, getPluginName, getPreferredSchemaName, getSafeFieldname, getSchemaTableCombination, getSelectCountStatement, getSequenceNoMaxValueOption, getServername, getSQLColumnExists, getSQLCurrentSequenceValue, getSQLInsertAutoIncUnknownDimensionRow, getSQLListOfProcedures, getSQLListOfSchemas, getSQLListOfSequences, getSQLLockTables, getSQLNextSequenceValue, getSqlScriptStatements, getSQLSequenceExists, getSQLTableExists, getSQLUnlockTables, getSQLValue, getSynonymTypes, getTablespaceDDL, getTableTypes, getTruncateTableStatement, getUsername, getValueFromResultSet, getViewTypes, isChanged, isDefaultingToUppercase, isDisplaySizeTwiceThePrecision, isExplorable, isFetchSizeSupported, isForcingIdentifiersToLowerCase, isForcingIdentifiersToUpperCase, isMySQLVariant, isPartitioned, isQuoteAllFields, isRequiringTransactionsOnQueries, isStreamingResults, isSystemTable, isUsingConnectionPool, isUsingDoubleDecimalAsSchemaTableSeparator, needsPlaceHolder, needsToLockAllTables, onlySpaces, parseStatements, preserveReservedCase, quoteReservedWords, quoteSQLString, releaseSavepoint, requiresCastToVariousForIsNull, requiresCreateTablePrimaryKeyAppend, requiresName, setAccessType, setChanged, setConnectionPoolingProperties, setConnectSQL, setDatabaseName, setDatabasePortNumberString, setDataTablespace, setDisplayName, setForcingIdentifiersToLowerCase, setForcingIdentifiersToUpperCase, setHostname, setIndexTablespace, setInitialPoolSize, setInitialPoolSizeString, setMaximumPoolSize, setMaximumPoolSizeString, setName, setNamedCluster, setObjectId, setPartitioned, setPartitioningInformation, setPassword, setPluginId, setPluginName, setPreferredSchemaName, setPreserveReservedCase, setQuoteAllFields, setServername, setStreamingResults, setSupportsBooleanDataType, setSupportsTimestampDataType, setUsername, setUsingConnectionPool, setUsingDoubleDecimalAsSchemaTableSeparator, supportsAutoGeneratedKeys, supportsAutoInc, supportsBatchUpdates, supportsBitmapIndex, supportsBooleanDataType, supportsCatalogs, supportsEmptyTransactions, supportsErrorHandling, supportsErrorHandlingOnBatchUpdates, supportsFloatRoundingOnUpdate, supportsGetBlob, supportsNewLinesInSQL, supportsOptionsInURL, supportsPreparedStatementMetadataRetrieval, supportsRepository, supportsResultSetMetadataRetrievalOnly, supportsSchemas, supportsSequenceNoMaxValueOption, supportsSequences, supportsSetCharacterStream, supportsSetLong, supportsSetMaxRows, supportsSynonyms, supportsTimestampDataType, supportsTimeStampToDateConversion, supportsTransactions, supportsViews, useSafePoints, useSchemaNameForTableList

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.core.database.DatabaseInterface

createSqlScriptParser, getLegacyColumnName, getNamedClusterList, getSchemas, getSQLListOfSchemas, getTables, getUnsupportedTableOutputMessage, putOptionalOptions, supportsIndexes, supportsStandardTableOutput

Constructor Details

AthenaDatabaseMeta

public AthenaDatabaseMeta()

Method Details

getDriverClass

public String getDriverClass()

Description copied from interface: DatabaseInterface

Obtain the name of the JDBC driver class that we need to use!

Returns:

the name of the JDBC driver class for the specific database

setAttributes

public void setAttributes(Properties attributes)

Description copied from class: BaseDatabaseMeta

Set extra attributes on this database connection

Specified by:

setAttributes in interface DatabaseInterface

Overrides:

setAttributes in class BaseDatabaseMeta

Parameters:

attributes - The extra attributes to set on this database connection.

getAccessTypeList

public int[] getAccessTypeList()

Description copied from interface: DatabaseInterface

Get the list of possible access types for a database.

Specified by:

getAccessTypeList in interface DatabaseInterface

Specified by:

getAccessTypeList in class BaseDatabaseMeta

Returns:

the list of possible access types for a database.

getDefaultDatabasePort

public int getDefaultDatabasePort()

Specified by:

getDefaultDatabasePort in interface DatabaseInterface

Overrides:

getDefaultDatabasePort in class BaseDatabaseMeta

Returns:

the default database port number

getURL

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

Parameters:

hostname - the hostname

port - the port as a string

databaseName - the database name

Returns:

the URL to use for connecting to the database.

Throws:

KettleDatabaseException - in case a configuration error is detected.

getWorkGroup

public String getWorkGroup()

setWorkGroup

public void setWorkGroup(String workgroup)

getRegion

public String getRegion()

setRegion

public void setRegion(String region)

getCatalog

public String getCatalog()

setCatalog

public void setCatalog(String catalog)

getOutputLocation

public String getOutputLocation()

setOutputLocation

public void setOutputLocation(String outputLocation)

getAuthType

public AthenaDatabaseMeta.AuthType getAuthType()

setAuthType

public void setAuthType(AthenaDatabaseMeta.AuthType AuthType)

getProfileName

public Optional<String> getProfileName()

setProfileName

public void setProfileName(String profileName)

getAttribute

public Optional<String> getAttribute(String name)

getLimitClause

public String getLimitClause(int nrRows)

Specified by:

getLimitClause in interface DatabaseInterface

Overrides:

getLimitClause in class BaseDatabaseMeta

Parameters:

nrRows - The number of rows to which we want to limit the result of the query.

Returns:

the clause after a select statement to limit the number of rows

getSQLQueryFields

public String getSQLQueryFields(String tableName)

Description copied from class: BaseDatabaseMeta

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 DatabaseInterface

Overrides:

getSQLQueryFields in class BaseDatabaseMeta

Parameters:

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

Returns:

The SQL to launch.

getXulOverlayFile

public String getXulOverlayFile()

Specified by:

getXulOverlayFile in interface DatabaseInterface

Overrides:

getXulOverlayFile in class BaseDatabaseMeta

Returns:

The name of the XUL overlay file to display extra options. This is only used in case of a non-standard plugin. Usually this method returns null.

getReservedWords

public String[] getReservedWords()

Specified by:

getReservedWords in interface DatabaseInterface

Overrides:

getReservedWords in class BaseDatabaseMeta

Returns:

an array of reserved words for the database type...

getFieldDefinition

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

Description copied from interface: DatabaseInterface

Describe a Value as a field in the database.

Parameters:

v - The value to describe

tk - The field that's going to be the technical key

pk - The field that's going to be the primary key

useAutoinc - Use autoincrement or not

addFieldName - Add the fieldname to the definition or not

addCr - Add a cariage return at the end of the definition or not.

Returns:

a value described as a field in this database.

getAddColumnStatement

public String getAddColumnStatement(String tablename,
 ValueMetaInterface v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Description copied from interface: DatabaseInterface

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

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,
 ValueMetaInterface v,
 String tk,
 boolean useAutoinc,
 String pk,
 boolean semicolon)

Description copied from interface: DatabaseInterface

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

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

getUsedLibraries

public String[] getUsedLibraries()

Returns:

the required libraries (in lib) for this database connection.

getStartQuote

public String getStartQuote()

Specified by:

getStartQuote in interface DatabaseInterface

Overrides:

getStartQuote in class BaseDatabaseMeta

Returns:

The start quote sequence, mostly just double quote, but sometimes [, ...

getEndQuote

public String getEndQuote()

Specified by:

getEndQuote in interface DatabaseInterface

Overrides:

getEndQuote in class BaseDatabaseMeta

Returns:

The end quote sequence, mostly just double quote, but sometimes ], ...

setConnectionSpecificInfoFromAttributes

public void setConnectionSpecificInfoFromAttributes(Map<String,String> attributes)

Description copied from interface: DatabaseInterface

Sets connection-specific information from the provided attributes map in the overridden methods. This method functions similarly to the and methods. For Webttle to interact properly with the specific database type, this method should be overridden whenever any additional attributes need to be set for the connection.

Parameters:

attributes - a map containing key-value pairs of connection-specific attributes.