PostgreSqlEngine (pdb 2.8.2 API)

java.lang.Object
- com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine
- - com.feedzai.commons.sql.abstraction.engine.impl.PostgreSqlEngine

All Implemented Interfaces:

DatabaseEngine, AutoCloseable

Direct Known Subclasses:

CockroachDBEngine
```
public class PostgreSqlEngine
extends AbstractDatabaseEngine
```
PostgreSQL specific database implementation.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONSTRAINT_NAME_ALREADY_EXISTS` Constraint name already exists.
`static String`	`NAME_ALREADY_EXISTS` Name is already used by an existing object.
`static QueryExceptionHandler`	`PG_QUERY_EXCEPTION_HANDLER` An instance of `QueryExceptionHandler` specific for PostgreSQL engine, to be used in disambiguating SQL exceptions.
`protected static String`	`POSTGRESQL_DRIVER` The PostgreSQL JDBC driver.
`static String`	`TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY` Table can have only one primary key.
`static String`	`TABLE_OR_VIEW_DOES_NOT_EXIST` Table or view does not exist.

Fields inherited from class com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine
conn, currentSchema, DEFAULT_QUERY_EXCEPTION_HANDLER, dev, dialect, eh, entities, injector, logger, notificationLogger, properties, socketTimeoutExecutor, stmts, translator

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PostgreSqlEngine(PdbProperties properties)` Creates a new PostgreSql connection.
`protected`	`PostgreSqlEngine(PdbProperties properties, String driver)` Creates a new PostgreSql connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addColumn(DbEntity entity, DbColumn... columns)` Adds the column to an existent table.
`protected void`	`addFks(DbEntity entity)` Adds the FKs.
`protected void`	`addIndexes(DbEntity entity)` Add the desired indexes.
`protected void`	`addPrimaryKey(DbEntity entity)` Add a primary key to the entity.
`protected void`	`addSequences(DbEntity entity)` Adds the necessary sequences.
`protected boolean`	`checkConnection(Connection conn)` Checks if the connection is alive.
`protected MappedEntity`	`createPreparedStatementForInserts(DbEntity entity)` Creates and gets the prepared statement that will be used for insertions.
`protected ResultIterator`	`createResultIterator(PreparedStatement ps)` Creates a specific `ResultIterator` for the engine in place given a prepared statement.
`protected ResultIterator`	`createResultIterator(Statement statement, String sql)` Creates a specific `ResultIterator` given the engine implementation.
`protected void`	`createTable(DbEntity entity)` Creates the table.
`protected long`	`doPersist(PreparedStatement ps, MappedEntity me, boolean useAutoInc, int lastBindPosition)` DB engine specific auxiliary method for `AbstractDatabaseEngine.persist(String, EntityEntry, boolean)` to effectively perform the persist action.
`protected void`	`dropColumn(DbEntity entity, String... columns)` Drops the column.
`protected void`	`dropSequences(DbEntity entity)` Drops the sequences of the entity.
`protected void`	`dropTable(DbEntity entity)` Drops the table.
`protected int`	`entityToPreparedStatement(DbEntity entity, PreparedStatement ps, EntityEntry entry, boolean useAutoInc)` Translates the given entry entity to the prepared statement.
`protected Properties`	`getDBProperties()` Get the properties to be passed to the database connection that will be created.
`protected QueryExceptionHandler`	`getQueryExceptionHandler()` Gets the instance of `QueryExceptionHandler` to be used in disambiguating SQL exceptions.
`Class<? extends AbstractTranslator>`	`getTranslatorClass()` Gets the class that translates SQL bound to this engine.
`boolean`	`isStringAggDistinctCapable()` Checks if the engine supports using DISTINCT inside a string aggregation.
`void`	`setParameter(String name, int index, Object param, DbColumnType paramType)` Sets the parameter on the specified index given its type.
`protected void`	`setSchema(String schema)` Sets the schema for the current `connection`.
`protected DbColumnType`	`toPdbType(int type, String typeName)` Maps the database type to `DbColumnType`.
`protected void`	`updatePersistAutoIncSequence(MappedEntity mappedEntity, long currentAutoIncVal)` Updates the autoInc sequence value after a persist operation.

Methods inherited from class com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine
addBatch, addEntity, beginTransaction, checkConnection, checkConnection, clearParameters, close, commentCharacter, commit, connect, containsEntity, createBatch, createBatch, createBatch, createBatch, createPreparedStatement, createPreparedStatement, createPreparedStatement, createPreparedStatement, createSelectStatement, dropEntity, dropEntity, dropFks, dropView, duplicate, entityToPreparedStatementForBatch, escapeCharacter, executePS, executePSUpdate, executeUpdate, executeUpdate, executeUpdateSilently, flush, getConnection, getDialect, getEntities, getEntities, getFinalJdbcConnection, getMetadata, getMetadata, getPreparedStatementForPersist, getPrivateKey, getProperties, getPSIterator, getPSIterator, getPSResultSet, getQueryMetadata, getQueryMetadata, getSchema, handleOperation, hasIdentityColumn, inject, isTransactionActive, iterator, iterator, iterator, iterator, iterator, iterator, loadEntity, objectToArray, persist, persist, preparedStatementExists, processResultIterator, query, query, query, query, reconnectExceptionally, removeEntity, removePreparedStatement, rollback, setExceptionHandler, setParameter, setParameters, setParameterValues, setTransactionIsolation, translate, translateType, updateEntity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - POSTGRESQL_DRIVER
```
protected static final String POSTGRESQL_DRIVER
```
    The PostgreSQL JDBC driver.
  - NAME_ALREADY_EXISTS
```
public static final String NAME_ALREADY_EXISTS
```
    Name is already used by an existing object.
    
    See Also:
    
    Constant Field Values
  - TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY
```
public static final String TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY
```
    Table can have only one primary key.
    
    See Also:
    
    Constant Field Values
  - TABLE_OR_VIEW_DOES_NOT_EXIST
```
public static final String TABLE_OR_VIEW_DOES_NOT_EXIST
```
    Table or view does not exist.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_NAME_ALREADY_EXISTS
```
public static final String CONSTRAINT_NAME_ALREADY_EXISTS
```
    Constraint name already exists.
    
    See Also:
    
    Constant Field Values
  - PG_QUERY_EXCEPTION_HANDLER
```
public static final QueryExceptionHandler PG_QUERY_EXCEPTION_HANDLER
```
    An instance of QueryExceptionHandler specific for PostgreSQL engine, to be used in disambiguating SQL exceptions.
    
    Since:
    
    2.5.1
- Constructor Detail
  - PostgreSqlEngine
```
public PostgreSqlEngine(PdbProperties properties)
                 throws DatabaseEngineException
```
    Creates a new PostgreSql connection.
    
    Parameters:
    
    properties - The properties for the database connection.
    
    Throws:
    
    DatabaseEngineException - When the connection fails.
  - PostgreSqlEngine
```
protected PostgreSqlEngine(PdbProperties properties,
                           String driver)
                    throws DatabaseEngineException
```
    Creates a new PostgreSql connection. Note: this constructor exists so that most of the code in this implementation can be reused by (almost) compatible engines, like CockroachDB.
    
    Parameters:
    
    properties - The properties for the database connection.
    
    driver - The driver to connect to the database.
    
    Throws:
    
    DatabaseEngineException - When the connection fails.
    
    Since:
    
    2.5.0
- Method Detail
  - entityToPreparedStatement
```
protected int entityToPreparedStatement(DbEntity entity,
                                        PreparedStatement ps,
                                        EntityEntry entry,
                                        boolean useAutoInc)
                                 throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Translates the given entry entity to the prepared statement.
    
    Specified by:
    
    entityToPreparedStatement in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    ps - The prepared statement.
    
    entry - The entry.
    
    Returns:
    
    The position (1-based) of the last bind parameter that was filled in a prepared statement.
    
    Throws:
    
    DatabaseEngineException - if something occurs during the translation.
  - setParameter
```
public void setParameter(String name,
                         int index,
                         Object param,
                         DbColumnType paramType)
                  throws DatabaseEngineException,
                         ConnectionResetException
```
    Description copied from interface: DatabaseEngine
    
    Sets the parameter on the specified index given its type. This is for situations where the java type of the parameter alone is not enough to determine the corresponding database type; for example, Strings can be used to represent both actual Strings and Json values, so if we have an update statement that updates a json column we need to specify that the bind parameter is of type json.
    
    Specified by:
    
    setParameter in interface DatabaseEngine
    
    Overrides:
    
    setParameter in class AbstractDatabaseEngine
    
    Parameters:
    
    name - The prepared statement name.
    
    index - The index to set.
    
    param - The parameter to set.
    
    paramType - The type of the parameter being set.
    
    Throws:
    
    DatabaseEngineException - If something occurs setting the parameters.
    
    ConnectionResetException - If the connection was reset while trying to set the parameter.
  - isStringAggDistinctCapable
```
public boolean isStringAggDistinctCapable()
```
    Description copied from interface: DatabaseEngine
    
    Checks if the engine supports using DISTINCT inside a string aggregation.
    
    Returns:
    
    true if the engine supports using DISTINCT inside a string aggregation, false otherwise.
  - createTable
```
protected void createTable(DbEntity entity)
                    throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Creates the table.
    
    Specified by:
    
    createTable in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong while creating the table.
  - addPrimaryKey
```
protected void addPrimaryKey(DbEntity entity)
                      throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Add a primary key to the entity.
    
    Specified by:
    
    addPrimaryKey in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong while creating the table.
  - addIndexes
```
protected void addIndexes(DbEntity entity)
                   throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Add the desired indexes.
    
    Specified by:
    
    addIndexes in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong while creating the table.
  - addSequences
```
protected void addSequences(DbEntity entity)
                     throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Adds the necessary sequences.
    
    Specified by:
    
    addSequences in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong while creating the table.
  - createPreparedStatementForInserts
```
protected MappedEntity createPreparedStatementForInserts(DbEntity entity)
                                                  throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Creates and gets the prepared statement that will be used for insertions.
    
    Specified by:
    
    createPreparedStatementForInserts in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong while creating the table.
  - dropSequences
```
protected void dropSequences(DbEntity entity)
                      throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Drops the sequences of the entity.
    
    Specified by:
    
    dropSequences in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong dropping the sequences.
  - dropTable
```
protected void dropTable(DbEntity entity)
                  throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Drops the table.
    
    Specified by:
    
    dropTable in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong dropping the sequences.
  - dropColumn
```
protected void dropColumn(DbEntity entity,
                          String... columns)
                   throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Drops the column.
    
    Specified by:
    
    dropColumn in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    columns - The column name to drop.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong dropping the sequences.
  - addColumn
```
protected void addColumn(DbEntity entity,
                         DbColumn... columns)
                  throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Adds the column to an existent table.
    
    Specified by:
    
    addColumn in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity that represents the table.
    
    columns - The db column to add.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong adding columns.
  - getTranslatorClass
```
public Class<? extends AbstractTranslator> getTranslatorClass()
```
    Description copied from class: AbstractDatabaseEngine
    
    Gets the class that translates SQL bound to this engine.
    
    Specified by:
    
    getTranslatorClass in class AbstractDatabaseEngine
    
    Returns:
    
    The class that translates SQL bound to this engine.
  - doPersist
```
protected long doPersist(PreparedStatement ps,
                         MappedEntity me,
                         boolean useAutoInc,
                         int lastBindPosition)
                  throws Exception
```
    Description copied from class: AbstractDatabaseEngine
    
    DB engine specific auxiliary method for AbstractDatabaseEngine.persist(String, EntityEntry, boolean) to effectively perform the persist action.
    
    Specified by:
    
    doPersist in class AbstractDatabaseEngine
    
    Parameters:
    
    ps - The PreparedStatement to use in the persist operation
    
    me - The mapped entity on which to persist.
    
    useAutoInc - Whether to use autoInc.
    
    lastBindPosition - The position (1-based) of the last bind parameter that was filled in the prepared statement.
    
    Returns:
    
    The ID of the auto generated value (0 if there's no auto generated value). If the table has more than 1 column with auto generated values, then it will return the first column found.
    
    Throws:
    
    Exception - if any problem occurs while persisting.
  - updatePersistAutoIncSequence
```
protected void updatePersistAutoIncSequence(MappedEntity mappedEntity,
                                            long currentAutoIncVal)
```
    Updates the autoInc sequence value after a persist operation.
    
    Parameters:
    
    mappedEntity - The mapped entity to for which to update the autoInc sequence.
    
    currentAutoIncVal - The current value for the autoInc column.
    
    Since:
    
    2.5.1
  - addFks
```
protected void addFks(DbEntity entity)
               throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Adds the FKs.
    
    Specified by:
    
    addFks in class AbstractDatabaseEngine
    
    Parameters:
    
    entity - The entity.
    
    Throws:
    
    DatabaseEngineException - If something goes wrong creating the FKs.
  - getDBProperties
```
protected Properties getDBProperties()
```
    Description copied from class: AbstractDatabaseEngine
    
    Get the properties to be passed to the database connection that will be created. Since these properties are specific to the database engine, it is up to the AbstractDatabaseEngine implementation to specify them. This is used, for instance, to set the database connection timeout.
    
    Overrides:
    
    getDBProperties in class AbstractDatabaseEngine
    
    Returns:
    
    the properties of the connection to the database.
  - checkConnection
```
protected boolean checkConnection(Connection conn)
```
    Description copied from class: AbstractDatabaseEngine
    
    Checks if the connection is alive.
    
    Overrides:
    
    checkConnection in class AbstractDatabaseEngine
    
    Parameters:
    
    conn - The connection to test.
    
    Returns:
    
    True if the connection is valid, false otherwise.
  - setSchema
```
protected void setSchema(String schema)
                  throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Sets the schema for the current connection.
    
    Overrides:
    
    setSchema in class AbstractDatabaseEngine
    
    Throws:
    
    DatabaseEngineException - If schema doesn't exist, a database access error occurs or this method is called on a closed connection.
  - toPdbType
```
protected DbColumnType toPdbType(int type,
                                 String typeName)
```
    Description copied from class: AbstractDatabaseEngine
    
    Maps the database type to DbColumnType. If there's no mapping a DbColumnType.UNMAPPED is returned.
    
    Overrides:
    
    toPdbType in class AbstractDatabaseEngine
    
    Parameters:
    
    type - The SQL type from Types.
    
    typeName - The native database type name. It provides additional information for derived classes to resolve types unmapped here.
    
    Returns:
    
    The DbColumnType.
  - createResultIterator
```
protected ResultIterator createResultIterator(Statement statement,
                                              String sql)
                                       throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Creates a specific ResultIterator given the engine implementation.
    
    Specified by:
    
    createResultIterator in class AbstractDatabaseEngine
    
    Parameters:
    
    statement - The statement.
    
    sql - The SQL sentence.
    
    Returns:
    
    An iterator for the specific engine.
    
    Throws:
    
    DatabaseEngineException - If a database access error occurs.
  - createResultIterator
```
protected ResultIterator createResultIterator(PreparedStatement ps)
                                       throws DatabaseEngineException
```
    Description copied from class: AbstractDatabaseEngine
    
    Creates a specific ResultIterator for the engine in place given a prepared statement.
    
    Specified by:
    
    createResultIterator in class AbstractDatabaseEngine
    
    Parameters:
    
    ps - The prepared statement.
    
    Returns:
    
    The result iterator.
    
    Throws:
    
    DatabaseEngineException - If a database access error occurs.
  - getQueryExceptionHandler
```
protected QueryExceptionHandler getQueryExceptionHandler()
```
    Description copied from class: AbstractDatabaseEngine
    
    Gets the instance of QueryExceptionHandler to be used in disambiguating SQL exceptions.
    
    Overrides:
    
    getQueryExceptionHandler in class AbstractDatabaseEngine
    
    Returns:
    
    the QueryExceptionHandler.

Class PostgreSqlEngine

Field Summary

Fields inherited from class com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine

Constructor Summary

Method Summary

Methods inherited from class com.feedzai.commons.sql.abstraction.engine.AbstractDatabaseEngine

Methods inherited from class java.lang.Object

Field Detail

POSTGRESQL_DRIVER

NAME_ALREADY_EXISTS

TABLE_CAN_ONLY_HAVE_ONE_PRIMARY_KEY

TABLE_OR_VIEW_DOES_NOT_EXIST

CONSTRAINT_NAME_ALREADY_EXISTS

PG_QUERY_EXCEPTION_HANDLER

Constructor Detail

PostgreSqlEngine

PostgreSqlEngine

Method Detail

entityToPreparedStatement

setParameter

isStringAggDistinctCapable

createTable

addPrimaryKey

addIndexes

addSequences

createPreparedStatementForInserts

dropSequences

dropTable

dropColumn

addColumn

getTranslatorClass

doPersist

updatePersistAutoIncSequence

addFks

getDBProperties

checkConnection

setSchema

toPdbType

createResultIterator

createResultIterator

getQueryExceptionHandler