org.mule.db.commons.internal.domain.connection

Interface DbConnection

All Superinterfaces:

org.mule.runtime.extension.api.tx.Transactional, org.mule.runtime.extension.api.connectivity.TransactionalConnection

All Known Implementing Classes:

DefaultDbConnection, XADbConnection

public interface DbConnection
extends org.mule.runtime.extension.api.connectivity.TransactionalConnection

Wraps a Connection adding connector's specific functionality

Method Summary

Modifier and Type	Method and Description
void	abortActiveLobStreams() Resets the count of the returned results that are streams that still need to be consumed.
void	beginStreaming() Starts streaming.
default Array	createArrayOf(String typeName, Object value) Creates an Array of the given typeName with the given values
default Array	createArrayOf(String typeName, Object[] values) Creates an Array of the given typeName with the given values
default Struct	createStruct(String typeName, Object[] values) Creates an Struct of the given typeName with the given values
void	decrementActiveLobStreams() Decrements the count of the returned results that are streams that need to be consumed.
void	endStreaming() Marks that the streaming is over
List<DbType>	getCustomDataTypes()
default Optional<DbType>	getDbTypeByVendor(String typeName, ResultSet procedureColumns)
Connection	getJdbcConnection()
default ResultSet	getProcedureColumns(String storedProcedureName, String storedProcedureOwner, String storedProcedureParentOwner, String catalogName) Retrieves a description of the given stored procedure parameter and result columns.
default Optional<String>	getProcedureColumnType(String procedureName, String columnName, String owner) Returns the type name of a Stored Procedure Column
StatementResultIteratorFactory	getStatementResultIteratorFactory(ResultSetHandler resultSetHandler) Returns the StatementResultIteratorFactory used to create the StatementResultIterator for this connection.
default Set<String>	getTables() Returns all the available tables of the current Database.
List<DbType>	getVendorDataTypes()
boolean	hasActiveLobStreams() Finds out if there are open LOB streams in the results that need to be consumed.
void	incrementActiveLobStreams() Increments the count of the returned results that are streams that need to be consumed.
boolean	isStreaming()
boolean	isTransactionActive()
void	release() Closes the underlying JDBC connection, provided that isStreaming() is false
boolean	supportsContentStreaming()

Methods inherited from interface org.mule.runtime.extension.api.tx.Transactional

begin, commit, rollback

Method Detail

getStatementResultIteratorFactory

StatementResultIteratorFactory getStatementResultIteratorFactory(ResultSetHandler resultSetHandler)

Returns the StatementResultIteratorFactory used to create the StatementResultIterator for this connection.

Parameters:

resultSetHandler - used to process resultSets created from this connection

Returns:

the StatementResultIterator for this connection.

getCustomDataTypes

List<DbType> getCustomDataTypes()

Returns:

A list of customer defined DbTypes

getVendorDataTypes

List<DbType> getVendorDataTypes()

Returns:

A list of DbTypes which are specific to the Database vendor

getJdbcConnection

Connection getJdbcConnection()

Returns:

The underlying JDBC connection

release

void release()

Closes the underlying JDBC connection, provided that isStreaming() is false

beginStreaming

void beginStreaming()

Starts streaming. Invoke this method when a streaming resultset generated with this connection is about to be iterated

isStreaming

boolean isStreaming()

Returns:

whether beginStreaming() has been invoked on this instance but endStreaming() has not

endStreaming

void endStreaming()

Marks that the streaming is over

isTransactionActive

boolean isTransactionActive()

Returns:

a boolean indicating if the current connection is being part of a Transaction.

supportsContentStreaming

boolean supportsContentStreaming()

Returns:

a boolean indicating if the current connection supports to stream the fetched content

Since:

1.3.4

incrementActiveLobStreams

void incrementActiveLobStreams()

Increments the count of the returned results that are streams that need to be consumed.

decrementActiveLobStreams

void decrementActiveLobStreams()

Decrements the count of the returned results that are streams that need to be consumed.

abortActiveLobStreams

void abortActiveLobStreams()

Resets the count of the returned results that are streams that still need to be consumed.

hasActiveLobStreams

boolean hasActiveLobStreams()

Finds out if there are open LOB streams in the results that need to be consumed.

Returns:

A boolean indicating if there are open LOB streams that still need to be read.

createArrayOf

default Array createArrayOf(String typeName,
                            Object[] values)
                     throws SQLException

Creates an Array of the given typeName with the given values

Parameters:

typeName - The Array type name

values - The values to convert to an Array

Returns:

The created Array

Throws:

SQLException - if an error occurs trying to create the array.

Since:

1.5.0

createArrayOf

default Array createArrayOf(String typeName,
                            Object value)
                     throws SQLException

Creates an Array of the given typeName with the given values

Parameters:

typeName - The Array type name

value - The values to convert to an Array

Returns:

The created Array

Throws:

SQLException - if an error occurs trying to create the array.

Since:

1.5.0

createStruct

default Struct createStruct(String typeName,
                            Object[] values)
                     throws SQLException

Creates an Struct of the given typeName with the given values

Parameters:

typeName - The Struct type name

values - The values to convert to an Struct

Returns:

The created Struct

Throws:

SQLException - if an error occurs trying to create the struct.

Since:

1.5.2

getProcedureColumns

default ResultSet getProcedureColumns(String storedProcedureName,
                                      String storedProcedureOwner,
                                      String storedProcedureParentOwner,
                                      String catalogName)
                               throws SQLException

Retrieves a description of the given stored procedure parameter and result columns. For more information DatabaseMetaData.getProcedureColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

Some Databases assign a different meaning to each parameter. You should override this method when needed.

Parameters:

storedProcedureName - the stored procedure name

storedProcedureOwner - the owner of the stored procedure

storedProcedureParentOwner - the owner of the owner of the stored procedure

catalogName - the catalog name where the stored procedure is defined

Returns:

ResultSet - each row describes a stored procedure parameter or column

Throws:

SQLException - if a database access error occurs

getProcedureColumnType

default Optional<String> getProcedureColumnType(String procedureName,
                                                String columnName,
                                                String owner)
                                         throws SQLException

Returns the type name of a Stored Procedure Column

Parameters:

procedureName - The Stored Procedure name

columnName - Name of the column name

owner - The owner of the stored procedure

Returns:

An Optional String with the Column type Name

Throws:

SQLException - if an error occurs trying to obtain the column name

Since:

1.5.0

getTables

default Set<String> getTables()
                       throws SQLException

Returns all the available tables of the current Database.

Returns:

A Set with all the table names

Throws:

SQLException - if an error occurs trying to obtain the table names

Since:

1.5.0

getDbTypeByVendor

default Optional<DbType> getDbTypeByVendor(String typeName,
                                           ResultSet procedureColumns)
                                    throws SQLException

Throws:

SQLException