Module org.firebirdsql.jaybird

# Package org.firebirdsql.gds.ng

@InternalApi package 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. These classes are used by the JDBC implementation of Jaybird. The classes in this package (and its subpackages) can be used directly but the stability of the interface is not guaranteed (not even between point releases). We strongly advise to use the JDBC implementation.

The classes and interfaces provided by this package can be used to add additional protocol implementations, but given the expected volatility of the interface (see above) we urge you to use caution.

The ng stands for Next Generation, as this is the second incarnation, replacing the original GDS API introduced in Jaybird 1.0 (removed in Jaybird 3.0).

Since:
  3

- Related Packages
  Package
  Description
  org.firebirdsql.gds
  Low-level APIs for accessing a Firebird database server.
  org.firebirdsql.gds.ng.dbcrypt
  SPI for Firebird database encryption callback.
  org.firebirdsql.gds.ng.fields
  Low-level field (column or parameter) descriptors, row descriptors, and row values.
  org.firebirdsql.gds.ng.listeners
  Listener interfaces and supporting classes for the `org.firebirdsql.gds.ng` API.
  org.firebirdsql.gds.ng.monitor
  Interfaces for operation monitoring (experimental feature).
  org.firebirdsql.gds.ng.tz
  Mapping between Firebird and Java time zones and supporting classes.
  org.firebirdsql.gds.ng.wire
  Pure-java implementation of the `org.firebirdsql.gds.ng` API for the Firebird wire protocol.
- Class
  Description
  AbstractAttachProperties<T extends IAttachProperties<T>>
  Abstract mutable implementation of `IAttachProperties`.
  AbstractAttachProperties.PropertyUpdateListener
  Property update listener.
  AbstractConnection<T extends IAttachProperties<T>,C extends FbAttachment>
  Abstract class with common logic for connections.
  AbstractEventHandle
  Abstract implementation for event handle.
  AbstractFbAttachment<T extends AbstractConnection<? extends IAttachProperties<?>,? extends FbAttachment>>
  Common behavior for `AbstractFbService` and `AbstractFbDatabase`.
  AbstractFbBlob
  Base class for low-level blob operations.
  AbstractFbBlob.BlobState
  State of the blob.
  AbstractFbDatabase<T extends AbstractConnection<IConnectionProperties,? extends FbDatabase>>
  Abstract implementation of `FbDatabase` with behavior common to the various implementations.
  AbstractFbService<T extends AbstractConnection<IServiceProperties,? extends FbService>>
  Abstract service implementation.
  AbstractFbStatement
  AbstractFbTransaction
  AbstractImmutableAttachProperties<T extends IAttachProperties<T>>
  Abstract immutable implementation of `IAttachProperties`.
  AbstractParameterConverter<D extends AbstractConnection<IConnectionProperties,?>,S extends AbstractConnection<IServiceProperties,?>>
  Abstract class for behavior common to `ParameterConverter` implementations.
  BatchCompletion
  Completion data from a batch execute.
  BatchCompletion.DetailedError
  BlobConfig
  Firebird configuration for a blob.
  BlobHelper
  Class with static helper methods for use with blobs.
  BlobLengthProcessor
  Blob information processor for retrieving blob length.
  CachedInfoResponse
  Cached info response.
  CursorFlag
  Cursor flags.
  DatatypeCoder
  Interface defining the encoding and decoding for Firebird (numerical) data types.
  DefaultDatatypeCoder
  The default datatype coder.
  DeferredResponse<T>
  Interface for receiving deferred/async responses.
  EncodingSpecificDatatypeCoder
  Datatype coder wrapping another datatype coder and applying a specific encoding definition, while delegating other methods to the wrapped datatype coder.
  ExecutionPlanProcessor
  InfoProcessor to retrieve the (normal) execution plan of a statement.
  FbAttachment
  Connection to a Firebird server (to a database or service).
  FbBatchConfig
  Configuration for a Firebird 4+ batch.
  FbBatchConfig.Immutable
  Class to provide an immutable copy of a batch config.
  FbBlob
  Interface for blob operations.
  FbBlob.SeekMode
  Seek mode for `FbBlob.seek(int, org.firebirdsql.gds.ng.FbBlob.SeekMode)`.
  FbConnectionProperties
  Mutable implementation of `IConnectionProperties`
  FbDatabase
  Connection handle to a database.
  FbDatabaseFactory
  Factory for `FbDatabase` instances.
  FbExceptionBuilder
  Builder for exceptions received from Firebird.
  FbImmutableConnectionProperties
  Immutable implementation of `IConnectionProperties`.
  FbImmutableServiceProperties
  Immutable implementation of `IServiceProperties`.
  FbService
  Connection handle to a service.
  FbServiceProperties
  Mutable implementation of `IServiceProperties`.
  FbStatement
  API for statement handles.
  FbTransaction
  Handle for a transaction.
  FetchDirection
  Direction of fetch.
  FetchType
  Type of fetch.
  IAttachProperties<T extends IAttachProperties<T>>
  Common properties for database and service attach.
  IConnectionProperties
  Connection properties for the Firebird connection.
  InfoProcessor<T>
  Functional interface to process an information buffer (responses to p_info_* requests) returning an object of type T.
  InfoProcessor.StatementInfo
  Interface for information on a statement.
  InfoTruncatedException
  Thrown to indicate that an info request buffer was truncated (`isc_info_truncated`).
  IServiceProperties
  Connection properties for a Firebird service attachment.
  LockCloseable
  Unlocks the lock on `LockCloseable.close()`, intended for use with try-with-resources.
  OdsVersion
  Value class representing the Firebird On-Disk Structure (ODS) version.
  OperationCloseHandle
  Close handle for `Operation` implementations.
  OperationMonitor
  The statement operation monitor allows monitoring of statement execution and fetching of all statements.
  ParameterConverter<D extends AbstractConnection<IConnectionProperties,?>,S extends AbstractConnection<IServiceProperties,?>>
  Provides conversion of parameters (e.g.
  SqlCountHolder
  Class for holding the SQL counts (update, delete, select, insert) for a statement execution.
  SqlCountProcessor
  Info processor for retrieving affected record count.
  StatementInfoProcessor
  InfoProcessor to retrieve the statement information associated with `AbstractFbStatement.getStatementInfoRequestItems()` and `AbstractFbStatement.getParameterDescriptionInfoRequestItems()`.
  StatementState
  Statement states for `FbStatement` implementations
  StatementType
  Firebird statement types.
  TransactionHelper
  Class with static helper methods for use with transactions
  TransactionState
  Transactions states.
  WarningMessageCallback
  Callback interface for passing warnings.
  WireCrypt