MySQLExecutionFactory (JDBC Translator 13.1.1 API)

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

Direct Known Subclasses:: MySQL5ExecutionFactory

@Translator(name="mysql",
            description="A translator for open source MySQL Database, used with any version lower than 5")
public class MySQLExecutionFactory
extends JDBCExecutionFactory

Since:: 4.3

Nested Class Summary
- Nested classes/interfaces inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory
  JDBCExecutionFactory.StructRetrieval
- Nested classes/interfaces inherited from class org.teiid.translator.ExecutionFactory
  ExecutionFactory.Format, ExecutionFactory.NullOrder, ExecutionFactory.SupportedJoinCriteria, ExecutionFactory.TransactionSupport

Field Summary

Fields
Modifier and Type Field and Description

static Version FIVE_0

static Version FIVE_6
- Fields inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory
  DEFAULT_MAX_DEPENDENT_PREDICATES, DEFAULT_MAX_IN_CRITERIA, DEFAULT_TIME_ZONE, dialect
- Fields inherited from class org.teiid.translator.ExecutionFactory
  DEFAULT_MAX_FROM_GROUPS, DEFAULT_MAX_IN_CRITERIA_SIZE, DEFAULT_MAX_PROJECTED_COLUMNS

Fields
Modifier and Type	Field and Description
`static Version`	`FIVE_0`
`static Version`	`FIVE_6`

Constructor Summary

Constructors
Constructor and Description

MySQLExecutionFactory()

Constructors
Constructor and Description
`MySQLExecutionFactory()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected JDBCMetadataProcessor`	`createMetadataProcessor()` Deprecated.
`String`	`getHibernateDialectClassName()`
`String`	`getLikeRegexString()` Get the predicate name for LIKE_REGEX
`MetadataProcessor<Connection>`	`getMetadataProcessor()`
`List<String>`	`getSupportedFunctions()`
`int`	`getTimestampNanoPrecision()` Return the precision of timestamp literals.
`void`	`initCapabilities(Connection connection)`
`protected boolean`	`isVersion5OrGreater()`
`GeometryType`	`retrieveGeometryValue(CallableStatement results, int parameterIndex)`
`GeometryType`	`retrieveGeometryValue(ResultSet results, int paramIndex)` The default strategy assumes a blob value containing wkb
`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`	`start()`
`boolean`	`supportsAggregatesDistinct()`
`boolean`	`supportsAggregatesEnhancedNumeric()`
`boolean`	`supportsGroupByRollup()`
`boolean`	`supportsInlineViews()`
`boolean`	`supportsLikeRegex()`
`boolean`	`supportsOrderByWithExtendedGrouping()`
`boolean`	`supportsRowLimit()`
`boolean`	`supportsRowOffset()`
`boolean`	`supportsSelectWithoutFrom()`
`List<?>`	`translate(LanguageObject obj, ExecutionContext context)` Return a List of translated parts (`LanguageObject`s and Objects), or null if to rely on the default translation.
`List<?>`	`translateCommand(Command command, ExecutionContext context)` Return a List of translated parts (`LanguageObject`s and Objects), or null if to rely on the default translation.
`Expression`	`translateGeometrySelect(Expression expr)` Translate GEOMETRY column reference into an expression that will return WKB and possibly the SRID.
`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`	`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.
`protected boolean`	`usesDatabaseVersion()`
`boolean`	`useWithRollup()`

Methods inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory
addSourceComment, afterInitialConnectionObtained, bindValue, closeConnection, convertObject, createDirectExecution, createProcedureExecution, createResultSetExecution, createTempTable, createUpdateExecution, executeStoredProcedure, formatDateValue, formatDateValue, getCommentFormat, getConnection, getCreateTemporaryTablePostfix, getCreateTemporaryTableString, getCreateTempTableSQL, getDatabaseCalendar, getDatabaseTimeZone, getDatabaseVersion, getDefaultNullOrder, getDefaultSupportedFunctions, getDialect, getFunctionModifiers, getLateralKeyword, getMaxPreparedInsertBatchSize, getMetadata, getRemovePushdownCharacters, getSetOperationString, getSourceComment, getSQLConversionVisitor, getStructRetrieval, getTemporaryTableName, getVersion, hasTimeType, intializeConnectionAfterCancel, isCharacterType, isDefaultTimeZone, isEnableDependentJoins, isExtendedAscii, isNonAscii, isNonAscii, isNonAsciiFunction, isSourceRequired, isSourceRequiredForCapabilities, isTrimStrings, loadedTemporaryTable, obtainedConnection, registerFunctionModifier, registerSpecificTypeOfOutParameter, replaceElementName, retrieveGeographyValue, retrieveGeographyValue, setCommentFormat, setDatabaseTimeZone, setDatabaseVersion, setDatabaseVersion, setEnableDependentJoins, setFetchSize, setMaxPreparedInsertBatchSize, setRemovePushdownCharacters, setStructRetrieval, setTrimStrings, setUseBindingsForDependentJoin, setUseBindVariables, setUseCommentsInSourceQuery, supportsAggregatesAvg, supportsAggregatesCount, supportsAggregatesCountStar, supportsAggregatesMax, supportsAggregatesMin, supportsAggregatesSum, supportsAliasedTable, supportsBatchedUpdates, supportsBooleanExpressions, supportsBulkUpdate, supportsCompareCriteriaEquals, supportsCompareCriteriaOrdered, supportsCorrelatedSubqueries, supportsDependentJoins, supportsExistsCriteria, supportsFullDependentJoins, supportsGeneratedKeys, supportsGeneratedKeys, supportsGroupBy, supportsHaving, supportsInCriteria, supportsInCriteriaSubquery, supportsInsertWithQueryExpression, supportsIsNullCriteria, supportsLikeCriteria, supportsLikeCriteriaEscapeCharacter, supportsNotCriteria, supportsOrCriteria, supportsOrderByUnrelated, supportsProcedureParameterExpression, supportsQuantifiedCompareCriteriaAll, supportsQuantifiedCompareCriteriaSome, supportsScalarSubqueries, supportsSearchedCaseExpressions, supportsSelectExpression, supportsSelfJoins, supportsSetQueryOrderBy, supportsUnions, tempTableRequiresTransaction, translateGeographyLiteral, translateGeographyParameter, translateGeographySelect, translateGeometryLiteral, translateGeometryParameter, translateLimit, translateLiteralBinaryType, translateLiteralBoolean, useAsInGroupAlias, useBindingsForDependentJoin, useBindVariables, useColumnNamesForGeneratedKeys, useCommentsInSourceQuery, useNBindingType, usePreparedStatements, useScientificNotation, useSelectLimit, useStreamsForLobs, useUnicodePrefix

Methods inherited from class org.teiid.translator.ExecutionFactory
addPushDownFunction, areLobsUsableAfterClose, createExecution, getCacheDirective, getCollationLocale, getConnection, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, getMaxProjectedColumns, getNativeQueryProcedureName, getPushDownFunctions, getRequiredLikeEscape, getSupportedJoinCriteria, getTransactionSupport, getTypeFacility, isCopyLobs, isForkable, isImmutable, isSourceRequiredForMetadata, isThreadBound, requiresCriteria, returnsSingleUpdateCount, setCollationLocale, setCopyLobs, setDirectQueryProcedureName, setExcludedCommonTableExpressionName, setImmutable, setMaxDependentInPredicates, setMaxInCriteriaSize, setNativeQueryProcedureName, setRequiresCriteria, setSourceRequired, setSourceRequiredForMetadata, setSupportedJoinCriteria, setSupportsDirectQueryProcedure, setSupportsFullOuterJoins, setSupportsInnerJoins, setSupportsNativeQueries, setSupportsOrderBy, setSupportsOuterJoins, setSupportsSelectDistinct, setThreadBound, setTransactionSupport, supportsAdvancedOlapOperations, supportsAggregatesCountBig, supportsArrayAgg, supportsArrayType, supportsCommonTableExpressions, supportsCompareCriteriaOrderedExclusive, supportsConvert, supportsCorrelatedSubqueryLimit, supportsDirectQueryProcedure, supportsElementaryOlapOperations, supportsExcept, supportsFormatLiteral, supportsFullOuterJoins, supportsFunctionsInGroupBy, supportsGeographyType, supportsGroupByMultipleDistinctAggregates, supportsInnerJoins, supportsIntersect, supportsIsDistinctCriteria, supportsLateralJoin, supportsLateralJoinCondition, supportsListAgg, supportsMultipleOpenExecutions, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLateralJoinProcedure, supportsOnlyLiteralComparison, supportsOnlySingleTableGroupBy, supportsOnlyTimestampAddLiteral, supportsOrderBy, supportsOrderByNullOrdering, supportsOuterJoins, supportsPartialFiltering, supportsProcedureTable, supportsRecursiveCommonTableExpressions, supportsScalarSubqueryProjection, supportsSelectDistinct, supportsSelectExpressionArrayType, supportsSetQueryLimitOffset, supportsSimilarTo, supportsStringAgg, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUpsert, supportsWindowDistinctAggregates, supportsWindowFrameClause, supportsWindowFunctionCumeDist, supportsWindowFunctionNthValue, supportsWindowFunctionNtile, supportsWindowFunctionPercentRank, supportsWindowOrderByWithAggregates, useAnsiJoin

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FIVE_6
```
public static final Version FIVE_6
```
  - FIVE_0
```
public static final Version FIVE_0
```
- Constructor Detail
  - MySQLExecutionFactory
```
public MySQLExecutionFactory()
```
- Method Detail
  - start
```
public void start()
           throws TranslatorException
```
    Overrides:
    
    start in class JDBCExecutionFactory
    
    Throws:
    
    TranslatorException
  - initCapabilities
```
public void initCapabilities(Connection connection)
                      throws TranslatorException
```
    Overrides:
    
    initCapabilities in class JDBCExecutionFactory
    
    Throws:
    
    TranslatorException
  - translateLiteralDate
```
public String translateLiteralDate(Date dateValue)
```
    Description copied from class: JDBCExecutionFactory
    
    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'}
    
    Overrides:
    
    translateLiteralDate in class JDBCExecutionFactory
    
    Parameters:
    
    dateValue - Date value, never null
    
    Returns:
    
    Translated string
  - translateLiteralTime
```
public String translateLiteralTime(Time timeValue)
```
    Description copied from class: JDBCExecutionFactory
    
    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 JDBCExecutionFactory.hasTimeType() to represent literal times as timestamps.
    
    Overrides:
    
    translateLiteralTime in class JDBCExecutionFactory
    
    Parameters:
    
    timeValue - Time value, never null
    
    Returns:
    
    Translated string
  - translateLiteralTimestamp
```
public String translateLiteralTimestamp(Timestamp timestampValue)
```
    Description copied from class: JDBCExecutionFactory
    
    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 JDBCExecutionFactory.getTimestampNanoPrecision() to control the literal precision.
    
    Overrides:
    
    translateLiteralTimestamp in class JDBCExecutionFactory
    
    Parameters:
    
    timestampValue - Timestamp value, never null
    
    Returns:
    
    Translated string
  - useParensForSetQueries
```
public boolean useParensForSetQueries()
```
    Description copied from class: JDBCExecutionFactory
    
    Set to true to indicate that every branch of a set query should have parenthesis, i.e. (query) union (query)
    
    Overrides:
    
    useParensForSetQueries in class JDBCExecutionFactory
    
    Returns:
    
    true if parenthesis should be used for each set branch
  - getTimestampNanoPrecision
```
public int getTimestampNanoPrecision()
```
    Description copied from class: JDBCExecutionFactory
    
    Return the precision of timestamp literals. Defaults to 9.
    
    Overrides:
    
    getTimestampNanoPrecision in class JDBCExecutionFactory
    
    Returns:
    
    digits of timestamp nano precision.
  - isVersion5OrGreater
```
protected boolean isVersion5OrGreater()
```
  - useParensForJoins
```
public boolean useParensForJoins()
```
    Description copied from class: JDBCExecutionFactory
    
    Set to true to indicate that every branch of a join should have parenthesis.
    
    Overrides:
    
    useParensForJoins in class JDBCExecutionFactory
    
    Returns:
    
    true if every branch of a join should use parenthesis
  - getSupportedFunctions
```
public List<String> getSupportedFunctions()
```
    Overrides:
    
    getSupportedFunctions in class JDBCExecutionFactory
  - supportsAggregatesDistinct
```
public boolean supportsAggregatesDistinct()
```
    Overrides:
    
    supportsAggregatesDistinct in class JDBCExecutionFactory
  - supportsRowLimit
```
public boolean supportsRowLimit()
```
    Overrides:
    
    supportsRowLimit in class ExecutionFactory<DataSource,Connection>
  - supportsRowOffset
```
public boolean supportsRowOffset()
```
    Overrides:
    
    supportsRowOffset in class ExecutionFactory<DataSource,Connection>
  - supportsSelectWithoutFrom
```
public boolean supportsSelectWithoutFrom()
```
    Overrides:
    
    supportsSelectWithoutFrom in class ExecutionFactory<DataSource,Connection>
  - getHibernateDialectClassName
```
public String getHibernateDialectClassName()
```
    Overrides:
    
    getHibernateDialectClassName in class JDBCExecutionFactory
  - getMetadataProcessor
```
public MetadataProcessor<Connection> getMetadataProcessor()
```
    Overrides:
    
    getMetadataProcessor in class JDBCExecutionFactory
  - createMetadataProcessor
```
@Deprecated
protected JDBCMetadataProcessor createMetadataProcessor()
```
    Deprecated.
    
    Overrides:
    
    createMetadataProcessor in class JDBCExecutionFactory
    
    See Also:
    
    JDBCExecutionFactory.getMetadataProcessor()
  - translateGeometrySelect
```
public Expression translateGeometrySelect(Expression expr)
```
    Description copied from class: JDBCExecutionFactory
    
    Translate GEOMETRY column reference into an expression that will return WKB and possibly the SRID.
    
    Overrides:
    
    translateGeometrySelect in class JDBCExecutionFactory
    
    Returns:
  - retrieveGeometryValue
```
public GeometryType retrieveGeometryValue(ResultSet results,
                                          int paramIndex)
                                   throws SQLException
```
    Description copied from class: JDBCExecutionFactory
    
    The default strategy assumes a blob value containing wkb
    
    Overrides:
    
    retrieveGeometryValue in class JDBCExecutionFactory
    
    Returns:
    
    Throws:
    
    SQLException
  - retrieveGeometryValue
```
public GeometryType retrieveGeometryValue(CallableStatement results,
                                          int parameterIndex)
                                   throws SQLException
```
    Overrides:
    
    retrieveGeometryValue in class JDBCExecutionFactory
    
    Throws:
    
    SQLException
  - translate
```
public List<?> translate(LanguageObject obj,
                         ExecutionContext context)
```
    Description copied from class: JDBCExecutionFactory
    
    Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation. Override with care.
    
    Overrides:
    
    translate in class JDBCExecutionFactory
    
    Returns:
    
    list of translated parts
  - translateCommand
```
public List<?> translateCommand(Command command,
                                ExecutionContext context)
```
    Description copied from class: JDBCExecutionFactory
    
    Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
    
    Overrides:
    
    translateCommand in class JDBCExecutionFactory
    
    Returns:
    
    a list of translated parts
  - usesDatabaseVersion
```
protected boolean usesDatabaseVersion()
```
    Overrides:
    
    usesDatabaseVersion in class JDBCExecutionFactory
  - supportsLikeRegex
```
public boolean supportsLikeRegex()
```
    Overrides:
    
    supportsLikeRegex in class ExecutionFactory<DataSource,Connection>
  - getLikeRegexString
```
public String getLikeRegexString()
```
    Description copied from class: JDBCExecutionFactory
    
    Get the predicate name for LIKE_REGEX
    
    Overrides:
    
    getLikeRegexString in class JDBCExecutionFactory
    
    Returns:
  - supportsGroupByRollup
```
public boolean supportsGroupByRollup()
```
    Overrides:
    
    supportsGroupByRollup in class ExecutionFactory<DataSource,Connection>
  - useWithRollup
```
public boolean useWithRollup()
```
    Overrides:
    
    useWithRollup in class JDBCExecutionFactory
    
    Returns:
    
    true if the rollup syntax is WITH ROLLUP
  - supportsOrderByWithExtendedGrouping
```
public boolean supportsOrderByWithExtendedGrouping()
```
    Overrides:
    
    supportsOrderByWithExtendedGrouping in class ExecutionFactory<DataSource,Connection>
  - supportsInlineViews
```
public boolean supportsInlineViews()
```
    Overrides:
    
    supportsInlineViews in class JDBCExecutionFactory
  - supportsAggregatesEnhancedNumeric
```
public boolean supportsAggregatesEnhancedNumeric()
```
    Overrides:
    
    supportsAggregatesEnhancedNumeric in class ExecutionFactory<DataSource,Connection>
  - retrieveValue
```
public Object retrieveValue(ResultSet results,
                            int columnIndex,
                            Class<?> expectedType)
                     throws SQLException
```
    Description copied from class: JDBCExecutionFactory
    
    Retrieve the value on the current resultset row for the given column index.
    
    Overrides:
    
    retrieveValue in class JDBCExecutionFactory
    
    Returns:
    
    the value
    
    Throws:
    
    SQLException
  - retrieveValue
```
public Object retrieveValue(CallableStatement results,
                            int parameterIndex,
                            Class<?> expectedType)
                     throws SQLException
```
    Description copied from class: JDBCExecutionFactory
    
    Retrieve the value for the given parameter index
    
    Overrides:
    
    retrieveValue in class JDBCExecutionFactory
    
    Returns:
    
    the value
    
    Throws:
    
    SQLException

Class MySQLExecutionFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory

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

Field Summary

Fields inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory

Fields inherited from class org.teiid.translator.ExecutionFactory

Constructor Summary

Method Summary

Methods inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory

Methods inherited from class org.teiid.translator.ExecutionFactory

Methods inherited from class java.lang.Object

Field Detail

FIVE_6

FIVE_0

Constructor Detail

MySQLExecutionFactory

Method Detail

start

initCapabilities

translateLiteralDate

translateLiteralTime

translateLiteralTimestamp

useParensForSetQueries

getTimestampNanoPrecision

isVersion5OrGreater

useParensForJoins

getSupportedFunctions

supportsAggregatesDistinct

supportsRowLimit

supportsRowOffset

supportsSelectWithoutFrom

getHibernateDialectClassName

getMetadataProcessor

createMetadataProcessor

translateGeometrySelect

retrieveGeometryValue

retrieveGeometryValue

translate

translateCommand

usesDatabaseVersion

supportsLikeRegex

getLikeRegexString

supportsGroupByRollup

useWithRollup

supportsOrderByWithExtendedGrouping

supportsInlineViews

supportsAggregatesEnhancedNumeric

retrieveValue

retrieveValue