Package nl.cwi.monetdb.jdbc
Class MonetConnection
java.lang.Object
nl.cwi.monetdb.jdbc.MonetWrapper
nl.cwi.monetdb.jdbc.MonetConnection
- All Implemented Interfaces:
AutoCloseable,Connection,Wrapper
public abstract class MonetConnection extends MonetWrapper implements Connection, AutoCloseable
A
Connection suitable for the MonetDB database.
This connection represents a connection (session) to a MonetDB
database. SQL statements are executed and results are returned within
the context of a connection. This Connection object holds a physical
connection to the MonetDB database.
A Connection object's database should able to provide information
describing its tables, its supported SQL grammar, its stored
procedures, the capabilities of this connection, and so on. This
information is obtained with the getMetaData method.
Note: By default a Connection object is in auto-commit mode, which
means that it automatically commits changes after executing each
statement. If auto-commit mode has been disabled, the method commit
must be called explicitly in order to commit changes; otherwise,
database changes will not be saved.
The current state of this connection is that it nearly implements the
whole Connection interface.- Version:
- 1.3
- Author:
- Fabian Groffen, Martin van Dinther, Pedro Ferreira
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classMonetConnection.ResponseListA list of Response objects. -
Field Summary
Fields Modifier and Type Field Description protected Propertiesconn_propsThe successful processed input propertiesprotected StringhashAuthentication hash methodprotected nl.cwi.monetdb.mcl.connection.IMonetDBLanguagelanguageThe language to connect withprotected intlastSetQueryTimeoutThe last set query timeout on the server as used by Statement, PreparedStatement and CallableStatementprotected nl.cwi.monetdb.mcl.protocol.AbstractProtocolprotocolThe underlying proticol provided by the connection (MAPI or embedded)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 MonetConnection(Properties props, String hash, nl.cwi.monetdb.mcl.connection.IMonetDBLanguage language, boolean blobIsBinary, boolean clobIsLongChar)Constructor of a Connection for MonetDB. -
Method Summary
Modifier and Type Method Description voidabort(Executor executor)Terminates an open connection.voidclearWarnings()Clears all warnings reported for this Connection object.voidclose()Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.abstract voidcloseUnderlyingConnection()Closes the underlying connection implementation.voidcommit()Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object.abstract List<String>connect(String user, String pass)Connects to the server, authenticating the user.ArraycreateArrayOf(String typeName, Object[] elements)Factory method for creating Array objects.BlobcreateBlob()Constructs an object that implements the Blob interface.ClobcreateClob()Constructs an object that implements the Clob interface.NClobcreateNClob()Constructs an object that implements the NClob interface.SQLXMLcreateSQLXML()Constructs an object that implements the SQLXML interface.StatementcreateStatement()Creates a Statement object for sending SQL statements to the database.StatementcreateStatement(int resultSetType, int resultSetConcurrency)Creates a Statement object that will generate ResultSet objects with the given type and concurrency.StatementcreateStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.StructcreateStruct(String typeName, Object[] attributes)Factory method for creating Struct objects.protected abstract booleanexecuteNextQueryBatch(MonetStatement statement, List<String> batch, int[] counts, BatchUpdateException e)Execute a batch of SQL query statements.protected voidfinalize()Destructor called by garbage collector before destroying this object tries to disconnect the MonetDB connection if it has not been disconnected already.booleangetAutoCommit()Retrieves the current auto-commit mode for this Connection object.abstract intgetBlockSize()Gets the underlying connection block size length.StringgetCatalog()Retrieves this Connection object's current catalog name.PropertiesgetClientInfo()Returns a list containing the name and current value of each client info property supported by the driver.StringgetClientInfo(String name)Returns the value of the client info property specified by name.abstract intgetDefFetchsize()Gets the underlying connection default fetch size for DataBlock responses.intgetHoldability()Retrieves the current holdability of ResultSet objects created using this Connection object.abstract StringgetJDBCURL()Gets the underlying connection JDBC String URL.nl.cwi.monetdb.mcl.connection.IMonetDBLanguagegetLanguage()Gets the connection's language data.DatabaseMetaDatagetMetaData()Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection.intgetNetworkTimeout()Retrieves the number of milliseconds the driver will wait for a database request to complete.nl.cwi.monetdb.mcl.protocol.AbstractProtocolgetProtocol()Gets the connection's protocol.StringgetSchema()Retrieves this Connection object's current schema name.static intgetSeqCounter()Gets the current sequence counter.abstract intgetSoTimeout()Gets the underlying connection socket timeout.intgetTransactionIsolation()Retrieves this Connection object's current transaction isolation level.Map<String,Class<?>>getTypeMap()Retrieves the Map object associated with this Connection object.SQLWarninggetWarnings()Retrieves the first warning reported by calls on this Connection object.abstract intinitialStringBuilderSize()Gets the initial value for the StringBuilder size.booleanisClosed()Retrieves whether this Connection object has been closed.booleanisEmbedded()Checks if the conection is embedded or notbooleanisReadOnly()Retrieves whether this Connection object is in read-only mode.booleanisValid(int timeout)Returns true if the connection has not been closed and is still valid.booleanmapBlobAsVarBinary()booleanmapClobAsVarChar()StringnativeSQL(String sql)Converts the given SQL statement into the system's native SQL grammar.CallableStatementprepareCall(String sql)Creates a CallableStatement object for calling database stored procedures.CallableStatementprepareCall(String sql, int resultSetType, int resultSetConcurrency)Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.CallableStatementprepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.PreparedStatementprepareStatement(String sql)Creates a PreparedStatement object for sending parameterized SQL statements to the database.PreparedStatementprepareStatement(String sql, int autoGeneratedKeys)Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.PreparedStatementprepareStatement(String sql, int[] columnIndexes)Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.PreparedStatementprepareStatement(String sql, int resultSetType, int resultSetConcurrency)Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.PreparedStatementprepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.PreparedStatementprepareStatement(String sql, String[] columnNames)Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.voidreleaseSavepoint(Savepoint savepoint)Removes the given Savepoint object from the current transaction.voidrollback()Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object.voidrollback(Savepoint savepoint)Undoes all changes made after the given Savepoint object was set.abstract voidsendControlCommand(int commandID, int data)Sends a control command to the server.voidsetAutoCommit(boolean autoCommit)Sets this connection's auto-commit mode to the given state.voidsetCatalog(String catalog)Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.voidsetClientInfo(String name, String value)Sets the value of the client info property specified by name to the value specified by value.voidsetClientInfo(Properties props)Sets the value of the connection's client info properties.voidsetHoldability(int holdability)Changes the default holdability of ResultSet objects created using this Connection object to the given holdability.voidsetNetworkTimeout(Executor executor, int millis)Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request.voidsetReadOnly(boolean readOnly)Puts this connection in read-only mode as a hint to the driver to enable database optimizations.SavepointsetSavepoint()Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.SavepointsetSavepoint(String name)Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.voidsetSchema(String schema)Sets the given schema name to access.abstract voidsetSoTimeout(int timeout)Sets the underlying connection socket timeout.voidsetTransactionIsolation(int level)Attempts to change the transaction isolation level for this Connection object to the one given.voidsetTypeMap(Map<String,Class<?>> map)Installs the given TypeMap object as the type map for this Connection object.StringtoString()Returns a string identifying this Connection to the MonetDB server.Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid
-
Field Details
-
conn_props
The successful processed input properties -
language
protected nl.cwi.monetdb.mcl.connection.IMonetDBLanguage languageThe language to connect with -
hash
Authentication hash method -
protocol
protected nl.cwi.monetdb.mcl.protocol.AbstractProtocol protocolThe underlying proticol provided by the connection (MAPI or embedded) -
lastSetQueryTimeout
protected int lastSetQueryTimeoutThe last set query timeout on the server as used by Statement, PreparedStatement and CallableStatement
-
-
Constructor Details
-
MonetConnection
public MonetConnection(Properties props, String hash, nl.cwi.monetdb.mcl.connection.IMonetDBLanguage language, boolean blobIsBinary, boolean clobIsLongChar)Constructor of a Connection for MonetDB. At this moment the current implementation limits itself to storing the given host, database, username and password for later use by the createStatement() call. This constructor is only accessible to classes from the jdbc package.- Parameters:
props- a Property hashtable holding the properties needed for connecting- Throws:
SQLException- if a database error occursIllegalArgumentException- is one of the arguments is null or empty
-
-
Method Details
-
getSeqCounter
public static int getSeqCounter()Gets the current sequence counter.- Returns:
- The current sequence counter
-
isEmbedded
public boolean isEmbedded()Checks if the conection is embedded or not- Returns:
- If the connection is embedded
-
getLanguage
public nl.cwi.monetdb.mcl.connection.IMonetDBLanguage getLanguage()Gets the connection's language data.- Returns:
- The connection's language data
-
getProtocol
public nl.cwi.monetdb.mcl.protocol.AbstractProtocol getProtocol()Gets the connection's protocol.- Returns:
- The connection's protocol
-
connect
public abstract List<String> connect(String user, String pass) throws IOException, nl.cwi.monetdb.mcl.protocol.ProtocolException, nl.cwi.monetdb.mcl.connection.MCLExceptionConnects to the server, authenticating the user.- Parameters:
user- The user name to authenticatepass- The user's password- Returns:
- A List with informational (warning) messages. If this list is empty; then there are no warnings.
- Throws:
IOException- if an I/O error occurs when creating the socketnl.cwi.monetdb.mcl.protocol.ProtocolException- if bogus data is receivednl.cwi.monetdb.mcl.connection.MCLException- if an MCL related error occurs
-
getBlockSize
public abstract int getBlockSize()Gets the underlying connection block size length.- Returns:
- The block size length
-
getDefFetchsize
public abstract int getDefFetchsize()Gets the underlying connection default fetch size for DataBlock responses.- Returns:
- The default fetch size
-
initialStringBuilderSize
public abstract int initialStringBuilderSize()Gets the initial value for the StringBuilder size.- Returns:
- The initial value for the StringBuilder size
-
getSoTimeout
Gets the underlying connection socket timeout.- Returns:
- The underlying connection socket timeout
- Throws:
SocketException
-
setSoTimeout
Sets the underlying connection socket timeout.- Parameters:
timeout- The specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout- Throws:
SocketException
-
closeUnderlyingConnection
Closes the underlying connection implementation.- Throws:
IOException- if an I/O error occurs while closing the connection
-
getJDBCURL
Gets the underlying connection JDBC String URL.- Returns:
- The underlying connection JDBC String URL
-
sendControlCommand
Sends a control command to the server.- Parameters:
commandID- The command identifier according toControlCommandslistingdata- The integer to send according to the control command- Throws:
SQLException- if an IO exception or a database error occurs
-
executeNextQueryBatch
protected abstract boolean executeNextQueryBatch(MonetStatement statement, List<String> batch, int[] counts, BatchUpdateException e) throws SQLExceptionExecute a batch of SQL query statements.- Parameters:
statement- The original MonetStatement where the batch comes frombatch- The list of queries to executecounts- The return of the update statement of each input querye- An exception to be thrown if an error occurs- Returns:
- If all queries in the batch executed successfully or not
- Throws:
SQLException- if an IO exception or a database error occurs
-
clearWarnings
public void clearWarnings()Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection object.- Specified by:
clearWarningsin interfaceConnection
-
close
public void close()Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released. All Statements created from this Connection will be closed when this method is called. Calling the method close on a Connection object that is already closed is a no-op.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceConnection
-
finalize
Destructor called by garbage collector before destroying this object tries to disconnect the MonetDB connection if it has not been disconnected already. -
commit
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.- Specified by:
commitin interfaceConnection- Throws:
SQLException- if a database access error occurs or this Connection object is in auto-commit mode- See Also:
setAutoCommit(boolean)
-
createStatement
Creates a 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.- Specified by:
createStatementin interfaceConnection- Returns:
- a new default Statement object
- Throws:
SQLException- if a database access error occurs
-
createStatement
Creates a 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.- Specified by:
createStatementin interfaceConnection- Parameters:
resultSetType- a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE- Returns:
- a new Statement object that will generate ResultSet objects with the given type and concurrency
- Throws:
SQLException- if a database access error occurs
-
createStatement
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLExceptionCreates a 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.- Specified by:
createStatementin interfaceConnection- Parameters:
resultSetType- one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
- Throws:
SQLException- if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
-
getAutoCommit
public boolean getAutoCommit()Retrieves the current auto-commit mode for this Connection object.- Specified by:
getAutoCommitin interfaceConnection- Returns:
- the current state of this Connection object's auto-commit mode
- See Also:
setAutoCommit(boolean)
-
getCatalog
Retrieves this Connection object's current catalog name.- Specified by:
getCatalogin interfaceConnection- Returns:
- the current catalog name or null if there is none
-
getHoldability
public int getHoldability()Retrieves the current holdability of ResultSet objects created using this Connection object.- Specified by:
getHoldabilityin interfaceConnection- Returns:
- the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
- See Also:
setHoldability(int)
-
getMetaData
Retrieves a 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.- Specified by:
getMetaDatain interfaceConnection- Returns:
- a DatabaseMetaData object for this Connection object
- Throws:
SQLException- if the current language is not SQL
-
getTransactionIsolation
public int getTransactionIsolation()Retrieves this Connection object's current transaction isolation level.- Specified by:
getTransactionIsolationin interfaceConnection- Returns:
- the current transaction isolation level, which will be Connection.TRANSACTION_SERIALIZABLE
-
getTypeMap
Retrieves the Map object associated with this Connection object. Unless the application has added an entry, the type map returned will be empty.- Specified by:
getTypeMapin interfaceConnection- Returns:
- the java.util.Map object associated with this Connection object
-
getWarnings
Retrieves the first warning reported by calls on this 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.- Specified by:
getWarningsin interfaceConnection- Returns:
- the first SQLWarning object or null if there are none
- Throws:
SQLException- if a database access error occurs or this method is called on a closed connection
-
isClosed
public boolean isClosed()Retrieves whether this 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.- Specified by:
isClosedin interfaceConnection- Returns:
- true if this Connection object is closed; false if it is still open
-
isReadOnly
public boolean isReadOnly()Retrieves whether this Connection object is in read-only mode. MonetDB currently doesn't support updateable result sets, but updates are possible. Hence the Connection object is never in read-only mode.- Specified by:
isReadOnlyin interfaceConnection- Returns:
- true if this Connection object is read-only; false otherwise
-
nativeSQL
Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it. This method returns the native form of the statement that the driver would have sent.- Specified by:
nativeSQLin interfaceConnection- Parameters:
sql- - an SQL statement that may contain one or more '?' parameter placeholders.- Returns:
- the native form of this statement
-
prepareCall
Creates a 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 getHoldability().- Specified by:
prepareCallin interfaceConnection- Parameters:
sql- - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is specified using JDBC call escape syntax.- Returns:
- a new default CallableStatement object containing the pre-compiled SQL statement
- Throws:
SQLException- - if a database access error occurs or this method is called on a closed connectionSQLFeatureNotSupportedException- - if the JDBC driver does not support this method.
-
prepareCall
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLExceptionCreates a 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 getHoldability().- Specified by:
prepareCallin interfaceConnection- Parameters:
sql- - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters Typically this statement is specified using JDBC call escape syntax.resultSetType- - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE- Returns:
- a new CallableStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
- Throws:
SQLException- - 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.
-
prepareCall
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLExceptionCreates a 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.- Specified by:
prepareCallin interfaceConnection- Parameters:
sql- - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters Typically this statement is specified using JDBC call escape syntax.resultSetType- - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLEresultSetHoldability- - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
- Throws:
SQLException- - 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.
-
prepareStatement
Creates a 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.- Specified by:
prepareStatementin interfaceConnection- Parameters:
sql- an SQL statement that may contain one or more '?' IN parameter placeholders- Returns:
- a new default PreparedStatement object containing the pre-compiled SQL statement
- Throws:
SQLException- if a database access error occurs
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLExceptionCreates a 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.- Specified by:
prepareStatementin interfaceConnection- Parameters:
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_SENSITIVEresultSetConcurrency- a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE- Returns:
- a new PreparedStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
- Throws:
SQLException- if a database access error occurs or the given parameters are not ResultSet constants indicating type and concurrency
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLExceptionCreates a 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.- Specified by:
prepareStatementin interfaceConnection- Parameters:
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_SENSITIVEresultSetConcurrency- one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLEresultSetHoldability- one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
- Throws:
SQLException- if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
-
prepareStatement
Creates a default 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. 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.- Specified by:
prepareStatementin interfaceConnection- Parameters:
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- Returns:
- a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
- Throws:
SQLException- - if a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned
-
prepareStatement
Creates a default 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 getHoldability().- Specified by:
prepareStatementin interfaceConnection- Parameters:
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 rows- Returns:
- a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
- Throws:
SQLException- - if a database access error occurs or this method is called on a closed connectionSQLFeatureNotSupportedException- - if the JDBC driver does not support this method
-
prepareStatement
Creates a default 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 getHoldability().- Specified by:
prepareStatementin interfaceConnection- Parameters:
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 rows- Returns:
- a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names
- Throws:
SQLException- - if a database access error occurs or this method is called on a closed connectionSQLFeatureNotSupportedException- - if the JDBC driver does not support this method
-
releaseSavepoint
Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.- Specified by:
releaseSavepointin interfaceConnection- Parameters:
savepoint- the Savepoint object to be removed- Throws:
SQLException- if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction
-
rollback
Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.- Specified by:
rollbackin interfaceConnection- Throws:
SQLException- if a database access error occurs or this Connection object is in auto-commit mode- See Also:
setAutoCommit(boolean)
-
rollback
Undoes all changes made after the given Savepoint object was set. This method should be used only when auto-commit has been disabled.- Specified by:
rollbackin interfaceConnection- Parameters:
savepoint- the Savepoint object to roll back to- Throws:
SQLException- if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode
-
setAutoCommit
Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode. The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet object, the statement completes when the last row of the ResultSet object has been retrieved or the ResultSet object has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases, the commit occurs when all results and output parameter values have been retrieved. NOTE: If this method is called during a transaction, the transaction is committed.- Specified by:
setAutoCommitin interfaceConnection- Parameters:
autoCommit- true to enable auto-commit mode; false to disable it- Throws:
SQLException- if a database access error occurs- See Also:
getAutoCommit()
-
setCatalog
Sets the given catalog name in order to select a subspace of this Connection object's database in which to work. If the driver does not support catalogs, it will silently ignore this request.- Specified by:
setCatalogin interfaceConnection
-
setHoldability
Changes the default holdability of 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().- Specified by:
setHoldabilityin interfaceConnection- Parameters:
holdability- - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT- Throws:
SQLException- - if a database access error occurs or this method is called on a closed connectionSQLFeatureNotSupportedException- - if the JDBC driver does not support this method or argument- See Also:
getHoldability()
-
setReadOnly
Puts this connection in read-only mode as a hint to the driver to enable database optimizations. MonetDB doesn't support any mode here, hence an SQLWarning is generated if attempted to set to true here.- Specified by:
setReadOnlyin interfaceConnection- Parameters:
readOnly- true enables read-only mode; false disables it- Throws:
SQLException- if a database access error occurs or this method is called during a transaction.
-
setSavepoint
Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.- Specified by:
setSavepointin interfaceConnection- Returns:
- the new Savepoint object
- Throws:
SQLException- if a database access error occurs or this Connection object is currently in auto-commit mode
-
setSavepoint
Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.- Specified by:
setSavepointin interfaceConnection- Parameters:
name- a String containing the name of the savepoint- Returns:
- the new Savepoint object
- Throws:
SQLException- if a database access error occurs or this Connection object is currently in auto-commit mode
-
setTransactionIsolation
public void setTransactionIsolation(int level)Attempts to change the transaction isolation level for this Connection object to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.- Specified by:
setTransactionIsolationin interfaceConnection- Parameters:
level- one of the following Connection constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE.
-
setTypeMap
Installs the given 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.- Specified by:
setTypeMapin interfaceConnection- Parameters:
map- the java.util.Map object to install as the replacement for this Connection object's default type map
-
toString
Returns a string identifying this Connection to the MonetDB server. -
createArrayOf
Factory method for creating Array objects. 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.- Specified by:
createArrayOfin interfaceConnection- Parameters:
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- Returns:
- an Array object whose elements map to the specified SQL type
- Throws:
SQLException- - 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 type- Since:
- 1.6
-
createClob
Constructs an object that implements the 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.- Specified by:
createClobin interfaceConnection- Returns:
- a MonetClob instance
- Throws:
SQLException- - 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.- Since:
- 1.6
-
createBlob
Constructs an object that implements the 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.- Specified by:
createBlobin interfaceConnection- Returns:
- a MonetBlob instance
- Throws:
SQLException- - 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.- Since:
- 1.6
-
createNClob
Constructs an object that implements the 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.- Specified by:
createNClobin interfaceConnection- Returns:
- an NClob instance
- Throws:
SQLException- - 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 type- Since:
- 1.6
-
createStruct
Factory method for creating Struct objects.- Specified by:
createStructin interfaceConnection- Parameters:
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 object- Returns:
- a Struct object that maps to the given SQL type and is populated with the given attributes
- Throws:
SQLException- - if an object that implements the Struct 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 type- Since:
- 1.6
-
createSQLXML
Constructs an object that implements the 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.- Specified by:
createSQLXMLin interfaceConnection- Returns:
- An object that implements the SQLXML interface
- Throws:
SQLException- - 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 type- Since:
- 1.6
-
isValid
Returns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called. The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.- Specified by:
isValidin interfaceConnection- Parameters:
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.- Returns:
- true if the connection is valid, false otherwise
- Throws:
SQLException- if the value supplied for timeout is less than 0- Since:
- 1.6
-
getClientInfo
Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver. Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.- Specified by:
getClientInfoin interfaceConnection- Parameters:
name- - The name of the client info property to retrieve- Returns:
- The value of the client info property specified or null
- Throws:
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- Since:
- 1.6
-
getClientInfo
Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.- Specified by:
getClientInfoin interfaceConnection- Returns:
- A Properties object that contains the name and current value of each of the client info properties supported by the driver.
- Throws:
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- Since:
- 1.6
-
setClientInfo
Sets the value of the client info property specified by name to the value specified by value. 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. ApplicationName - The name of the application currently utilizing the connection ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection. ClientHostname - The hostname of the computer the application using the connection is running on.- Specified by:
setClientInfoin interfaceConnection- Parameters:
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.- Throws:
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- Since:
- 1.6
-
setClientInfo
Sets the value of the connection's client info properties. The 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.- Specified by:
setClientInfoin interfaceConnection- Parameters:
props- - The list of client info properties to set- Throws:
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- Since:
- 1.6
-
setSchema
Sets the given schema name to access.- Specified by:
setSchemain interfaceConnection- Parameters:
schema- the name of a schema in which to work- Throws:
SQLException- if a database access error occurs or this method is called on a closed connection- Since:
- 1.7
-
getSchema
Retrieves this Connection object's current schema name.- Specified by:
getSchemain interfaceConnection- Returns:
- the current schema name or null if there is none
- Throws:
SQLException- if a database access error occurs or this method is called on a closed connection- Since:
- 1.7
-
abort
Terminates an open connection. Calling abort results in: * The connection marked as closed * Closes any physical connection to the database * Releases resources used by the connection * Insures that any thread that is currently accessing the connection will either progress to completion or throw an SQLException. Calling abort marks the connection closed and releases any resources. Calling abort on a closed connection is a no-op.- Specified by:
abortin interfaceConnection- Parameters:
executor- The Executor implementation which will be used by abort- Throws:
SQLException- if a database access error occurs or the executor is nullSecurityException- if a security manager exists and its checkPermission method denies calling abort- Since:
- 1.7
-
setNetworkTimeout
Sets the maximum period a 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.- Specified by:
setNetworkTimeoutin interfaceConnection- Parameters:
executor- The Executor implementation which will be used by setNetworkTimeoutmillis- The time in milliseconds to wait for the database operation to complete- Throws:
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.- Since:
- 1.7
-
getNetworkTimeout
Retrieves the number of milliseconds the driver will wait for a database request to complete. If the limit is exceeded, a SQLException is thrown.- Specified by:
getNetworkTimeoutin interfaceConnection- Returns:
- the current timeout limit in milliseconds; zero means there is no limit
- Throws:
SQLException- if a database access error occurs or this method is called on a closed Connection- Since:
- 1.7
-
mapBlobAsVarBinary
public boolean mapBlobAsVarBinary()- Returns:
- whether the JDBC BLOB type should be mapped to VARBINARY type. This allows generic JDBC programs to fetch Blob data via getBytes() instead of getBlob() and Blob.getBinaryStream() to reduce overhead.
-
mapClobAsVarChar
public boolean mapClobAsVarChar()- Returns:
- whether the JDBC CLOB type should be mapped to VARCHAR type. This allows generic JDBC programs to fetch Clob data via getString() instead of getClob() and Clob.getCharacterStream() to reduce overhead.
-