org.teiid.translator.jdbc.postgresql

Class PostgreSQLExecutionFactory

java.lang.Object

org.teiid.translator.ExecutionFactory<DataSource,Connection>

org.teiid.translator.jdbc.JDBCExecutionFactory

org.teiid.translator.jdbc.postgresql.PostgreSQLExecutionFactory

Direct Known Subclasses:

GreenplumExecutionFactory, RedshiftExecutionFactory

@Translator(name="postgresql",
            description="A translator for postgreSQL Database")
public class PostgreSQLExecutionFactory
extends JDBCExecutionFactory

Translator class for PostgreSQL. Updated to expect a 8.0+ jdbc client

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

org.teiid.translator.ExecutionFactory.Format, org.teiid.translator.ExecutionFactory.NullOrder, org.teiid.translator.ExecutionFactory.SupportedJoinCriteria, org.teiid.translator.ExecutionFactory.TransactionSupport

Field Summary

Fields

Modifier and Type	Field and Description
static org.teiid.util.Version	EIGHT_0
static org.teiid.util.Version	EIGHT_1
static org.teiid.util.Version	EIGHT_2
static org.teiid.util.Version	EIGHT_3
static org.teiid.util.Version	EIGHT_4
static org.teiid.util.Version	NINE_0
static org.teiid.util.Version	NINE_3
static org.teiid.util.Version	ONE_3
static org.teiid.util.Version	ONE_4
static org.teiid.util.Version	ONE_5
protected OracleFormatFunctionModifier	parseModifier
static String	POSTGRESQL
static org.teiid.util.Version	TWO_0

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

Constructor Summary

Constructors

Constructor and Description
PostgreSQLExecutionFactory()

Method Summary

Modifier and Type	Method and Description
static List<Object>	addDefaultEscape(org.teiid.language.Like like) Add a default escape
void	bindValue(PreparedStatement stmt, Object param, Class<?> paramType, int i) Sets prepared statement parameter i with param.
Object	convertToken(String group) Convert to a new parsing token or return null if not possible
String	getCreateTemporaryTablePostfix(boolean inTransaction)
org.teiid.translator.ExecutionFactory.NullOrder	getDefaultNullOrder()
String	getHibernateDialectClassName()
org.teiid.translator.MetadataProcessor<Connection>	getMetadataProcessor()
String	getPostGisVersion()
SQLConversionVisitor	getSQLConversionVisitor() Create the SQLConversionVisitor that will perform translation.
List<String>	getSupportedFunctions()
int	getTimestampNanoPrecision() Return the precision of timestamp literals.
void	initCapabilities(Connection connection)
boolean	isProjSupported()
void	loadedTemporaryTable(String tableName, org.teiid.translator.ExecutionContext context, Connection connection) pg needs to collect stats for effective planning
Object	retrieveGeometryValue(ResultSet results, int paramIndex)
void	setPostGisVersion(String postGisVersion)
void	setProjSupported(boolean projSupported)
void	start()
boolean	supportsAggregatesEnhancedNumeric()
boolean	supportsArrayAgg()
boolean	supportsArrayType()
boolean	supportsCommonTableExpressions()
boolean	supportsElementaryOlapOperations()
boolean	supportsExcept()
boolean	supportsFormatLiteral(String literal, org.teiid.translator.ExecutionFactory.Format format)
boolean	supportsFunctionsInGroupBy()
boolean	supportsInlineViews() This is true only after Postgre version 7.1 However, since version 7 was released in 2000 we'll assume a post 7 instance.
boolean	supportsIntersect()
boolean	supportsIsDistinctCriteria()
boolean	supportsLateralJoin()
boolean	supportsLikeRegex()
boolean	supportsOnlyFormatLiterals()
boolean	supportsOrderByNullOrdering()
boolean	supportsRecursiveCommonTableExpressions()
boolean	supportsRowLimit()
boolean	supportsRowOffset()
boolean	supportsSelectWithoutFrom()
boolean	supportsSimilarTo()
boolean	supportsStringAgg()
boolean	supportsWindowDistinctAggregates()
List<?>	translate(org.teiid.language.LanguageObject obj, org.teiid.translator.ExecutionContext context) Postgres doesn't provide min/max(boolean), so this conversion writes a min(BooleanValue) as bool_and(BooleanValue)
org.teiid.language.Expression	translateGeometrySelect(org.teiid.language.Expression expr) Translate GEOMETRY column reference into an expression that will return SRID & WKB.
List<?>	translateLimit(org.teiid.language.Limit limit, org.teiid.translator.ExecutionContext context) Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
String	translateLiteralBinaryType(BinaryType obj) Subclasses should override this method to provide a different sql translation of the literal varbinary value.
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.
protected boolean	usesDatabaseVersion()
boolean	useStreamsForLobs() If streams should be used for Blob/Clob sets on PreparedStatements

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

addSourceComment, afterInitialConnectionObtained, closeConnection, convertObject, createDirectExecution, createMetadataProcessor, createProcedureExecution, createResultSetExecution, createTempTable, createUpdateExecution, executeStoredProcedure, formatDateValue, formatDateValue, getCommentFormat, getConnection, getCreateTemporaryTableString, getCreateTempTableSQL, getDatabaseCalendar, getDatabaseTimeZone, getDatabaseVersion, getDefaultSupportedFunctions, getDialect, getFunctionModifiers, getLateralKeyword, getLikeRegexString, getMaxPreparedInsertBatchSize, getMetadata, getRemovePushdownCharacters, getSetOperationString, getSourceComment, getStructRetrieval, getTemporaryTableName, getVersion, hasTimeType, intializeConnectionAfterCancel, isEnableDependentJoins, isNonAscii, isNonAsciiFunction, isSourceRequired, isSourceRequiredForCapabilities, isTrimStrings, obtainedConnection, parseName, registerFunctionModifier, registerSpecificTypeOfOutParameter, replaceElementName, retrieveGeometryValue, retrieveValue, retrieveValue, setCommentFormat, setDatabaseTimeZone, setDatabaseVersion, setDatabaseVersion, setEnableDependentJoins, setFetchSize, setMaxPreparedInsertBatchSize, setRemovePushdownCharacters, setStructRetrieval, setTrimStrings, setUseBindingsForDependentJoin, setUseBindVariables, setUseCommentsInSourceQuery, supportsAggregatesAvg, supportsAggregatesCount, supportsAggregatesCountStar, supportsAggregatesDistinct, 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, supportsQuantifiedCompareCriteriaAll, supportsQuantifiedCompareCriteriaSome, supportsScalarSubqueries, supportsSearchedCaseExpressions, supportsSelectExpression, supportsSelfJoins, supportsSetQueryOrderBy, supportsUnions, tempTableRequiresTransaction, translateCommand, translateGeometryLiteral, translateGeometryParameter, useAsInGroupAlias, useBindingsForDependentJoin, useBindVariables, useColumnNamesForGeneratedKeys, useCommentsInSourceQuery, useParensForJoins, useParensForSetQueries, usePreparedStatements, useScientificNotation, useSelectLimit, useUnicodePrefix, useWithRollup

Methods inherited from class org.teiid.translator.ExecutionFactory

addPushDownFunction, areLobsUsableAfterClose, createExecution, getCacheDirective, getCollationLocale, getConnection, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, 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, supportsCompareCriteriaOrderedExclusive, supportsConvert, supportsCorrelatedSubqueryLimit, supportsDirectQueryProcedure, supportsFullOuterJoins, supportsGroupByMultipleDistinctAggregates, supportsGroupByRollup, supportsInnerJoins, supportsLateralJoinCondition, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyLateralJoinProcedure, supportsOnlyLiteralComparison, supportsOnlySingleTableGroupBy, supportsOnlyTimestampAddLiteral, supportsOrderBy, supportsOrderByWithExtendedGrouping, supportsOuterJoins, supportsPartialFiltering, supportsProcedureTable, supportsScalarSubqueryProjection, supportsSelectDistinct, supportsSelectExpressionArrayType, supportsSetQueryLimitOffset, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUpsert, supportsWindowOrderByWithAggregates, useAnsiJoin

Methods inherited from class java.lang.Object

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

Field Detail

POSTGRESQL

public static String POSTGRESQL

EIGHT_0

public static final org.teiid.util.Version EIGHT_0

EIGHT_1

public static final org.teiid.util.Version EIGHT_1

EIGHT_2

public static final org.teiid.util.Version EIGHT_2

EIGHT_3

public static final org.teiid.util.Version EIGHT_3

EIGHT_4

public static final org.teiid.util.Version EIGHT_4

NINE_0

public static final org.teiid.util.Version NINE_0

NINE_3

public static final org.teiid.util.Version NINE_3

parseModifier

protected OracleFormatFunctionModifier parseModifier

ONE_3

public static final org.teiid.util.Version ONE_3

ONE_4

public static final org.teiid.util.Version ONE_4

ONE_5

public static final org.teiid.util.Version ONE_5

TWO_0

public static final org.teiid.util.Version TWO_0

Constructor Detail

PostgreSQLExecutionFactory

public PostgreSQLExecutionFactory()

Method Detail

convertToken

public Object convertToken(String group)

Convert to a new parsing token or return null if not possible

Parameters:

group -

Returns:

start

public void start()
           throws org.teiid.translator.TranslatorException

Overrides:

start in class JDBCExecutionFactory

Throws:

org.teiid.translator.TranslatorException

initCapabilities

public void initCapabilities(Connection connection)
                      throws org.teiid.translator.TranslatorException

Overrides:

initCapabilities in class JDBCExecutionFactory

Throws:

org.teiid.translator.TranslatorException

translateLiteralBoolean

public String translateLiteralBoolean(Boolean booleanValue)

Description copied from class: JDBCExecutionFactory

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'.

Overrides:

translateLiteralBoolean in class JDBCExecutionFactory

Parameters:

booleanValue - Boolean value, never null

Returns:

Translated string

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

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.

translateLimit

public List<?> translateLimit(org.teiid.language.Limit limit,
                              org.teiid.translator.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:

translateLimit in class JDBCExecutionFactory

Returns:

a list of translated parts

translate

public List<?> translate(org.teiid.language.LanguageObject obj,
                         org.teiid.translator.ExecutionContext context)

Postgres doesn't provide min/max(boolean), so this conversion writes a min(BooleanValue) as bool_and(BooleanValue)

Overrides:

translate in class JDBCExecutionFactory

Returns:

list of translated parts

Since:

4.3

See Also:

LanguageObjectVisitor.visit(org.teiid.language.AggregateFunction)

addDefaultEscape

public static List<Object> addDefaultEscape(org.teiid.language.Like like)

Add a default escape

Parameters:

like -

Returns:

getDefaultNullOrder

public org.teiid.translator.ExecutionFactory.NullOrder getDefaultNullOrder()

Overrides:

getDefaultNullOrder in class JDBCExecutionFactory

supportsOrderByNullOrdering

public boolean supportsOrderByNullOrdering()

Overrides:

supportsOrderByNullOrdering in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

getSupportedFunctions

public List<String> getSupportedFunctions()

Overrides:

getSupportedFunctions in class JDBCExecutionFactory

supportsInlineViews

public boolean supportsInlineViews()

This is true only after Postgre version 7.1 However, since version 7 was released in 2000 we'll assume a post 7 instance.

Overrides:

supportsInlineViews in class JDBCExecutionFactory

supportsRowLimit

public boolean supportsRowLimit()

Overrides:

supportsRowLimit in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsRowOffset

public boolean supportsRowOffset()

Overrides:

supportsRowOffset in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsExcept

public boolean supportsExcept()

Overrides:

supportsExcept in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsIntersect

public boolean supportsIntersect()

Overrides:

supportsIntersect in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsAggregatesEnhancedNumeric

public boolean supportsAggregatesEnhancedNumeric()

Overrides:

supportsAggregatesEnhancedNumeric in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsCommonTableExpressions

public boolean supportsCommonTableExpressions()

Overrides:

supportsCommonTableExpressions in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsRecursiveCommonTableExpressions

public boolean supportsRecursiveCommonTableExpressions()

Overrides:

supportsRecursiveCommonTableExpressions in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsArrayAgg

public boolean supportsArrayAgg()

Overrides:

supportsArrayAgg in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsElementaryOlapOperations

public boolean supportsElementaryOlapOperations()

Overrides:

supportsElementaryOlapOperations in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsWindowDistinctAggregates

public boolean supportsWindowDistinctAggregates()

Overrides:

supportsWindowDistinctAggregates in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsSimilarTo

public boolean supportsSimilarTo()

Overrides:

supportsSimilarTo in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsLikeRegex

public boolean supportsLikeRegex()

Overrides:

supportsLikeRegex in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsOnlyFormatLiterals

public boolean supportsOnlyFormatLiterals()

Overrides:

supportsOnlyFormatLiterals in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsFormatLiteral

public boolean supportsFormatLiteral(String literal,
                                     org.teiid.translator.ExecutionFactory.Format format)

Overrides:

supportsFormatLiteral in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsArrayType

public boolean supportsArrayType()

Overrides:

supportsArrayType in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

usesDatabaseVersion

protected boolean usesDatabaseVersion()

Overrides:

usesDatabaseVersion in class JDBCExecutionFactory

supportsStringAgg

public boolean supportsStringAgg()

Overrides:

supportsStringAgg in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsSelectWithoutFrom

public boolean supportsSelectWithoutFrom()

Overrides:

supportsSelectWithoutFrom in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

getHibernateDialectClassName

public String getHibernateDialectClassName()

Overrides:

getHibernateDialectClassName in class JDBCExecutionFactory

getCreateTemporaryTablePostfix

public String getCreateTemporaryTablePostfix(boolean inTransaction)

Overrides:

getCreateTemporaryTablePostfix in class JDBCExecutionFactory

Returns:

the post script for the temp table create

loadedTemporaryTable

public void loadedTemporaryTable(String tableName,
                                 org.teiid.translator.ExecutionContext context,
                                 Connection connection)
                          throws SQLException

pg needs to collect stats for effective planning

Overrides:

loadedTemporaryTable in class JDBCExecutionFactory

Throws:

SQLException

getSQLConversionVisitor

public SQLConversionVisitor getSQLConversionVisitor()

Description copied from class: JDBCExecutionFactory

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.

Overrides:

getSQLConversionVisitor in class JDBCExecutionFactory

Returns:

the SQLConversionVisitor

setPostGisVersion

public void setPostGisVersion(String postGisVersion)

getPostGisVersion

@TranslatorProperty(display="PostGIS Version",
                    description="The version of the PostGIS extension.",
                    advanced=true)
public String getPostGisVersion()

isProjSupported

@TranslatorProperty(display="Proj support enabled",
                    description="If PostGIS Proj support is enabled for ST_TRANSFORM",
                    advanced=true)
public boolean isProjSupported()

setProjSupported

public void setProjSupported(boolean projSupported)

getMetadataProcessor

public org.teiid.translator.MetadataProcessor<Connection> getMetadataProcessor()

Overrides:

getMetadataProcessor in class JDBCExecutionFactory

translateGeometrySelect

public org.teiid.language.Expression translateGeometrySelect(org.teiid.language.Expression expr)

Description copied from class: JDBCExecutionFactory

Translate GEOMETRY column reference into an expression that will return SRID & WKB.

Overrides:

translateGeometrySelect in class JDBCExecutionFactory

Returns:

retrieveGeometryValue

public Object retrieveGeometryValue(ResultSet results,
                                    int paramIndex)
                             throws SQLException

Overrides:

retrieveGeometryValue in class JDBCExecutionFactory

Throws:

SQLException

useStreamsForLobs

public boolean useStreamsForLobs()

Description copied from class: JDBCExecutionFactory

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

Overrides:

useStreamsForLobs in class JDBCExecutionFactory

Returns:

translateLiteralBinaryType

public String translateLiteralBinaryType(BinaryType obj)

Description copied from class: JDBCExecutionFactory

Subclasses should override this method to provide a different sql translation of the literal varbinary value. By default, a varbinary literal is represented as: X'hex value'

Overrides:

translateLiteralBinaryType in class JDBCExecutionFactory

Parameters:

obj - value, never null

Returns:

Translated string

supportsLateralJoin

public boolean supportsLateralJoin()

Overrides:

supportsLateralJoin in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

bindValue

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

Description copied from class: JDBCExecutionFactory

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.

Overrides:

bindValue in class JDBCExecutionFactory

Throws:

SQLException

supportsIsDistinctCriteria

public boolean supportsIsDistinctCriteria()

Overrides:

supportsIsDistinctCriteria in class org.teiid.translator.ExecutionFactory<DataSource,Connection>

supportsFunctionsInGroupBy

public boolean supportsFunctionsInGroupBy()

Overrides:

supportsFunctionsInGroupBy in class org.teiid.translator.ExecutionFactory<DataSource,Connection>