public class PgConnection extends Object implements BaseConnection
Modifier and Type | Class and Description |
---|---|
class |
PgConnection.AbortCommand |
Modifier and Type | Field and Description |
---|---|
protected int |
defaultFetchSize
Default fetch size for statement
|
protected boolean |
forcebinary |
protected DatabaseMetaData |
metadata |
protected int |
prepareThreshold |
protected Map<String,Class<?>> |
typemap
The current type mappings
|
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
Constructor and Description |
---|
PgConnection(HostSpec[] hostSpecs,
String user,
String database,
Properties info,
String url) |
Modifier and Type | Method and Description |
---|---|
protected void |
abort() |
void |
abort(Executor executor) |
void |
addDataType(String type,
Class<? extends PGobject> klass)
This allows client code to add a handler for one of org.postgresql's more unique data types.
|
void |
addDataType(String type,
String name)
This allows client code to add a handler for one of org.postgresql's more unique data types.
|
void |
addTimerTask(TimerTask timerTask,
long milliSeconds)
Schedule a TimerTask for later execution.
|
void |
addWarning(SQLWarning warn)
This adds a warning to the warning chain.
|
boolean |
binaryTransferSend(int oid)
Returns true if value for the given oid should be sent using binary transfer.
|
void |
cancelQuery()
Cancel the current query executing on this connection.
|
protected void |
checkClosed() |
void |
clearWarnings() |
void |
close()
Note: even though
Statement is automatically closed when it is garbage
collected, it is better to close it explicitly to lower resource consumption. |
void |
commit() |
Array |
createArrayOf(String typeName,
Object[] elements) |
Blob |
createBlob() |
Clob |
createClob() |
NClob |
createNClob() |
CachedQuery |
createQuery(String sql,
boolean escapeProcessing,
boolean isParameterized,
String... columnNames) |
<T> T |
createQueryObject(Class<T> ifc) |
SQLXML |
createSQLXML() |
Statement |
createStatement() |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency) |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) |
Struct |
createStruct(String typeName,
Object[] attributes) |
protected TypeInfo |
createTypeInfo(BaseConnection conn,
int unknownLength) |
byte[] |
encodeString(String str)
Encode a string using the database's client_encoding (usually UTF8, but can vary on older
server versions).
|
String |
escapeIdentifier(String identifier)
Return the given string suitably quoted to be used as an identifier in an SQL statement string.
|
String |
escapeLiteral(String literal)
Return the given string suitably quoted to be used as a string literal in an SQL statement
string.
|
String |
escapeString(String str)
Escapes a string for use as string-literal within an SQL command.
|
ResultSet |
execSQLQuery(String s)
Execute a SQL query that returns a single resultset.
|
ResultSet |
execSQLQuery(String s,
int resultSetType,
int resultSetConcurrency) |
void |
execSQLUpdate(String s)
Execute a SQL query that does not return results.
|
protected void |
finalize()
Overrides finalize().
|
boolean |
getAutoCommit() |
AutoSave |
getAutosave()
Connection configuration regarding automatic per-query savepoints.
|
int |
getBackendPID()
Return the process ID (PID) of the backend server process handling this connection.
|
String |
getCatalog() |
Properties |
getClientInfo() |
String |
getClientInfo(String name) |
CopyManager |
getCopyAPI()
This returns the COPY API for the current connection.
|
String |
getCursorName()
getCursorName gets the cursor name.
|
String |
getDBVersionNumber()
Get server version number
|
int |
getDefaultFetchSize()
Get the default fetch size for statements created from this connection
|
Encoding |
getEncoding() |
Fastpath |
getFastpathAPI()
This returns the Fastpath API for the current connection.
|
LruCache<FieldMetadata.Key,FieldMetadata> |
getFieldMetadataCache()
Return metadata cache for given connection
|
boolean |
getForceBinary() |
int |
getHoldability() |
protected String |
getIsolationLevelName(int level) |
LargeObjectManager |
getLargeObjectAPI()
This returns the LargeObject API for the current connection.
|
Logger |
getLogger() |
DatabaseMetaData |
getMetaData() |
int |
getNetworkTimeout() |
PGNotification[] |
getNotifications()
This method returns any notifications that have been received since the last call to this
method.
|
Object |
getObject(String type,
String value,
byte[] byteValue)
Construct and return an appropriate object for the given type and value.
|
PreferQueryMode |
getPreferQueryMode()
Returns true if the connection is configured to use "simple 'Q' execute" commands only
When running in simple protocol only, certain features are not available: callable statements,
partial result set fetch, bytea type, etc.
|
int |
getPrepareThreshold()
Get the default server-side prepare reuse threshold for statements created from this
connection.
|
int |
getProtocolVersion() |
QueryExecutor |
getQueryExecutor()
Get the QueryExecutor implementation for this connection.
|
String |
getSchema() |
int |
getServerMajorVersion()
Get server major version
|
int |
getServerMinorVersion()
Get server minor version
|
boolean |
getStandardConformingStrings()
Returns whether the server treats string-literals according to the SQL standard or if it uses
traditional PostgreSQL escaping rules.
|
boolean |
getStringVarcharFlag() |
TimestampUtils |
getTimestampUtils() |
int |
getTransactionIsolation() |
TransactionState |
getTransactionState()
Get the current transaction state of this connection.
|
TypeInfo |
getTypeInfo() |
Map<String,Class<?>> |
getTypeMap() |
String |
getURL()
We are required to bring back certain information by the DatabaseMetaData class.
|
String |
getUserName()
Method getUserName() brings back the User Name (again, we saved it)
|
SQLWarning |
getWarnings() |
boolean |
haveMinimumCompatibleVersion(int ver)
Check if we should use driver behaviour introduced in a particular driver version.
|
boolean |
haveMinimumCompatibleVersion(String ver)
Check if we should use driver behaviour introduced in a particular driver version.
|
boolean |
haveMinimumCompatibleVersion(Version ver)
Check if we should use driver behaviour introduced in a particular driver version.
|
boolean |
haveMinimumServerVersion(int ver)
Check if we have at least a particular server version.
|
boolean |
haveMinimumServerVersion(String ver)
Check if we have at least a particular server version.
|
boolean |
haveMinimumServerVersion(Version ver)
Check if we have at least a particular server version.
|
boolean |
isClosed() |
boolean |
isColumnSanitiserDisabled()
Return whether to disable column name sanitation.
|
boolean |
isReadOnly() |
boolean |
isValid(int timeout) |
boolean |
isWrapperFor(Class<?> iface) |
protected Array |
makeArray(int oid,
String fieldString) |
protected Blob |
makeBlob(long oid) |
protected Clob |
makeClob(long oid) |
protected SQLXML |
makeSQLXML() |
String |
nativeSQL(String sql) |
CallableStatement |
prepareCall(String sql) |
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency) |
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) |
PreparedStatement |
prepareStatement(String sql) |
PreparedStatement |
prepareStatement(String sql,
int autoGeneratedKeys) |
PreparedStatement |
prepareStatement(String sql,
int[] columnIndexes) |
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency) |
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability) |
PreparedStatement |
prepareStatement(String sql,
String[] columnNames) |
void |
purgeTimerTasks()
Invoke purge() on the underlying shared Timer so that internal resources will be released.
|
void |
releaseSavepoint(Savepoint savepoint) |
void |
rollback() |
void |
rollback(Savepoint savepoint) |
void |
setAutoCommit(boolean autoCommit) |
void |
setAutosave(AutoSave autoSave)
Configures if connection should use automatic savepoints.
|
void |
setCatalog(String catalog) |
void |
setClientInfo(Properties properties) |
void |
setClientInfo(String name,
String value) |
void |
setCursorName(String cursor)
In SQL, a result table can be retrieved through a cursor that is named.
|
void |
setDefaultFetchSize(int fetchSize)
Set the default fetch size for statements created from this connection
|
void |
setDisableColumnSanitiser(boolean disableColumnSanitiser) |
void |
setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)
By default, the connection resets statement cache in case deallocate all/discard all
message is observed.
|
void |
setForceBinary(boolean newValue) |
void |
setHoldability(int holdability) |
void |
setNetworkTimeout(Executor executor,
int milliseconds) |
void |
setPrepareThreshold(int newThreshold)
Set the default statement reuse threshold before enabling server-side prepare.
|
void |
setReadOnly(boolean readOnly) |
Savepoint |
setSavepoint() |
Savepoint |
setSavepoint(String name) |
void |
setSchema(String schema) |
void |
setTransactionIsolation(int level) |
void |
setTypeMap(Map<String,Class<?>> map) |
void |
setTypeMapImpl(Map<String,Class<?>> map) |
<T> T |
unwrap(Class<T> iface) |
protected int prepareThreshold
protected int defaultFetchSize
PGProperty.DEFAULT_ROW_FETCH_SIZE
protected boolean forcebinary
protected DatabaseMetaData metadata
public PgConnection(HostSpec[] hostSpecs, String user, String database, Properties info, String url) throws SQLException
SQLException
public CachedQuery createQuery(String sql, boolean escapeProcessing, boolean isParameterized, String... columnNames) throws SQLException
createQuery
in interface BaseConnection
SQLException
public void setFlushCacheOnDeallocate(boolean flushCacheOnDeallocate)
BaseConnection
setFlushCacheOnDeallocate
in interface BaseConnection
flushCacheOnDeallocate
- true if statement cache should be reset when "deallocate/discard" message observedpublic TimestampUtils getTimestampUtils()
getTimestampUtils
in interface BaseConnection
public Statement createStatement() throws SQLException
createStatement
in interface Connection
SQLException
public PreparedStatement prepareStatement(String sql) throws SQLException
prepareStatement
in interface Connection
SQLException
public CallableStatement prepareCall(String sql) throws SQLException
prepareCall
in interface Connection
SQLException
public Map<String,Class<?>> getTypeMap() throws SQLException
getTypeMap
in interface Connection
SQLException
public QueryExecutor getQueryExecutor()
BaseConnection
getQueryExecutor
in interface BaseConnection
public void addWarning(SQLWarning warn)
warn
- warning to addpublic ResultSet execSQLQuery(String s) throws SQLException
BaseConnection
execSQLQuery
in interface BaseConnection
s
- the query to executeSQLException
- if something goes wrong.public ResultSet execSQLQuery(String s, int resultSetType, int resultSetConcurrency) throws SQLException
execSQLQuery
in interface BaseConnection
SQLException
public void execSQLUpdate(String s) throws SQLException
BaseConnection
execSQLUpdate
in interface BaseConnection
s
- the query to executeSQLException
- if something goes wrong.public void setCursorName(String cursor) throws SQLException
We do not support positioned update/delete, so this is a no-op.
cursor
- the cursor nameSQLException
- if a database access error occurspublic String getCursorName() throws SQLException
SQLException
- if a database access error occurspublic String getURL() throws SQLException
Method getURL() brings back the URL (good job we saved it)
SQLException
- just in case...public String getUserName() throws SQLException
SQLException
- just in case...public Fastpath getFastpathAPI() throws SQLException
PGConnection
getFastpathAPI
in interface PGConnection
SQLException
- if something wrong happenspublic LargeObjectManager getLargeObjectAPI() throws SQLException
PGConnection
getLargeObjectAPI
in interface PGConnection
SQLException
- if something wrong happenspublic Object getObject(String type, String value, byte[] byteValue) throws SQLException
BaseConnection
PGConnection.addDataType(String, Class)
and
PGConnection.addDataType(String, String)
.
If no class is registered as handling the given type, then a generic
PGobject
instance is returned.
getObject
in interface BaseConnection
type
- the backend typenamevalue
- the type-specific string representation of the valuebyteValue
- the type-specific binary representation of the valueSQLException
- if something goes wrongprotected TypeInfo createTypeInfo(BaseConnection conn, int unknownLength)
public TypeInfo getTypeInfo()
getTypeInfo
in interface BaseConnection
public void addDataType(String type, String name)
PGConnection
addDataType(type, Class.forName(name))
.addDataType
in interface PGConnection
type
- JDBC type namename
- class namepublic void addDataType(String type, Class<? extends PGobject> klass) throws SQLException
PGConnection
NOTE: This is not part of JDBC, but an extension.
The best way to use this is as follows:
... ((org.postgresql.PGConnection)myconn).addDataType("mytype", my.class.name.class); ...
where myconn is an open Connection to org.postgresql.
The handling class must extend org.postgresql.util.PGobject
addDataType
in interface PGConnection
type
- the PostgreSQL type to registerklass
- the class implementing the Java representation of the type; this class must
implement PGobject
).SQLException
- if klass
does not implement
PGobject
).PGobject
public void close() throws SQLException
Statement
is automatically closed when it is garbage
collected, it is better to close it explicitly to lower resource consumption.
close
in interface AutoCloseable
close
in interface Connection
SQLException
public String nativeSQL(String sql) throws SQLException
nativeSQL
in interface Connection
SQLException
public SQLWarning getWarnings() throws SQLException
getWarnings
in interface Connection
SQLException
public void clearWarnings() throws SQLException
clearWarnings
in interface Connection
SQLException
public void setReadOnly(boolean readOnly) throws SQLException
setReadOnly
in interface Connection
SQLException
public boolean isReadOnly() throws SQLException
isReadOnly
in interface Connection
SQLException
public void setAutoCommit(boolean autoCommit) throws SQLException
setAutoCommit
in interface Connection
SQLException
public boolean getAutoCommit() throws SQLException
getAutoCommit
in interface Connection
SQLException
public void commit() throws SQLException
commit
in interface Connection
SQLException
protected void checkClosed() throws SQLException
SQLException
public void rollback() throws SQLException
rollback
in interface Connection
SQLException
public TransactionState getTransactionState()
BaseConnection
getTransactionState
in interface BaseConnection
public int getTransactionIsolation() throws SQLException
getTransactionIsolation
in interface Connection
SQLException
public void setTransactionIsolation(int level) throws SQLException
setTransactionIsolation
in interface Connection
SQLException
protected String getIsolationLevelName(int level)
public void setCatalog(String catalog) throws SQLException
setCatalog
in interface Connection
SQLException
public String getCatalog() throws SQLException
getCatalog
in interface Connection
SQLException
protected void finalize() throws Throwable
This was done at the request of Rachel Greenham who hit a problem where multiple clients didn't close the connection, and once a fortnight enough clients were open to kill the postgres server.
public String getDBVersionNumber()
public int getServerMajorVersion()
public int getServerMinorVersion()
public boolean haveMinimumServerVersion(String ver)
BaseConnection
haveMinimumServerVersion
in interface BaseConnection
ver
- the server version to checkpublic boolean haveMinimumServerVersion(int ver)
BaseConnection
haveMinimumServerVersion
in interface BaseConnection
ver
- the server version to check, of the form xxyyzz eg 90401public boolean haveMinimumServerVersion(Version ver)
BaseConnection
haveMinimumServerVersion
in interface BaseConnection
ver
- the server version to checkpublic boolean haveMinimumCompatibleVersion(int ver)
BaseConnection
haveMinimumCompatibleVersion
in interface BaseConnection
ver
- the driver version to check, eg 90401 for 9.4.1public boolean haveMinimumCompatibleVersion(String ver)
BaseConnection
haveMinimumCompatibleVersion
in interface BaseConnection
ver
- the driver version to checkpublic boolean haveMinimumCompatibleVersion(Version ver)
BaseConnection
haveMinimumCompatibleVersion
in interface BaseConnection
ver
- the driver version to checkpublic Encoding getEncoding()
getEncoding
in interface BaseConnection
public byte[] encodeString(String str) throws SQLException
BaseConnection
encodeString
in interface BaseConnection
str
- the string to encodeSQLException
- if something goes wrong.public String escapeString(String str) throws SQLException
BaseConnection
BaseConnection.getStandardConformingStrings()
.escapeString
in interface BaseConnection
str
- a string valueSQLException
- if the string contains a \0 characterpublic boolean getStandardConformingStrings()
BaseConnection
getStandardConformingStrings
in interface BaseConnection
QueryExecutor.getStandardConformingStrings()
public boolean isClosed() throws SQLException
isClosed
in interface Connection
SQLException
public void cancelQuery() throws SQLException
BaseConnection
cancelQuery
in interface BaseConnection
SQLException
- if something goes wrong.public PGNotification[] getNotifications() throws SQLException
PGConnection
getNotifications
in interface PGConnection
SQLException
- if something wrong happenspublic int getPrepareThreshold()
PGConnection
getPrepareThreshold
in interface PGConnection
public void setDefaultFetchSize(int fetchSize) throws SQLException
PGConnection
setDefaultFetchSize
in interface PGConnection
fetchSize
- new default fetch sizeSQLException
- if specified negative fetchSize
parameterStatement.setFetchSize(int)
public int getDefaultFetchSize()
PGConnection
getDefaultFetchSize
in interface PGConnection
PGProperty.DEFAULT_ROW_FETCH_SIZE
,
Statement.getFetchSize()
public void setPrepareThreshold(int newThreshold)
PGConnection
PGStatement.setPrepareThreshold(int)
for details.setPrepareThreshold
in interface PGConnection
newThreshold
- the new thresholdpublic boolean getForceBinary()
public void setForceBinary(boolean newValue)
public void setTypeMapImpl(Map<String,Class<?>> map) throws SQLException
SQLException
public Logger getLogger()
getLogger
in interface BaseConnection
public int getProtocolVersion()
public boolean getStringVarcharFlag()
getStringVarcharFlag
in interface BaseConnection
public CopyManager getCopyAPI() throws SQLException
PGConnection
getCopyAPI
in interface PGConnection
SQLException
- if something wrong happenspublic boolean binaryTransferSend(int oid)
BaseConnection
binaryTransferSend
in interface BaseConnection
oid
- The oid to check.public int getBackendPID()
PGConnection
getBackendPID
in interface PGConnection
public boolean isColumnSanitiserDisabled()
BaseConnection
isColumnSanitiserDisabled
in interface BaseConnection
public void setDisableColumnSanitiser(boolean disableColumnSanitiser)
public PreferQueryMode getPreferQueryMode()
PGConnection
getPreferQueryMode
in interface PGConnection
public AutoSave getAutosave()
PGConnection
getAutosave
in interface PGConnection
PGProperty.AUTOSAVE
public void setAutosave(AutoSave autoSave)
PGConnection
setAutosave
in interface PGConnection
autoSave
- connection configuration regarding automatic per-query savepointsPGProperty.AUTOSAVE
protected void abort()
public void addTimerTask(TimerTask timerTask, long milliSeconds)
BaseConnection
addTimerTask
in interface BaseConnection
timerTask
- timer task to schedulemilliSeconds
- delay in millisecondspublic void purgeTimerTasks()
BaseConnection
purgeTimerTasks
in interface BaseConnection
public String escapeIdentifier(String identifier) throws SQLException
PGConnection
escapeIdentifier
in interface PGConnection
identifier
- input identifierSQLException
- if something goes wrongpublic String escapeLiteral(String literal) throws SQLException
PGConnection
escapeLiteral
in interface PGConnection
literal
- input literalSQLException
- if something goes wrongpublic LruCache<FieldMetadata.Key,FieldMetadata> getFieldMetadataCache()
BaseConnection
getFieldMetadataCache
in interface BaseConnection
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
createStatement
in interface Connection
SQLException
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
prepareStatement
in interface Connection
SQLException
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
prepareCall
in interface Connection
SQLException
public DatabaseMetaData getMetaData() throws SQLException
getMetaData
in interface Connection
SQLException
public void setTypeMap(Map<String,Class<?>> map) throws SQLException
setTypeMap
in interface Connection
SQLException
protected Array makeArray(int oid, String fieldString) throws SQLException
SQLException
protected Blob makeBlob(long oid) throws SQLException
SQLException
protected Clob makeClob(long oid) throws SQLException
SQLException
protected SQLXML makeSQLXML() throws SQLException
SQLException
public Clob createClob() throws SQLException
createClob
in interface Connection
SQLException
public Blob createBlob() throws SQLException
createBlob
in interface Connection
SQLException
public NClob createNClob() throws SQLException
createNClob
in interface Connection
SQLException
public SQLXML createSQLXML() throws SQLException
createSQLXML
in interface Connection
SQLException
public Struct createStruct(String typeName, Object[] attributes) throws SQLException
createStruct
in interface Connection
SQLException
public Array createArrayOf(String typeName, Object[] elements) throws SQLException
createArrayOf
in interface Connection
SQLException
public boolean isValid(int timeout) throws SQLException
isValid
in interface Connection
SQLException
public void setClientInfo(String name, String value) throws SQLClientInfoException
setClientInfo
in interface Connection
SQLClientInfoException
public void setClientInfo(Properties properties) throws SQLClientInfoException
setClientInfo
in interface Connection
SQLClientInfoException
public String getClientInfo(String name) throws SQLException
getClientInfo
in interface Connection
SQLException
public Properties getClientInfo() throws SQLException
getClientInfo
in interface Connection
SQLException
public <T> T createQueryObject(Class<T> ifc) throws SQLException
SQLException
public boolean isWrapperFor(Class<?> iface) throws SQLException
isWrapperFor
in interface Wrapper
SQLException
public <T> T unwrap(Class<T> iface) throws SQLException
unwrap
in interface Wrapper
SQLException
public String getSchema() throws SQLException
getSchema
in interface Connection
SQLException
public void setSchema(String schema) throws SQLException
setSchema
in interface Connection
SQLException
public void abort(Executor executor) throws SQLException
abort
in interface Connection
SQLException
public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException
setNetworkTimeout
in interface Connection
SQLException
public int getNetworkTimeout() throws SQLException
getNetworkTimeout
in interface Connection
SQLException
public void setHoldability(int holdability) throws SQLException
setHoldability
in interface Connection
SQLException
public int getHoldability() throws SQLException
getHoldability
in interface Connection
SQLException
public Savepoint setSavepoint() throws SQLException
setSavepoint
in interface Connection
SQLException
public Savepoint setSavepoint(String name) throws SQLException
setSavepoint
in interface Connection
SQLException
public void rollback(Savepoint savepoint) throws SQLException
rollback
in interface Connection
SQLException
public void releaseSavepoint(Savepoint savepoint) throws SQLException
releaseSavepoint
in interface Connection
SQLException
public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
createStatement
in interface Connection
SQLException
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
prepareStatement
in interface Connection
SQLException
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
prepareCall
in interface Connection
SQLException
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
prepareStatement
in interface Connection
SQLException
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
prepareStatement
in interface Connection
SQLException
public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
prepareStatement
in interface Connection
SQLException
Copyright © 2016 PostgreSQL Global Development Group. All rights reserved.