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)
Terminates an open connection.
|
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()
Clears all warnings reported for this
Connection object. |
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()
Makes all changes made since the previous
commit/rollback permanent and releases any database locks
currently held by this
Connection object. |
Array |
createArrayOf(String typeName,
Object elements)
Creates an
Array wrapping elements. |
Array |
createArrayOf(String typeName,
Object[] elements)
Factory method for creating Array objects.
|
Blob |
createBlob()
Constructs an object that implements the
Blob interface. |
Clob |
createClob()
Constructs an object that implements the
Clob interface. |
NClob |
createNClob()
Constructs an object that implements the
NClob interface. |
CachedQuery |
createQuery(String sql,
boolean escapeProcessing,
boolean isParameterized,
String... columnNames) |
<T> T |
createQueryObject(Class<T> ifc) |
SQLXML |
createSQLXML()
Constructs an object that implements the
SQLXML interface. |
Statement |
createStatement()
Creates a
Statement object for sending
SQL statements to the database. |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency)
Creates a
Statement object that will generate
ResultSet objects with the given type and concurrency. |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a
Statement object that will generate
ResultSet objects with the given type, concurrency,
and holdability. |
Struct |
createStruct(String typeName,
Object[] attributes)
Factory method for creating Struct objects.
|
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()
Retrieves the current auto-commit mode for this
Connection
object. |
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()
Retrieves this
Connection object's current catalog name. |
Properties |
getClientInfo()
Returns a list containing the name and current value of each client info
property supported by the driver.
|
String |
getClientInfo(String name)
Returns the value of the client info property specified by 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() |
boolean |
getHideUnprivilegedObjects() |
int |
getHoldability()
Retrieves the current holdability of
ResultSet objects
created using this Connection object. |
protected String |
getIsolationLevelName(int level) |
LargeObjectManager |
getLargeObjectAPI()
This returns the LargeObject API for the current connection.
|
Logger |
getLogger() |
DatabaseMetaData |
getMetaData()
Retrieves a
DatabaseMetaData object that contains
metadata about the database to which this
Connection object represents a connection. |
int |
getNetworkTimeout()
Retrieves the number of milliseconds the driver will
wait for a database request to complete.
|
PGNotification[] |
getNotifications()
This method returns any notifications that have been received since the last call to this
method.
|
PGNotification[] |
getNotifications(int timeoutMillis)
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.
|
String |
getParameterStatus(String parameterName)
Shorthand for getParameterStatuses().get(...) .
|
Map<String,String> |
getParameterStatuses()
Returns the current values of all parameters reported by the server.
|
PreferQueryMode |
getPreferQueryMode()
Returns the query mode for this connection.
|
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.
|
PGReplicationConnection |
getReplicationAPI() |
ReplicationProtocol |
getReplicationProtocol()
Internal protocol for work with physical and logical replication.
|
String |
getSchema()
Retrieves this
Connection object's current schema name. |
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()
Retrieves this
Connection object's current
transaction isolation level. |
TransactionState |
getTransactionState()
Get the current transaction state of this connection.
|
TypeInfo |
getTypeInfo() |
Map<String,Class<?>> |
getTypeMap()
Retrieves the
Map object associated with this
Connection object. |
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()
Retrieves the first warning reported by calls on this
Connection object. |
boolean |
haveMinimumServerVersion(int 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 |
hintReadOnly()
Indicates if statements to backend should be hinted as read only.
|
boolean |
isClosed()
Retrieves whether this
Connection object has been
closed. |
boolean |
isColumnSanitiserDisabled()
Return whether to disable column name sanitation.
|
boolean |
isReadOnly()
Retrieves whether this
Connection
object is in read-only mode. |
boolean |
isValid(int timeout)
Returns true if the connection has not been closed and is still valid.
|
boolean |
isWrapperFor(Class<?> iface)
Returns true if this either implements the interface argument or is directly or indirectly a wrapper
for an object that does.
|
protected Array |
makeArray(int oid,
String fieldString) |
protected Blob |
makeBlob(long oid) |
protected Clob |
makeClob(long oid) |
protected SQLXML |
makeSQLXML() |
String |
nativeSQL(String sql)
Converts the given SQL statement into the system's native SQL grammar.
|
CallableStatement |
prepareCall(String sql)
Creates a
CallableStatement object for calling
database stored procedures. |
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency)
Creates a
CallableStatement object that will generate
ResultSet objects with the given type and concurrency. |
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a
CallableStatement object that will generate
ResultSet objects with the given type and concurrency. |
PreparedStatement |
prepareStatement(String sql)
Creates a
PreparedStatement object for sending
parameterized SQL statements to the database. |
PreparedStatement |
prepareStatement(String sql,
int autoGeneratedKeys)
Creates a default
PreparedStatement object that has
the capability to retrieve auto-generated keys. |
PreparedStatement |
prepareStatement(String sql,
int[] columnIndexes)
Creates a default
PreparedStatement object capable
of returning the auto-generated keys designated by the given array. |
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency)
Creates a
PreparedStatement object that will generate
ResultSet objects with the given type and concurrency. |
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a
PreparedStatement object that will generate
ResultSet objects with the given type, concurrency,
and holdability. |
PreparedStatement |
prepareStatement(String sql,
String[] columnNames)
Creates a default
PreparedStatement object capable
of returning the auto-generated keys designated by the given array. |
void |
purgeTimerTasks()
Invoke purge() on the underlying shared Timer so that internal resources will be released.
|
void |
releaseSavepoint(Savepoint savepoint)
Removes the specified
Savepoint and subsequent Savepoint objects from the current
transaction. |
void |
rollback()
Undoes all changes made in the current transaction
and releases any database locks currently held
by this
Connection object. |
void |
rollback(Savepoint savepoint)
Undoes all changes made after the given
Savepoint object
was set. |
void |
setAutoCommit(boolean autoCommit)
Sets this connection's auto-commit mode to the given state.
|
void |
setAutosave(AutoSave autoSave)
Configures if connection should use automatic savepoints.
|
void |
setCatalog(String catalog)
Sets the given catalog name in order to select
a subspace of this
Connection object's database
in which to work. |
void |
setClientInfo(Properties properties)
Sets the value of the connection's client info properties.
|
void |
setClientInfo(String name,
String value)
Sets the value of the client info property specified by name to the
value specified by 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)
Changes the default holdability of
ResultSet objects
created using this Connection object to the given
holdability. |
void |
setNetworkTimeout(Executor executor,
int milliseconds)
Sets the maximum period a
Connection or
objects created from the Connection
will wait for the database to reply to any one request. |
void |
setPrepareThreshold(int newThreshold)
Set the default statement reuse threshold before enabling server-side prepare.
|
void |
setReadOnly(boolean readOnly)
Puts this connection in read-only mode as a hint to the driver to enable
database optimizations.
|
Savepoint |
setSavepoint()
Creates an unnamed savepoint in the current transaction and
returns the new
Savepoint object that represents it. |
Savepoint |
setSavepoint(String name)
Creates a savepoint with the given name in the current transaction
and returns the new
Savepoint object that represents it. |
void |
setSchema(String schema)
Sets the given schema name to access.
|
void |
setTransactionIsolation(int level)
Attempts to change the transaction isolation level for this
Connection object to the one given. |
void |
setTypeMap(Map<String,Class<?>> map)
Installs the given
TypeMap object as the type map for
this Connection object. |
void |
setTypeMapImpl(Map<String,Class<?>> map) |
<T> T |
unwrap(Class<T> iface)
Returns an object that implements the given interface to allow access to
non-standard methods, or standard methods not exposed by the proxy.
|
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
java.sql.Connection
Statement
object for sending
SQL statements to the database.
SQL statements without parameters are normally
executed using Statement
objects. If the same SQL statement
is executed many times, it may be more efficient to use a
PreparedStatement
object.
Result sets created using the returned Statement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
createStatement
in interface Connection
Statement
objectSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic PreparedStatement prepareStatement(String sql) throws SQLException
java.sql.Connection
PreparedStatement
object for sending
parameterized SQL statements to the database.
A SQL statement with or without IN parameters can be
pre-compiled and stored in a PreparedStatement
object. This
object can then be used to efficiently execute this statement
multiple times.
Note: This method is optimized for handling
parametric SQL statements that benefit from precompilation. If
the driver supports precompilation,
the method prepareStatement
will send
the statement to the database for precompilation. Some drivers
may not support precompilation. In this case, the statement may
not be sent to the database until the PreparedStatement
object is executed. This has no direct effect on users; however, it does
affect which methods throw certain SQLException
objects.
Result sets created using the returned PreparedStatement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholdersPreparedStatement
object containing the
pre-compiled SQL statementSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic CallableStatement prepareCall(String sql) throws SQLException
java.sql.Connection
CallableStatement
object for calling
database stored procedures.
The CallableStatement
object provides
methods for setting up its IN and OUT parameters, and
methods for executing the call to a stored procedure.
Note: This method is optimized for handling stored
procedure call statements. Some drivers may send the call
statement to the database when the method prepareCall
is done; others
may wait until the CallableStatement
object
is executed. This has no
direct effect on users; however, it does affect which method
throws certain SQLExceptions.
Result sets created using the returned CallableStatement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareCall
in interface Connection
sql
- an SQL statement that may contain one or more '?'
parameter placeholders. Typically this statement is specified using JDBC
call escape syntax.CallableStatement
object containing the
pre-compiled SQL statementSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic Map<String,Class<?>> getTypeMap() throws SQLException
java.sql.Connection
Map
object associated with this
Connection
object.
Unless the application has added an entry, the type map returned
will be empty.
You must invoke setTypeMap
after making changes to the
Map
object returned from
getTypeMap
as a JDBC driver may create an internal
copy of the Map
object passed to setTypeMap
:
Map<String,Class<?>> myMap = con.getTypeMap(); myMap.put("mySchemaName.ATHLETES", Athletes.class); con.setTypeMap(myMap);
getTypeMap
in interface Connection
java.util.Map
object associated
with this Connection
objectSQLException
- if a database access error occurs
or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodConnection.setTypeMap(java.util.Map<java.lang.String, java.lang.Class<?>>)
public QueryExecutor getQueryExecutor()
BaseConnection
getQueryExecutor
in interface BaseConnection
public ReplicationProtocol getReplicationProtocol()
BaseConnection
getReplicationProtocol
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
In SQL, a result table can be retrieved through a cursor that is named. The current row of a result can be updated or deleted using a positioned update/delete statement that references the cursor name.
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
We are required to bring back certain information by the DatabaseMetaData class. These functions do that.
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
Construct and return an appropriate object for the given type and value. This only considers
the types registered via 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
This allows client code to add a handler for one of org.postgresql's more unique data types.
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.
Releases this Connection
object's database and JDBC resources
immediately instead of waiting for them to be automatically released.
Calling the method close
on a Connection
object that is already closed is a no-op.
It is strongly recommended that an application explicitly
commits or rolls back an active transaction prior to calling the
close
method. If the close
method is called
and there is an active transaction, the results are implementation-defined.
close
in interface AutoCloseable
close
in interface Connection
SQLException
- SQLException if a database access error occurspublic String nativeSQL(String sql) throws SQLException
java.sql.Connection
nativeSQL
in interface Connection
sql
- an SQL statement that may contain one or more '?'
parameter placeholdersSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic SQLWarning getWarnings() throws SQLException
java.sql.Connection
Connection
object. If there is more than one
warning, subsequent warnings will be chained to the first one
and can be retrieved by calling the method
SQLWarning.getNextWarning
on the warning
that was retrieved previously.
This method may not be
called on a closed connection; doing so will cause an
SQLException
to be thrown.
Note: Subsequent warnings will be chained to this SQLWarning.
getWarnings
in interface Connection
SQLWarning
object or null
if there are noneSQLException
- if a database access error occurs or
this method is called on a closed connectionSQLWarning
public void clearWarnings() throws SQLException
java.sql.Connection
Connection
object.
After a call to this method, the method getWarnings
returns null
until a new warning is
reported for this Connection
object.clearWarnings
in interface Connection
SQLException
- SQLException if a database access error occurs
or this method is called on a closed connectionpublic void setReadOnly(boolean readOnly) throws SQLException
java.sql.Connection
Note: This method cannot be called during a transaction.
setReadOnly
in interface Connection
readOnly
- true
enables read-only mode;
false
disables itSQLException
- if a database access error occurs, this
method is called on a closed connection or this
method is called during a transactionpublic boolean isReadOnly() throws SQLException
java.sql.Connection
Connection
object is in read-only mode.isReadOnly
in interface Connection
true
if this Connection
object
is read-only; false
otherwiseSQLException
- SQLException if a database access error occurs
or this method is called on a closed connectionpublic boolean hintReadOnly()
BaseConnection
hintReadOnly
in interface BaseConnection
PGProperty.READ_ONLY_MODE
public void setAutoCommit(boolean autoCommit) throws SQLException
java.sql.Connection
commit
or the method rollback
.
By default, new connections are in auto-commit
mode.
The commit occurs when the statement completes. The time when the statement completes depends on the type of SQL Statement:
CallableStatement
objects or for statements that return
multiple results, the statement is complete
when all of the associated result sets have been closed, and all update
counts and output parameters have been retrieved.
NOTE: If this method is called during a transaction and the
auto-commit mode is changed, the transaction is committed. If
setAutoCommit
is called and the auto-commit mode is
not changed, the call is a no-op.
setAutoCommit
in interface Connection
autoCommit
- true
to enable auto-commit mode;
false
to disable itSQLException
- if a database access error occurs,
setAutoCommit(true) is called while participating in a distributed transaction,
or this method is called on a closed connectionConnection.getAutoCommit()
public boolean getAutoCommit() throws SQLException
java.sql.Connection
Connection
object.getAutoCommit
in interface Connection
Connection
object's
auto-commit modeSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setAutoCommit(boolean)
public void commit() throws SQLException
java.sql.Connection
Connection
object.
This method should be
used only when auto-commit mode has been disabled.commit
in interface Connection
SQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
if this method is called on a closed connection or this
Connection
object is in auto-commit modeConnection.setAutoCommit(boolean)
protected void checkClosed() throws SQLException
SQLException
public void rollback() throws SQLException
java.sql.Connection
Connection
object. This method should be
used only when auto-commit mode has been disabled.rollback
in interface Connection
SQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection or this
Connection
object is in auto-commit modeConnection.setAutoCommit(boolean)
public TransactionState getTransactionState()
BaseConnection
getTransactionState
in interface BaseConnection
public int getTransactionIsolation() throws SQLException
java.sql.Connection
Connection
object's current
transaction isolation level.getTransactionIsolation
in interface Connection
Connection.TRANSACTION_READ_UNCOMMITTED
,
Connection.TRANSACTION_READ_COMMITTED
,
Connection.TRANSACTION_REPEATABLE_READ
,
Connection.TRANSACTION_SERIALIZABLE
, or
Connection.TRANSACTION_NONE
.SQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setTransactionIsolation(int)
public void setTransactionIsolation(int level) throws SQLException
java.sql.Connection
Connection
object to the one given.
The constants defined in the interface Connection
are the possible transaction isolation levels.
Note: If this method is called during a transaction, the result is implementation-defined.
setTransactionIsolation
in interface Connection
level
- one of the following Connection
constants:
Connection.TRANSACTION_READ_UNCOMMITTED
,
Connection.TRANSACTION_READ_COMMITTED
,
Connection.TRANSACTION_REPEATABLE_READ
, or
Connection.TRANSACTION_SERIALIZABLE
.
(Note that Connection.TRANSACTION_NONE
cannot be used
because it specifies that transactions are not supported.)SQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameter is not one of the Connection
constantsDatabaseMetaData.supportsTransactionIsolationLevel(int)
,
Connection.getTransactionIsolation()
protected String getIsolationLevelName(int level)
public void setCatalog(String catalog) throws SQLException
java.sql.Connection
Connection
object's database
in which to work.
If the driver does not support catalogs, it will silently ignore this request.
Calling setCatalog
has no effect on previously created or prepared
Statement
objects. It is implementation defined whether a DBMS
prepare operation takes place immediately when the Connection
method prepareStatement
or prepareCall
is invoked.
For maximum portability, setCatalog
should be called before a
Statement
is created or prepared.
setCatalog
in interface Connection
catalog
- the name of a catalog (subspace in this
Connection
object's database) in which to workSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.getCatalog()
public String getCatalog() throws SQLException
java.sql.Connection
Connection
object's current catalog name.getCatalog
in interface Connection
null
if there is noneSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setCatalog(java.lang.String)
public boolean getHideUnprivilegedObjects()
protected void finalize() throws Throwable
Overrides finalize(). If called, it closes the connection.
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(int ver)
BaseConnection
Check if we have at least a particular server version.
The input version is of the form xxyyzz, matching a PostgreSQL version like xx.yy.zz. So 9.0.12 is 90012.
haveMinimumServerVersion
in interface BaseConnection
ver
- the server version to check, of the form xxyyzz eg 90401public boolean haveMinimumServerVersion(Version ver)
BaseConnection
Check if we have at least a particular server version.
The input version is of the form xxyyzz, matching a PostgreSQL version like xx.yy.zz. So 9.0.12 is 90012.
haveMinimumServerVersion
in interface BaseConnection
ver
- the server 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
standard_conforming_strings
server variable.getStandardConformingStrings
in interface BaseConnection
QueryExecutor.getStandardConformingStrings()
public boolean isClosed() throws SQLException
java.sql.Connection
Connection
object has been
closed. A connection is closed if the method close
has been called on it or if certain fatal errors have occurred.
This method is guaranteed to return true
only when
it is called after the method Connection.close
has
been called.
This method generally cannot be called to determine whether a connection to a database is valid or invalid. A typical client can determine that a connection is invalid by catching any exceptions that might be thrown when an operation is attempted.
isClosed
in interface Connection
true
if this Connection
object
is closed; false
if it is still openSQLException
- if a database access error occurspublic void cancelQuery() throws SQLException
BaseConnection
cancelQuery
in interface BaseConnection
cancelQuery
in interface PGConnection
SQLException
- if something goes wrong.public PGNotification[] getNotifications() throws SQLException
PGConnection
getNotifications
in interface PGConnection
SQLException
- if something wrong happenspublic PGNotification[] getNotifications(int timeoutMillis) throws SQLException
PGConnection
getNotifications
in interface PGConnection
timeoutMillis
- when 0, blocks forever. when > 0, blocks up to the specified number of millies
or until at least one notification has been received. If more than one notification is
about to be received, these will be returned in one batch.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
Returns the query mode for this connection.
When running in simple query mode, certain features are not available: callable statements, partial result set fetch, bytea type, etc.
The list of supported features is subject to change.
getPreferQueryMode
in interface PGConnection
PreferQueryMode
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 PGReplicationConnection getReplicationAPI()
getReplicationAPI
in interface PGConnection
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
java.sql.Connection
Statement
object that will generate
ResultSet
objects with the given type, concurrency,
and holdability.
This method is the same as the createStatement
method
above, but it allows the default result set
type, concurrency, and holdability to be overridden.createStatement
in interface Connection
resultSetType
- one of the following ResultSet
constants:
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- one of the following ResultSet
constants:
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
resultSetHoldability
- one of the following ResultSet
constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
Statement
object that will generate
ResultSet
objects with the given type,
concurrency, and holdabilitySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilitySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type, result set holdability and result set concurrency.ResultSet
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
java.sql.Connection
PreparedStatement
object that will generate
ResultSet
objects with the given type, concurrency,
and holdability.
This method is the same as the prepareStatement
method
above, but it allows the default result set
type, concurrency, and holdability to be overridden.
prepareStatement
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain one or more '?' IN
parametersresultSetType
- one of the following ResultSet
constants:
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- one of the following ResultSet
constants:
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
resultSetHoldability
- one of the following ResultSet
constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
PreparedStatement
object, containing the
pre-compiled SQL statement, that will generate
ResultSet
objects with the given type,
concurrency, and holdabilitySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilitySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type, result set holdability and result set concurrency.ResultSet
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
java.sql.Connection
CallableStatement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the prepareCall
method
above, but it allows the default result set
type, result set concurrency type and holdability to be overridden.prepareCall
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain on or more '?' parametersresultSetType
- one of the following ResultSet
constants:
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- one of the following ResultSet
constants:
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
resultSetHoldability
- one of the following ResultSet
constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
CallableStatement
object, containing the
pre-compiled SQL statement, that will generate
ResultSet
objects with the given type,
concurrency, and holdabilitySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilitySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type, result set holdability and result set concurrency.ResultSet
public DatabaseMetaData getMetaData() throws SQLException
java.sql.Connection
DatabaseMetaData
object that contains
metadata about the database to which this
Connection
object represents a connection.
The metadata includes information about the database's
tables, its supported SQL grammar, its stored
procedures, the capabilities of this connection, and so on.getMetaData
in interface Connection
DatabaseMetaData
object for this
Connection
objectSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic void setTypeMap(Map<String,Class<?>> map) throws SQLException
java.sql.Connection
TypeMap
object as the type map for
this Connection
object. The type map will be used for the
custom mapping of SQL structured types and distinct types.
You must set the the values for the TypeMap
prior to
callng setMap
as a JDBC driver may create an internal copy
of the TypeMap
:
Map myMap<String,Class<?>> = new HashMap<String,Class<?>>(); myMap.put("mySchemaName.ATHLETES", Athletes.class); con.setTypeMap(myMap);
setTypeMap
in interface Connection
map
- the java.util.Map
object to install
as the replacement for this Connection
object's default type mapSQLException
- if a database access error occurs, this
method is called on a closed connection or
the given parameter is not a java.util.Map
objectSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodConnection.getTypeMap()
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
java.sql.Connection
Clob
interface. The object
returned initially contains no data. The setAsciiStream
,
setCharacterStream
and setString
methods of
the Clob
interface may be used to add data to the Clob
.createClob
in interface Connection
Clob
interfaceSQLException
- if an object that implements the
Clob
interface can not be constructed, this method is
called on a closed connection or a database access error occurs.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic Blob createBlob() throws SQLException
java.sql.Connection
Blob
interface. The object
returned initially contains no data. The setBinaryStream
and
setBytes
methods of the Blob
interface may be used to add data to
the Blob
.createBlob
in interface Connection
Blob
interfaceSQLException
- if an object that implements the
Blob
interface can not be constructed, this method is
called on a closed connection or a database access error occurs.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic NClob createNClob() throws SQLException
java.sql.Connection
NClob
interface. The object
returned initially contains no data. The setAsciiStream
,
setCharacterStream
and setString
methods of the NClob
interface may
be used to add data to the NClob
.createNClob
in interface Connection
NClob
interfaceSQLException
- if an object that implements the
NClob
interface can not be constructed, this method is
called on a closed connection or a database access error occurs.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic SQLXML createSQLXML() throws SQLException
java.sql.Connection
SQLXML
interface. The object
returned initially contains no data. The createXmlStreamWriter
object and
setString
method of the SQLXML
interface may be used to add data to the SQLXML
object.createSQLXML
in interface Connection
SQLXML
interfaceSQLException
- if an object that implements the SQLXML
interface can not
be constructed, this method is
called on a closed connection or a database access error occurs.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic Struct createStruct(String typeName, Object[] attributes) throws SQLException
java.sql.Connection
createStruct
in interface Connection
typeName
- the SQL type name of the SQL structured type that this Struct
object maps to. The typeName is the name of a user-defined type that
has been defined for this database. It is the value returned by
Struct.getSQLTypeName
.attributes
- the attributes that populate the returned objectSQLException
- if a database error occurs, the typeName is null or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support this data typepublic Array createArrayOf(String typeName, Object elements) throws SQLException
PGConnection
Array
wrapping elements. This is similar to
Connection.createArrayOf(String, Object[])
, but also
provides support for primitive arrays.createArrayOf
in interface PGConnection
typeName
- The SQL name of the type to map the elements to.
Must not be null
.elements
- The array of objects to map. A null
value will result in
an Array
representing null
.Array
wrapping elements.SQLException
- If for some reason the array cannot be created.Connection.createArrayOf(String, Object[])
public Array createArrayOf(String typeName, Object[] elements) throws SQLException
java.sql.Connection
Note: When createArrayOf
is used to create an array object
that maps to a primitive data type, then it is implementation-defined
whether the Array
object is an array of that primitive
data type or an array of Object
.
Note: The JDBC driver is responsible for mapping the elements
Object
array to the default JDBC SQL type defined in
java.sql.Types for the given class of Object
. The default
mapping is specified in Appendix B of the JDBC specification. If the
resulting JDBC type is not the appropriate type for the given typeName then
it is implementation defined whether an SQLException
is
thrown or the driver supports the resulting conversion.
createArrayOf
in interface Connection
typeName
- the SQL name of the type the elements of the array map to. The typeName is a
database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This
is the value returned by Array.getBaseTypeName
elements
- the elements that populate the returned objectSQLException
- if a database error occurs, the JDBC type is not
appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support this data typepublic boolean isValid(int timeout) throws SQLException
java.sql.Connection
The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.
isValid
in interface Connection
timeout
- - The time in seconds to wait for the database operation
used to validate the connection to complete. If
the timeout period expires before the operation
completes, this method returns false. A value of
0 indicates a timeout is not applied to the
database operation.
SQLException
- if the value supplied for timeout
is less then 0DatabaseMetaData.getClientInfoProperties()
public void setClientInfo(String name, String value) throws SQLClientInfoException
java.sql.Connection
Applications may use the DatabaseMetaData.getClientInfoProperties
method to determine the client info properties supported by the driver
and the maximum length that may be specified for each property.
The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.
The driver shall generate a warning if the client info name specified is not recognized by the driver.
If the value specified to this method is greater than the maximum
length for the property the driver may either truncate the value and
generate a warning or generate a SQLClientInfoException
. If the driver
generates a SQLClientInfoException
, the value specified was not set on the
connection.
The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used.
setClientInfo
in interface Connection
name
- The name of the client info property to setvalue
- The value to set the client info property to. If the
value is null, the current value of the specified
property is cleared.
SQLClientInfoException
- if the database server returns an error while
setting the client info value on the database server or this method
is called on a closed connection
public void setClientInfo(Properties properties) throws SQLClientInfoException
java.sql.Connection
Properties
object contains the names and values of the client info
properties to be set. The set of client info properties contained in
the properties list replaces the current set of client info properties
on the connection. If a property that is currently set on the
connection is not present in the properties list, that property is
cleared. Specifying an empty properties list will clear all of the
properties on the connection. See setClientInfo (String, String)
for
more information.
If an error occurs in setting any of the client info properties, a
SQLClientInfoException
is thrown. The SQLClientInfoException
contains information indicating which client info properties were not set.
The state of the client information is unknown because
some databases do not allow multiple client info properties to be set
atomically. For those databases, one or more properties may have been
set before the error occurred.
setClientInfo
in interface Connection
properties
- the list of client info properties to set
SQLClientInfoException
- if the database server returns an error while
setting the clientInfo values on the database server or this method
is called on a closed connection
setClientInfo(String, String)
public String getClientInfo(String name) throws SQLException
java.sql.Connection
Applications may use the DatabaseMetaData.getClientInfoProperties
method to determine the client info properties supported by the driver.
getClientInfo
in interface Connection
name
- The name of the client info property to retrieve
SQLException
- if the database server returns an error when
fetching the client info value from the database
or this method is called on a closed connection
DatabaseMetaData.getClientInfoProperties()
public Properties getClientInfo() throws SQLException
java.sql.Connection
getClientInfo
in interface Connection
Properties
object that contains the name and current value of
each of the client info properties supported by the driver.
SQLException
- if the database server returns an error when
fetching the client info values from the database
or this method is called on a closed connection
public <T> T createQueryObject(Class<T> ifc) throws SQLException
SQLException
public boolean isWrapperFor(Class<?> iface) throws SQLException
java.sql.Wrapper
isWrapperFor
on the wrapped
object. If this does not implement the interface and is not a wrapper, return false.
This method should be implemented as a low-cost operation compared to unwrap
so that
callers can use this method to avoid expensive unwrap
calls that may fail. If this method
returns true then calling unwrap
with the same argument should succeed.isWrapperFor
in interface Wrapper
iface
- a Class defining an interface.SQLException
- if an error occurs while determining whether this is a wrapper
for an object with the given interface.public <T> T unwrap(Class<T> iface) throws SQLException
java.sql.Wrapper
unwrap
recursively on the wrapped object
or a proxy for that result. If the receiver is not a
wrapper and does not implement the interface, then an SQLException
is thrown.unwrap
in interface Wrapper
iface
- A Class defining an interface that the result must implement.SQLException
- If no object found that implements the interfacepublic String getSchema() throws SQLException
java.sql.Connection
Connection
object's current schema name.getSchema
in interface Connection
null
if there is noneSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setSchema(java.lang.String)
public void setSchema(String schema) throws SQLException
java.sql.Connection
If the driver does not support schemas, it will silently ignore this request.
Calling setSchema
has no effect on previously created or prepared
Statement
objects. It is implementation defined whether a DBMS
prepare operation takes place immediately when the Connection
method prepareStatement
or prepareCall
is invoked.
For maximum portability, setSchema
should be called before a
Statement
is created or prepared.
setSchema
in interface Connection
schema
- the name of a schema in which to workSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.getSchema()
public void abort(Executor executor) throws SQLException
java.sql.Connection
abort
results in:
SQLException
.
Calling abort
marks the connection closed and releases any
resources. Calling abort
on a closed connection is a
no-op.
It is possible that the aborting and releasing of the resources that are
held by the connection can take an extended period of time. When the
abort
method returns, the connection will have been marked as
closed and the Executor
that was passed as a parameter to abort
may still be executing tasks to release resources.
This method checks to see that there is an SQLPermission
object before allowing the method to proceed. If a
SecurityManager
exists and its
checkPermission
method denies calling abort
,
this method throws a
java.lang.SecurityException
.
abort
in interface Connection
executor
- The Executor
implementation which will
be used by abort
.SQLException
- if a database access error occurs or
the executor
is null
,SecurityManager.checkPermission(java.security.Permission)
,
Executor
public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException
java.sql.Connection
Connection
or
objects created from the Connection
will wait for the database to reply to any one request. If any
request remains unanswered, the waiting method will
return with a SQLException
, and the Connection
or objects created from the Connection
will be marked as
closed. Any subsequent use of
the objects, with the exception of the close
,
isClosed
or Connection.isValid
methods, will result in a SQLException
.
Note: This method is intended to address a rare but serious
condition where network partitions can cause threads issuing JDBC calls
to hang uninterruptedly in socket reads, until the OS TCP-TIMEOUT
(typically 10 minutes). This method is related to the
abort()
method which provides an administrator
thread a means to free any such threads in cases where the
JDBC connection is accessible to the administrator thread.
The setNetworkTimeout
method will cover cases where
there is no administrator thread, or it has no access to the
connection. This method is severe in it's effects, and should be
given a high enough value so it is never triggered before any more
normal timeouts, such as transaction timeouts.
JDBC driver implementations may also choose to support the
setNetworkTimeout
method to impose a limit on database
response time, in environments where no network is present.
Drivers may internally implement some or all of their API calls with multiple internal driver-database transmissions, and it is left to the driver implementation to determine whether the limit will be applied always to the response to the API call, or to any single request made during the API call.
This method can be invoked more than once, such as to set a limit for an area of JDBC code, and to reset to the default on exit from this area. Invocation of this method has no impact on already outstanding requests.
The Statement.setQueryTimeout()
timeout value is independent of the
timeout value specified in setNetworkTimeout
. If the query timeout
expires before the network timeout then the
statement execution will be canceled. If the network is still
active the result will be that both the statement and connection
are still usable. However if the network timeout expires before
the query timeout or if the statement timeout fails due to network
problems, the connection will be marked as closed, any resources held by
the connection will be released and both the connection and
statement will be unusable.
When the driver determines that the setNetworkTimeout
timeout
value has expired, the JDBC driver marks the connection
closed and releases any resources held by the connection.
This method checks to see that there is an SQLPermission
object before allowing the method to proceed. If a
SecurityManager
exists and its
checkPermission
method denies calling
setNetworkTimeout
, this method throws a
java.lang.SecurityException
.
setNetworkTimeout
in interface Connection
executor
- The Executor
implementation which will
be used by setNetworkTimeout
.milliseconds
- The time in milliseconds to wait for the database
operation
to complete. If the JDBC driver does not support milliseconds, the
JDBC driver will round the value up to the nearest second. If the
timeout period expires before the operation
completes, a SQLException will be thrown.
A value of 0 indicates that there is not timeout for database operations.SQLException
- if a database access error occurs, this
method is called on a closed connection,
the executor
is null
,
or the value specified for seconds
is less than 0.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSecurityManager.checkPermission(java.security.Permission)
,
Statement.setQueryTimeout(int)
,
Connection.getNetworkTimeout()
,
Connection.abort(java.util.concurrent.Executor)
,
Executor
public int getNetworkTimeout() throws SQLException
java.sql.Connection
SQLException
is thrown.getNetworkTimeout
in interface Connection
SQLException
- if a database access error occurs or
this method is called on a closed Connection
SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodConnection.setNetworkTimeout(java.util.concurrent.Executor, int)
public void setHoldability(int holdability) throws SQLException
java.sql.Connection
ResultSet
objects
created using this Connection
object to the given
holdability. The default holdability of ResultSet
objects
can be be determined by invoking
DatabaseMetaData.getResultSetHoldability()
.setHoldability
in interface Connection
holdability
- a ResultSet
holdability constant; one of
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access occurs, this method is called
on a closed connection, or the given parameter
is not a ResultSet
constant indicating holdabilitySQLFeatureNotSupportedException
- if the given holdability is not supportedConnection.getHoldability()
,
DatabaseMetaData.getResultSetHoldability()
,
ResultSet
public int getHoldability() throws SQLException
java.sql.Connection
ResultSet
objects
created using this Connection
object.getHoldability
in interface Connection
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setHoldability(int)
,
DatabaseMetaData.getResultSetHoldability()
,
ResultSet
public Savepoint setSavepoint() throws SQLException
java.sql.Connection
Savepoint
object that represents it.
if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.
setSavepoint
in interface Connection
Savepoint
objectSQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection
or this Connection
object is currently in
auto-commit modeSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSavepoint
public Savepoint setSavepoint(String name) throws SQLException
java.sql.Connection
Savepoint
object that represents it.
if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.
setSavepoint
in interface Connection
name
- a String
containing the name of the savepointSavepoint
objectSQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection
or this Connection
object is currently in
auto-commit modeSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSavepoint
public void rollback(Savepoint savepoint) throws SQLException
java.sql.Connection
Savepoint
object
was set.
This method should be used only when auto-commit has been disabled.
rollback
in interface Connection
savepoint
- the Savepoint
object to roll back toSQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection,
the Savepoint
object is no longer valid,
or this Connection
object is currently in
auto-commit modeSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSavepoint
,
Connection.rollback()
public void releaseSavepoint(Savepoint savepoint) throws SQLException
java.sql.Connection
Savepoint
and subsequent Savepoint
objects from the current
transaction. Any reference to the savepoint after it have been removed
will cause an SQLException
to be thrown.releaseSavepoint
in interface Connection
savepoint
- the Savepoint
object to be removedSQLException
- if a database access error occurs, this
method is called on a closed connection or
the given Savepoint
object is not a valid
savepoint in the current transactionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
java.sql.Connection
Statement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the createStatement
method
above, but it allows the default result set
type and concurrency to be overridden.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.createStatement
in interface Connection
resultSetType
- a result set type; one of
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- a concurrency type; one of
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
Statement
object that will generate
ResultSet
objects with the given type and
concurrencySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type and concurrencySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type and result set concurrency.public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
java.sql.Connection
PreparedStatement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the prepareStatement
method
above, but it allows the default result set
type and concurrency to be overridden.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.prepareStatement
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain one or more '?' IN
parametersresultSetType
- a result set type; one of
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- a concurrency type; one of
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
ResultSet
objects with the given type and concurrencySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type and concurrencySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type and result set concurrency.public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
java.sql.Connection
CallableStatement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the prepareCall
method
above, but it allows the default result set
type and concurrency to be overridden.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.prepareCall
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain on or more '?' parametersresultSetType
- a result set type; one of
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- a concurrency type; one of
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
CallableStatement
object containing the
pre-compiled SQL statement that will produce ResultSet
objects with the given type and concurrencySQLException
- if a database access error occurs, this method
is called on a closed connection
or the given parameters are not ResultSet
constants indicating type and concurrencySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type and result set concurrency.public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
java.sql.Connection
PreparedStatement
object that has
the capability to retrieve auto-generated keys. The given constant
tells the driver whether it should make auto-generated keys
available for retrieval. This parameter is ignored if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
Note: This method is optimized for handling
parametric SQL statements that benefit from precompilation. If
the driver supports precompilation,
the method prepareStatement
will send
the statement to the database for precompilation. Some drivers
may not support precompilation. In this case, the statement may
not be sent to the database until the PreparedStatement
object is executed. This has no direct effect on users; however, it does
affect which methods throw certain SQLExceptions.
Result sets created using the returned PreparedStatement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholdersautoGeneratedKeys
- a flag indicating whether auto-generated keys
should be returned; one of
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
PreparedStatement
object, containing the
pre-compiled SQL statement, that will have the capability of
returning auto-generated keysSQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameter is not a Statement
constant indicating whether auto-generated keys should be
returnedSQLFeatureNotSupportedException
- if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYSpublic PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
java.sql.Connection
PreparedStatement
object capable
of returning the auto-generated keys designated by the given array.
This array contains the indexes of the columns in the target
table that contain the auto-generated keys that should be made
available. The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
An SQL statement with or without IN parameters can be
pre-compiled and stored in a PreparedStatement
object. This
object can then be used to efficiently execute this statement
multiple times.
Note: This method is optimized for handling
parametric SQL statements that benefit from precompilation. If
the driver supports precompilation,
the method prepareStatement
will send
the statement to the database for precompilation. Some drivers
may not support precompilation. In this case, the statement may
not be sent to the database until the PreparedStatement
object is executed. This has no direct effect on users; however, it does
affect which methods throw certain SQLExceptions.
Result sets created using the returned PreparedStatement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholderscolumnIndexes
- an array of column indexes indicating the columns
that should be returned from the inserted row or rowsPreparedStatement
object, containing the
pre-compiled statement, that is capable of returning the
auto-generated keys designated by the given array of column
indexesSQLException
- if a database access error occurs
or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
java.sql.Connection
PreparedStatement
object capable
of returning the auto-generated keys designated by the given array.
This array contains the names of the columns in the target
table that contain the auto-generated keys that should be returned.
The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
An SQL statement with or without IN parameters can be
pre-compiled and stored in a PreparedStatement
object. This
object can then be used to efficiently execute this statement
multiple times.
Note: This method is optimized for handling
parametric SQL statements that benefit from precompilation. If
the driver supports precompilation,
the method prepareStatement
will send
the statement to the database for precompilation. Some drivers
may not support precompilation. In this case, the statement may
not be sent to the database until the PreparedStatement
object is executed. This has no direct effect on users; however, it does
affect which methods throw certain SQLExceptions.
Result sets created using the returned PreparedStatement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholderscolumnNames
- an array of column names indicating the columns
that should be returned from the inserted row or rowsPreparedStatement
object, containing the
pre-compiled statement, that is capable of returning the
auto-generated keys designated by the given array of column
namesSQLException
- if a database access error occurs
or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic final Map<String,String> getParameterStatuses()
PGConnection
Returns the current values of all parameters reported by the server.
PostgreSQL reports values for a subset of parameters (GUCs) to the client
at connect-time, then sends update messages whenever the values change
during a session. PgJDBC records the latest values and exposes it to client
applications via getParameterStatuses()
.
PgJDBC exposes individual accessors for some of these parameters as listed below. They are more backwarrds-compatible and should be preferred where possible.
Not all parameters are reported, only those marked
GUC_REPORT
in the source code. The pg_settings
view does not expose information about which parameters are reportable.
PgJDBC's map will only contain the parameters the server reports values
for, so you cannot use this method as a substitute for running a
SHOW paramname;
or SELECT
current_setting('paramname');
query for arbitrary parameters.
Parameter names are case-insensitive and case-preserving
in this map, like in PostgreSQL itself. So DateStyle
and
datestyle
are the same key.
As of PostgreSQL 11 the reportable parameter list, and related PgJDBC interfaces or accesors, are:
application_name
-
Connection.getClientInfo()
,
Connection.setClientInfo(java.util.Properties)
and ApplicationName
connection property.
client_encoding
- PgJDBC always sets this to UTF8
.
See allowEncodingChanges
connection property.
DateStyle
- PgJDBC requires this to always be set to ISO
standard_conforming_strings
- indirectly via PGConnection.escapeLiteral(String)
TimeZone
- set from JDK timezone see TimeZone.getDefault()
and TimeZone.setDefault(TimeZone)
integer_datetimes
IntervalStyle
server_encoding
server_version
is_superuser
session_authorization
Note that some PgJDBC operations will change server parameters automatically.
getParameterStatuses
in interface PGConnection
public final String getParameterStatus(String parameterName)
PGConnection
getParameterStatus
in interface PGConnection
parameterName
- case-insensitive parameter namePGConnection.getParameterStatuses()
Copyright © 2020 PostgreSQL Global Development Group. All rights reserved.