org.firebirdsql.gds

Interface GDS

public interface GDS

The interface GDS has most of the C client interface functions lightly mapped to java, as well as the constants returned from the server.

Version:

1.0

Author:

Alejandro Alberola, David Jencks

Method Summary

Modifier and Type	Method and Description
void	close() Close this GDS instance.
BlobParameterBuffer	createBlobParameterBuffer() Create a new BlobParameterBuffer instance for setting blob parameters in the current GDS implementation.
DatabaseParameterBuffer	createDatabaseParameterBuffer() Create a new DatabaseParameterBuffer instance for setting database parameters in the current GDS implementation.
EventHandle	createEventHandle(java.lang.String eventName) Create a new EventHandle specific to a given GDS implementation.
IscBlobHandle	createIscBlobHandle() Factory method to create a new IscBlobHandle instance specific to the implementation of this interface.
IscDbHandle	createIscDbHandle() Factory method to create a new IscDbHandle instance specific to the implementation of this interface.
IscStmtHandle	createIscStmtHandle() Factory method to create a new IscStmtHandle instance specific to the implementation of this interface.
IscSvcHandle	createIscSvcHandle() Factory method to create a new IscSvcHandle instance that is linked to the current GDS implemenation.
IscTrHandle	createIscTrHandle() Factory method to create a new IscTrHandle instance that is linked to the current GDS implementation.
ServiceParameterBuffer	createServiceParameterBuffer() Create a new ServiceParameterBuffer instance for setting service parameters in the current GDS implementation.
ServiceRequestBuffer	createServiceRequestBuffer(int taskIdentifier) Create a new ServiceRequestBuffer instance for setting service request parameters in the current GDS implementation.
void	fbCancelOperation(IscDbHandle dbHandle, int kind) Cancel the currently running operation on the server
void	getSqlCounts(IscStmtHandle stmt) Fetch count information for a statement.
org.firebirdsql.gds.impl.GDSType	getType() Get type of this instance.
void	iscAttachDatabase(java.lang.String fileName, IscDbHandle dbHandle, DatabaseParameterBuffer databaseParameterBuffer) Attach to an existing database via a filename.
byte[]	iscBlobInfo(IscBlobHandle handle, byte[] items, int bufferLength) Retrieve data about an existing blob.
void	iscCancelEvents(IscDbHandle dbHandle, EventHandle eventHandle) Cancel event listening based on an EventHandle.
void	iscCloseBlob(IscBlobHandle blob) Close an open blob.
void	iscCommitRetaining(IscTrHandle trHandle)
void	iscCommitTransaction(IscTrHandle trHandle) Commit a transaction.
void	iscCreateBlob2(IscDbHandle db, IscTrHandle tr, IscBlobHandle blob, BlobParameterBuffer blobParameterBuffer) Create a new blob within a given transaction.
void	iscCreateDatabase(java.lang.String fileName, IscDbHandle dbHandle, DatabaseParameterBuffer databaseParameterBuffer) Create a database based on the supplied filename and database parameters.
byte[]	iscDatabaseInfo(IscDbHandle dbHandle, byte[] items, int bufferLength) Get information about the database to which IscDbHandle is attached.
void	iscDetachDatabase(IscDbHandle dbHandle) Detach the given database handle from its database.
void	iscDropDatabase(IscDbHandle dbHandle) Drop (delete) the database to which IscDbHandle is attached.
void	iscDsqlAllocateStatement(IscDbHandle dbHandle, IscStmtHandle stmtHandle) Allocate a dynamic SQL (DSQL) statement on the database to which IscDbHandle is attached.
XSQLDA	iscDsqlDescribe(IscStmtHandle stmtHandle, int daVersion) Retrieve data for a statement.
XSQLDA	iscDsqlDescribeBind(IscStmtHandle stmtHandle, int daVersion) Retrieve data for a bind statement.
void	iscDsqlExecImmed2(IscDbHandle dbHandle, IscTrHandle trHandle, byte[] statement, int dialect, XSQLDA inXSQLDA, XSQLDA outXSQLDA) Execute a string SQL statement directly, without first allocating a statement handle.
void	iscDsqlExecImmed2(IscDbHandle dbHandle, IscTrHandle trHandle, java.lang.String statement, int dialect, XSQLDA inXSQLDA, XSQLDA outXSQLDA) Execute a string SQL statement directly, without first allocating a statement handle.
void	iscDsqlExecImmed2(IscDbHandle dbHandle, IscTrHandle trHandle, java.lang.String statement, java.lang.String encoding, int dialect, XSQLDA inXSQLDA, XSQLDA outXSQLDA) Deprecated. use iscDsqlExecImmed2(IscDbHandle, IscTrHandle, byte[], int, XSQLDA, XSQLDA)
void	iscDsqlExecute(IscTrHandle trHandle, IscStmtHandle stmtHandle, int daVersion, XSQLDA xsqlda) Execute a statement with only outgoing data.
void	iscDsqlExecute2(IscTrHandle trHandle, IscStmtHandle stmtHandle, int daVersion, XSQLDA inXSQLDA, XSQLDA outXSQLDA) Execute a statement with outgoing and incoming data.
void	iscDsqlExecuteImmediate(IscDbHandle dbHandle, IscTrHandle trHandle, byte[] statement, int dialect, XSQLDA xsqlda) Execute a string SQL statement directly, without first allocating a statement handle.
void	iscDsqlExecuteImmediate(IscDbHandle dbHandle, IscTrHandle trHandle, java.lang.String statement, int dialect, XSQLDA xsqlda) Execute a string SQL statement directly, without first allocating a statement handle.
void	iscDsqlExecuteImmediate(IscDbHandle dbHandle, IscTrHandle trHandle, java.lang.String statement, java.lang.String encoding, int dialect, XSQLDA xsqlda) Deprecated. use iscDsqlExecuteImmediate(IscDbHandle, IscTrHandle, byte[], int, XSQLDA)
void	iscDsqlFetch(IscStmtHandle stmt_handle, int daVersion, XSQLDA xsqlda, int fetchSize) Retrieve record data from a statement.
void	iscDsqlFreeStatement(IscStmtHandle stmtHandle, int option) Free a statement in the database that is pointed to by a valid handle.
XSQLDA	iscDsqlPrepare(IscTrHandle trHandle, IscStmtHandle stmtHandle, byte[] statement, int dialect) Prepare a string SQL statement for execution in the database.
XSQLDA	iscDsqlPrepare(IscTrHandle trHandle, IscStmtHandle stmtHandle, java.lang.String statement, int dialect) Prepare a string SQL statement for execution in the database.
XSQLDA	iscDsqlPrepare(IscTrHandle trHandle, IscStmtHandle stmtHandle, java.lang.String statement, java.lang.String encoding, int dialect) Deprecated. use iscDsqlPrepare(IscTrHandle, IscStmtHandle, byte[], int)
void	iscDsqlSetCursorName(IscStmtHandle stmtHandle, java.lang.String cursorName, int type) Set the name to be used for a given statement.
byte[]	iscDsqlSqlInfo(IscStmtHandle stmtHandle, byte[] items, int bufferLength) Retrieve data about a statement.
void	iscEventBlock(EventHandle eventHandle) Initialize the internal databastructures for an EventHandle.
void	iscEventCounts(EventHandle eventHandle) Retrieve count information after an event has occurred.
byte[]	iscGetSegment(IscBlobHandle blob, int maxread) Fetch a segment of a blob.
void	iscOpenBlob2(IscDbHandle db, IscTrHandle tr, IscBlobHandle blob, BlobParameterBuffer blobParameterBuffer) Open a blob within a given transaction.
void	iscPrepareTransaction(IscTrHandle trHandle)
void	iscPrepareTransaction2(IscTrHandle trHandle, byte[] bytes)
void	iscPutSegment(IscBlobHandle blob_handle, byte[] buffer) Write a segment of data to a blob.
int	iscQueueEvents(IscDbHandle dbHandle, EventHandle eventHandle, EventHandler eventHandler) Queue an EventHandler.
void	iscReconnectTransaction(IscTrHandle trHandle, IscDbHandle dbHandle, long transactionId) Reconnect "in limbo" transaction using new database handle.
void	iscRollbackRetaining(IscTrHandle trHandle)
void	iscRollbackTransaction(IscTrHandle trHandle) Rollback a transaction.
void	iscSeekBlob(IscBlobHandle handle, int position, int seekMode) Seek to a given position in a blob.
void	iscServiceAttach(java.lang.String service, IscSvcHandle serviceHandle, ServiceParameterBuffer serviceParameterBuffer) Attach to a Service Manager.
void	iscServiceDetach(IscSvcHandle serviceHandle) Detach from a Service Manager.
void	iscServiceQuery(IscSvcHandle serviceHandle, ServiceParameterBuffer serviceParameterBuffer, ServiceRequestBuffer serviceRequestBuffer, byte[] resultBuffer) Query a service manager
void	iscServiceStart(IscSvcHandle serviceHandle, ServiceRequestBuffer serviceRequestBuffer) Start a service operation.
void	iscStartTransaction(IscTrHandle trHandle, IscDbHandle dbHandle, TransactionParameterBuffer tpb) Start a transaction based on a handle to a transaction.
byte[]	iscTransactionInformation(IscTrHandle trHandle, byte[] requestBuffer, int bufferLen)
int	iscVaxInteger(byte[] buffer, int pos, int length) Retrieve an integer value from a sequence of bytes.
long	iscVaxLong(byte[] buffer, int pos, int length) Retrieve an long value from a sequence of bytes.
TransactionParameterBuffer	newTransactionParameterBuffer() Create new TransactionParameterBuffer instance for setting transaction parameters in the current GDS implementation.

Method Detail

createIscDbHandle

IscDbHandle createIscDbHandle()

Factory method to create a new IscDbHandle instance specific to the implementation of this interface.

Returns:

instance of IscDbHandle

createIscTrHandle

IscTrHandle createIscTrHandle()

Factory method to create a new IscTrHandle instance that is linked to the current GDS implementation.

Returns:

A new IscTrHandle instance

createIscStmtHandle

IscStmtHandle createIscStmtHandle()

Factory method to create a new IscStmtHandle instance specific to the implementation of this interface.

Returns:

A new IscStmtHandle instance

createIscBlobHandle

IscBlobHandle createIscBlobHandle()

Factory method to create a new IscBlobHandle instance specific to the implementation of this interface.

Returns:

A new IscBlobHandle instance

createIscSvcHandle

IscSvcHandle createIscSvcHandle()

Factory method to create a new IscSvcHandle instance that is linked to the current GDS implemenation.

Returns:

A new IscSvcHandle instance

createServiceParameterBuffer

ServiceParameterBuffer createServiceParameterBuffer()

Create a new ServiceParameterBuffer instance for setting service parameters in the current GDS implementation.

Returns:

a new ServiceParameterBuffer

createServiceRequestBuffer

ServiceRequestBuffer createServiceRequestBuffer(int taskIdentifier)

Create a new ServiceRequestBuffer instance for setting service request parameters in the current GDS implementation. The returned ServiceRequestBuffer is linked to a specific Services API task, and must be one of the isc_info_svc_* or isc_action_svc constants from ISCConstants.

Parameters:

taskIdentifier - The specific Services API task for which the ServiceRequestBuffer is created

Returns:

A new ServiceRequestBuffer

createDatabaseParameterBuffer

DatabaseParameterBuffer createDatabaseParameterBuffer()

Create a new DatabaseParameterBuffer instance for setting database parameters in the current GDS implementation.

Returns:

A new DatabaseParameterBuffer

createBlobParameterBuffer

BlobParameterBuffer createBlobParameterBuffer()

Create a new BlobParameterBuffer instance for setting blob parameters in the current GDS implementation.

Returns:

A new BlobParameterBuffer

newTransactionParameterBuffer

TransactionParameterBuffer newTransactionParameterBuffer()

Create new TransactionParameterBuffer instance for setting transaction parameters in the current GDS implementation.

Returns:

A new TransactionParameterBuffer .

close

void close()

Close this GDS instance.

iscCreateDatabase

void iscCreateDatabase(java.lang.String fileName,
                       IscDbHandle dbHandle,
                       DatabaseParameterBuffer databaseParameterBuffer)
                throws GDSException

Create a database based on the supplied filename and database parameters. The supplied IscDbHandle is attached to the newly created database.

Parameters:

fileName - The filename for the new database, including host and port. The expected format is host:port:filepath. The value for host is localhost if not supplied. The value for port is 3050 if not supplied.

dbHandle - The handle to attach to the new database

databaseParameterBuffer - The parameters for the new database and attachment to it

Throws:

GDSException - if an error occurs while creating the database

iscAttachDatabase

void iscAttachDatabase(java.lang.String fileName,
                       IscDbHandle dbHandle,
                       DatabaseParameterBuffer databaseParameterBuffer)
                throws GDSException

Attach to an existing database via a filename.

Parameters:

fileName - The filename for the database, including host and port. The expected format is <host name>/<port>:<file path>. The value for host is localhost if not supplied. The value for port is 3050 if not supplied.

dbHandle - The handle to attach to the database

databaseParameterBuffer - parameters for the database attachment

Throws:

GDSException - if an error occurs while attaching to the database

iscDatabaseInfo

byte[] iscDatabaseInfo(IscDbHandle dbHandle,
                       byte[] items,
                       int bufferLength)
                throws GDSException

Get information about the database to which IscDbHandle is attached. The requested parameters are values set in items, and the values in the returned byte-array correspond to the requested parameters in items

Parameters:

dbHandle - Handle to the database for which info is to be retrieved

items - An array of values from the isc_info_* constant fields from ISCConstants

bufferLength - The size of the byte array that is to be returned

Returns:

array of bytes whose values correspond the requested parameters in items

Throws:

GDSException - if an error occurs while retrieving database info

iscDetachDatabase

void iscDetachDatabase(IscDbHandle dbHandle)
                throws GDSException

Detach the given database handle from its database. This effectively closes the connection to the database.

Parameters:

dbHandle - The handle to be detached

Throws:

GDSException - if an error occurs while detaching from the database

iscDropDatabase

void iscDropDatabase(IscDbHandle dbHandle)
              throws GDSException

Drop (delete) the database to which IscDbHandle is attached.

Parameters:

dbHandle - Handle to the database to be dropped

Throws:

GDSException - if an error occurs while dropping the database

iscStartTransaction

void iscStartTransaction(IscTrHandle trHandle,
                         IscDbHandle dbHandle,
                         TransactionParameterBuffer tpb)
                  throws GDSException

Start a transaction based on a handle to a transaction.

Parameters:

trHandle - Handle to the transaction that is to be started

dbHandle - Handle to the database in which the transaction is to be started

tpb - Transaction Parameter Block in the form of a byte array, contains parameter data for the transaction attributes

Throws:

GDSException - if an error occurs while starting the transaction

See Also:

createIscTrHandle()

iscReconnectTransaction

void iscReconnectTransaction(IscTrHandle trHandle,
                             IscDbHandle dbHandle,
                             long transactionId)
                      throws GDSException

Reconnect "in limbo" transaction using new database handle.

Parameters:

trHandle - transaction handle that will be reconnected.

dbHandle - database handle in which "in limbo" transaction will be reconnected.

transactionId - ID of the transaction to reconnect.

Throws:

GDSException - if something went wrong.

iscCommitTransaction

void iscCommitTransaction(IscTrHandle trHandle)
                   throws GDSException

Commit a transaction.

Parameters:

trHandle - Handle to the transaction to be committed.

Throws:

GDSException - if an error occurs while committing the transaction

See Also:

iscRollbackTransaction(IscTrHandle)

iscCommitRetaining

void iscCommitRetaining(IscTrHandle trHandle)
                 throws GDSException

Throws:

GDSException

iscPrepareTransaction

void iscPrepareTransaction(IscTrHandle trHandle)
                    throws GDSException

Throws:

GDSException

iscPrepareTransaction2

void iscPrepareTransaction2(IscTrHandle trHandle,
                            byte[] bytes)
                     throws GDSException

Throws:

GDSException

iscRollbackTransaction

void iscRollbackTransaction(IscTrHandle trHandle)
                     throws GDSException

Rollback a transaction.

Parameters:

trHandle - Handle to the transaction that is to be rolled back

Throws:

GDSException - if an error occurs while rolling back

See Also:

iscCommitTransaction(IscTrHandle)

iscRollbackRetaining

void iscRollbackRetaining(IscTrHandle trHandle)
                   throws GDSException

Throws:

GDSException

iscTransactionInformation

byte[] iscTransactionInformation(IscTrHandle trHandle,
                                 byte[] requestBuffer,
                                 int bufferLen)
                          throws GDSException

Throws:

GDSException

iscDsqlAllocateStatement

void iscDsqlAllocateStatement(IscDbHandle dbHandle,
                              IscStmtHandle stmtHandle)
                       throws GDSException

Allocate a dynamic SQL (DSQL) statement on the database to which IscDbHandle is attached.

Parameters:

dbHandle - Handle to the database where the statement is to be allocated

stmtHandle - Handle to attach to the newly allocated statement

Throws:

GDSException - if an error occurs while allocating the statement

iscDsqlDescribe

XSQLDA iscDsqlDescribe(IscStmtHandle stmtHandle,
                       int daVersion)
                throws GDSException

Retrieve data for a statement.

Parameters:

stmtHandle - Handle to the statement about which data is to be retrieved

daVersion - Version of the XSQLDA to be retrieved

Returns:

data for the given statement

Throws:

GDSException - if an error occurs while retrieving statement data

iscDsqlDescribeBind

XSQLDA iscDsqlDescribeBind(IscStmtHandle stmtHandle,
                           int daVersion)
                    throws GDSException

Retrieve data for a bind statement.

Parameters:

stmtHandle - Handle to the bind statement about which bind data is to be retrieved

daVersion - Version of the XSQLDA to be retrieved

Returns:

data for the given bind statement

Throws:

GDSException - if an error occurs while retrieving statement data

iscDsqlExecute

void iscDsqlExecute(IscTrHandle trHandle,
                    IscStmtHandle stmtHandle,
                    int daVersion,
                    XSQLDA xsqlda)
             throws GDSException

Execute a statement with only outgoing data.

Parameters:

trHandle - Handle to the transaction in which the statement is to be executed

stmtHandle - Handle to the statement to be executed

daVersion - Version of XSQLDA to be used

xsqlda - Input data for executing the statement

Throws:

GDSException - if an error occurs while executing the statement

iscDsqlExecute2

void iscDsqlExecute2(IscTrHandle trHandle,
                     IscStmtHandle stmtHandle,
                     int daVersion,
                     XSQLDA inXSQLDA,
                     XSQLDA outXSQLDA)
              throws GDSException

Execute a statement with outgoing and incoming data.

Parameters:

trHandle - Handle to the transaction in which the statement is to be executed

stmtHandle - Handle to the statement to be executed

daVersion - Version of XSQLDA to be used

inXSQLDA - Data to be sent to the database for the statement

outXSQLDA - Holder for data to be received from executing the statement

Throws:

GDSException - if an error occurs while executing the statement

iscDsqlExecuteImmediate

void iscDsqlExecuteImmediate(IscDbHandle dbHandle,
                             IscTrHandle trHandle,
                             java.lang.String statement,
                             int dialect,
                             XSQLDA xsqlda)
                      throws GDSException

Execute a string SQL statement directly, without first allocating a statement handle. No data is retrieved using this method.

Parameters:

dbHandle - Handle to the database where the statement is to be executed

trHandle - Handle to the transaction in which the statement is to be executed

statement - SQL command to be executed

dialect - Interbase dialect for the SQL, should be one of the SQL_DIALECT_* constants from ISCConstants

xsqlda - Data to be sent to the database for the statement

Throws:

GDSException - if an error occurs while executing the statement

iscDsqlExecuteImmediate

void iscDsqlExecuteImmediate(IscDbHandle dbHandle,
                             IscTrHandle trHandle,
                             java.lang.String statement,
                             java.lang.String encoding,
                             int dialect,
                             XSQLDA xsqlda)
                      throws GDSException

Deprecated. use iscDsqlExecuteImmediate(IscDbHandle, IscTrHandle, byte[], int, XSQLDA)

Throws:

GDSException

iscDsqlExecuteImmediate

void iscDsqlExecuteImmediate(IscDbHandle dbHandle,
                             IscTrHandle trHandle,
                             byte[] statement,
                             int dialect,
                             XSQLDA xsqlda)
                      throws GDSException

Execute a string SQL statement directly, without first allocating a statement handle. No data is retrieved using this method.

Parameters:

dbHandle - Handle to the database where the statement is to be executed

trHandle - Handle to the transaction in which the statement is to be executed

statement - byte array holding the SQL to be executed

dialect - Interbase dialect for the SQL, should be one of the SQL_DIALECT_* constants from ISCConstants

xsqlda - Data to be sent to the database for the statement

Throws:

GDSException - if an error occurs while executing the statement

iscDsqlExecImmed2

void iscDsqlExecImmed2(IscDbHandle dbHandle,
                       IscTrHandle trHandle,
                       java.lang.String statement,
                       int dialect,
                       XSQLDA inXSQLDA,
                       XSQLDA outXSQLDA)
                throws GDSException

Execute a string SQL statement directly, without first allocating a statement handle. Data is retrieved using this method.

Parameters:

dbHandle - Handle to the database where the statement is to be executed

trHandle - Handle to the transaction in which the statement is to be executed

statement - byte array holding the SQL to be executed

dialect - Interbase dialect for the SQL, should be one of the SQL_DIALECT_* constants from ISCConstants

inXSQLDA - Data to be sent to the database for the statement

outXSQLDA - Placeholder for data retrieved from executing the SQL statement

Throws:

GDSException - if an error occurs while executing the statement

iscDsqlExecImmed2

void iscDsqlExecImmed2(IscDbHandle dbHandle,
                       IscTrHandle trHandle,
                       java.lang.String statement,
                       java.lang.String encoding,
                       int dialect,
                       XSQLDA inXSQLDA,
                       XSQLDA outXSQLDA)
                throws GDSException

Deprecated. use iscDsqlExecImmed2(IscDbHandle, IscTrHandle, byte[], int, XSQLDA, XSQLDA)

Throws:

GDSException

iscDsqlExecImmed2

void iscDsqlExecImmed2(IscDbHandle dbHandle,
                       IscTrHandle trHandle,
                       byte[] statement,
                       int dialect,
                       XSQLDA inXSQLDA,
                       XSQLDA outXSQLDA)
                throws GDSException

Execute a string SQL statement directly, without first allocating a statement handle. Output data from executing the statement is stored in outXSQLDA.

Parameters:

dbHandle - Handle to the database where the statement is to be executed

trHandle - Handle to the transaction in which the statement is to be executed

statement - byte array holding the SQL to be executed

dialect - Interbase dialect for the SQL, should be one of the SQL_DIALECT_* constants from ISCConstants

inXSQLDA - Data to be sent to the database for the statement

outXSQLDA - Holder for data retrieved from the database

Throws:

GDSException - if an error occurs while executing the statement

iscDsqlFetch

void iscDsqlFetch(IscStmtHandle stmt_handle,
                  int daVersion,
                  XSQLDA xsqlda,
                  int fetchSize)
           throws GDSException

Retrieve record data from a statement. A maximum of fetchSize records will be fetched.

Parameters:

stmt_handle - Handle to the statement for which records are to be fetched

daVersion - Version of XSQLDA to be used

xsqlda - Holder for records that are fetched

fetchSize - The maximum number of records to be fetched

Throws:

GDSException - if an error occurs while fetching the records

iscDsqlFreeStatement

void iscDsqlFreeStatement(IscStmtHandle stmtHandle,
                          int option)
                   throws GDSException

Free a statement in the database that is pointed to by a valid handle. The statement can be closed or fully deallocated, depending on the value of option. option should be one of ISCConstants.DSQL_drop or ISCConstants.DSQL_close.

Parameters:

stmtHandle - Handle to the statement to be freed

option - Option to be used when freeing the statement. If the value is ISCConstants.DSQL_drop, the statement will be deallocated, if the value is ISCConstants.DSQL_close, the statement will only be closed

Throws:

GDSException - If an error occurs freeing the statement

iscDsqlPrepare

XSQLDA iscDsqlPrepare(IscTrHandle trHandle,
                      IscStmtHandle stmtHandle,
                      java.lang.String statement,
                      int dialect)
               throws GDSException

Prepare a string SQL statement for execution in the database.

Parameters:

trHandle - Handle to the transaction in which the SQL statement is to be prepared

stmtHandle - Handle to the statement for which the SQL is to be prepared

statement - The SQL statement to be prepared

dialect - Interbase dialect for the SQL, should be one of the SQL_DIALECT_* constants from ISCConstants

Returns:

A datastructure with data about the prepared statement

Throws:

GDSException - if an error occurs while preparing the SQL

iscDsqlPrepare

XSQLDA iscDsqlPrepare(IscTrHandle trHandle,
                      IscStmtHandle stmtHandle,
                      java.lang.String statement,
                      java.lang.String encoding,
                      int dialect)
               throws GDSException

Deprecated. use iscDsqlPrepare(IscTrHandle, IscStmtHandle, byte[], int)

Throws:

GDSException

iscDsqlPrepare

XSQLDA iscDsqlPrepare(IscTrHandle trHandle,
                      IscStmtHandle stmtHandle,
                      byte[] statement,
                      int dialect)
               throws GDSException

Prepare a string SQL statement for execution in the database.

Parameters:

trHandle - Handle to the transaction in which the SQL statement is to be prepared

stmtHandle - Handle to the statement for which the SQL is to be prepared

statement - byte-array with containing the SQL to be prepared

dialect - Interbase dialect for the SQL, should be one of the SQL_DIALECT_* constants from ISCConstants

Returns:

A datastructure with data about the prepared statement

Throws:

GDSException - if an error occurs while preparing the SQL

iscDsqlSetCursorName

void iscDsqlSetCursorName(IscStmtHandle stmtHandle,
                          java.lang.String cursorName,
                          int type)
                   throws GDSException

Set the name to be used for a given statement.

Parameters:

stmtHandle - Handle to the statement for which the cursor name is to be set

cursorName - Name to set for the cursor

type - Reserved for future use

Throws:

GDSException - if an error occurs while setting the cursor name

iscDsqlSqlInfo

byte[] iscDsqlSqlInfo(IscStmtHandle stmtHandle,
                      byte[] items,
                      int bufferLength)
               throws GDSException

Retrieve data about a statement. The parameters that are requested are defined by the isc_info_sql_* constants defined in ISCConstants. An array with corresponding values for the requested parameters is returned.

Parameters:

stmtHandle - Handle to the statement about which data is to be retrieved

items - Array of parameters whose values are to be retrieved

bufferLength - The length of the byte-array to be returned

Returns:

An array of values corresponding to the requested parameters

Throws:

GDSException - if an error occurs while retrieving the statement info

getSqlCounts

void getSqlCounts(IscStmtHandle stmt)
           throws GDSException

Fetch count information for a statement. The count information that is retrieved includes counts for all CRUD operations, and is set in the handle itself.

Parameters:

stmt - Handle to the statement for which count data is to be retrieved

Throws:

GDSException - if an error occurs while retrieving the count data

iscVaxInteger

int iscVaxInteger(byte[] buffer,
                  int pos,
                  int length)

Retrieve an integer value from a sequence of bytes.

Parameters:

buffer - The byte array from which the integer is to be retrieved

pos - The offset starting position from which to start retrieving byte values

length - The number of bytes to use in retrieving the integer value.

Returns:

The integer value retrieved from the bytes

iscVaxLong

long iscVaxLong(byte[] buffer,
                int pos,
                int length)

Retrieve an long value from a sequence of bytes.

Parameters:

buffer - The byte array from which the integer is to be retrieved

pos - The offset starting position from which to start retrieving byte values

length - The number of bytes to use in retrieving the long value.

Returns:

The long value retrieved from the bytes

iscCreateBlob2

void iscCreateBlob2(IscDbHandle db,
                    IscTrHandle tr,
                    IscBlobHandle blob,
                    BlobParameterBuffer blobParameterBuffer)
             throws GDSException

Create a new blob within a given transaction.

Parameters:

db - Handle to the database in which the blob will be created

tr - Handle to the transaction in which the blob will be created

blob - Handle to be attached to the newly created blob

blobParameterBuffer - contains parameters for creation of the new blob, can be null

Throws:

GDSException - if an error occurs while creating the blob

iscOpenBlob2

void iscOpenBlob2(IscDbHandle db,
                  IscTrHandle tr,
                  IscBlobHandle blob,
                  BlobParameterBuffer blobParameterBuffer)
           throws GDSException

Open a blob within a given transaction.

Parameters:

db - Handle to the database in which the blob will be opened

tr - Handle to the transaction in which the blob will be opened

blob - Handle to the blob to be opened

blobParameterBuffer - Contains parameters for the blob

Throws:

GDSException - if an error occurs while opening the blob

iscGetSegment

byte[] iscGetSegment(IscBlobHandle blob,
                     int maxread)
              throws GDSException

Fetch a segment of a blob.

Parameters:

blob - Handle to the blob from which a segment is to be fetched

maxread - The maximum number of bytes to attempt to fetch

Returns:

A segment of data from the blob, with maximum length of maxread

Throws:

GDSException - if an error occurs while fetching the blob segment

iscPutSegment

void iscPutSegment(IscBlobHandle blob_handle,
                   byte[] buffer)
            throws GDSException

Write a segment of data to a blob.

Parameters:

blob_handle - Handle to the blob to which data is to be written

buffer - Data to be written to the blob

Throws:

GDSException - if an error occurs while writing to the blob

iscCloseBlob

void iscCloseBlob(IscBlobHandle blob)
           throws GDSException

Close an open blob.

Parameters:

blob - Handle to the blob to be closed

Throws:

GDSException - if an error occurs while closing the blob

iscBlobInfo

byte[] iscBlobInfo(IscBlobHandle handle,
                   byte[] items,
                   int bufferLength)
            throws GDSException

Retrieve data about an existing blob. The parameters to be retrieved are placed in items, and the corresponding values are returned. The values in items should be isc_info_blob_* constants from ISCConstants.

Parameters:

handle - Handle to the blob for which data is to be retrieved

items - Parameters to be fetched about the blob

bufferLength - Length of the byte array to be returned

Returns:

Data corresponding to the parameters requested in items

Throws:

GDSException - if an error occurs while fetching data about the blob

iscSeekBlob

void iscSeekBlob(IscBlobHandle handle,
                 int position,
                 int seekMode)
          throws GDSException

Seek to a given position in a blob. seekMode is used in the same way as the system fseek call, i.e.:

• 0 - seek relative to the start of the blob
• 1 - seek relative to the current position in the blob
• 2 - seek relative to the end of the blob

position is the offset number of bytes to seek to, relative to the position described by seekMode. Seeking can only be done in a forward direction.

Parameters:

handle - Handle to the blob for which seeking will be done

position - The offset number of bytes to seek to

seekMode - Describes the base point to be used in seeking, should be negative if seekMode is equal to 2

Throws:

GDSException - if an error occurs while seeking

iscServiceAttach

void iscServiceAttach(java.lang.String service,
                      IscSvcHandle serviceHandle,
                      ServiceParameterBuffer serviceParameterBuffer)
               throws GDSException

Attach to a Service Manager.

Parameters:

service - The name/path to the service manager

serviceHandle - Handle to be linked to the attached service manager

serviceParameterBuffer - Contains parameters for attaching to the service manager

Throws:

GDSException - if an error occurs while attaching

iscServiceDetach

void iscServiceDetach(IscSvcHandle serviceHandle)
               throws GDSException

Detach from a Service Manager.

Parameters:

serviceHandle - Handle to the service manager that is to be detached

Throws:

GDSException - if an error occurs while detaching

iscServiceStart

void iscServiceStart(IscSvcHandle serviceHandle,
                     ServiceRequestBuffer serviceRequestBuffer)
              throws GDSException

Start a service operation.

Parameters:

serviceHandle - Handle to the service manager where the operation is to be started

serviceRequestBuffer - parameters about the service to be started

Throws:

GDSException

iscServiceQuery

void iscServiceQuery(IscSvcHandle serviceHandle,
                     ServiceParameterBuffer serviceParameterBuffer,
                     ServiceRequestBuffer serviceRequestBuffer,
                     byte[] resultBuffer)
              throws GDSException

Query a service manager

Parameters:

serviceHandle - Handle to the service manager to be queried

serviceParameterBuffer - parameters about the service

serviceRequestBuffer - parameters requested in the query

resultBuffer - buffer to hold the query results

Throws:

GDSException - if an error occurs while querying

iscQueueEvents

int iscQueueEvents(IscDbHandle dbHandle,
                   EventHandle eventHandle,
                   EventHandler eventHandler)
            throws GDSException

Queue an EventHandler.

Parameters:

dbHandle - Handle to the database where events are to be listened for

eventHandle - Handle for event management

eventHandler - Callback to be called when an event occurs

Throws:

GDSException - If a database communication error occurs

iscEventBlock

void iscEventBlock(EventHandle eventHandle)
            throws GDSException

Initialize the internal databastructures for an EventHandle.

Parameters:

eventHandle - The event handle to be initialized

Throws:

GDSException - If a database communication error occurs

iscEventCounts

void iscEventCounts(EventHandle eventHandle)
             throws GDSException

Retrieve count information after an event has occurred.

Parameters:

eventHandle - The handle containing event data

Throws:

GDSException - If a database communication error occurs

iscCancelEvents

void iscCancelEvents(IscDbHandle dbHandle,
                     EventHandle eventHandle)
              throws GDSException

Cancel event listening based on an EventHandle.

Parameters:

dbHandle - Handle to the database where events are being listened for

eventHandle - Datastructure for handling event data

Throws:

GDSException - If a database communication error occurs

createEventHandle

EventHandle createEventHandle(java.lang.String eventName)

Create a new EventHandle specific to a given GDS implementation.

Returns:

The newly created EventHandle

fbCancelOperation

void fbCancelOperation(IscDbHandle dbHandle,
                       int kind)
                throws GDSException

Cancel the currently running operation on the server

Parameters:

dbHandle - Handle to the database operation of which should be cancelled.

kind - one of ISCConstants.fb_cancel_disable, ISCConstants.fb_cancel_enable, ISCConstants.fb_cancel_raise or ISCConstants.fb_cancel_abort

Throws:

GDSException - If a database communication error happens.

getType

org.firebirdsql.gds.impl.GDSType getType()

Get type of this instance.

Returns:

instance of GDSType.