org.datanucleus.store.rdbms.adapter

Class PostgreSQLAdapter

java.lang.Object

org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

org.datanucleus.store.rdbms.adapter.PostgreSQLAdapter

All Implemented Interfaces:

DatastoreAdapter

public class PostgreSQLAdapter
extends BaseDatastoreAdapter

Provides methods for adapting SQL language elements to the PostgreSQL database.

Nested Class Summary

Nested classes/interfaces inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

BaseDatastoreAdapter.DatastoreTypeMappings

Field Summary

Fields

Modifier and Type	Field and Description
static String	POSTGRESQL_RESERVED_WORDS List of Postgresql keywords that aren't in SQL92, SQL99
protected Map<String,String>	psqlTypes

Fields inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, MAX_IDENTIFIER_LENGTH, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, NONRESERVED_WORDS, properties, reservedKeywords, SQL2003_RESERVED_WORDS, SQL92_RESERVED_WORDS, SQL99_RESERVED_WORDS, supportedJdbcTypesById, supportedOptions, unsupportedJdbcTypesById

Fields inherited from interface org.datanucleus.store.rdbms.adapter.DatastoreAdapter

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANALYSIS_METHODS, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, AUTO_INCREMENT_COLUMN_TYPE_SPECIFICATION, AUTO_INCREMENT_KEYS_NULL_SPECIFICATION, AUTO_INCREMENT_PK_IN_CREATE_TABLE_COLUMN_DEF, BIT_IS_REALLY_BOOLEAN, BLOB_SET_USING_SETSTRING, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, CHAR_COLUMNS_PADDED_WITH_SPACES, CHECK_IN_CREATE_STATEMENTS, CHECK_IN_END_CREATE_STATEMENTS, CLOB_SET_USING_SETSTRING, CREATE_INDEXES_BEFORE_FOREIGN_KEYS, CROSSJOIN_ASINNER11_SYNTAX, DATETIME_STORES_MILLISECS, DEFAULT_BEFORE_NULL_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_WITH_NOT_NULL_IN_COLUMN_OPTIONS, DEFERRED_CONSTRAINTS, DISTINCT_WITH_SELECT_FOR_UPDATE, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, EXISTS_SYNTAX, FK_DELETE_ACTION_CASCADE, FK_DELETE_ACTION_DEFAULT, FK_DELETE_ACTION_NULL, FK_DELETE_ACTION_RESTRICT, FK_IN_END_CREATE_STATEMENTS, FK_UPDATE_ACTION_CASCADE, FK_UPDATE_ACTION_DEFAULT, FK_UPDATE_ACTION_NULL, FK_UPDATE_ACTION_RESTRICT, GET_GENERATED_KEYS_STATEMENT, GROUP_BY_REQUIRES_ALL_SELECT_PRIMARIES, GROUPING_WITH_SELECT_FOR_UPDATE, HAVING_WITH_SELECT_FOR_UPDATE, HOLD_CURSORS_OVER_COMMIT, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMNS, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_OPTION_PLACED_AFTER_FROM, LOCK_OPTION_PLACED_WITHIN_JOIN, LOCK_WITH_SELECT_FOR_UPDATE, MULTITABLES_WITH_SELECT_FOR_UPDATE, NATIVE_ENUM_TYPE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, OPERATOR_BITWISE_AND, OPERATOR_BITWISE_OR, OPERATOR_BITWISE_XOR, ORDERBY_NULLS_DIRECTIVES, ORDERBY_NULLS_USING_CASE_NULL, ORDERBY_NULLS_USING_COLUMN_IS_NULL, ORDERBY_NULLS_USING_ISNULL, ORDERBY_USING_SELECT_COLUMN_INDEX, ORDERING_WITH_SELECT_FOR_UPDATE, PARAMETER_IN_CASE_IN_UPDATE_CLAUSE, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, PROJECTION_IN_TABLE_REFERENCE_JOINS, RESULTSET_TYPE_FORWARD_ONLY, RESULTSET_TYPE_SCROLL_INSENSITIVE, RESULTSET_TYPE_SCROLL_SENSITIVE, RIGHT_OUTER_JOIN, SCHEMAS_IN_TABLE_DEFINITIONS, SELECT_FOR_UPDATE_NOWAIT, SEQUENCES, SOME_ANY_ALL_SUBQUERY_EXPRESSIONS, STATEMENT_BATCHING, STORED_PROCEDURES, SUBQUERY_IN_HAVING, TX_ISOLATION_NONE, TX_ISOLATION_READ_COMMITTED, TX_ISOLATION_READ_UNCOMMITTED, TX_ISOLATION_REPEATABLE_READ, TX_ISOLATION_SERIALIZABLE, UNION_SYNTAX, UNIQUE_IN_END_CREATE_STATEMENTS, UPDATE_DELETE_STATEMENT_ALLOW_TABLE_ALIAS_IN_WHERE_CLAUSE, UPDATE_STATEMENT_ALLOW_TABLE_ALIAS_IN_SET_CLAUSE, USE_UNION_ALL, VALUE_GENERATION_UUID_STRING, VIEWS

Constructor Summary

Constructors

Constructor and Description
PostgreSQLAdapter(DatabaseMetaData metadata) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAddColumnStatement(Table table, Column col) Accessor for the SQL statement to add a column to a table.
String	getAddPrimaryKeyStatement(PrimaryKey pk, IdentifierFactory factory) PostgreSQL allows specification of PRIMARY KEY in the CREATE TABLE, so we need nothing here.
String	getAutoIncrementKeyword() Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).
String	getAutoIncrementStmt(Table table, String columnName) Accessor for the autoincrement sql access statement for this datastore.
String	getCreateIndexStatement(Index idx, IdentifierFactory factory) Returns the appropriate DDL to create an index.
String	getDropDatabaseStatement(String catalogName, String schemaName) Method to return the statement necessary to drop a database with this RDBMS.
String	getDropTableStatement(Table table) Accessor for the statement for dropping a table.
String	getEscapePatternExpression() The character for escaping patterns.
String	getInsertStatementForNoColumns(Table table) Method to return the INSERT statement to use when inserting into a table and we dont want to specify columns.
String	getRangeByLimitEndOfStatementClause(long offset, long count, boolean hasOrdering) Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMUT keyword.
String	getSequenceCreateStmt(String sequenceName, Integer min, Integer max, Integer start, Integer increment, Integer cacheSize) Accessor for the sequence statement to create the sequence.
String	getSequenceNextStmt(String sequenceName) Accessor for the statement for getting the next id from the sequence for this datastore.
Class	getSQLMethodClass(String className, String methodName, org.datanucleus.ClassLoaderResolver clr) Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).
String	getVendorID() Accessor for the vendor id.
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.store.connection.ManagedConnection mconn) Initialise the types for this datastore.
boolean	isStatementCancel(SQLException sqle) return whether this exception represents a cancelled statement.
protected void	loadDatastoreMappings(org.datanucleus.plugin.PluginManager mgr, org.datanucleus.ClassLoaderResolver clr) Load all datastore mappings for this RDBMS database.
ForeignKeyInfo	newFKInfo(ResultSet rs) Method to return ForeignKeyInfo for the current row of the ResultSet which will have been obtained from a call to DatabaseMetaData.getImportedKeys() or DatabaseMetaData.getExportedKeys().
RDBMSColumnInfo	newRDBMSColumnInfo(ResultSet rs) Method to create a column info for the current row.
SQLTypeInfo	newSQLTypeInfo(ResultSet rs) Create a new SQL type info from the current row of the passed ResultSet.
boolean	sequenceExists(Connection conn, String catalogName, String schemaName, String seqName) Convenience method to return whether the specified sequence already exists.
boolean	supportsQueryFetchSize(int size) Whether the datastore will support setting the query fetch size to the supplied value.

Methods inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

addSQLTypeForJDBCType, deregisterDatastoreMappingsForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddForeignKeyStatement, getAutoIncrementJavaTypeForType, getCatalogName, getCatalogSeparator, getCheckConstraintForValues, getColumns, getContinuationString, getCreateDatabaseStatement, getCreateTableStatement, getDatastoreDateStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreIdentifierMaxLength, getDatastoreMappingClass, getDatastoreProductName, getDatastoreProductVersion, getDefaultSqlTypeForJavaType, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getEscapeCharacter, getExistingIndexes, getIdentifierQuoteString, getJDBCTypeForName, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNameForJDBCType, getNewUUIDFunction, getNumericConversionFunction, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getSchemaName, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSQLOperationClass, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getUpdateTableStatement, getValueForProperty, initialise, initialiseDatastore, isIdentityFieldDataType, isReservedKeyword, isStatementTimeout, isValidPrimaryKeyType, iteratorReservedWords, registerDatastoreMapping, registerDatastoreMapping, setProperties, supportsOption, supportsTransactionIsolation, toString, validToIndexMapping, validToSelectMappingInStatement

Methods inherited from class java.lang.Object

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

Field Detail

POSTGRESQL_RESERVED_WORDS

public static final String POSTGRESQL_RESERVED_WORDS

List of Postgresql keywords that aren't in SQL92, SQL99

See Also:

Constant Field Values

psqlTypes

protected Map<String,String> psqlTypes

Constructor Detail

PostgreSQLAdapter

public PostgreSQLAdapter(DatabaseMetaData metadata)

Constructor.

Parameters:

metadata - MetaData for the DB

Method Detail

initialiseTypes

public void initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler,
                            org.datanucleus.store.connection.ManagedConnection mconn)

Initialise the types for this datastore.

Specified by:

initialiseTypes in interface DatastoreAdapter

Overrides:

initialiseTypes in class BaseDatastoreAdapter

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - Managed connection to use

getVendorID

public String getVendorID()

Accessor for the vendor id.

Specified by:

getVendorID in interface DatastoreAdapter

Overrides:

getVendorID in class BaseDatastoreAdapter

Returns:

The vendor id.

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(ResultSet rs)

Description copied from interface: DatastoreAdapter

Create a new SQL type info from the current row of the passed ResultSet. Allows an adapter to override particular types where the JDBC driver is known to be buggy.

Specified by:

newSQLTypeInfo in interface DatastoreAdapter

Overrides:

newSQLTypeInfo in class BaseDatastoreAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

newRDBMSColumnInfo

public RDBMSColumnInfo newRDBMSColumnInfo(ResultSet rs)

Method to create a column info for the current row. Overrides the dataType/columnSize/decimalDigits to cater for Postgresql particularities.

Specified by:

newRDBMSColumnInfo in interface DatastoreAdapter

Overrides:

newRDBMSColumnInfo in class BaseDatastoreAdapter

Parameters:

rs - ResultSet from DatabaseMetaData.getColumns()

Returns:

column info

newFKInfo

public ForeignKeyInfo newFKInfo(ResultSet rs)

Method to return ForeignKeyInfo for the current row of the ResultSet which will have been obtained from a call to DatabaseMetaData.getImportedKeys() or DatabaseMetaData.getExportedKeys().

Specified by:

newFKInfo in interface DatastoreAdapter

Overrides:

newFKInfo in class BaseDatastoreAdapter

Parameters:

rs - The result set returned from DatabaseMetaData.get??portedKeys()

Returns:

The foreign key info

getDropDatabaseStatement

public String getDropDatabaseStatement(String catalogName,
                                       String schemaName)

Description copied from interface: DatastoreAdapter

Method to return the statement necessary to drop a database with this RDBMS. Note that some RDBMS don't support this.

Specified by:

getDropDatabaseStatement in interface DatastoreAdapter

Overrides:

getDropDatabaseStatement in class BaseDatastoreAdapter

Parameters:

catalogName - Name of the catalog

schemaName - Name of the schema

Returns:

The DDL statement

getAddColumnStatement

public String getAddColumnStatement(Table table,
                                    Column col)

Accessor for the SQL statement to add a column to a table.

Specified by:

getAddColumnStatement in interface DatastoreAdapter

Overrides:

getAddColumnStatement in class BaseDatastoreAdapter

Parameters:

table - The table

col - The column

Returns:

The SQL necessary to add the column

getInsertStatementForNoColumns

public String getInsertStatementForNoColumns(Table table)

Method to return the INSERT statement to use when inserting into a table and we dont want to specify columns. This is the case when we have a single column in the table and that column is autoincrement/identity (and so is assigned automatically in the datastore). Postgresql expects something like

 INSERT INTO tbl VALUES(DEFAULT)
 

Specified by:

getInsertStatementForNoColumns in interface DatastoreAdapter

Overrides:

getInsertStatementForNoColumns in class BaseDatastoreAdapter

Parameters:

table - The table

Returns:

The statement for the INSERT

getAddPrimaryKeyStatement

public String getAddPrimaryKeyStatement(PrimaryKey pk,
                                        IdentifierFactory factory)

PostgreSQL allows specification of PRIMARY KEY in the CREATE TABLE, so we need nothing here.

Specified by:

getAddPrimaryKeyStatement in interface DatastoreAdapter

Overrides:

getAddPrimaryKeyStatement in class BaseDatastoreAdapter

Parameters:

pk - An object describing the primary key.

factory - Identifier factory

Returns:

The PK statement

getDropTableStatement

public String getDropTableStatement(Table table)

Accessor for the statement for dropping a table. PostgreSQL has supported the DROP TABLE tbl-name CASCADE since 7.3.

Specified by:

getDropTableStatement in interface DatastoreAdapter

Overrides:

getDropTableStatement in class BaseDatastoreAdapter

Parameters:

table - The table to drop.

Returns:

The statement for dropping a table.

getCreateIndexStatement

public String getCreateIndexStatement(Index idx,
                                      IdentifierFactory factory)

Returns the appropriate DDL to create an index. Overrides the superclass variant since Postgresql doesn't support having index names specified in a particular schema (i.e "{schema}.{indexName}").

Specified by:

getCreateIndexStatement in interface DatastoreAdapter

Overrides:

getCreateIndexStatement in class BaseDatastoreAdapter

Parameters:

idx - An object describing the index.

factory - Identifier factory

Returns:

The text of the SQL statement.

getAutoIncrementStmt

public String getAutoIncrementStmt(Table table,
                                   String columnName)

Accessor for the autoincrement sql access statement for this datastore.

Specified by:

getAutoIncrementStmt in interface DatastoreAdapter

Overrides:

getAutoIncrementStmt in class BaseDatastoreAdapter

Parameters:

table - Table that the autoincrement is for

columnName - Name of the column that the autoincrement is for

Returns:

The statement for getting the latest auto-increment key

getAutoIncrementKeyword

public String getAutoIncrementKeyword()

Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).

Specified by:

getAutoIncrementKeyword in interface DatastoreAdapter

Overrides:

getAutoIncrementKeyword in class BaseDatastoreAdapter

Returns:

The keyword for a column using auto-increment

sequenceExists

public boolean sequenceExists(Connection conn,
                              String catalogName,
                              String schemaName,
                              String seqName)

Description copied from interface: DatastoreAdapter

Convenience method to return whether the specified sequence already exists.

Specified by:

sequenceExists in interface DatastoreAdapter

Overrides:

sequenceExists in class BaseDatastoreAdapter

Parameters:

conn - Connection to use for checking

catalogName - Catalog name

schemaName - Schema name

seqName - Name of the sequence

Returns:

Whether it exists

getSequenceCreateStmt

public String getSequenceCreateStmt(String sequenceName,
                                    Integer min,
                                    Integer max,
                                    Integer start,
                                    Integer increment,
                                    Integer cacheSize)

Accessor for the sequence statement to create the sequence.

Specified by:

getSequenceCreateStmt in interface DatastoreAdapter

Overrides:

getSequenceCreateStmt in class BaseDatastoreAdapter

Parameters:

sequenceName - Name of the sequence

min - Minimum value for the sequence

max - Maximum value for the sequence

start - Start value for the sequence

increment - Increment value for the sequence

cacheSize - Cache size for the sequence

Returns:

The statement for getting the next id from the sequence

getSequenceNextStmt

public String getSequenceNextStmt(String sequenceName)

Accessor for the statement for getting the next id from the sequence for this datastore.

Specified by:

getSequenceNextStmt in interface DatastoreAdapter

Overrides:

getSequenceNextStmt in class BaseDatastoreAdapter

Parameters:

sequenceName - Name of the sequence

Returns:

The statement for getting the next id for the sequence

supportsQueryFetchSize

public boolean supportsQueryFetchSize(int size)

Whether the datastore will support setting the query fetch size to the supplied value.

Specified by:

supportsQueryFetchSize in interface DatastoreAdapter

Overrides:

supportsQueryFetchSize in class BaseDatastoreAdapter

Parameters:

size - The value to set to

Returns:

Whether it is supported.

getRangeByLimitEndOfStatementClause

public String getRangeByLimitEndOfStatementClause(long offset,
                                                  long count,
                                                  boolean hasOrdering)

Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMUT keyword.

Specified by:

getRangeByLimitEndOfStatementClause in interface DatastoreAdapter

Overrides:

getRangeByLimitEndOfStatementClause in class BaseDatastoreAdapter

Parameters:

offset - The offset to return from

count - The number of items to return

hasOrdering - Whether ordering is present

Returns:

The SQL to append to allow for ranges using LIMIT.

getEscapePatternExpression

public String getEscapePatternExpression()

The character for escaping patterns.

Specified by:

getEscapePatternExpression in interface DatastoreAdapter

Overrides:

getEscapePatternExpression in class BaseDatastoreAdapter

Returns:

Escape character(s)

isStatementCancel

public boolean isStatementCancel(SQLException sqle)

return whether this exception represents a cancelled statement.

Specified by:

isStatementCancel in interface DatastoreAdapter

Overrides:

isStatementCancel in class BaseDatastoreAdapter

Parameters:

sqle - the exception

Returns:

whether it is a cancel

getSQLMethodClass

public Class getSQLMethodClass(String className,
                               String methodName,
                               org.datanucleus.ClassLoaderResolver clr)

Description copied from interface: DatastoreAdapter

Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).

Specified by:

getSQLMethodClass in interface DatastoreAdapter

Overrides:

getSQLMethodClass in class BaseDatastoreAdapter

Parameters:

className - Name of the class (or null if this is a STATIC method)

methodName - Method name

clr - ClassLoader resolver, in case className is a subclass of a supported type

Returns:

The SQLMethod class (or null if not defined for this datastore).

loadDatastoreMappings

protected void loadDatastoreMappings(org.datanucleus.plugin.PluginManager mgr,
                                     org.datanucleus.ClassLoaderResolver clr)

Load all datastore mappings for this RDBMS database.

Overrides:

loadDatastoreMappings in class BaseDatastoreAdapter

Parameters:

mgr - the PluginManager

clr - the ClassLoaderResolver