Package org.apache.openjpa.jdbc.sql

Class PostgresDictionary

java.lang.Object

org.apache.openjpa.jdbc.sql.DBDictionary

org.apache.openjpa.jdbc.sql.PostgresDictionary

All Implemented Interfaces:

JoinSyntaxes, Configurable, IdentifierConfiguration, ConnectionDecorator, LoggingConnectionDecorator.SQLWarningHandler

public class PostgresDictionary
extends DBDictionary

Dictionary for PostgreSQL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PostgresDictionary.PostgresConnection	Connection wrapper to work around the postgres empty result set bug.
protected static class	PostgresDictionary.PostgresPreparedStatement	Statement wrapper to work around the postgres empty result set bug.

Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.sql.DBDictionary

DBDictionary.DateMillisecondBehaviors, DBDictionary.SerializedData

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	_timestampTypes
String	allSequencesFromOneSchemaSQL	SQL statement to load schema,name pairs from a named schema.
String	allSequencesSQL	SQL statement to load all sequence schema,name pairs from all schemas.
String	isOwnedSequenceSQL	Statement used to determine whether a sequence is owned.
String	namedSequenceFromOneSchemaSQL	SQL statement to load a sequence's schema,name pair from one schema.
String	namedSequencesFromAllSchemasSQL	SQL statement to load schema,name pairs for all sequences with a certain name from all schemas.
boolean	supportsSetFetchSize	Some Postgres drivers do not support the Statement.setFetchSize(int) method.

Fields inherited from class org.apache.openjpa.jdbc.sql.DBDictionary

_procs, _proxyManager, allowQueryTimeoutOnFindUpdate, allowsAliasInBulkClause, arrayTypeName, autoAssignClause, autoAssignTypeName, batchLimit, bigintTypeName, binaryTypeName, bitLengthFunction, bitTypeName, blobBufferSize, blobTypeName, booleanRepresentation, booleanTypeName, castFunction, catalogSeparator, CENTI, characterColumnSize, charTypeName, clobBufferSize, clobTypeName, closePoolSQL, concatenateDelimiter, concatenateFunction, conf, connected, CONS_NAME_AFTER, CONS_NAME_BEFORE, CONS_NAME_MID, constraintNameMode, createPrimaryKeys, crossJoinClause, currentDateFunction, currentTimeFunction, currentTimestampFunction, databaseProductName, databaseProductVersion, dateFractionDigits, datePrecision, dateTypeName, DECI, decimalTypeName, defaultSchemaName, delimitedCase, disableAlterSeqenceIncrementBy, disableSchemaFactoryColumnTypeErrors, distinctCountColumnSeparator, distinctTypeName, doubleTypeName, driverVendor, dropTableSQL, extractDateTimeFieldFunction, fixedSizeTypeNames, fixedSizeTypeNameSet, floatTypeName, forUpdateClause, fractionalTypeNameSet, fullResultCollectionInOrderByRelation, getStringVal, inClauseLimit, indexPhysicalForeignKeys, initializationSQL, innerJoinClause, integerTypeName, invalidColumnWordSet, isJDBC3, isJDBC4, javaObjectTypeName, javaToDbColumnNameProcessing, joinSyntax, lastGeneratedKeyQuery, leadingDelimiter, log, longVarbinaryTypeName, longVarcharTypeName, maxAutoAssignNameLength, maxColumnNameLength, maxConstraintNameLength, maxEmbeddedBlobSize, maxEmbeddedClobSize, maxIndexesPerTable, maxIndexNameLength, maxTableNameLength, MICRO, MILLI, NAME_ANY, NAME_SEQUENCE, NAME_TABLE, nameConcatenator, NANO, nativeSequenceType, nextSequenceQuery, NO_BATCH, nullTypeName, numericTypeName, otherTypeName, outerJoinClause, platform, RANGE_POST_DISTINCT, RANGE_POST_LOCK, RANGE_POST_SELECT, RANGE_PRE_DISTINCT, rangePosition, realTypeName, refTypeName, reportsSuccessNoInfoOnBatchUpdates, requiresAliasForSubselect, requiresAutoCommitForMetaData, requiresCastForComparisons, requiresCastForMathFunctions, requiresConditionForCrossJoin, requiresSearchStringEscapeForLike, requiresTargetForDelete, reservedWords, reservedWordSet, roundTimeToMillisec, SCHEMA_CASE_LOWER, SCHEMA_CASE_PRESERVE, SCHEMA_CASE_UPPER, schemaCase, searchStringEscape, SEC, selectWords, selectWordSet, sequenceNameSQL, sequenceSchemaSQL, sequenceSQL, setStringRightTruncationOn, simulateLocking, smallintTypeName, sqlStateCodes, storageLimitationsFatal, storeCharsAsNumbers, storeLargeNumbersAsStrings, stringLengthFunction, structTypeName, substringFunctionName, supportsAlterTableWithAddColumn, supportsAlterTableWithDropColumn, supportsAutoAssign, supportsCascadeDeleteAction, supportsCascadeUpdateAction, supportsCaseConversionForLob, supportsComments, supportsCorrelatedSubselect, supportsDefaultDeleteAction, supportsDefaultUpdateAction, supportsDeferredConstraints, supportsDelimitedIdentifiers, supportsForeignKeys, supportsForeignKeysComposite, supportsGeneralCaseExpression, supportsGetGeneratedKeys, supportsHaving, supportsLockingWithDistinctClause, supportsLockingWithInnerJoin, supportsLockingWithMultipleTables, supportsLockingWithOrderClause, supportsLockingWithOuterJoin, supportsLockingWithSelectRange, supportsModOperator, supportsMultipleNontransactionalResultSets, supportsNullDeleteAction, supportsNullTableForGetColumns, supportsNullTableForGetImportedKeys, supportsNullTableForGetIndexInfo, supportsNullTableForGetPrimaryKeys, supportsNullUniqueColumn, supportsNullUpdateAction, supportsParameterInSelect, supportsQueryTimeout, supportsRestrictDeleteAction, supportsRestrictUpdateAction, supportsSchemaForGetColumns, supportsSchemaForGetTables, supportsSelectEndIndex, supportsSelectForUpdate, supportsSelectFromFinalTable, supportsSelectStartIndex, supportsSimpleCaseExpression, supportsSubselect, supportsUniqueConstraints, supportsUuidType, supportsXMLColumn, systemSchemas, systemSchemaSet, systemTables, systemTableSet, tableForUpdateClause, tableLengthIncludesSchema, tableTypes, timestampTypeName, timestampWithZoneTypeName, timeTypeName, timeWithZoneTypeName, tinyintTypeName, toLowerCaseFunction, toUpperCaseFunction, trailingDelimiter, trimBothFunction, trimLeadingFunction, trimSchemaName, trimStringColumns, trimTrailingFunction, typeModifierSet, UNLIMITED, useGetBestRowIdentifierForPrimaryKeys, useGetBytesForBlobs, useGetObjectForBlobs, useGetStringForClobs, useJDBC4SetBinaryStream, useNativeSequenceCache, useSchemaName, useSetBytesForBlobs, useSetStringForClobs, useWildCardForCount, uuidTypeName, validationSQL, varbinaryTypeName, varcharTypeName, VENDOR_DATADIRECT, VENDOR_OTHER, xmlTypeEncoding, xmlTypeName

Fields inherited from interface org.apache.openjpa.jdbc.sql.JoinSyntaxes

SYNTAX_DATABASE, SYNTAX_SQL92, SYNTAX_TRADITIONAL

Constructor Summary

Constructors

Constructor	Description
PostgresDictionary()

Method Summary

Modifier and Type	Method	Description
protected void	appendSelectRange(SQLBuffer buf, long start, long end, boolean subselect)	If this dictionary can select ranges, use this method to append the range SQL.
void	appendXmlComparison(SQLBuffer buf, String op, FilterValue lhs, FilterValue rhs, boolean lhsxml, boolean rhsxml)	Append XML comparison.
void	connectedConfiguration(Connection conn)	Determine XML column support and backslash handling, etc
Connection	decorate(Connection conn)	Decorate the given connection if needed.
void	deleteStream(JDBCStore store, Select sel)
byte	getByte(ResultSet rs, int column)	Convert the specified column of the SQL ResultSet to the proper java type.
Date	getDate(ResultSet rs, int column)	Convert the specified column of the SQL ResultSet to the proper java type.
protected Connection	getDbcpDelegate(Connection conn)	Get the delegated connection from the given DBCP connection.
int	getInt(ResultSet rs, int column)	Convert the specified column of the SQL ResultSet to the proper java type.
protected org.postgresql.largeobject.LargeObjectManager	getLargeObjectManager(DelegatingConnection conn)	Get the native PostgreSQL Large Object Manager used for LOB handling.
InputStream	getLOBStream(JDBCStore store, ResultSet rs, int column)
LocalDate	getLocalDate(ResultSet rs, int column)	Retrieve the specified column of the SQL ResultSet to the proper LocalDate java type.
LocalDateTime	getLocalDateTime(ResultSet rs, int column)	Retrieve the specified column of the SQL ResultSet to the proper LocalDateTime java type.
LocalTime	getLocalTime(ResultSet rs, int column)	Retrieve the specified column of the SQL ResultSet to the proper LocalTime java type.
long	getLong(ResultSet rs, int column)	Convert the specified column of the SQL ResultSet to the proper java type.
Object	getObject(ResultSet rs, int column, Map map)	Override the getOjbect() method to handle the case where the latest Postgres JDBC driver returns a org.postgresql.util.PGobject instead of a java.sql.Timestamp
OffsetDateTime	getOffsetDateTime(ResultSet rs, int column)	Retrieve the specified column of the SQL ResultSet to the proper OffsetDateTime java type.
OffsetTime	getOffsetTime(ResultSet rs, int column)	Retrieve the specified column of the SQL ResultSet to the proper OffsetTime java type.
protected org.postgresql.PGConnection	getPGConnection(DelegatingConnection conn)	Get the native PostgreSQL connection from the given connection.
String	getPlaceholderValueString(Column col)	Return a SQL string to act as a placeholder for the given column.
protected String	getSequencesSQL(String schemaName, String sequenceName)	Return the SQL needed to select the list of sequences.
protected String	getSequencesSQL(DBIdentifier schemaName, DBIdentifier sequenceName)
short	getShort(ResultSet rs, int column)	Convert the specified column of the SQL ResultSet to the proper java type.
void	indexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)	Invoke this database's indexOf function.
void	insertBlobForStreamingLoad(Row row, Column col, JDBCStore store, Object ob, Select sel)
boolean	isFatalException(int subtype, SQLException ex)	Determine if the given SQL Exception is fatal or recoverable (such as a timeout).
boolean	isOwnedSequence(DBIdentifier name, DBIdentifier schema, Connection conn)	Uses the native Postgres function pg_get_serial_sequence to determine whether a sequence is owned by the database.
boolean	isSystemIndex(String name, Table table)	This method is used to filter system indexes from database metadata.
boolean	isSystemIndex(DBIdentifier name, Table table)	This method is used to filter system indexes from database metadata.
boolean	isSystemSequence(String name, String schema, boolean targetSchema)	This method is used to filter system sequences from database metadata.
boolean	isSystemSequence(DBIdentifier name, DBIdentifier schema, boolean targetSchema)	This method is used to filter system sequences from database metadata.
boolean	isSystemSequence(DBIdentifier name, DBIdentifier schema, boolean targetSchema, Connection conn)	This method is used to filter system sequences from database metadata.
boolean	isSystemTable(String name, String schema, boolean targetSchema)	This method is used to filter system tables from database metadata.
boolean	isSystemTable(DBIdentifier name, DBIdentifier schema, boolean targetSchema)	This method is used to filter system tables from database metadata.
void	setClobString(PreparedStatement stmnt, int idx, String val, Column col)	If column is an XML column, PostgreSQL requires that its value is set by using PreparedStatement.setObject(int, Object, int) with Types.OTHER as the third argument.
void	setLocalDate(PreparedStatement stmnt, int idx, LocalDate val, Column col)	Set the given LocalDate value as a parameter to the statement.
void	setLocalDateTime(PreparedStatement stmnt, int idx, LocalDateTime val, Column col)	Set the given LocalTime value as a parameter to the statement.
void	setLocalTime(PreparedStatement stmnt, int idx, LocalTime val, Column col)	Set the given LocalTime value as a parameter to the statement.
void	setNull(PreparedStatement stmnt, int idx, int colType, Column col)	Handle XML and bytea/oid columns in a PostgreSQL way.
void	setOffsetDateTime(PreparedStatement stmnt, int idx, OffsetDateTime val, Column col)	Set the given LocalTime value as a parameter to the statement.
void	setOffsetTime(PreparedStatement stmnt, int idx, OffsetTime val, Column col)	default column type for OffsetTime is 'time with time zone'.
protected boolean	supportsDeferredUniqueConstraints()	Whether or not this dictionary supports deferred unique constraints.
void	updateBlob(Select sel, JDBCStore store, InputStream is)

Methods inherited from class org.apache.openjpa.jdbc.sql.DBDictionary

addCastAsType, addErrorCode, appendCast, appendLength, appendNumericCast, appendSelect, appendSize, appendUpdates, applyRange, assertSupport, calculateValue, canOuterJoin, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, delimitAll, endConfiguration, executeQuery, fromDBName, getAddColumnSQL, getAddForeignKeySQL, getAddPrimaryKeySQL, getAlterSequenceSQL, getArray, getAsciiStream, getBatchFetchSize, getBatchLimit, getBatchUpdateCount, getBigDecimal, getBigInteger, getBinaryStream, getBlob, getBlobObject, getBoolean, getBooleanRepresentation, getBytes, getCalendar, getCastFunction, getCastFunction, getCatalogNameForMetadata, getCatalogNameForMetadata, getChar, getCharacterStream, getClob, getClobString, getColumnDBName, getColumnIdentifier, getColumnNameForMetadata, getColumnNameForMetadata, getColumns, getColumns, getConversionKey, getCreateIndexSQL, getCreateSequenceSQL, getCreateTableSQL, getCreateTableSQL, getDate, getDateFractionDigits, getDeclareColumnSQL, getDefaultIdentifierRule, getDefaultSchemaName, getDeleteTableContentsSQL, getDeleteTargets, getDelimitedCase, getDelimitIdentifiers, getDouble, getDropColumnSQL, getDropForeignKeySQL, getDropIndexSQL, getDropPrimaryKeySQL, getDropSequenceSQL, getDropTableSQL, getFloat, getForeignKeyConstraintSQL, getForUpdateClause, getFrom, getFromSelect, getFullIdentifier, getFullName, getFullName, getFullName, getGeneratedKey, getGeneratedKeySequenceName, getGenKeySeqName, getIdentifierConcatenator, getIdentifierDelimiter, getIdentifierRule, getIdentifierRules, getIdentityColumnName, getImportedKeys, getImportedKeys, getImportedKeys, getImportedKeys, getIndexInfo, getIndexInfo, getInvalidColumnWordSet, getIsNotNullSQL, getIsNullSQL, getJDBCType, getJDBCType, getJDBCType, getKey, getLeadingDelimiter, getLocale, getLog, getMajorVersion, getMarkerForInsertUpdate, getMillisecondBehavior, getMinorVersion, getNamingUtil, getNumber, getPreferredType, getPrimaryKeyConstraintSQL, getPrimaryKeys, getPrimaryKeys, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaCase, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelectOperation, getSelects, getSelectTableAliases, getSequence, getSequences, getSequences, getStoredProcedure, getString, getSupportsDelimitedIdentifiers, getSupportsXMLColumn, getTableNameForMetadata, getTableNameForMetadata, getTables, getTables, getTime, getTimestamp, getTrailingDelimiter, getTrimSchemaName, getTypeName, getTypeName, getUniqueConstraintSQL, getValidColumnName, getValidColumnName, getValidColumnName, getValidColumnName, getValidForeignKeyName, getValidForeignKeyName, getValidIndexName, getValidIndexName, getValidPrimaryKeyName, getValidSequenceName, getValidSequenceName, getValidTableName, getValidTableName, getValidUniqueName, getValidUniqueName, getVersionColumn, getVersionColumn, getWhere, getXMLTypeEncoding, handleWarning, insertClobForStreamingLoad, insertSize, isImplicitJoin, isSelect, isUsingLimit, isUsingOffset, isUsingOrderBy, isUsingRange, makeNameValid, makeNameValid, makeNameValid, makeNameValid, matchErrorState, mathFunction, needsToCreateIndex, needsToCreateIndex, newColumn, newForeignKey, newIndex, newPrimaryKey, newSequence, newStoreException, newTable, prepareStatement, processDBColumnName, putBytes, putChars, putString, refSchemaComponents, serialize, setArray, setAsciiStream, setBatchLimit, setBigDecimal, setBigInteger, setBinaryStream, setBlob, setBlobObject, setBoolean, setBooleanRepresentation, setByte, setBytes, setCalendar, setChar, setCharacterStream, setClob, setConfiguration, setDate, setDate, setDateMillisecondBehavior, setDefaultSchemaName, setDelimitedCase, setDelimitIdentifiers, setDouble, setFloat, setInt, setJoinSyntax, setLeadingDelimiter, setLocale, setLong, setMajorVersion, setMinorVersion, setNumber, setObject, setQueryTimeout, setRef, setShort, setStatementQueryTimeout, setString, setSupportsDelimitedIdentifiers, setSupportsXMLColumn, setTime, setTimeouts, setTimeouts, setTimestamp, setTrailingDelimiter, setTrimSchemaName, setTyped, setUnknown, setUnknown, setXMLTypeEncoding, shorten, startConfiguration, storageWarning, substring, supportsDeferredForeignKeyConstraints, supportsDeleteAction, supportsIsolationForUpdate, supportsLocking, supportsRandomAccessResultSet, supportsUpdateAction, toBulkOperation, toDBName, toDBName, toDelete, toNativeJoin, toOperation, toOperation, toSelect, toSelect, toSelect, toSelect, toSelect, toSelectCount, toSnakeCase, toSQL92Join, toTraditionalJoin, toUpdate, updateClob, validateBatchProcess, validateDBSpecificBatchProcess, versionEqualOrEarlierThan, versionEqualOrLaterThan, versionLaterThan

Methods inherited from class java.lang.Object

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

Field Detail

_timestampTypes

protected Set<String> _timestampTypes

allSequencesSQL

public String allSequencesSQL

SQL statement to load all sequence schema,name pairs from all schemas.

namedSequencesFromAllSchemasSQL

public String namedSequencesFromAllSchemasSQL

SQL statement to load schema,name pairs for all sequences with a certain name from all schemas.

allSequencesFromOneSchemaSQL

public String allSequencesFromOneSchemaSQL

SQL statement to load schema,name pairs from a named schema.

namedSequenceFromOneSchemaSQL

public String namedSequenceFromOneSchemaSQL

SQL statement to load a sequence's schema,name pair from one schema.

supportsSetFetchSize

public boolean supportsSetFetchSize

Some Postgres drivers do not support the Statement.setFetchSize(int) method.

isOwnedSequenceSQL

public String isOwnedSequenceSQL

Statement used to determine whether a sequence is owned. Owned sequences are managed by the database and are considered system sequences. parm 1: '' parm 2: ''

Constructor Detail

PostgresDictionary

public PostgresDictionary()

Method Detail

getDate

public Date getDate(ResultSet rs,
                    int column)
             throws SQLException

Description copied from class: DBDictionary

Convert the specified column of the SQL ResultSet to the proper java type. Converts the date from a Timestamp by default.

Overrides:

getDate in class DBDictionary

Throws:

SQLException

getByte

public byte getByte(ResultSet rs,
                    int column)
             throws SQLException

Description copied from class: DBDictionary

Convert the specified column of the SQL ResultSet to the proper java type.

Overrides:

getByte in class DBDictionary

Throws:

SQLException

getShort

public short getShort(ResultSet rs,
                      int column)
               throws SQLException

Description copied from class: DBDictionary

Convert the specified column of the SQL ResultSet to the proper java type.

Overrides:

getShort in class DBDictionary

Throws:

SQLException

getInt

public int getInt(ResultSet rs,
                  int column)
           throws SQLException

Description copied from class: DBDictionary

Convert the specified column of the SQL ResultSet to the proper java type.

Overrides:

getInt in class DBDictionary

Throws:

SQLException

getLong

public long getLong(ResultSet rs,
                    int column)
             throws SQLException

Description copied from class: DBDictionary

Convert the specified column of the SQL ResultSet to the proper java type.

Overrides:

getLong in class DBDictionary

Throws:

SQLException

setNull

public void setNull(PreparedStatement stmnt,
                    int idx,
                    int colType,
                    Column col)
             throws SQLException

Handle XML and bytea/oid columns in a PostgreSQL way.

Overrides:

setNull in class DBDictionary

Throws:

SQLException

appendSelectRange

protected void appendSelectRange(SQLBuffer buf,
                                 long start,
                                 long end,
                                 boolean subselect)

Description copied from class: DBDictionary

If this dictionary can select ranges, use this method to append the range SQL.

Overrides:

appendSelectRange in class DBDictionary

indexOf

public void indexOf(SQLBuffer buf,
                    FilterValue str,
                    FilterValue find,
                    FilterValue start)

Description copied from class: DBDictionary

Invoke this database's indexOf function.

Overrides:

indexOf in class DBDictionary

Parameters:

buf - the SQL buffer to write the indexOf invocation to

str - a query value representing the target string

find - a query value representing the search string

start - a query value representing the start index, or null to start at the beginning

supportsDeferredUniqueConstraints

protected boolean supportsDeferredUniqueConstraints()

Description copied from class: DBDictionary

Whether or not this dictionary supports deferred unique constraints. This implementation returns DBDictionary.supportsUniqueConstraints.

Overrides:

supportsDeferredUniqueConstraints in class DBDictionary

getSequencesSQL

protected String getSequencesSQL(String schemaName,
                                 String sequenceName)

Description copied from class: DBDictionary

Return the SQL needed to select the list of sequences.

Overrides:

getSequencesSQL in class DBDictionary

getSequencesSQL

protected String getSequencesSQL(DBIdentifier schemaName,
                                 DBIdentifier sequenceName)

Overrides:

getSequencesSQL in class DBDictionary

isSystemSequence

public boolean isSystemSequence(String name,
                                String schema,
                                boolean targetSchema)

Description copied from class: DBDictionary

This method is used to filter system sequences from database metadata. Return true if the given sequence represents a system sequence that should not appear in the schema definition. Returns true if system schema by default.

Overrides:

isSystemSequence in class DBDictionary

Parameters:

name - the table name

schema - the table schema; may be null

targetSchema - if true, then the given schema was listed by the user as one of his schemas

isSystemSequence

public boolean isSystemSequence(DBIdentifier name,
                                DBIdentifier schema,
                                boolean targetSchema)

Description copied from class: DBDictionary

This method is used to filter system sequences from database metadata. Return true if the given sequence represents a system sequence that should not appear in the schema definition. Returns true if system schema by default.

Overrides:

isSystemSequence in class DBDictionary

Parameters:

name - the table name

schema - the table schema; may be null

targetSchema - if true, then the given schema was listed by the user as one of his schemas

isSystemSequence

public boolean isSystemSequence(DBIdentifier name,
                                DBIdentifier schema,
                                boolean targetSchema,
                                Connection conn)

Description copied from class: DBDictionary

This method is used to filter system sequences from database metadata. Return true if the given sequence represents a system sequence that should not appear in the schema definition. Returns true if system schema by default.

Overrides:

isSystemSequence in class DBDictionary

Parameters:

name - the table name

schema - the table schema; may be null

targetSchema - if true, then the given schema was listed by the user as one of his schemas

conn - connection to the database

isOwnedSequence

public boolean isOwnedSequence(DBIdentifier name,
                               DBIdentifier schema,
                               Connection conn)

Uses the native Postgres function pg_get_serial_sequence to determine whether a sequence is owned by the database. Column types such as bigserial use a system assigned sequence generator of the format: table_column_seq

isSystemTable

public boolean isSystemTable(String name,
                             String schema,
                             boolean targetSchema)

Description copied from class: DBDictionary

This method is used to filter system tables from database metadata. Return true if the given table name represents a system table that should not appear in the schema definition. By default, returns true only if the given table is in the internal list of system tables, or if the given schema is in the list of system schemas and is not the target schema.

Overrides:

isSystemTable in class DBDictionary

Parameters:

name - the table name

schema - the table schema; may be null

targetSchema - if true, then the given schema was listed by the user as one of his schemas

isSystemTable

public boolean isSystemTable(DBIdentifier name,
                             DBIdentifier schema,
                             boolean targetSchema)

Description copied from class: DBDictionary

This method is used to filter system tables from database metadata. Return true if the given table name represents a system table that should not appear in the schema definition. By default, returns true only if the given table is in the internal list of system tables, or if the given schema is in the list of system schemas and is not the target schema.

Overrides:

isSystemTable in class DBDictionary

Parameters:

name - the table name

schema - the table schema; may be null

targetSchema - if true, then the given schema was listed by the user as one of his schemas

isSystemIndex

public boolean isSystemIndex(String name,
                             Table table)

Description copied from class: DBDictionary

This method is used to filter system indexes from database metadata. Return true if the given index name represents a system index that should not appear in the schema definition. Returns false by default.

Overrides:

isSystemIndex in class DBDictionary

Parameters:

name - the index name

table - the index table

isSystemIndex

public boolean isSystemIndex(DBIdentifier name,
                             Table table)

Description copied from class: DBDictionary

This method is used to filter system indexes from database metadata. Return true if the given index name represents a system index that should not appear in the schema definition. Returns false by default.

Overrides:

isSystemIndex in class DBDictionary

Parameters:

name - the index name

table - the index table

decorate

public Connection decorate(Connection conn)
                    throws SQLException

Description copied from class: DBDictionary

Decorate the given connection if needed. Some databases require special handling for JDBC bugs. This implementation issues any DBDictionary.initializationSQL that has been set for the dictionary but does not decorate the connection.

Specified by:

decorate in interface ConnectionDecorator

Overrides:

decorate in class DBDictionary

Throws:

SQLException

getLOBStream

public InputStream getLOBStream(JDBCStore store,
                                ResultSet rs,
                                int column)
                         throws SQLException

Overrides:

getLOBStream in class DBDictionary

Throws:

SQLException

insertBlobForStreamingLoad

public void insertBlobForStreamingLoad(Row row,
                                       Column col,
                                       JDBCStore store,
                                       Object ob,
                                       Select sel)
                                throws SQLException

Overrides:

insertBlobForStreamingLoad in class DBDictionary

Throws:

SQLException

updateBlob

public void updateBlob(Select sel,
                       JDBCStore store,
                       InputStream is)
                throws SQLException

Overrides:

updateBlob in class DBDictionary

Throws:

SQLException

deleteStream

public void deleteStream(JDBCStore store,
                         Select sel)
                  throws SQLException

Overrides:

deleteStream in class DBDictionary

Throws:

SQLException

getLocalDate

public LocalDate getLocalDate(ResultSet rs,
                              int column)
                       throws SQLException

Description copied from class: DBDictionary

Retrieve the specified column of the SQL ResultSet to the proper LocalDate java type.

Overrides:

getLocalDate in class DBDictionary

Throws:

SQLException

getLocalTime

public LocalTime getLocalTime(ResultSet rs,
                              int column)
                       throws SQLException

Description copied from class: DBDictionary

Retrieve the specified column of the SQL ResultSet to the proper LocalTime java type.

Overrides:

getLocalTime in class DBDictionary

Throws:

SQLException

getLocalDateTime

public LocalDateTime getLocalDateTime(ResultSet rs,
                                      int column)
                               throws SQLException

Description copied from class: DBDictionary

Retrieve the specified column of the SQL ResultSet to the proper LocalDateTime java type.

Overrides:

getLocalDateTime in class DBDictionary

Throws:

SQLException

getOffsetDateTime

public OffsetDateTime getOffsetDateTime(ResultSet rs,
                                        int column)
                                 throws SQLException

Description copied from class: DBDictionary

Retrieve the specified column of the SQL ResultSet to the proper OffsetDateTime java type.

Overrides:

getOffsetDateTime in class DBDictionary

Throws:

SQLException

setOffsetTime

public void setOffsetTime(PreparedStatement stmnt,
                          int idx,
                          OffsetTime val,
                          Column col)
                   throws SQLException

default column type for OffsetTime is 'time with time zone'. But opposed to the name PostgreSQL internally stores those values in UTC time without any timezone.

Overrides:

setOffsetTime in class DBDictionary

Throws:

SQLException

getOffsetTime

public OffsetTime getOffsetTime(ResultSet rs,
                                int column)
                         throws SQLException

Description copied from class: DBDictionary

Retrieve the specified column of the SQL ResultSet to the proper OffsetTime java type.

Overrides:

getOffsetTime in class DBDictionary

Throws:

SQLException

setLocalDate

public void setLocalDate(PreparedStatement stmnt,
                         int idx,
                         LocalDate val,
                         Column col)
                  throws SQLException

Description copied from class: DBDictionary

Set the given LocalDate value as a parameter to the statement.

Overrides:

setLocalDate in class DBDictionary

Throws:

SQLException

setLocalTime

public void setLocalTime(PreparedStatement stmnt,
                         int idx,
                         LocalTime val,
                         Column col)
                  throws SQLException

Description copied from class: DBDictionary

Set the given LocalTime value as a parameter to the statement.

Overrides:

setLocalTime in class DBDictionary

Throws:

SQLException

setLocalDateTime

public void setLocalDateTime(PreparedStatement stmnt,
                             int idx,
                             LocalDateTime val,
                             Column col)
                      throws SQLException

Description copied from class: DBDictionary

Set the given LocalTime value as a parameter to the statement.

Overrides:

setLocalDateTime in class DBDictionary

Throws:

SQLException

setOffsetDateTime

public void setOffsetDateTime(PreparedStatement stmnt,
                              int idx,
                              OffsetDateTime val,
                              Column col)
                       throws SQLException

Description copied from class: DBDictionary

Set the given LocalTime value as a parameter to the statement.

Overrides:

setOffsetDateTime in class DBDictionary

Throws:

SQLException

connectedConfiguration

public void connectedConfiguration(Connection conn)
                            throws SQLException

Determine XML column support and backslash handling, etc

Overrides:

connectedConfiguration in class DBDictionary

Throws:

SQLException

isFatalException

public boolean isFatalException(int subtype,
                                SQLException ex)

Description copied from class: DBDictionary

Determine if the given SQL Exception is fatal or recoverable (such as a timeout). This implementation always returns true (i.e. all exceptions are fatal). The current dictionary implementation can overwrite this method to mark certain exception conditions as recoverable error.

Overrides:

isFatalException in class DBDictionary

Parameters:

subtype - A constant indicating the category of error as defined in StoreException.

ex - original SQL Exception as raised by the database driver.

Returns:

false if the error is fatal.

setClobString

public void setClobString(PreparedStatement stmnt,
                          int idx,
                          String val,
                          Column col)
                   throws SQLException

If column is an XML column, PostgreSQL requires that its value is set by using PreparedStatement.setObject(int, Object, int) with Types.OTHER as the third argument.

Overrides:

setClobString in class DBDictionary

Throws:

SQLException

getObject

public Object getObject(ResultSet rs,
                        int column,
                        Map map)
                 throws SQLException

Override the getOjbect() method to handle the case where the latest Postgres JDBC driver returns a org.postgresql.util.PGobject instead of a java.sql.Timestamp

Overrides:

getObject in class DBDictionary

Parameters:

rs -

column -

map -

Throws:

SQLException

appendXmlComparison

public void appendXmlComparison(SQLBuffer buf,
                                String op,
                                FilterValue lhs,
                                FilterValue rhs,
                                boolean lhsxml,
                                boolean rhsxml)

Append XML comparison.

Overrides:

appendXmlComparison in class DBDictionary

Parameters:

buf - the SQL buffer to write the comparison

op - the comparison operation to perform

lhs - the left hand side of the comparison

rhs - the right hand side of the comparison

lhsxml - indicates whether the left operand maps to XML

rhsxml - indicates whether the right operand maps to XML

getPlaceholderValueString

public String getPlaceholderValueString(Column col)

Return a SQL string to act as a placeholder for the given column.

Overrides:

getPlaceholderValueString in class DBDictionary

getLargeObjectManager

protected org.postgresql.largeobject.LargeObjectManager getLargeObjectManager(DelegatingConnection conn)
                                                                       throws SQLException

Get the native PostgreSQL Large Object Manager used for LOB handling.

Throws:

SQLException

getPGConnection

protected org.postgresql.PGConnection getPGConnection(DelegatingConnection conn)

Get the native PostgreSQL connection from the given connection. Various attempts of unwrapping are being performed.

getDbcpDelegate

protected Connection getDbcpDelegate(Connection conn)

Get the delegated connection from the given DBCP connection.

Parameters:

conn - must be a DBCP connection

Returns:

connection the DBCP connection delegates to