Package org.teiid.translator.mongodb

Class MongoDBExecutionFactory

java.lang.Object

org.teiid.translator.ExecutionFactory<ConnectionFactory,MongoDBConnection>

org.teiid.translator.mongodb.MongoDBExecutionFactory

@Translator(name="mongodb",
            description="MongoDB Translator, reads and writes the data to MongoDB")
public class MongoDBExecutionFactory
extends ExecutionFactory<ConnectionFactory,MongoDBConnection>

Nested Class Summary

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	Description
static String	AVOID_PROJECTION
static Version	FOUR_0
static String	FUNC_GEO_INTERSECTS
static String	FUNC_GEO_NEAR
static String	FUNC_GEO_NEAR_SPHERE
static String	FUNC_GEO_POLYGON_INTERSECTS
static String	FUNC_GEO_POLYGON_WITHIN
static String	FUNC_GEO_WITHIN
protected Map<String,FunctionModifier>	functionModifiers
static String[]	GEOSPATIAL_FUNCTIONS
static Version	THREE_0
static Version	TWO_4
static Version	TWO_6

Fields inherited from class org.teiid.translator.ExecutionFactory

DEFAULT_MAX_FROM_GROUPS, DEFAULT_MAX_IN_CRITERIA_SIZE, DEFAULT_MAX_PROJECTED_COLUMNS

Constructor Summary

Constructors

Constructor	Description
MongoDBExecutionFactory()

Method Summary

Modifier and Type	Method	Description
Object	convertToMongoType(Object value, com.mongodb.DB mongoDB, String fqn)	Mongodb only supports certain data types, Teiid need to serialize them in other compatible formats, and convert them back while reading them.
ProcedureExecution	createDirectExecution(List<Argument> arguments, Command command, ExecutionContext executionContext, RuntimeMetadata metadata, MongoDBConnection connection)
ProcedureExecution	createProcedureExecution(Call command, ExecutionContext executionContext, RuntimeMetadata metadata, MongoDBConnection connection)
ResultSetExecution	createResultSetExecution(QueryExpression command, ExecutionContext executionContext, RuntimeMetadata metadata, MongoDBConnection connection)
UpdateExecution	createUpdateExecution(Command command, ExecutionContext executionContext, RuntimeMetadata metadata, MongoDBConnection connection)
String	getDatabaseVersion()
List<String>	getDefaultSupportedFunctions()
Map<String,FunctionModifier>	getFunctionModifiers()
MetadataProcessor<MongoDBConnection>	getMetadataProcessor()
com.mongodb.AggregationOptions	getOptions(int batchSize)
List<String>	getSupportedFunctions()
ExecutionFactory.TransactionSupport	getTransactionSupport()
void	initCapabilities(MongoDBConnection connection)
boolean	isSourceRequiredForCapabilities()
void	registerFunctionModifier(String name, FunctionModifier modifier)
Object	retrieveValue(Object value, Class<?> expectedClass, com.mongodb.DB mongoDB, String fqn, String colName)
void	setDatabaseVersion(String version)	Sets the database version.
void	setDatabaseVersion(Version version)
void	setSupportsAggregatesCount(boolean value)
void	setUseDisk(boolean useDisk)
void	start()
boolean	supportsAggregatesAvg()
boolean	supportsAggregatesCount()
boolean	supportsAggregatesCountStar()
boolean	supportsAggregatesMax()
boolean	supportsAggregatesMin()
boolean	supportsAggregatesSum()
boolean	supportsBulkUpdate()
boolean	supportsCompareCriteriaEquals()
boolean	supportsCompareCriteriaOrdered()
boolean	supportsGroupBy()
boolean	supportsHaving()
boolean	supportsInCriteria()
boolean	supportsIsNullCriteria()
boolean	supportsLikeCriteria()
boolean	supportsLikeRegex()
boolean	supportsNotCriteria()
boolean	supportsOnlyLiteralComparison()
boolean	supportsOrCriteria()
boolean	supportsOrderByUnrelated()
boolean	supportsRowLimit()
boolean	supportsRowOffset()
boolean	supportsSelectExpression()
boolean	supportsSelfJoins()
boolean	useAnsiJoin()
boolean	useDisk()

Methods inherited from class org.teiid.translator.ExecutionFactory

addPushDownFunction, areLobsUsableAfterClose, closeConnection, createExecution, getCacheDirective, getCollationLocale, getConnection, getConnection, getDefaultNullOrder, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, getMaxProjectedColumns, getMetadata, getNativeQueryProcedureName, getPushDownFunctions, getRequiredLikeEscape, getSupportedJoinCriteria, getTypeFacility, isCopyLobs, isForkable, isImmutable, isSourceRequired, 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, supportsAggregatesDistinct, supportsAggregatesEnhancedNumeric, supportsAliasedTable, supportsArrayAgg, supportsArrayType, supportsBatchedUpdates, supportsCommonTableExpressions, supportsCompareCriteriaOrderedExclusive, supportsConvert, supportsCorrelatedSubqueries, supportsCorrelatedSubqueryLimit, supportsDependentJoins, supportsDirectQueryProcedure, supportsElementaryOlapOperations, supportsExcept, supportsExistsCriteria, supportsFormatLiteral, supportsFullDependentJoins, supportsFullOuterJoins, supportsFunctionsInGroupBy, supportsGeographyType, supportsGroupByMultipleDistinctAggregates, supportsGroupByRollup, supportsInCriteriaSubquery, supportsInlineViews, supportsInnerJoins, supportsInsertWithQueryExpression, supportsIntersect, supportsIsDistinctCriteria, supportsLateralJoin, supportsLateralJoinCondition, supportsLikeCriteriaEscapeCharacter, supportsListAgg, supportsMultipleOpenExecutions, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLateralJoinProcedure, supportsOnlySingleTableGroupBy, supportsOnlyTimestampAddLiteral, supportsOrderBy, supportsOrderByNullOrdering, supportsOrderByWithExtendedGrouping, supportsOuterJoins, supportsPartialFiltering, supportsProcedureParameterExpression, supportsProcedureTable, supportsQuantifiedCompareCriteriaAll, supportsQuantifiedCompareCriteriaSome, supportsRecursiveCommonTableExpressions, supportsScalarSubqueries, supportsScalarSubqueryProjection, supportsSearchedCaseExpressions, supportsSelectDistinct, supportsSelectExpressionArrayType, supportsSelectWithoutFrom, supportsSetQueryLimitOffset, supportsSetQueryOrderBy, supportsSimilarTo, supportsStringAgg, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUnions, supportsUpsert, supportsWindowDistinctAggregates, supportsWindowFrameClause, supportsWindowFunctionCumeDist, supportsWindowFunctionNthValue, supportsWindowFunctionNtile, supportsWindowFunctionPercentRank, supportsWindowOrderByWithAggregates, useBindingsForDependentJoin

Methods inherited from class java.lang.Object

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

Field Detail

TWO_4

public static final Version TWO_4

TWO_6

public static final Version TWO_6

THREE_0

public static final Version THREE_0

FOUR_0

public static final Version FOUR_0

FUNC_GEO_WITHIN

public static final String FUNC_GEO_WITHIN

See Also:

Constant Field Values

FUNC_GEO_INTERSECTS

public static final String FUNC_GEO_INTERSECTS

See Also:

Constant Field Values

FUNC_GEO_NEAR

public static final String FUNC_GEO_NEAR

See Also:

Constant Field Values

FUNC_GEO_NEAR_SPHERE

public static final String FUNC_GEO_NEAR_SPHERE

See Also:

Constant Field Values

FUNC_GEO_POLYGON_WITHIN

public static final String FUNC_GEO_POLYGON_WITHIN

See Also:

Constant Field Values

FUNC_GEO_POLYGON_INTERSECTS

public static final String FUNC_GEO_POLYGON_INTERSECTS

See Also:

Constant Field Values

GEOSPATIAL_FUNCTIONS

public static final String[] GEOSPATIAL_FUNCTIONS

AVOID_PROJECTION

public static final String AVOID_PROJECTION

See Also:

Constant Field Values

functionModifiers

protected Map<String,FunctionModifier> functionModifiers

Constructor Detail

MongoDBExecutionFactory

public MongoDBExecutionFactory()

Method Detail

start

public void start()
           throws TranslatorException

Overrides:

start in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

Throws:

TranslatorException

getDatabaseVersion

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

useDisk

@TranslatorProperty(display="Use Disk",
                    description="Use disk for aggregation processing in MongoDB",
                    advanced=true)
public boolean useDisk()

setUseDisk

public void setUseDisk(boolean useDisk)

setDatabaseVersion

public void setDatabaseVersion(String version)

Sets the database version. See also getVersion()

Parameters:

version -

setDatabaseVersion

public void setDatabaseVersion(Version version)

getMetadataProcessor

public MetadataProcessor<MongoDBConnection> getMetadataProcessor()

Overrides:

getMetadataProcessor in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

registerFunctionModifier

public void registerFunctionModifier(String name,
                                     FunctionModifier modifier)

getFunctionModifiers

public Map<String,FunctionModifier> getFunctionModifiers()

createResultSetExecution

public ResultSetExecution createResultSetExecution(QueryExpression command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   MongoDBConnection connection)
                                            throws TranslatorException

Overrides:

createResultSetExecution in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

Throws:

TranslatorException

createProcedureExecution

public ProcedureExecution createProcedureExecution(Call command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   MongoDBConnection connection)
                                            throws TranslatorException

Overrides:

createProcedureExecution in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

Throws:

TranslatorException

createUpdateExecution

public UpdateExecution createUpdateExecution(Command command,
                                             ExecutionContext executionContext,
                                             RuntimeMetadata metadata,
                                             MongoDBConnection connection)
                                      throws TranslatorException

Overrides:

createUpdateExecution in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

Throws:

TranslatorException

createDirectExecution

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

Overrides:

createDirectExecution in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

Throws:

TranslatorException

useAnsiJoin

public boolean useAnsiJoin()

Overrides:

useAnsiJoin in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsSelfJoins

public boolean supportsSelfJoins()

Overrides:

supportsSelfJoins in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsCompareCriteriaEquals

public boolean supportsCompareCriteriaEquals()

Overrides:

supportsCompareCriteriaEquals in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsCompareCriteriaOrdered

public boolean supportsCompareCriteriaOrdered()

Overrides:

supportsCompareCriteriaOrdered in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsLikeCriteria

public boolean supportsLikeCriteria()

Overrides:

supportsLikeCriteria in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsOrCriteria

public boolean supportsOrCriteria()

Overrides:

supportsOrCriteria in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsOrderByUnrelated

public boolean supportsOrderByUnrelated()

Overrides:

supportsOrderByUnrelated in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsGroupBy

public boolean supportsGroupBy()

Overrides:

supportsGroupBy in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsHaving

public boolean supportsHaving()

Overrides:

supportsHaving in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsAggregatesSum

public boolean supportsAggregatesSum()

Overrides:

supportsAggregatesSum in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsAggregatesAvg

public boolean supportsAggregatesAvg()

Overrides:

supportsAggregatesAvg in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsAggregatesMin

public boolean supportsAggregatesMin()

Overrides:

supportsAggregatesMin in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsAggregatesMax

public boolean supportsAggregatesMax()

Overrides:

supportsAggregatesMax in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

setSupportsAggregatesCount

public void setSupportsAggregatesCount(boolean value)

supportsAggregatesCount

@TranslatorProperty(display="Supports Count(expr)",
                    description="Supports Aggregate function count with expression",
                    advanced=true)
public boolean supportsAggregatesCount()

Overrides:

supportsAggregatesCount in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsAggregatesCountStar

public boolean supportsAggregatesCountStar()

Overrides:

supportsAggregatesCountStar in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

getSupportedFunctions

public List<String> getSupportedFunctions()

Overrides:

getSupportedFunctions in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

getDefaultSupportedFunctions

public List<String> getDefaultSupportedFunctions()

supportsInCriteria

public boolean supportsInCriteria()

Overrides:

supportsInCriteria in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsNotCriteria

public boolean supportsNotCriteria()

Overrides:

supportsNotCriteria in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsRowLimit

public boolean supportsRowLimit()

Overrides:

supportsRowLimit in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsIsNullCriteria

public boolean supportsIsNullCriteria()

Overrides:

supportsIsNullCriteria in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsRowOffset

public boolean supportsRowOffset()

Overrides:

supportsRowOffset in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsBulkUpdate

public boolean supportsBulkUpdate()

Overrides:

supportsBulkUpdate in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsLikeRegex

public boolean supportsLikeRegex()

Overrides:

supportsLikeRegex in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsSelectExpression

public boolean supportsSelectExpression()

Overrides:

supportsSelectExpression in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

supportsOnlyLiteralComparison

public boolean supportsOnlyLiteralComparison()

Overrides:

supportsOnlyLiteralComparison in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

retrieveValue

public Object retrieveValue(Object value,
                            Class<?> expectedClass,
                            com.mongodb.DB mongoDB,
                            String fqn,
                            String colName)
                     throws TranslatorException

Throws:

TranslatorException

convertToMongoType

public Object convertToMongoType(Object value,
                                 com.mongodb.DB mongoDB,
                                 String fqn)
                          throws TranslatorException

Mongodb only supports certain data types, Teiid need to serialize them in other compatible formats, and convert them back while reading them.

Parameters:

value -

Returns:

Throws:

TranslatorException

getOptions

public com.mongodb.AggregationOptions getOptions(int batchSize)

isSourceRequiredForCapabilities

public boolean isSourceRequiredForCapabilities()

Overrides:

isSourceRequiredForCapabilities in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

getTransactionSupport

public ExecutionFactory.TransactionSupport getTransactionSupport()

Overrides:

getTransactionSupport in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

initCapabilities

public void initCapabilities(MongoDBConnection connection)
                      throws TranslatorException

Overrides:

initCapabilities in class ExecutionFactory<ConnectionFactory,MongoDBConnection>

Throws:

TranslatorException