SalesForceExecutionFactory (Teiid 12.1.0 API)

java.lang.Object
- org.teiid.translator.ExecutionFactory<ConnectionFactory,SalesforceConnection>
- - org.teiid.translator.salesforce.SalesForceExecutionFactory

Direct Known Subclasses:: SalesForce34ExecutionFactory, SalesForce41ExecutionFactory

@Translator(name="salesforce",
            description="A translator for Salesforce")
public class SalesForceExecutionFactory
extends ExecutionFactory<ConnectionFactory,SalesforceConnection>

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

Field Summary
- 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 and Description

SalesForceExecutionFactory()

Constructors
Constructor and Description
`SalesForceExecutionFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.sforce.soap.partner.QueryResult`	`buildQueryResult(com.sforce.soap.partner.sobject.SObject[] objects)`
`ProcedureExecution`	`createDirectExecution(List<Argument> arguments, Command command, ExecutionContext executionContext, RuntimeMetadata metadata, SalesforceConnection connection)`
`ProcedureExecution`	`createProcedureExecution(Call command, ExecutionContext executionContext, RuntimeMetadata metadata, SalesforceConnection connection)`
`ResultSetExecution`	`createResultSetExecution(QueryExpression command, ExecutionContext executionContext, RuntimeMetadata metadata, SalesforceConnection connection)`
`UpdateExecution`	`createUpdateExecution(Command command, ExecutionContext executionContext, RuntimeMetadata metadata, SalesforceConnection connection)`
`int`	`getMaxBulkInsertBatchSize()`
`int`	`getMaxFromGroups()` The number of groups supported in the from clause.
`void`	`getMetadata(MetadataFactory metadataFactory, SalesforceConnection connection)` Implement to provide metadata to the metadata for use by the engine.
`MetadataProcessor<SalesforceConnection>`	`getMetadataProcessor()` Get a MetadataProcessor for the translator to read the metadata.
`List<String>`	`getSupportedFunctions()` Get list of all supported function names.
`boolean`	`isModelAuditFields()`
`void`	`setMaxBulkInsertBatchSize(int maxInsertBatchSize)`
`void`	`setModelAuditFields(boolean modelAuditFields)`
`void`	`setSupportsGroupBy(boolean supportsGroupBy)`
`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`	`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`	`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`	`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`	`supportsIsNullCriteria()` Support indicates connector accepts criteria of form (element IS NULL)
`boolean`	`supportsLikeCriteria()` Support indicates connector accepts criteria of form (element LIKE constant)
`boolean`	`supportsNotCriteria()` Support indicates connector accepts logical criteria NOT
`boolean`	`supportsOnlyLiteralComparison()`
`boolean`	`supportsOnlySingleTableGroupBy()` Whether the source supports grouping only over a single table
`boolean`	`supportsOrCriteria()` Support indicates connector accepts logical criteria connected by OR
`boolean`	`supportsRowLimit()` Gets whether the connector can limit the number of rows returned by a query.
`boolean`	`supportsUpsert()`
`boolean`	`useAnsiJoin()` Whether the source prefers to use ANSI style joins.

Methods inherited from class org.teiid.translator.ExecutionFactory
addPushDownFunction, areLobsUsableAfterClose, closeConnection, createExecution, getCacheDirective, getCollationLocale, getConnection, getConnection, getDefaultNullOrder, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxInCriteriaSize, getMaxProjectedColumns, getNativeQueryProcedureName, getPushDownFunctions, getRequiredLikeEscape, getSupportedJoinCriteria, getTransactionSupport, getTypeFacility, initCapabilities, isCopyLobs, isForkable, isImmutable, isSourceRequired, isSourceRequiredForCapabilities, 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, supportsLikeRegex, supportsListAgg, supportsMultipleOpenExecutions, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLateralJoinProcedure, supportsOnlyTimestampAddLiteral, supportsOrderBy, supportsOrderByNullOrdering, supportsOrderByUnrelated, supportsOrderByWithExtendedGrouping, supportsOuterJoins, supportsPartialFiltering, supportsProcedureTable, supportsQuantifiedCompareCriteriaAll, supportsQuantifiedCompareCriteriaSome, supportsRecursiveCommonTableExpressions, supportsRowOffset, supportsScalarSubqueries, supportsScalarSubqueryProjection, supportsSearchedCaseExpressions, supportsSelectDistinct, supportsSelectExpression, supportsSelectExpressionArrayType, supportsSelectWithoutFrom, supportsSelfJoins, supportsSetQueryLimitOffset, supportsSetQueryOrderBy, supportsSimilarTo, supportsStringAgg, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUnions, 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

- Constructor Detail
  - SalesForceExecutionFactory
```
public SalesForceExecutionFactory()
```
- Method Detail
  - isModelAuditFields
```
@TranslatorProperty(display="Model Audit Fields",
                    advanced=true)
public boolean isModelAuditFields()
```
  - setModelAuditFields
```
public void setModelAuditFields(boolean modelAuditFields)
```
  - start
```
public void start()
           throws TranslatorException
```
    Description copied from class: ExecutionFactory
    
    Initialize the connector with supplied configuration
    
    Overrides:
    
    start in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Throws:
    
    TranslatorException
  - createResultSetExecution
```
public ResultSetExecution createResultSetExecution(QueryExpression command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   SalesforceConnection connection)
                                            throws TranslatorException
```
    Overrides:
    
    createResultSetExecution in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Throws:
    
    TranslatorException
  - createUpdateExecution
```
public UpdateExecution createUpdateExecution(Command command,
                                             ExecutionContext executionContext,
                                             RuntimeMetadata metadata,
                                             SalesforceConnection connection)
                                      throws TranslatorException
```
    Overrides:
    
    createUpdateExecution in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Throws:
    
    TranslatorException
  - createProcedureExecution
```
public ProcedureExecution createProcedureExecution(Call command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   SalesforceConnection connection)
                                            throws TranslatorException
```
    Overrides:
    
    createProcedureExecution in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Throws:
    
    TranslatorException
  - createDirectExecution
```
public ProcedureExecution createDirectExecution(List<Argument> arguments,
                                                Command command,
                                                ExecutionContext executionContext,
                                                RuntimeMetadata metadata,
                                                SalesforceConnection connection)
                                         throws TranslatorException
```
    Overrides:
    
    createDirectExecution in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Throws:
    
    TranslatorException
  - getMetadata
```
public void getMetadata(MetadataFactory metadataFactory,
                        SalesforceConnection connection)
                 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<ConnectionFactory,SalesforceConnection>
    
    connection - may be null if the source is not required
    
    Throws:
    
    TranslatorException - to indicate a recoverable error, otherwise a RuntimeException
    
    See Also:
    
    ExecutionFactory.isSourceRequiredForMetadata()
  - getMetadataProcessor
```
public MetadataProcessor<SalesforceConnection> getMetadataProcessor()
```
    Description copied from class: ExecutionFactory
    
    Get a MetadataProcessor for the translator to read the metadata. Typically this will return a new instance.
    
    Overrides:
    
    getMetadataProcessor in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Returns:
  - 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<ConnectionFactory,SalesforceConnection>
    
    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. Note: User defined functions should be specified fully qualified.
  - supportsCompareCriteriaEquals
```
public boolean supportsCompareCriteriaEquals()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector accepts criteria of form (element = constant)
    
    Overrides:
    
    supportsCompareCriteriaEquals in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsInCriteria
```
public boolean supportsInCriteria()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector accepts criteria of form (element IN set)
    
    Overrides:
    
    supportsInCriteria in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsLikeCriteria
```
public boolean supportsLikeCriteria()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector accepts criteria of form (element LIKE constant)
    
    Overrides:
    
    supportsLikeCriteria in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsRowLimit
```
public boolean supportsRowLimit()
```
    Description copied from class: ExecutionFactory
    
    Gets whether the connector can limit the number of rows returned by a query.
    
    Overrides:
    
    supportsRowLimit in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsAggregatesCountStar
```
public boolean supportsAggregatesCountStar()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector can accept the COUNT(*) aggregate function
    
    Overrides:
    
    supportsAggregatesCountStar in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsAggregatesCount
```
public boolean supportsAggregatesCount()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector can accept the COUNT aggregate function
    
    Overrides:
    
    supportsAggregatesCount in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsAggregatesMax
```
public boolean supportsAggregatesMax()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector can accept the MAX aggregate function
    
    Overrides:
    
    supportsAggregatesMax in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsAggregatesMin
```
public boolean supportsAggregatesMin()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector can accept the MIN aggregate function
    
    Overrides:
    
    supportsAggregatesMin in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsAggregatesSum
```
public boolean supportsAggregatesSum()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector can accept the SUM aggregate function
    
    Overrides:
    
    supportsAggregatesSum in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsAggregatesAvg
```
public boolean supportsAggregatesAvg()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector can accept the AVG aggregate function
    
    Overrides:
    
    supportsAggregatesAvg in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsGroupBy
```
@TranslatorProperty(display="Supports Group By",
                    description="Defaults to true. Set to false to have Teiid process group by aggregations, such as those returning more than 2000 rows which error in SOQL",
                    advanced=true)
public boolean supportsGroupBy()
```
    Description copied from class: ExecutionFactory
    
    Whether the source supports an explicit GROUP BY clause
    
    Overrides:
    
    supportsGroupBy in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsOnlySingleTableGroupBy
```
public boolean supportsOnlySingleTableGroupBy()
```
    Description copied from class: ExecutionFactory
    
    Whether the source supports grouping only over a single table
    
    Overrides:
    
    supportsOnlySingleTableGroupBy in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Returns:
  - supportsNotCriteria
```
public boolean supportsNotCriteria()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector accepts logical criteria NOT
    
    Overrides:
    
    supportsNotCriteria in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsOrCriteria
```
public boolean supportsOrCriteria()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector accepts logical criteria connected by OR
    
    Overrides:
    
    supportsOrCriteria in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - 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<ConnectionFactory,SalesforceConnection>
  - supportsIsNullCriteria
```
public boolean supportsIsNullCriteria()
```
    Description copied from class: ExecutionFactory
    
    Support indicates connector accepts criteria of form (element IS NULL)
    
    Overrides:
    
    supportsIsNullCriteria in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsOnlyLiteralComparison
```
public boolean supportsOnlyLiteralComparison()
```
    Overrides:
    
    supportsOnlyLiteralComparison in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Returns:
    
    true if only Literal comparisons (equality, ordered, like, etc.) are supported for non-join conditions.
  - supportsHaving
```
public boolean supportsHaving()
```
    Description copied from class: ExecutionFactory
    
    Whether the source supports the HAVING clause
    
    Overrides:
    
    supportsHaving in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - getMaxFromGroups
```
public int getMaxFromGroups()
```
    Description copied from class: ExecutionFactory
    
    The number of groups supported in the from clause. Added for a Sybase limitation.
    
    Overrides:
    
    getMaxFromGroups in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Returns:
    
    the number of groups supported in the from clause, or -1 if there is no limit
  - useAnsiJoin
```
public boolean useAnsiJoin()
```
    Description copied from class: ExecutionFactory
    
    Whether the source prefers to use ANSI style joins.
    
    Overrides:
    
    useAnsiJoin in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - supportsBulkUpdate
```
public boolean supportsBulkUpdate()
```
    Description copied from class: ExecutionFactory
    
    Whether the source supports updates with multiple value sets
    
    Overrides:
    
    supportsBulkUpdate in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
  - getMaxBulkInsertBatchSize
```
@TranslatorProperty(display="Max Bulk Insert Batch Size",
                    description="The max size of a bulk insert batch.  Default 2048.",
                    advanced=true)
public int getMaxBulkInsertBatchSize()
```
  - setMaxBulkInsertBatchSize
```
public void setMaxBulkInsertBatchSize(int maxInsertBatchSize)
```
  - setSupportsGroupBy
```
public void setSupportsGroupBy(boolean supportsGroupBy)
```
  - buildQueryResult
```
public com.sforce.soap.partner.QueryResult buildQueryResult(com.sforce.soap.partner.sobject.SObject[] objects)
```
  - supportsUpsert
```
public boolean supportsUpsert()
```
    Overrides:
    
    supportsUpsert in class ExecutionFactory<ConnectionFactory,SalesforceConnection>
    
    Returns:
    
    true if the source supports upsert

Class SalesForceExecutionFactory

Nested Class Summary

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

Field Summary

Fields inherited from class org.teiid.translator.ExecutionFactory

Constructor Summary

Method Summary

Methods inherited from class org.teiid.translator.ExecutionFactory

Methods inherited from class java.lang.Object

Constructor Detail

SalesForceExecutionFactory

Method Detail

isModelAuditFields

setModelAuditFields

start

createResultSetExecution

createUpdateExecution

createProcedureExecution

createDirectExecution

getMetadata

getMetadataProcessor

getSupportedFunctions

supportsCompareCriteriaEquals

supportsInCriteria

supportsLikeCriteria

supportsRowLimit

supportsAggregatesCountStar

supportsAggregatesCount

supportsAggregatesMax

supportsAggregatesMin

supportsAggregatesSum

supportsAggregatesAvg

supportsGroupBy

supportsOnlySingleTableGroupBy

supportsNotCriteria

supportsOrCriteria

supportsCompareCriteriaOrdered

supportsIsNullCriteria

supportsOnlyLiteralComparison

supportsHaving

getMaxFromGroups

useAnsiJoin

supportsBulkUpdate

getMaxBulkInsertBatchSize

setMaxBulkInsertBatchSize

setSupportsGroupBy

buildQueryResult

supportsUpsert