org.firebirdsql.gds
Interface GDS

All Known Implementing Classes:

AbstractGDS

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

void	close()
isc_blob_handle	get_new_isc_blob_handle()
isc_db_handle	get_new_isc_db_handle()
isc_stmt_handle	get_new_isc_stmt_handle()
isc_svc_handle	get_new_isc_svc_handle()
isc_tr_handle	get_new_isc_tr_handle()
void	getSqlCounts(isc_stmt_handle stmt)
GDSType	getType() Get the type of the GDS implementation.
void	isc_attach_database(java.lang.String file_name, isc_db_handle db_handle, DatabaseParameterBuffer databaseParameterBuffer)
byte[]	isc_blob_info(isc_blob_handle handle, byte[] items, int buffer_length)
void	isc_close_blob(isc_blob_handle blob)
void	isc_commit_retaining(isc_tr_handle tr_handle)
void	isc_commit_transaction(isc_tr_handle tr_handle)
void	isc_create_blob2(isc_db_handle db, isc_tr_handle tr, isc_blob_handle blob, BlobParameterBuffer blobParameterBuffer)
void	isc_create_database(java.lang.String file_name, isc_db_handle db_handle, DatabaseParameterBuffer databaseParameterBuffer)
byte[]	isc_database_info(isc_db_handle db_handle, byte[] items, int buffer_length)
void	isc_detach_database(isc_db_handle db_handle)
void	isc_drop_database(isc_db_handle db_handle)
void	isc_dsql_alloc_statement2(isc_db_handle db_handle, isc_stmt_handle stmt_handle)
void	isc_dsql_allocate_statement(isc_db_handle db_handle, isc_stmt_handle stmt_handle)
XSQLDA	isc_dsql_describe_bind(isc_stmt_handle stmt_handle, int da_version)
XSQLDA	isc_dsql_describe(isc_stmt_handle stmt_handle, int da_version)
void	isc_dsql_exec_immed2(isc_db_handle db_handle, isc_tr_handle tr_handle, byte[] statement, int dialect, XSQLDA in_xsqlda, XSQLDA out_xsqlda)
void	isc_dsql_exec_immed2(isc_db_handle db_handle, isc_tr_handle tr_handle, java.lang.String statement, int dialect, XSQLDA in_xsqlda, XSQLDA out_xsqlda)
void	isc_dsql_exec_immed2(isc_db_handle db_handle, isc_tr_handle tr_handle, java.lang.String statement, java.lang.String encoding, int dialect, XSQLDA in_xsqlda, XSQLDA out_xsqlda) Deprecated. use {@link #isc_dsql_exec_immed2(isc_db_handle, isc_tr_handle, byte[], int, XSQLDA)
void	isc_dsql_execute_immediate(isc_db_handle db_handle, isc_tr_handle tr_handle, byte[] statement, int dialect, XSQLDA xsqlda)
void	isc_dsql_execute_immediate(isc_db_handle db_handle, isc_tr_handle tr_handle, java.lang.String statement, int dialect, XSQLDA xsqlda)
void	isc_dsql_execute_immediate(isc_db_handle db_handle, isc_tr_handle tr_handle, java.lang.String statement, java.lang.String encoding, int dialect, XSQLDA xsqlda) Deprecated. use {@link #isc_dsql_execute_immediate(isc_db_handle, isc_tr_handle, byte[], int, XSQLDA)
void	isc_dsql_execute(isc_tr_handle tr_handle, isc_stmt_handle stmt_handle, int da_version, XSQLDA xsqlda)
void	isc_dsql_execute2(isc_tr_handle tr_handle, isc_stmt_handle stmt_handle, int da_version, XSQLDA in_xsqlda, XSQLDA out_xsqlda)
void	isc_dsql_fetch(isc_stmt_handle stmt_handle, int da_version, XSQLDA xsqlda, int fetchSize)
void	isc_dsql_free_statement(isc_stmt_handle stmt_handle, int option)
XSQLDA	isc_dsql_prepare(isc_tr_handle tr_handle, isc_stmt_handle stmt_handle, byte[] statement, int dialect)
XSQLDA	isc_dsql_prepare(isc_tr_handle tr_handle, isc_stmt_handle stmt_handle, java.lang.String statement, int dialect)
XSQLDA	isc_dsql_prepare(isc_tr_handle tr_handle, isc_stmt_handle stmt_handle, java.lang.String statement, java.lang.String encoding, int dialect) Deprecated. use {@link #isc_dsql_prepare(isc_tr_handle, isc_stmt_handle, byte[], int)
void	isc_dsql_set_cursor_name(isc_stmt_handle stmt_handle, java.lang.String cursor_name, int type)
byte[]	isc_dsql_sql_info(isc_stmt_handle stmt_handle, byte[] items, int buffer_length)
byte[]	isc_expand_dpb(byte[] dpb, int dpb_length, int param, java.lang.Object[] params)
byte[]	isc_get_segment(isc_blob_handle blob, int maxread)
void	isc_open_blob2(isc_db_handle db, isc_tr_handle tr, isc_blob_handle blob, BlobParameterBuffer blobParameterBuffer)
void	isc_prepare_transaction(isc_tr_handle tr_handle)
void	isc_prepare_transaction2(isc_tr_handle tr_handle, byte[] bytes)
void	isc_put_segment(isc_blob_handle blob_handle, byte[] buffer)
void	isc_rollback_retaining(isc_tr_handle tr_handle)
void	isc_rollback_transaction(isc_tr_handle tr_handle)
void	isc_seek_blob(isc_blob_handle handle, int position, int seekMode)
void	isc_service_attach(java.lang.String service, isc_svc_handle serviceHandle, ServiceParameterBuffer serviceParameterBuffer)
void	isc_service_detach(isc_svc_handle serviceHandle)
void	isc_service_query(isc_svc_handle serviceHandle, ServiceParameterBuffer serviceParameterBuffer, ServiceRequestBuffer serviceRequestBuffer, byte[] resultBuffer)
void	isc_service_start(isc_svc_handle serviceHandle, ServiceRequestBuffer serviceRequestBuffer)
void	isc_start_transaction(isc_tr_handle tr_handle, isc_db_handle db_handle, byte[] tpb)
int	isc_vax_integer(byte[] buffer, int pos, int length)
BlobParameterBuffer	newBlobParameterBuffer()
DatabaseParameterBuffer	newDatabaseParameterBuffer()
ServiceParameterBuffer	newServiceParameterBuffer()
ServiceRequestBuffer	newServiceRequestBuffer(int taskIdentifier)

Method Detail

newServiceParameterBuffer

public ServiceParameterBuffer newServiceParameterBuffer()

newServiceRequestBuffer

public ServiceRequestBuffer newServiceRequestBuffer(int taskIdentifier)

newDatabaseParameterBuffer

public DatabaseParameterBuffer newDatabaseParameterBuffer()

newBlobParameterBuffer

public BlobParameterBuffer newBlobParameterBuffer()

getType

public GDSType getType()

Get the type of the GDS implementation.

Returns:

instance of GDSType.

isc_create_database

public void isc_create_database(java.lang.String file_name,
                                isc_db_handle db_handle,
                                DatabaseParameterBuffer databaseParameterBuffer)
                         throws GDSException

Throws:

GDSException

isc_attach_database

public void isc_attach_database(java.lang.String file_name,
                                isc_db_handle db_handle,
                                DatabaseParameterBuffer databaseParameterBuffer)
                         throws GDSException

Throws:

GDSException

isc_database_info

public byte[] isc_database_info(isc_db_handle db_handle,
                                byte[] items,
                                int buffer_length)
                         throws GDSException

Throws:

GDSException

isc_detach_database

public void isc_detach_database(isc_db_handle db_handle)
                         throws GDSException

Throws:

GDSException

isc_drop_database

public void isc_drop_database(isc_db_handle db_handle)
                       throws GDSException

Throws:

GDSException

isc_expand_dpb

public byte[] isc_expand_dpb(byte[] dpb,
                             int dpb_length,
                             int param,
                             java.lang.Object[] params)
                      throws GDSException

Throws:

GDSException

isc_start_transaction

public void isc_start_transaction(isc_tr_handle tr_handle,
                                  isc_db_handle db_handle,
                                  byte[] tpb)
                           throws GDSException

Throws:

GDSException

isc_commit_transaction

public void isc_commit_transaction(isc_tr_handle tr_handle)
                            throws GDSException

Throws:

GDSException

isc_commit_retaining

public void isc_commit_retaining(isc_tr_handle tr_handle)
                          throws GDSException

Throws:

GDSException

isc_prepare_transaction

public void isc_prepare_transaction(isc_tr_handle tr_handle)
                             throws GDSException

Throws:

GDSException

isc_prepare_transaction2

public void isc_prepare_transaction2(isc_tr_handle tr_handle,
                                     byte[] bytes)
                              throws GDSException

Throws:

GDSException

isc_rollback_transaction

public void isc_rollback_transaction(isc_tr_handle tr_handle)
                              throws GDSException

Throws:

GDSException

isc_rollback_retaining

public void isc_rollback_retaining(isc_tr_handle tr_handle)
                            throws GDSException

Throws:

GDSException

isc_dsql_allocate_statement

public void isc_dsql_allocate_statement(isc_db_handle db_handle,
                                        isc_stmt_handle stmt_handle)
                                 throws GDSException

Throws:

GDSException

isc_dsql_alloc_statement2

public void isc_dsql_alloc_statement2(isc_db_handle db_handle,
                                      isc_stmt_handle stmt_handle)
                               throws GDSException

Throws:

GDSException

isc_dsql_describe

public XSQLDA isc_dsql_describe(isc_stmt_handle stmt_handle,
                                int da_version)
                         throws GDSException

Throws:

GDSException

isc_dsql_describe_bind

public XSQLDA isc_dsql_describe_bind(isc_stmt_handle stmt_handle,
                                     int da_version)
                              throws GDSException

Throws:

GDSException

isc_dsql_execute

public void isc_dsql_execute(isc_tr_handle tr_handle,
                             isc_stmt_handle stmt_handle,
                             int da_version,
                             XSQLDA xsqlda)
                      throws GDSException

Throws:

GDSException

isc_dsql_execute2

public void isc_dsql_execute2(isc_tr_handle tr_handle,
                              isc_stmt_handle stmt_handle,
                              int da_version,
                              XSQLDA in_xsqlda,
                              XSQLDA out_xsqlda)
                       throws GDSException

Throws:

GDSException

isc_dsql_execute_immediate

public void isc_dsql_execute_immediate(isc_db_handle db_handle,
                                       isc_tr_handle tr_handle,
                                       java.lang.String statement,
                                       int dialect,
                                       XSQLDA xsqlda)
                                throws GDSException

Throws:

GDSException

isc_dsql_execute_immediate

public void isc_dsql_execute_immediate(isc_db_handle db_handle,
                                       isc_tr_handle tr_handle,
                                       java.lang.String statement,
                                       java.lang.String encoding,
                                       int dialect,
                                       XSQLDA xsqlda)
                                throws GDSException

Deprecated. use {@link #isc_dsql_execute_immediate(isc_db_handle, isc_tr_handle, byte[], int, XSQLDA)

Throws:

GDSException

isc_dsql_execute_immediate

public void isc_dsql_execute_immediate(isc_db_handle db_handle,
                                       isc_tr_handle tr_handle,
                                       byte[] statement,
                                       int dialect,
                                       XSQLDA xsqlda)
                                throws GDSException

Throws:

GDSException

isc_dsql_exec_immed2

public void isc_dsql_exec_immed2(isc_db_handle db_handle,
                                 isc_tr_handle tr_handle,
                                 java.lang.String statement,
                                 int dialect,
                                 XSQLDA in_xsqlda,
                                 XSQLDA out_xsqlda)
                          throws GDSException

Throws:

GDSException

isc_dsql_exec_immed2

public void isc_dsql_exec_immed2(isc_db_handle db_handle,
                                 isc_tr_handle tr_handle,
                                 java.lang.String statement,
                                 java.lang.String encoding,
                                 int dialect,
                                 XSQLDA in_xsqlda,
                                 XSQLDA out_xsqlda)
                          throws GDSException

Deprecated. use {@link #isc_dsql_exec_immed2(isc_db_handle, isc_tr_handle, byte[], int, XSQLDA)

Throws:

GDSException

isc_dsql_exec_immed2

public void isc_dsql_exec_immed2(isc_db_handle db_handle,
                                 isc_tr_handle tr_handle,
                                 byte[] statement,
                                 int dialect,
                                 XSQLDA in_xsqlda,
                                 XSQLDA out_xsqlda)
                          throws GDSException

Throws:

GDSException

isc_dsql_fetch

public void isc_dsql_fetch(isc_stmt_handle stmt_handle,
                           int da_version,
                           XSQLDA xsqlda,
                           int fetchSize)
                    throws GDSException

Throws:

GDSException

isc_dsql_free_statement

public void isc_dsql_free_statement(isc_stmt_handle stmt_handle,
                                    int option)
                             throws GDSException

Throws:

GDSException

isc_dsql_prepare

public XSQLDA isc_dsql_prepare(isc_tr_handle tr_handle,
                               isc_stmt_handle stmt_handle,
                               java.lang.String statement,
                               int dialect)
                        throws GDSException

Throws:

GDSException

isc_dsql_prepare

public XSQLDA isc_dsql_prepare(isc_tr_handle tr_handle,
                               isc_stmt_handle stmt_handle,
                               java.lang.String statement,
                               java.lang.String encoding,
                               int dialect)
                        throws GDSException

Deprecated. use {@link #isc_dsql_prepare(isc_tr_handle, isc_stmt_handle, byte[], int)

Throws:

GDSException

isc_dsql_prepare

public XSQLDA isc_dsql_prepare(isc_tr_handle tr_handle,
                               isc_stmt_handle stmt_handle,
                               byte[] statement,
                               int dialect)
                        throws GDSException

Throws:

GDSException

isc_dsql_set_cursor_name

public void isc_dsql_set_cursor_name(isc_stmt_handle stmt_handle,
                                     java.lang.String cursor_name,
                                     int type)
                              throws GDSException

Throws:

GDSException

isc_dsql_sql_info

public byte[] isc_dsql_sql_info(isc_stmt_handle stmt_handle,
                                byte[] items,
                                int buffer_length)
                         throws GDSException

Throws:

GDSException

getSqlCounts

public void getSqlCounts(isc_stmt_handle stmt)
                  throws GDSException

Throws:

GDSException

isc_vax_integer

public int isc_vax_integer(byte[] buffer,
                           int pos,
                           int length)

isc_create_blob2

public void isc_create_blob2(isc_db_handle db,
                             isc_tr_handle tr,
                             isc_blob_handle blob,
                             BlobParameterBuffer blobParameterBuffer)
                      throws GDSException

Throws:

GDSException

isc_open_blob2

public void isc_open_blob2(isc_db_handle db,
                           isc_tr_handle tr,
                           isc_blob_handle blob,
                           BlobParameterBuffer blobParameterBuffer)
                    throws GDSException

Throws:

GDSException

isc_get_segment

public byte[] isc_get_segment(isc_blob_handle blob,
                              int maxread)
                       throws GDSException

Throws:

GDSException

isc_put_segment

public void isc_put_segment(isc_blob_handle blob_handle,
                            byte[] buffer)
                     throws GDSException

Throws:

GDSException

isc_close_blob

public void isc_close_blob(isc_blob_handle blob)
                    throws GDSException

Throws:

GDSException

isc_blob_info

public byte[] isc_blob_info(isc_blob_handle handle,
                            byte[] items,
                            int buffer_length)
                     throws GDSException

Throws:

GDSException

isc_seek_blob

public void isc_seek_blob(isc_blob_handle handle,
                          int position,
                          int seekMode)
                   throws GDSException

Throws:

GDSException

isc_service_attach

public void isc_service_attach(java.lang.String service,
                               isc_svc_handle serviceHandle,
                               ServiceParameterBuffer serviceParameterBuffer)
                        throws GDSException

Throws:

GDSException

isc_service_detach

public void isc_service_detach(isc_svc_handle serviceHandle)
                        throws GDSException

Throws:

GDSException

isc_service_start

public void isc_service_start(isc_svc_handle serviceHandle,
                              ServiceRequestBuffer serviceRequestBuffer)
                       throws GDSException

Throws:

GDSException

isc_service_query

public void isc_service_query(isc_svc_handle serviceHandle,
                              ServiceParameterBuffer serviceParameterBuffer,
                              ServiceRequestBuffer serviceRequestBuffer,
                              byte[] resultBuffer)
                       throws GDSException

Throws:

GDSException

get_new_isc_db_handle

public isc_db_handle get_new_isc_db_handle()

get_new_isc_tr_handle

public isc_tr_handle get_new_isc_tr_handle()

get_new_isc_stmt_handle

public isc_stmt_handle get_new_isc_stmt_handle()

get_new_isc_blob_handle

public isc_blob_handle get_new_isc_blob_handle()

get_new_isc_svc_handle

public isc_svc_handle get_new_isc_svc_handle()

close

public void close()