Module org.firebirdsql.jaybird

# Package org.firebirdsql.gds

@InternalApi package org.firebirdsql.gds
Low-level APIs for accessing a Firebird database server.

This package contains classes defining the Firebird API for Java language that applications can use to access databases directly without JDBC interfaces. This is probably most efficient way to access the database, but also it is the most complicated one and requires deep knowledge of the Firebird API. For better understanding please refer to the "InterBase 6 API Guide" published by Borland and released together with the open-sourcing the InterBase code, a predecessor of Firebird.

Please refer to the documentation in the javadoc comments as well as to the source code for more information.

- Related Packages
  Package
  Description
  org.firebirdsql.gds.impl
  This package contains classes for the pluggable GDS implementations.
  org.firebirdsql.gds.ng
  The Jaybird GDS-ng API provides the abstraction for connecting to Firebird either through a wire protocol implementation, a native firebird client or other means.
- Class
  Description
  BatchParameterBuffer
  Represents a batch parameter buffer, for Firebird 4 and higher batch configuration.
  BlobParameterBuffer
  Instance of this interface represents a BLOB Parameter Buffer from the Firebird API documentation and specifies attributes for `FbDatabase.createBlobForOutput(org.firebirdsql.gds.ng.FbTransaction, BlobParameterBuffer)` or `FbDatabase.createBlobForInput(org.firebirdsql.gds.ng.FbTransaction, BlobParameterBuffer, long)` operations.
  BlrConstants
  Constants for the blr.
  ClumpletReader
  Reader for clumplets, similar to the implementation of `ClumpletReader.cpp` in Firebird.
  ClumpletReader.ClumpletType
  ClumpletReader.Kind
  ConnectionParameterBuffer
  DatabaseParameterBuffer
  Instance of this interface represents a Database Parameter Buffer from the Firebird API documentation and specifies the attributes for the current connection.
  EventHandle
  Handle to internal event-handling structures.
  EventHandler
  A callback handler interface for event handling.
  GDSException
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use a normal SQLException or subclass, this class may be removed in Jaybird 7 or later
  ISCConstants
  Constants for Firebird features, parameter blocks and errors.
  JaybirdErrorCodes
  Constants for Jaybird specific error codes.
  JaybirdSystemProperties
  Class to access Jaybird-specific system properties from a single place.
  MessageTemplate
  Message template for Firebird and Jaybird parameterized error messages.
  Parameter
  Interface for parameters stored in a `ParameterBuffer`.
  ParameterBuffer
  Instance of this interface represents a Parameter Buffer it is extended by various parameter buffer interfaces.
  ParameterTagMapping
  Mapping of connection parameter buffer item tags.
  ServiceParameterBuffer
  Instance of this interface represents a Service Parameter Buffer from the Firebird API documentation and specifies the attributes for the Services API connection.
  ServiceRequestBuffer
  Instance of this interface represents a Service Request Buffer from the Firebird API documentation and specifies the attributes for the Services API operation.
  TransactionParameterBuffer
  Instances of this interface represent Transaction Parameter Buffer from the Firebird API.
  VaxEncoding
  Helper methods for decoding Vax style (little endian) integers as used by Firebird from byte arrays.