org.teiid.translator.jdbc
Class JDBCExecutionFactory

java.lang.Object
  org.teiid.translator.ExecutionFactory<DataSource,Connection>
      org.teiid.translator.jdbc.JDBCExecutionFactory

Direct Known Subclasses:

BaseDB2ExecutionFactory, BaseSybaseExecutionFactory, ExcelExecutionFactory, H2ExecutionFactory, HiveExecutionFactory, HsqlExecutionFactory, InformixExecutionFactory, IngresExecutionFactory, InterSystemsCacheExecutionFactory, MetaMatrixExecutionFactory, ModeShapeExecutionFactory, MySQLExecutionFactory, NetezzaExecutionFactory, OracleExecutionFactory, PostgreSQLExecutionFactory, SimpleJDBCExecutionFactory, TeiidExecutionFactory, TeradataExecutionFactory

@Translator(name="jdbc-ansi",
            description="JDBC ANSI translator, can used with any ANSI compatible JDBC Driver")
public class JDBCExecutionFactory
extends ExecutionFactory<DataSource,Connection>

JDBC implementation of Connector interface.

Nested Class Summary

Nested classes/interfaces inherited from class org.teiid.translator.ExecutionFactory

ExecutionFactory.Format, ExecutionFactory.NullOrder, ExecutionFactory.SupportedJoinCriteria

Field Summary

static int	DEFAULT_MAX_DEPENDENT_PREDICATES
static int	DEFAULT_MAX_IN_CRITERIA
static TimeZone	DEFAULT_TIME_ZONE

Fields inherited from class org.teiid.translator.ExecutionFactory

DEFAULT_MAX_FROM_GROUPS, DEFAULT_MAX_IN_CRITERIA_SIZE

Constructor Summary

JDBCExecutionFactory()

Method Summary

boolean	addSourceComment() Returns true to indicate that SQL should include a comment indicating the session and request ids.
protected void	afterInitialConnectionObtained(Connection connection) Called exactly once for this source.
void	bindValue(PreparedStatement stmt, Object param, Class<?> paramType, int i) Sets prepared statement parameter i with param.
void	closeConnection(Connection connection, DataSource factory) Closes a connection object from the given connection factory.
ProcedureExecution	createDirectExecution(List<Argument> arguments, Command command, ExecutionContext executionContext, RuntimeMetadata metadata, Connection conn)
protected JDBCMetdataProcessor	createMetadataProcessor()
ProcedureExecution	createProcedureExecution(Call command, ExecutionContext executionContext, RuntimeMetadata metadata, Connection conn)
ResultSetExecution	createResultSetExecution(QueryExpression command, ExecutionContext executionContext, RuntimeMetadata metadata, Connection conn)
UpdateExecution	createUpdateExecution(Command command, ExecutionContext executionContext, RuntimeMetadata metadata, Connection conn)
ResultSet	executeStoredProcedure(CallableStatement statement, List<Argument> preparedValues, Class<?> returnType) This is a generic implementation.
String	formatDateValue(Date dateObject) Format the dateObject (of type date, time, or timestamp) into a string using the DatabaseTimeZone format.
Connection	getConnection(DataSource ds) Return a connection object from the given connection factory.
Calendar	getDatabaseCalendar() Gets the database calendar.
String	getDatabaseTimeZone()
String	getDatabaseVersion()
ExecutionFactory.NullOrder	getDefaultNullOrder() Returns the default null ordering
List<String>	getDefaultSupportedFunctions()
Map<String,FunctionModifier>	getFunctionModifiers() Return a map of function name to FunctionModifier.
String	getLikeRegexString() Get the predicate name for LIKE_REGEX
int	getMaxPreparedInsertBatchSize() Get the max number of inserts to perform in one batch.
void	getMetadata(MetadataFactory metadataFactory, Connection conn) Implement to provide metadata to the metadata for use by the engine.
String	getSetOperationString(SetQuery.Operation operation) Returns the name for a given SetQuery.Operation
String	getSourceComment(ExecutionContext context, Command command) Returns the source comment for the given command
SQLConversionVisitor	getSQLConversionVisitor() Create the SQLConversionVisitor that will perform translation.
List<String>	getSupportedFunctions() Get list of all supported function names.
int	getTimestampNanoPrecision() Return the precision of timestamp literals.
boolean	hasTimeType() Return false to indicate that time support should be emulated with timestamps.
boolean	isSourceRequired() Flag that indicates if a underlying source connection required for this execution factory to work
boolean	isTrimStrings()
void	obtainedConnection(Connection connection) Provides a hook to call source specific logic when a connection is obtained.
static List<String>	parseName(String tableName, char escape, char delim)
void	registerFunctionModifier(String name, FunctionModifier modifier) Add the FunctionModifier to the set of known modifiers.
protected void	registerSpecificTypeOfOutParameter(CallableStatement statement, Class<?> runtimeType, int index) For registering specific output parameter types we need to translate these into the appropriate java.sql.Types output parameters We will need to match these up with the appropriate standard sql types
String	replaceElementName(String group, String element) Override to return a name other than the default [group.]element
Object	retrieveValue(CallableStatement results, int parameterIndex, Class<?> expectedType) Retrieve the value for the given parameter index
Object	retrieveValue(ResultSet results, int columnIndex, Class<?> expectedType) Retrieve the value on the current resultset row for the given column index.
void	setDatabaseTimeZone(String databaseTimeZone)
void	setDatabaseVersion(String version)
void	setFetchSize(Command command, ExecutionContext context, Statement statement, int fetchSize) Set the fetch size on the given statement.
void	setMaxPreparedInsertBatchSize(int maxInsertBatchSize)
void	setTrimStrings(boolean trimStrings)
void	setUseBindVariables(boolean useBindVariables)
void	setUseCommentsInSourceQuery(boolean useCommentsInSourceQuery)
void	start() Initialize the connector with supplied configuration
boolean	supportsAggregatesAvg() Support indicates connector can accept the AVG aggregate function
boolean	supportsAggregatesCount() Support indicates connector can accept the COUNT aggregate function
boolean	supportsAggregatesCountStar() Support indicates connector can accept the COUNT(*) aggregate function
boolean	supportsAggregatesDistinct() Support indicates connector can accept DISTINCT within aggregate functions
boolean	supportsAggregatesMax() Support indicates connector can accept the MAX aggregate function
boolean	supportsAggregatesMin() Support indicates connector can accept the MIN aggregate function
boolean	supportsAggregatesSum() Support indicates connector can accept the SUM aggregate function
boolean	supportsAliasedTable() Support indicates connector can accept groups with aliases
boolean	supportsBatchedUpdates() Whether the source supports BatchedUpdates
boolean	supportsBulkUpdate() Whether the source supports updates with multiple value sets
boolean	supportsCompareCriteriaEquals() Support indicates connector accepts criteria of form (element = constant)
boolean	supportsCompareCriteriaOrdered() Support indicates connector accepts criteria of form (element <=|>= constant) The query engine will may pushdown queries containing < or > if NOT is also supported.
boolean	supportsCorrelatedSubqueries() Support indicates connector can accept correlated subqueries wherever subqueries are accepted
boolean	supportsExistsCriteria() Support indicates connector accepts the EXISTS criteria
boolean	supportsGeneratedKeys()
boolean	supportsGroupBy() Whether the source supports an explicit GROUP BY clause
boolean	supportsHaving() Whether the source supports the HAVING clause
boolean	supportsInCriteria() Support indicates connector accepts criteria of form (element IN set)
boolean	supportsInCriteriaSubquery() Support indicates connector accepts IN criteria with a subquery on the right side
boolean	supportsInlineViews() Support indicates connector can accept inline views (subqueries in the FROM clause).
boolean	supportsInsertWithQueryExpression() Support indicates that the connector can accept INSERTs with values specified by a SetQuery or Select
boolean	supportsIsNullCriteria() Support indicates connector accepts criteria of form (element IS NULL)
boolean	supportsLikeCriteria() Support indicates connector accepts criteria of form (element LIKE constant)
boolean	supportsLikeCriteriaEscapeCharacter() Support indicates connector accepts criteria of form (element LIKE constant ESCAPE char)
boolean	supportsNotCriteria() Support indicates connector accepts logical criteria NOT
boolean	supportsOrCriteria() Support indicates connector accepts logical criteria connected by OR
boolean	supportsOrderByUnrelated() Support indicates connector accepts ORDER BY clause with columns not from the select
boolean	supportsQuantifiedCompareCriteriaAll() Support indicates connector accepts the quantified comparison criteria that use ALL
boolean	supportsQuantifiedCompareCriteriaSome() Support indicates connector accepts the quantified comparison criteria that use SOME
boolean	supportsScalarSubqueries() Support indicates connector can accept scalar subqueries in the SELECT, WHERE, and HAVING clauses
boolean	supportsSearchedCaseExpressions() Support indicates connector can accept queries with searched CASE WHEN ...
boolean	supportsSelectExpression() Support indicates connector can accept expressions other than element symbols in the SELECT clause.
boolean	supportsSelfJoins() Support indicates connector can accept self-joins where a group is joined to itself with aliases.
boolean	supportsSetQueryOrderBy() Support indicates that the connector supports an ORDER BY on a SetQuery.
boolean	supportsUnions() Support indicates that the connector supports the UNION of two queries.
List<?>	translate(LanguageObject obj, ExecutionContext context) Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
List<?>	translateCommand(Command command, ExecutionContext context) Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
List<?>	translateLimit(Limit limit, ExecutionContext context) Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
String	translateLiteralBoolean(Boolean booleanValue) Subclasses should override this method to provide a different sql translation of the literal boolean value.
String	translateLiteralDate(Date dateValue) Subclasses should override this method to provide a different sql translation of the literal date value.
String	translateLiteralTime(Time timeValue) Subclasses should override this method to provide a different sql translation of the literal time value.
String	translateLiteralTimestamp(Timestamp timestampValue) Subclasses should override this method to provide a different sql translation of the literal timestamp value.
boolean	useAsInGroupAlias() Indicates whether group alias should be of the form "...FROM groupA AS X" or "...FROM groupA X".
boolean	useBindVariables()
boolean	useCommentsInSourceQuery()
boolean	useParensForJoins() Set to true to indicate that every branch of a join should have parenthesis.
boolean	useParensForSetQueries() Set to true to indicate that every branch of a set query should have parenthesis, i.e.
boolean	usePreparedStatements() Use PreparedStatements (or CallableStatements) as appropriate for all commands.
boolean	useSelectLimit() Returns whether the limit clause is applied to the select clause.
boolean	useStreamsForLobs() If streams should be used for Blob/Clob sets on PreparedStatements

Methods inherited from class org.teiid.translator.ExecutionFactory

addPushDownFunction, areLobsUsableAfterClose, createExecution, getCacheDirective, getConnection, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, getNativeQueryProcedureName, getPushDownFunctions, getSupportedJoinCriteria, getTypeFacility, isCopyLobs, isForkable, isImmutable, isSourceRequiredForMetadata, requiresCriteria, setCopyLobs, setImmutable, setMaxDependentInPredicates, setMaxInCriteriaSize, setNativeQueryProcedureName, setRequiresCriteria, setSourceRequired, setSourceRequiredForMetadata, setSupportedJoinCriteria, setSupportsFullOuterJoins, setSupportsInnerJoins, setSupportsNativeQueries, setSupportsOrderBy, setSupportsOuterJoins, setSupportsSelectDistinct, supportsAdvancedOlapOperations, supportsAggregatesEnhancedNumeric, supportsArrayAgg, supportsArrayType, supportsCommonTableExpressions, supportsConvert, supportsDependentJoins, supportsElementaryOlapOperations, supportsExcept, supportsFormatLiteral, supportsFullOuterJoins, supportsFunctionsInGroupBy, supportsInnerJoins, supportsIntersect, supportsLikeRegex, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLiteralComparison, supportsOnlySingleTableGroupBy, supportsOrderBy, supportsOrderByNullOrdering, supportsOuterJoins, supportsRowLimit, supportsRowOffset, supportsSelectDistinct, supportsSimilarTo, supportsSubqueryInOn, supportsWindowDistinctAggregates, supportsWindowOrderByWithAggregates, useAnsiJoin

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_IN_CRITERIA

public static final int DEFAULT_MAX_IN_CRITERIA

See Also:

Constant Field Values

DEFAULT_MAX_DEPENDENT_PREDICATES

public static final int DEFAULT_MAX_DEPENDENT_PREDICATES

See Also:

Constant Field Values

DEFAULT_TIME_ZONE

public static final TimeZone DEFAULT_TIME_ZONE

Constructor Detail

JDBCExecutionFactory

public JDBCExecutionFactory()

Method Detail

start

public void start()
           throws TranslatorException

Description copied from class: ExecutionFactory

Initialize the connector with supplied configuration

Overrides:

start in class ExecutionFactory<DataSource,Connection>

Throws:

TranslatorException

getDatabaseVersion

@TranslatorProperty(display="Database Version",
                    description="Database Version")
public String getDatabaseVersion()

setDatabaseVersion

public void setDatabaseVersion(String version)

useBindVariables

@TranslatorProperty(display="Use Bind Variables",
                    description="Use prepared statements and bind variables",
                    advanced=true)
public boolean useBindVariables()

setUseBindVariables

public void setUseBindVariables(boolean useBindVariables)

getDatabaseTimeZone

@TranslatorProperty(display="Database time zone",
                    description="Time zone of the database, if different than Integration Server",
                    advanced=true)
public String getDatabaseTimeZone()

setDatabaseTimeZone

public void setDatabaseTimeZone(String databaseTimeZone)

isTrimStrings

@TranslatorProperty(display="Trim string flag",
                    description="Right Trim fixed character types returned as Strings - note that the native type must be char or nchar and the source must support the rtrim function.",
                    advanced=true)
public boolean isTrimStrings()

setTrimStrings

public void setTrimStrings(boolean trimStrings)

useCommentsInSourceQuery

@TranslatorProperty(display="Use informational comments in Source Queries",
                    description="This will embed a /*comment*/ leading comment with session/request id in source SQL query for informational purposes",
                    advanced=true)
public boolean useCommentsInSourceQuery()

setUseCommentsInSourceQuery

public void setUseCommentsInSourceQuery(boolean useCommentsInSourceQuery)

isSourceRequired

public boolean isSourceRequired()

Description copied from class: ExecutionFactory

Flag that indicates if a underlying source connection required for this execution factory to work

Overrides:

isSourceRequired in class ExecutionFactory<DataSource,Connection>

Returns:

createResultSetExecution

public ResultSetExecution createResultSetExecution(QueryExpression command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   Connection conn)
                                            throws TranslatorException

Overrides:

createResultSetExecution in class ExecutionFactory<DataSource,Connection>

Throws:

TranslatorException

createDirectExecution

public ProcedureExecution createDirectExecution(List<Argument> arguments,
                                                Command command,
                                                ExecutionContext executionContext,
                                                RuntimeMetadata metadata,
                                                Connection conn)
                                         throws TranslatorException

Overrides:

createDirectExecution in class ExecutionFactory<DataSource,Connection>

Throws:

TranslatorException

createProcedureExecution

public ProcedureExecution createProcedureExecution(Call command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   Connection conn)
                                            throws TranslatorException

Overrides:

createProcedureExecution in class ExecutionFactory<DataSource,Connection>

Throws:

TranslatorException

createUpdateExecution

public UpdateExecution createUpdateExecution(Command command,
                                             ExecutionContext executionContext,
                                             RuntimeMetadata metadata,
                                             Connection conn)
                                      throws TranslatorException

Overrides:

createUpdateExecution in class ExecutionFactory<DataSource,Connection>

Throws:

TranslatorException

getConnection

public Connection getConnection(DataSource ds)
                         throws TranslatorException

Description copied from class: ExecutionFactory

Return a connection object from the given connection factory. The default implementation assumes a JCA ConnectionFactory. Subclasses should override, if they use another type of connection factory.

Overrides:

getConnection in class ExecutionFactory<DataSource,Connection>

Returns:

a connection

Throws:

TranslatorException

See Also:

ExecutionFactory.getConnection(Object, ExecutionContext)

closeConnection

public void closeConnection(Connection connection,
                            DataSource factory)

Description copied from class: ExecutionFactory

Closes a connection object from the given connection factory. The default implementation assumes a JCA Connection. Subclasses should override, if they use another type of connection.

Overrides:

closeConnection in class ExecutionFactory<DataSource,Connection>

getMetadata

public void getMetadata(MetadataFactory metadataFactory,
                        Connection conn)
                 throws TranslatorException

Description copied from class: ExecutionFactory

Implement to provide metadata to the metadata for use by the engine. This is the primary method of creating metadata for dynamic VDBs.

Overrides:

getMetadata in class ExecutionFactory<DataSource,Connection>

conn - may be null if the source is not required

Throws:

TranslatorException - to indicate a recoverable error, otherwise a RuntimeException

See Also:

ExecutionFactory.isSourceRequiredForMetadata()

createMetadataProcessor

protected JDBCMetdataProcessor createMetadataProcessor()

getSupportedFunctions

public List<String> getSupportedFunctions()

Description copied from class: ExecutionFactory

Get list of all supported function names. Arithmetic functions have names like "+".

Overrides:

getSupportedFunctions in class ExecutionFactory<DataSource,Connection>

See Also:

for a listing of system pushdown functions. Note that not all system functions are listed as some functions will use a common name such as CONCAT vs. the || operator, and other functions will be rewritten and not pushed down, such as SPACE.

getDefaultSupportedFunctions

public List<String> getDefaultSupportedFunctions()

supportsGroupBy

public boolean supportsGroupBy()

Description copied from class: ExecutionFactory

Whether the source supports an explicit GROUP BY clause

Overrides:

supportsGroupBy in class ExecutionFactory<DataSource,Connection>

supportsAggregatesAvg

public boolean supportsAggregatesAvg()

Description copied from class: ExecutionFactory

Support indicates connector can accept the AVG aggregate function

Overrides:

supportsAggregatesAvg in class ExecutionFactory<DataSource,Connection>

supportsAggregatesCount

public boolean supportsAggregatesCount()

Description copied from class: ExecutionFactory

Support indicates connector can accept the COUNT aggregate function

Overrides:

supportsAggregatesCount in class ExecutionFactory<DataSource,Connection>

supportsAggregatesCountStar

public boolean supportsAggregatesCountStar()

Description copied from class: ExecutionFactory

Support indicates connector can accept the COUNT(*) aggregate function

Overrides:

supportsAggregatesCountStar in class ExecutionFactory<DataSource,Connection>

supportsAggregatesDistinct

public boolean supportsAggregatesDistinct()

Description copied from class: ExecutionFactory

Support indicates connector can accept DISTINCT within aggregate functions

Overrides:

supportsAggregatesDistinct in class ExecutionFactory<DataSource,Connection>

supportsAggregatesMax

public boolean supportsAggregatesMax()

Description copied from class: ExecutionFactory

Support indicates connector can accept the MAX aggregate function

Overrides:

supportsAggregatesMax in class ExecutionFactory<DataSource,Connection>

supportsAggregatesMin

public boolean supportsAggregatesMin()

Description copied from class: ExecutionFactory

Support indicates connector can accept the MIN aggregate function

Overrides:

supportsAggregatesMin in class ExecutionFactory<DataSource,Connection>

supportsAggregatesSum

public boolean supportsAggregatesSum()

Description copied from class: ExecutionFactory

Support indicates connector can accept the SUM aggregate function

Overrides:

supportsAggregatesSum in class ExecutionFactory<DataSource,Connection>

supportsAliasedTable

public boolean supportsAliasedTable()

Description copied from class: ExecutionFactory

Support indicates connector can accept groups with aliases

Overrides:

supportsAliasedTable in class ExecutionFactory<DataSource,Connection>

supportsCompareCriteriaEquals

public boolean supportsCompareCriteriaEquals()

Description copied from class: ExecutionFactory

Support indicates connector accepts criteria of form (element = constant)

Overrides:

supportsCompareCriteriaEquals in class ExecutionFactory<DataSource,Connection>

supportsCorrelatedSubqueries

public boolean supportsCorrelatedSubqueries()

Description copied from class: ExecutionFactory

Support indicates connector can accept correlated subqueries wherever subqueries are accepted

Overrides:

supportsCorrelatedSubqueries in class ExecutionFactory<DataSource,Connection>

supportsExistsCriteria

public boolean supportsExistsCriteria()

Description copied from class: ExecutionFactory

Support indicates connector accepts the EXISTS criteria

Overrides:

supportsExistsCriteria in class ExecutionFactory<DataSource,Connection>

supportsInCriteria

public boolean supportsInCriteria()

Description copied from class: ExecutionFactory

Support indicates connector accepts criteria of form (element IN set)

Overrides:

supportsInCriteria in class ExecutionFactory<DataSource,Connection>

supportsInCriteriaSubquery

public boolean supportsInCriteriaSubquery()

Description copied from class: ExecutionFactory

Support indicates connector accepts IN criteria with a subquery on the right side

Overrides:

supportsInCriteriaSubquery in class ExecutionFactory<DataSource,Connection>

supportsIsNullCriteria

public boolean supportsIsNullCriteria()

Description copied from class: ExecutionFactory

Support indicates connector accepts criteria of form (element IS NULL)

Overrides:

supportsIsNullCriteria in class ExecutionFactory<DataSource,Connection>

supportsLikeCriteria

public boolean supportsLikeCriteria()

Description copied from class: ExecutionFactory

Support indicates connector accepts criteria of form (element LIKE constant)

Overrides:

supportsLikeCriteria in class ExecutionFactory<DataSource,Connection>

supportsLikeCriteriaEscapeCharacter

public boolean supportsLikeCriteriaEscapeCharacter()

Description copied from class: ExecutionFactory

Support indicates connector accepts criteria of form (element LIKE constant ESCAPE char)

Overrides:

supportsLikeCriteriaEscapeCharacter in class ExecutionFactory<DataSource,Connection>

supportsNotCriteria

public boolean supportsNotCriteria()

Description copied from class: ExecutionFactory

Support indicates connector accepts logical criteria NOT

Overrides:

supportsNotCriteria in class ExecutionFactory<DataSource,Connection>

supportsOrCriteria

public boolean supportsOrCriteria()

Description copied from class: ExecutionFactory

Support indicates connector accepts logical criteria connected by OR

Overrides:

supportsOrCriteria in class ExecutionFactory<DataSource,Connection>

supportsOrderByUnrelated

public boolean supportsOrderByUnrelated()

Description copied from class: ExecutionFactory

Support indicates connector accepts ORDER BY clause with columns not from the select

Overrides:

supportsOrderByUnrelated in class ExecutionFactory<DataSource,Connection>

Returns:

supportsQuantifiedCompareCriteriaAll

public boolean supportsQuantifiedCompareCriteriaAll()

Description copied from class: ExecutionFactory

Support indicates connector accepts the quantified comparison criteria that use ALL

Overrides:

supportsQuantifiedCompareCriteriaAll in class ExecutionFactory<DataSource,Connection>

supportsScalarSubqueries

public boolean supportsScalarSubqueries()

Description copied from class: ExecutionFactory

Support indicates connector can accept scalar subqueries in the SELECT, WHERE, and HAVING clauses

Overrides:

supportsScalarSubqueries in class ExecutionFactory<DataSource,Connection>

supportsSearchedCaseExpressions

public boolean supportsSearchedCaseExpressions()

Description copied from class: ExecutionFactory

Support indicates connector can accept queries with searched CASE WHEN ... END

Overrides:

supportsSearchedCaseExpressions in class ExecutionFactory<DataSource,Connection>

supportsSelfJoins

public boolean supportsSelfJoins()

Description copied from class: ExecutionFactory

Support indicates connector can accept self-joins where a group is joined to itself with aliases. Connector must also support ExecutionFactory.supportsAliasedTable().

Overrides:

supportsSelfJoins in class ExecutionFactory<DataSource,Connection>

supportsInlineViews

public boolean supportsInlineViews()

Description copied from class: ExecutionFactory

Support indicates connector can accept inline views (subqueries in the FROM clause).

Overrides:

supportsInlineViews in class ExecutionFactory<DataSource,Connection>

supportsQuantifiedCompareCriteriaSome

public boolean supportsQuantifiedCompareCriteriaSome()

Description copied from class: ExecutionFactory

Support indicates connector accepts the quantified comparison criteria that use SOME

Overrides:

supportsQuantifiedCompareCriteriaSome in class ExecutionFactory<DataSource,Connection>

supportsSetQueryOrderBy

public boolean supportsSetQueryOrderBy()

Description copied from class: ExecutionFactory

Support indicates that the connector supports an ORDER BY on a SetQuery.

Overrides:

supportsSetQueryOrderBy in class ExecutionFactory<DataSource,Connection>

supportsUnions

public boolean supportsUnions()

Description copied from class: ExecutionFactory

Support indicates that the connector supports the UNION of two queries.

Overrides:

supportsUnions in class ExecutionFactory<DataSource,Connection>

supportsBulkUpdate

public boolean supportsBulkUpdate()

Description copied from class: ExecutionFactory

Whether the source supports updates with multiple value sets

Overrides:

supportsBulkUpdate in class ExecutionFactory<DataSource,Connection>

supportsBatchedUpdates

public boolean supportsBatchedUpdates()

Description copied from class: ExecutionFactory

Whether the source supports BatchedUpdates

Overrides:

supportsBatchedUpdates in class ExecutionFactory<DataSource,Connection>

supportsCompareCriteriaOrdered

public boolean supportsCompareCriteriaOrdered()

Description copied from class: ExecutionFactory

Support indicates connector accepts criteria of form (element <=|>= constant)
The query engine will may pushdown queries containing < or > if NOT is also supported.

Overrides:

supportsCompareCriteriaOrdered in class ExecutionFactory<DataSource,Connection>

supportsHaving

public boolean supportsHaving()

Description copied from class: ExecutionFactory

Whether the source supports the HAVING clause

Overrides:

supportsHaving in class ExecutionFactory<DataSource,Connection>

supportsSelectExpression

public boolean supportsSelectExpression()

Description copied from class: ExecutionFactory

Support indicates connector can accept expressions other than element symbols in the SELECT clause. Specific supports for the expression type are still checked.

Overrides:

supportsSelectExpression in class ExecutionFactory<DataSource,Connection>

supportsInsertWithQueryExpression

public boolean supportsInsertWithQueryExpression()

Description copied from class: ExecutionFactory

Support indicates that the connector can accept INSERTs with values specified by a SetQuery or Select

Overrides:

supportsInsertWithQueryExpression in class ExecutionFactory<DataSource,Connection>

getMaxPreparedInsertBatchSize

@TranslatorProperty(display="Max Prepared Insert Batch Size",
                    description="The max size of a prepared insert batch.  Default 2048.",
                    advanced=true)
public int getMaxPreparedInsertBatchSize()

Get the max number of inserts to perform in one batch.

Returns:

setMaxPreparedInsertBatchSize

public void setMaxPreparedInsertBatchSize(int maxInsertBatchSize)

getDatabaseCalendar

public Calendar getDatabaseCalendar()

Gets the database calendar. This will be set to the time zone specified by the property JDBCPropertyNames#DATABASE_TIME_ZONE, or the local time zone if none is specified.

Returns:

the database calendar

translate

public List<?> translate(LanguageObject obj,
                         ExecutionContext context)

Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation. Override with care.

Parameters:

command -

context -

Returns:

list of translated parts

translateCommand

public List<?> translateCommand(Command command,
                                ExecutionContext context)

Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.

Parameters:

command -

context -

Returns:

a list of translated parts

translateLimit

public List<?> translateLimit(Limit limit,
                              ExecutionContext context)

Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.

Parameters:

limit -

context -

Returns:

a list of translated parts

getFunctionModifiers

public Map<String,FunctionModifier> getFunctionModifiers()

Return a map of function name to FunctionModifier.

Returns:

Map of function name to FunctionModifier.

registerFunctionModifier

public void registerFunctionModifier(String name,
                                     FunctionModifier modifier)

Add the FunctionModifier to the set of known modifiers.

Parameters:

name -

modifier -

translateLiteralBoolean

public String translateLiteralBoolean(Boolean booleanValue)

Subclasses should override this method to provide a different sql translation of the literal boolean value. By default, a boolean literal is represented as: '0' or '1'.

Parameters:

booleanValue - Boolean value, never null

Returns:

Translated string

translateLiteralDate

public String translateLiteralDate(Date dateValue)

Subclasses should override this method to provide a different sql translation of the literal date value. By default, a date literal is represented as: {d '2002-12-31'}

Parameters:

dateValue - Date value, never null

Returns:

Translated string

translateLiteralTime

public String translateLiteralTime(Time timeValue)

Subclasses should override this method to provide a different sql translation of the literal time value. By default, a time literal is represented as: {t '23:59:59'} See hasTimeType() to represent literal times as timestamps.

Parameters:

timeValue - Time value, never null

Returns:

Translated string

translateLiteralTimestamp

public String translateLiteralTimestamp(Timestamp timestampValue)

Subclasses should override this method to provide a different sql translation of the literal timestamp value. By default, a timestamp literal is represented as: {ts '2002-12-31 23:59:59'}. See getTimestampNanoPrecision() to control the literal precision.

Parameters:

timestampValue - Timestamp value, never null

Returns:

Translated string

formatDateValue

public String formatDateValue(Date dateObject)

Format the dateObject (of type date, time, or timestamp) into a string using the DatabaseTimeZone format.

Parameters:

dateObject -

Returns:

Formatted string

addSourceComment

public boolean addSourceComment()

Returns true to indicate that SQL should include a comment indicating the session and request ids.

useAsInGroupAlias

public boolean useAsInGroupAlias()

Indicates whether group alias should be of the form "...FROM groupA AS X" or "...FROM groupA X". Certain data sources (such as Oracle) may not support the first form.

Returns:

boolean

usePreparedStatements

public boolean usePreparedStatements()

Use PreparedStatements (or CallableStatements) as appropriate for all commands. Bind values will be determined by the BindValueVisitor. Literal#setBindValue(boolean) can be used to force a literal to be a bind value.

useParensForSetQueries

public boolean useParensForSetQueries()

Set to true to indicate that every branch of a set query should have parenthesis, i.e. (query) union (query)

Returns:

true if parenthesis should be used for each set branch

hasTimeType

public boolean hasTimeType()

Return false to indicate that time support should be emulated with timestamps.

Returns:

true if database has a time type

getSetOperationString

public String getSetOperationString(SetQuery.Operation operation)

Returns the name for a given SetQuery.Operation

Parameters:

operation -

Returns:

the name for the set operation

getSourceComment

public String getSourceComment(ExecutionContext context,
                               Command command)

Returns the source comment for the given command

Parameters:

context -

command -

Returns:

the comment

replaceElementName

public String replaceElementName(String group,
                                 String element)

Override to return a name other than the default [group.]element

Parameters:

group -

element -

Returns:

thre replacement name

getTimestampNanoPrecision

public int getTimestampNanoPrecision()

Return the precision of timestamp literals. Defaults to 9.

Returns:

digits of timestamp nano precision.

executeStoredProcedure

public ResultSet executeStoredProcedure(CallableStatement statement,
                                        List<Argument> preparedValues,
                                        Class<?> returnType)
                                 throws SQLException

This is a generic implementation. Because different databases handle stored procedures differently, subclasses should override this method if necessary.

Throws:

SQLException

registerSpecificTypeOfOutParameter

protected void registerSpecificTypeOfOutParameter(CallableStatement statement,
                                                  Class<?> runtimeType,
                                                  int index)
                                           throws SQLException

For registering specific output parameter types we need to translate these into the appropriate java.sql.Types output parameters We will need to match these up with the appropriate standard sql types

Parameters:

cstmt -

parameter -

Throws:

SQLException

bindValue

public void bindValue(PreparedStatement stmt,
                      Object param,
                      Class<?> paramType,
                      int i)
               throws SQLException

Sets prepared statement parameter i with param. Performs special handling to translate dates using the database time zone and to translate biginteger, float, and char to JDBC safe objects.

Parameters:

stmt -

param -

paramType -

i -

cal -

Throws:

SQLException

useStreamsForLobs

public boolean useStreamsForLobs()

If streams should be used for Blob/Clob sets on PreparedStatements

Returns:

retrieveValue

public Object retrieveValue(ResultSet results,
                            int columnIndex,
                            Class<?> expectedType)
                     throws SQLException

Retrieve the value on the current resultset row for the given column index.

Parameters:

results -

columnIndex -

expectedType -

Returns:

the value

Throws:

SQLException

retrieveValue

public Object retrieveValue(CallableStatement results,
                            int parameterIndex,
                            Class<?> expectedType)
                     throws SQLException

Retrieve the value for the given parameter index

Parameters:

results -

parameterIndex -

expectedType -

Returns:

the value

Throws:

SQLException

afterInitialConnectionObtained

protected void afterInitialConnectionObtained(Connection connection)

Called exactly once for this source.

Parameters:

connection -

obtainedConnection

public void obtainedConnection(Connection connection)

Provides a hook to call source specific logic when a connection is obtained. defect request 13979 & 13978

getSQLConversionVisitor

public SQLConversionVisitor getSQLConversionVisitor()

Create the SQLConversionVisitor that will perform translation. Typical custom JDBC connectors will not need to create custom conversion visitors, rather implementors should override existing JDBCExecutionFactory methods.

Returns:

the SQLConversionVisitor

useParensForJoins

public boolean useParensForJoins()

Set to true to indicate that every branch of a join should have parenthesis.

Returns:

true if every branch of a join should use parenthesis

getDefaultNullOrder

public ExecutionFactory.NullOrder getDefaultNullOrder()

Description copied from class: ExecutionFactory

Returns the default null ordering

Overrides:

getDefaultNullOrder in class ExecutionFactory<DataSource,Connection>

Returns:

the ExecutionFactory.NullOrder

useSelectLimit

public boolean useSelectLimit()

Returns whether the limit clause is applied to the select clause.

Returns:

true if the limit clause is part of the select

parseName

public static List<String> parseName(String tableName,
                                     char escape,
                                     char delim)

getLikeRegexString

public String getLikeRegexString()

Get the predicate name for LIKE_REGEX

Returns:

setFetchSize

public void setFetchSize(Command command,
                         ExecutionContext context,
                         Statement statement,
                         int fetchSize)
                  throws SQLException

Set the fetch size on the given statement.

Parameters:

context -

command -

statement -

fetchSize -

Throws:

SQLException

supportsGeneratedKeys

public boolean supportsGeneratedKeys()