Module org.postgresql.pljava.internal

Package org.postgresql.pljava.jdbc

Class SPIConnection

java.lang.Object

org.postgresql.pljava.jdbc.SPIConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

public class SPIConnection
extends Object
implements Connection

Provides access to the current connection (session) the Java stored procedure is running in. It is returned from the driver manager with DriverManager.getConnection("jdbc:default:connection"); and cannot be managed in any way since it's already running inside a transaction. This means the following methods cannot be used.

• commit()
• rollback()
• setAutoCommit()
• setTransactionIsolation()

Author:

Thomas Hallgren

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	JDBC_TYPE_NAMES
static final int[]	JDBC_TYPE_NUMBERS

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor	Description
SPIConnection()

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)
void	clearWarnings()	Warnings are not yet supported.
void	close()	This is a no-op.
void	commit()	It's not legal to do a commit within a call from SQL.
Array	createArrayOf(String typeName, Object[] elements)
Blob	createBlob()
Clob	createClob()
NClob	createNClob()
SQLXML	createSQLXML()
Statement	createStatement()	Creates a new instance of SPIStatement.
Statement	createStatement(int resultSetType, int resultSetConcurrency)	Creates a new instance of SPIStatement.
Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)	Creates a new instance of SPIStatement.
Struct	createStruct(String typeName, Object[] attributes)
boolean	getAutoCommit()	It is assumed that an SPI call is under transaction control.
String	getCatalog()	Returns the database in which we are running.
Properties	getClientInfo()
String	getClientInfo(String name)
static Connection	getDefault()	Returns a default connection instance.
int	getHoldability()	Returns ResultSet.CLOSE_CURSORS_AT_COMMIT.
DatabaseMetaData	getMetaData()	Retrieves an instance of SPIDatabaseMetaData representing this Connection object.
int	getNetworkTimeout()
String	getPGType(Oid oid)	Map the Oid of a PostgreSQL type to its name (specifically, the typname attribute of pg_type.
String	getSchema()
int	getSQLType(String pgTypeName)	Convert a PostgreSQL type name to a Types integer, using the JDBC_TYPE_NAMES/JDBC_TYPE_NUMBERS arrays; used in DatabaseMetaData and ResultSetMetaData.
int	getSQLType(Oid oid)	This returns the Types type for a PG type oid, by mapping it to a name using getPGType(org.postgresql.pljava.internal.Oid) and then to the result via getSQLType(String); used in ResultSetMetaData and five places in DatabaseMetaData.
int	getTransactionIsolation()	Returns Connection.TRANSACTION_READ_COMMITTED.
Map<String,Class<?>>	getTypeMap()	Returns null.
int[]	getVersionNumber()	Return the server version number as a three-element int array (of which the third may be null), as used in the getDatabase...Version methods of DatabaseMetaData.
SQLWarning	getWarnings()	Warnings are not yet supported.
boolean	isClosed()	Will always return false.
boolean	isReadOnly()	Returns false.
boolean	isValid(int timeout)
boolean	isWrapperFor(Class<?> iface)
String	nativeSQL(String sql)	Parse the JDBC SQL into PostgreSQL.
String	nativeSQL(String sql, int[] paramCountRet)
CallableStatement	prepareCall(String sql)	Procedure calls are not yet implemented.
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)	Procedure calls are not yet implemented.
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)	Procedure calls are not yet implemented.
PreparedStatement	prepareStatement(String sql)	Creates a new instance of SPIPreparedStatement.
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)	Return of auto generated keys is not yet supported.
PreparedStatement	prepareStatement(String sql, int[] columnIndexes)	Return of auto generated keys is not yet supported.
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)	Creates a new instance of SPIPreparedStatement.
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)	Creates a new instance of SPIPreparedStatement.
PreparedStatement	prepareStatement(String sql, String[] columnNames)	Return of auto generated keys is not yet supported.
void	releaseSavepoint(Savepoint savepoint)
void	rollback()	It's not legal to do a rollback within a call from SQL.
void	rollback(Savepoint savepoint)
void	setAutoCommit(boolean autoCommit)	It is assumed that an SPI call is under transaction control.
void	setCatalog(String catalog)	The catalog name cannot be set.
void	setClientInfo(String name, String value)
void	setClientInfo(Properties properties)
void	setHoldability(int holdability)	Change of holdability is not supported.
void	setNetworkTimeout(Executor executor, int milliseconds)
void	setReadOnly(boolean readOnly)	It is assumed that an inserts and updates can be performed using and SPIConnection.
Savepoint	setSavepoint()
Savepoint	setSavepoint(String name)
void	setSchema(String schema)
void	setTransactionIsolation(int level)	Change of transaction isolation level is not supported.
void	setTypeMap(Map<String,Class<?>> map)	Type map is not yet implemented.
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Connection

beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Field Details

JDBC_TYPE_NAMES

public static final String[] JDBC_TYPE_NAMES

JDBC_TYPE_NUMBERS

public static final int[] JDBC_TYPE_NUMBERS

Constructor Details

SPIConnection

public SPIConnection()

Method Details

getDefault

public static Connection getDefault()
                             throws SQLException

Returns a default connection instance. It is normally the caller's responsibility to close this instance, but as close is a no-op for this connection, that isn't critical.

Throws:

SQLException

getHoldability

public int getHoldability()

Returns ResultSet.CLOSE_CURSORS_AT_COMMIT.

Specified by:

getHoldability in interface Connection

getTransactionIsolation

public int getTransactionIsolation()

Returns Connection.TRANSACTION_READ_COMMITTED.

Specified by:

getTransactionIsolation in interface Connection

clearWarnings

public void clearWarnings()
                   throws SQLException

Warnings are not yet supported.

Specified by:

clearWarnings in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

close

public void close()

This is a no-op. The default connection never closes.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

commit

public void commit()
            throws SQLException

It's not legal to do a commit within a call from SQL.

Specified by:

commit in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

rollback

public void rollback()
              throws SQLException

It's not legal to do a rollback within a call from SQL.

Specified by:

rollback in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

getAutoCommit

public boolean getAutoCommit()

It is assumed that an SPI call is under transaction control. This method will always return false.

Specified by:

getAutoCommit in interface Connection

isClosed

public boolean isClosed()

Will always return false.

Specified by:

isClosed in interface Connection

isReadOnly

public boolean isReadOnly()

Returns false. The SPIConnection is not real-only.

Specified by:

isReadOnly in interface Connection

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Change of holdability is not supported.

Specified by:

setHoldability in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Change of transaction isolation level is not supported.

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

It is assumed that an SPI call is under transaction control. Changing that is not supported.

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

It is assumed that an inserts and updates can be performed using and SPIConnection. Changing that is not supported.

Specified by:

setReadOnly in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

getCatalog

public String getCatalog()
                  throws SQLException

Returns the database in which we are running.

Specified by:

getCatalog in interface Connection

Throws:

SQLException

setCatalog

public void setCatalog(String catalog)
                throws SQLException

The catalog name cannot be set.

Specified by:

setCatalog in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

getMetaData

public DatabaseMetaData getMetaData()

Retrieves an instance of SPIDatabaseMetaData representing this Connection object. The metadata includes information about the SQL grammar supported by PostgreSQL, the capabilities of PL/Java, as well as the tables and stored procedures for this connection and so on.

Specified by:

getMetaData in interface Connection

Returns:

an SPIDatabaseMetaData object for this Connection object

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Warnings are not yet supported.

Specified by:

getWarnings in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement()
                          throws SQLException

Creates a new instance of SPIStatement.

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int resultSetType,
 int resultSetConcurrency)
                          throws SQLException

Creates a new instance of SPIStatement.

Specified by:

createStatement in interface Connection

Throws:

SQLException - if the resultSetType differs from ResultSet.TYPE_FORWARD_ONLY or if the resultSetConcurrencty differs from ResultSet.CONCUR_READ_ONLY.

createStatement

public Statement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                          throws SQLException

Creates a new instance of SPIStatement.

Specified by:

createStatement in interface Connection

Throws:

SQLException - if the resultSetType differs from ResultSet.TYPE_FORWARD_ONLY, if the resultSetConcurrencty differs from ResultSet.CONCUR_READ_ONLY, or if the resultSetHoldability differs from ResultSet.CLOSE_CURSORS_AT_COMMIT.

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException

Returns null. Type map is not yet imlemented.

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

setTypeMap

public void setTypeMap(Map<String,Class<?>> map)
                throws SQLException

Type map is not yet implemented.

Specified by:

setTypeMap in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Parse the JDBC SQL into PostgreSQL.

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

nativeSQL

public String nativeSQL(String sql,
 int[] paramCountRet)

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Procedure calls are not yet implemented.

Specified by:

prepareCall in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

prepareCall

public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                              throws SQLException

Procedure calls are not yet implemented.

Specified by:

prepareCall in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

prepareCall

public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                              throws SQLException

Procedure calls are not yet implemented.

Specified by:

prepareCall in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Creates a new instance of SPIPreparedStatement.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int autoGeneratedKeys)
                                   throws SQLException

Return of auto generated keys is not yet supported.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                   throws SQLException

Creates a new instance of SPIPreparedStatement.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException - if the resultSetType differs from ResultSet.TYPE_FORWARD_ONLY or if the resultSetConcurrencty differs from ResultSet.CONCUR_READ_ONLY.

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                   throws SQLException

Creates a new instance of SPIPreparedStatement.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException - if the resultSetType differs from ResultSet.TYPE_FORWARD_ONLY, if the resultSetConcurrencty differs from ResultSet.CONCUR_READ_ONLY, or if the resultSetHoldability differs from ResultSet.CLOSE_CURSORS_AT_COMMIT.

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int[] columnIndexes)
                                   throws SQLException

Return of auto generated keys is not yet supported.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

prepareStatement

public PreparedStatement prepareStatement(String sql,
 String[] columnNames)
                                   throws SQLException

Return of auto generated keys is not yet supported.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException - indicating that this feature is not supported.

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

getVersionNumber

public int[] getVersionNumber()
                       throws SQLException

Return the server version number as a three-element int array (of which the third may be null), as used in the getDatabase...Version methods of DatabaseMetaData.

Throws:

SQLException

getSQLType

public int getSQLType(String pgTypeName)

Convert a PostgreSQL type name to a Types integer, using the JDBC_TYPE_NAMES/JDBC_TYPE_NUMBERS arrays; used in DatabaseMetaData and ResultSetMetaData.

getSQLType

public int getSQLType(Oid oid)
               throws SQLException

This returns the Types type for a PG type oid, by mapping it to a name using getPGType(org.postgresql.pljava.internal.Oid) and then to the result via getSQLType(String); used in ResultSetMetaData and five places in DatabaseMetaData.

This method is a bit goofy, as it first maps from Oid to type name, and then from name to JDBC type, all to accomplish the inverse of the JDBC type / Oid mapping that already exists in Oid.c, and so the mapping arrays in this file have to be updated in sync with that. Look into future consolidation....

Parameters:

oid - PostgreSQL type oid

Returns:

the java.sql.Types type

Throws:

SQLException - if a database access error occurs

getPGType

public String getPGType(Oid oid)
                 throws SQLException

Map the Oid of a PostgreSQL type to its name (specifically, the typname attribute of pg_type. Used in DatabaseMetaData and ResultSetMetaData.

Throws:

SQLException

isValid

public boolean isValid(int timeout)
                throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

setClientInfo

public void setClientInfo(String name,
 String value)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setClientInfo

public void setClientInfo(Properties properties)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

getClientInfo

public String getClientInfo(String name)
                     throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getClientInfo

public Properties getClientInfo()
                         throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStruct

public Struct createStruct(String typeName,
 Object[] attributes)
                    throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

createArrayOf

public Array createArrayOf(String typeName,
 Object[] elements)
                    throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createNClob

public NClob createNClob()
                  throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createClob

public Clob createClob()
                throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
 int milliseconds)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Specified by:

getSchema in interface Connection

Throws:

SQLException

setSchema

public void setSchema(String schema)
               throws SQLException

Specified by:

setSchema in interface Connection

Throws:

SQLException