# 1 Jaybird

## 1.1 Where do I get Jaybird?

### 1.1.1 Maven

#### 1.1.1.1 Jaybird 5

Jaybird 5 is available on Maven Central:

groupId: `org.firebirdsql.jdbc`,
artifactId: `jaybird`,
version: `5.0.3.javaXX` (where `XX` is `11` or `8`)

For example, for Java 11:

    <dependency>
        <groupId>org.firebirdsql.jdbc</groupId>
        <artifactId>jaybird</artifactId>
        <version>5.0.3.java11</version>
    </dependency>

If you want to use Type 2 support (native, local or embedded), you need to explicitly include JNA 5.12.1 as a dependency:

    <dependency>
        <groupId>net.java.dev.jna</groupId>
        <artifactId>jna</artifactId>
        <version>5.12.1</version>
    </dependency>

#### 1.1.1.2 Jaybird 4

Jaybird 4 is end-of-life and will receive no further updates. We recommend upgrading to Jaybird 5.

Jaybird 4 is available from Maven Central:

groupId: `org.firebirdsql.jdbc`,
artifactId: `jaybird`,
version: `4.0.10.javaXX` (where `XX` is `11`, `8` or `7`)

For backwards compatibility, we also provide a Maven relocation artifact with artifact id `jaybird-XX` (with `XX` `jdk17` or `jdk18`). However, we recommend switching to the `jaybird` artifact.

For example, for Java 11:

    <dependency>
        <groupId>org.firebirdsql.jdbc</groupId>
        <artifactId>jaybird</artifactId>
        <version>4.0.10.java11</version>
    </dependency>

If your application is deployed to a Java EE application server, you will need to exclude the `javax.resource:connector-api` dependency, and add it as a provided dependency:

    <dependency>
        <groupId>org.firebirdsql.jdbc</groupId>
        <artifactId>jaybird</artifactId>
        <version>4.0.10.java11</version>
        <exclusions>
            <exclusion>
                <groupId>javax.resource</groupId>
                <artifactId>connector-api</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>javax.resource</groupId>
        <artifactId>connector-api</artifactId>
        <version>1.5</version>
        <scope>provided</scope>
    </dependency>

If you want to use Type 2 support (native, local or embedded), you need to explicitly include JNA 5.5.0 as a dependency:

    <dependency>
        <groupId>net.java.dev.jna</groupId>
        <artifactId>jna</artifactId>
        <version>5.5.0</version>
    </dependency>

#### 1.1.1.3 Jaybird 3.0

Jaybird 3 is end-of-life and will receive no further updates. We recommend upgrading to Jaybird 5.

Jaybird 3 is available from Maven central:

groupId: `org.firebirdsql.jdbc`,
artifactId: `jaybird-XX` (where `XX` is `jdk17` or `jdk18`),
version: `3.0.12`

For ease of use, we also provide a Maven relocation artifact with artifact id `jaybird`. For Jaybird 3 this relocation artifact points to `jaybird-jdk18`.

For example, for Java 8:

    <dependency>
        <groupId>org.firebirdsql.jdbc</groupId>
        <artifactId>jaybird-jdk18</artifactId>
        <version>3.0.12</version>
    </dependency>

If your application is deployed to a Java EE application server, you will need to exclude the `javax.resource:connector-api` dependency, and add it as a provided dependency:

    <dependency>
        <groupId>org.firebirdsql.jdbc</groupId>
        <artifactId>jaybird-jdk18</artifactId>
        <version>3.0.12</version>
        <exclusions>
            <exclusion>
                <groupId>javax.resource</groupId>
                <artifactId>connector-api</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>javax.resource</groupId>
        <artifactId>connector-api</artifactId>
        <version>1.5</version>
        <scope>provided</scope>
    </dependency>

If you want to use Type 2 support (native, local or embedded), you need to explicitly include JNA 4.4.0 as a dependency:

    <dependency>
        <groupId>net.java.dev.jna</groupId>
        <artifactId>jna</artifactId>
        <version>4.4.0</version>
    </dependency>

#### 1.1.1.4 Jaybird 2.2

Jaybird 2.2 is end-of-life and will receive no further updates. We recommend upgrading to Jaybird 5.

Jaybird 2.2 is available on Maven, with a separate artifact for each supported Java version.

groupId: `org.firebirdsql.jdbc`,
artifactId: `jaybird-XX` (where `XX` is `jdk16`, `jdk17` or `jdk18`),
version: `2.2.15`

For ease of use, we also provide a Maven relocation artifact with artifact id `jaybird`. For Jaybird 2.2 this relocation artifact points to `jaybird-jdk17`.

For example:

    <dependency>
        <groupId>org.firebirdsql.jdbc</groupId>
        <artifactId>jaybird-jdk18</artifactId>
        <version>2.2.15</version>
    </dependency>

When deploying to a JavaEE environment, exclude the `javax.resource connector-api` dependency as this will be provided by the application server.

### 1.1.2 Download

Firebird can be downloaded from the Firebird website, under Downloads, JDBC Driver.

Alternatively, you can go directly to GitHub and download Jaybird from the jaybird releases.

## 1.2 Where can I get the sourcecode?

All Jaybird distribution zips contain a `jaybird-<version>-sources.zip` with the sources used for that specific version. The full Jaybird sourcecode is also available from GitHub in the jaybird repository:

https://github.com/FirebirdSQL/jaybird

Each release is also tagged in the repository.

## 1.3 How is Jaybird licensed?

Jaybird JDBC driver is distributed under the GNU Lesser General Public License (LGPL). Text of the license can be obtained from http://www.gnu.org/copyleft/lesser.html.

Using Jaybird (by importing Jaybird's public interfaces in your Java code), and extending Jaybird by subclassing or implementation of an extension interface (but not abstract or concrete class) is considered by the authors of Jaybird to be dynamic linking. Hence, our interpretation of the LGPL is that the use of the unmodified Jaybird source does not affect the license of your application code.

Even more, all extension interfaces to which an application might want to link are released under dual LGPL/modified BSD license. Latter is basically "AS IS" license that allows any kind of use of that source code. Jaybird should be viewed as an implementation of that interfaces and the LGPL section for dynamic linking is applicable in this case.

### 1.3.1 Which version of the LGPL applies?

Current releases of Jaybird do not explicitly specify an LGPL version. This means that you can choose which version applies. Future versions of Jaybird may specify an explicit version, or be released under a different license.

## 1.4 Which Java versions are supported?

Jaybird 5 supports Java 8, 11, 17 and 21. Support for Java 9 and higher is limited to Java 8, 11, 17, 21 and the most recent LTS version after Java 21 and the latest Java release.

Jaybird 5 is the last version to support Java 8 and 11, support will be dropped with Jaybird 6, raising the minimum supported version to Java 17.

Jaybird 4 supports Java 7, 8, 11, 17 and 21. Support for Java 9 and higher is limited to Java 11, 17 and 21.

Jaybird 4 is the last version to support Java 7, support will be dropped with Jaybird 5. Jaybird 4.0.10 is the last release of Jaybird 4, and is end-of-life. We recommend upgrading to Jaybird 5.

Jaybird 3 supports Java 7 and 8 and has basic support for Java 9 and higher using the Java 8 version of the driver. Support for Java 9 and higher is limited to Java 11 and 17, but in practice Jaybird should work on all Java 9+ versions upto Java 17 (versions after Java 17 have not been tested). Jaybird 3.0.12 is the last release of Jaybird 3, and is end-of-life. We recommend upgrading to Jaybird 5.

Jaybird 2.2 supports Java 6, 7 and 8. Jaybird 2.2.15 is that last release of Jaybird 2.2, and is end-of-life. We recommend upgrading to Jaybird 5.

Jaybird 2.2.4 added basic support for Java 8 (JDBC 4.2), although not all JDBC 4.2 features are supported or fully implemented.

Jaybird 2.2.7 is the last version to support Java 5, support has been dropped with Jaybird 2.2.8.

Jaybird 2.2 is the last version to support Java 6, support has been dropped with Jaybird 3.

### 1.4.1 What is the Java 9 module name for Jaybird?

Jaybird itself is not (yet) modularized. To ensure a stable module name, Jaybird, since 2.2.14 and 3.0.3, declares the automatic module name `org.firebirdsql.jaybird`.

Jaybird 6 will be modular.

## 1.5 Which Firebird versions are supported?

Jaybird 5 supports Firebird version 2.5, 3.0 and 4.0, and provides tentative support for Firebird 5.0. Firebird 5.0 will become fully supported in the first release after Firebird 5.0.0.

Jaybird 5 is the last version to support Firebird 2.5. Future versions of Jaybird are not guaranteed to work with version 2.5 and earlier.

Jaybird 4 supports Firebird version 2.5, 3.0 and 4.0, and introduces support for Firebird 4.0 types `DECLOAT`, extended precision of `NUMERIC` and `DECIMAL`, and time zone types (`TIME WITH TIME ZONE` and `TIMESTAMP WITH TIME ZONE`).

Jaybird 4 only provides partial support for Firebird 5.0, and the generated-keys support does not work in all cases due to Firebird 5.0 now supporting multi-row `RETURNING`. Full Firebird 5.0 support is available in Jaybird 5.

Jaybird 3 supports Firebird versions 2.0 - 4.0. Support for Firebird 4.0 is limited to the Firebird 3.0 feature set. Formally, Firebird 5.0 is not supported, though in practice the problems are similar as for Jaybird 4.

Jaybird 3 is the last version to support Firebird 2.0 and 2.1. Future versions of Jaybird are not guaranteed to work with version 2.1 and earlier.

Jaybird 2.2 supports Firebird versions 1.0 - 4.0. Jaybird 2.2.4 added support for new features of Firebird 3.0 (e.g. `BOOLEAN` support). Support for Firebird 4 is limited to the Firebird 3.0 feature set.

Jaybird 2.2 is the last version to support Firebird 1.0 and 1.5. Future versions of Jaybird are not guaranteed to work with these versions.

## 1.6 Can Jaybird connect to Interbase?

Jaybird does not support Interbase, and as far as we know connecting to Interbase 6.0 and later will fail due to Firebird specific changes in the implementation.

# 2 Documentation and Support

## 2.1 Where to get more information on Jaybird

Apart from this FAQ, you can get additional information from:

- Jaybird wiki
- Jaybird JDBC Driver Java Programmer’s Manual (HTML, PDF version) (covers Jaybird 2.2 and higher)
- Firebird Website: Development, JDBC Driver

For version specific details, consult the release notes

- Jaybird 5.0.x release notes
- Jaybird 4.0.x release notes
- Jaybird 3.0.x release notes
- Jaybird 2.2.x release notes

## 2.2 Where to get help

- On Stack Overflow, please tag your questions with jaybird and firebird

- The Firebird-Java group and corresponding mailing list firebird-java@googlegroups.com

  You can subscribe to the mailing list by sending an email to firebird-java+subscribe@googlegroups.com

- Looking for professional support of Jaybird? Jaybird is now part of the Tidelift subscription.

- The Firebird project home page

- Firebird support and other Firebird mailing lists for questions not directly related to Jaybird and java.

## 2.3 Contributing

There are several ways you can contribute to Jaybird or Firebird in general:

- Participate on the mailing lists (see https://www.firebirdsql.org/en/mailing-lists/)
- Report bugs or submit patches on the tracker (see Reporting Bugs)
- Create pull requests on GitHub (https://github.com/FirebirdSQL/jaybird)
- Become a developer (for Jaybird contact us on firebird-java, for Firebird in general, use the Firebird-devel mailing list)
- Donate to the Firebird Foundation (see https://www.firebirdsql.org/en/donate/)
- Become a paying member or sponsor of the Firebird Foundation (see https://www.firebirdsql.org/en/firebird-foundation/)

## 2.4 Reporting Bugs

The developers follow the firebird-java Google Group. Join the list and post information about suspected bugs. List members may be able to help out to determine if it is an actual bug, provide a workaround and get you going again, whereas bug fixes might take a while.

You can report bugs in the Firebird bug tracker, https://github.com/FirebirdSQL/jaybird/issues/

When reporting bugs, please provide a minimal, but complete reproduction, including databases and sourcecode to reproduce the problem. Patches to fix bugs are also appreciated. Make sure the patch is against a recent master version of the code. You can also fork the jaybird repository and create pull requests.

# 3 Connecting to Firebird

## 3.1 JDBC URLs (`java.sql.DriverManager`)

### 3.1.1 Pure Java (default)

Default URL format:

    jdbc:firebirdsql://host[:port]/<database>

This will connect to the database using the Type 4 JDBC driver using the Java implementation of the Firebird wire-protocol. This is best suited for client-server applications with dedicated database server. Port can be omitted (default value is `3050`), host name must be present.

The `<host>` part is either the hostname, the IPv4 address, or the IPv6 address in brackets (eg `[::1]`). Use of IPv6 address literals is only supported in Jaybird 3 or newer with Firebird 3 or newer.

The `<database>` part should be replaced with the database alias or the path to the database. In general, it is advisable to use database aliases instead of the path of the database file as it hides implementation details like file locations and OS type.

On Linux the root `/` should be included in the path. A database located on `/opt/firebird/db.fdb` should use (note the double slash after port!):

    jdbc:firebirdsql://host:port//opt/firebird/db.fdb

Deprecated, but still supported legacy URL format:

    jdbc:firebirdsql:host[/port]:<database>

The legacy URL format does not support IPv6 address literals.

Jaybird 4 and higher also support:

    jdbc:firebird://host[:port]/<database>
    jdbc:firebird:host[/port]:<database>

### 3.1.2 Open Office/Libre Office (Pure Java)

Jaybird can be used together with OpenOffice and LibreOffice Base. To address some compatibility issues (and differences in interpretation of JDBC specifications) a separate sub-protocol is used:

    jdbc:firebirdsql:oo://host[:port]/<database>

Jaybird 4 and higher also support:

    jdbc:firebird:oo://host[:port]/<database>

### 3.1.3 Native (using Firebird client library)

Default URL format:

    jdbc:firebirdsql:native://host[:port]/<database>

Legacy URL format:

    jdbc:firebirdsql:native:host[/port]:<database>

Type 2 driver, will connect to the database using client library (`fbclient.dll` on Windows, and `libfbclient.so` on Linux). Requires correct installation of the client library and - for Jaybird 2.2 or earlier - the Jaybird native library, or - for Jaybird 3 - the JNA jar file.

    jdbc:firebirdsql:local:<database>

Type 2 driver in local mode. Uses client library as in previous case, however will not use socket communication, but rather access database directly. Requires correct installation of the client library and - for Jaybird 2.2 or earlier - the Jaybird native library, or - for Jaybird 3 - the JNA jar file.

Jaybird 4 and higher also support:

    jdbc:firebird:native://host[:port]/<database>
    jdbc:firebird:native:host[/port]:<database>
    jdbc:firebird:local:<database>

### 3.1.4 Embedded Server

    jdbc:firebirdsql:embedded:<database>

Similar to the Firebird client library, however `fbembed.dll` on Windows and `libfbembed.so` on Linux are used, falling back to `fbclient.dll`/`libfbclient.so` under the assumption it provides Embedded functionality. Requires correctly installed and configured Firebird embedded library and - for Jaybird 2.2 or earlier - the Jaybird native library, or - for Jaybird 3 - the JNA jar file.

Jaybird 4 and higher also support:

    jdbc:firebird:embedded:<database>

## 3.2 Character sets

### 3.2.1 How can I specify the connection character set?

Jaybird provides two connection properties to specify the connection character set:

- `charSet` with a Java character set name (alias: `localEncoding`)

  The Java character set name must map to an equivalent Firebird character set.

- `encoding` with a Firebird character set name (alias: `lc_ctype`)

  The Firebird character set name - except `NONE` - must map to an equivalent Java character set.

For most applications, use only one of these two properties.

For special situations it is possible to specify both `charSet` and `encoding` to convert/reinterpret a character set into another character set, this is usually only necessary to fix data problems.

To phrase differently:

- `encoding=<firebird charset>`: use connection encoding `<firebird charset>` and interpret in the equivalent Java character set

- `charSet=<java charset>`: use Firebird equivalent of `<java charset>` as connection encoding and interpret in

- `encoding=<firebird charset>&charSet=<java charset>`: use connection encoding `<firebird charset>`, but interpret in `<java charset>`

The handling of Firebird character set `NONE` is slightly different, see below.

### 3.2.2 How does character set `NONE` work?

The Firebird character set `NONE` is a special case, it essentially means "no character set". You can store anything in it, but conversions to or from this character set are not defined.

Using character set `NONE` can result in incorrect character set handling when the database is used from different locales.

When used as a connection character set, Jaybird handles `NONE` as follows:

#### 3.2.2.1 Jaybird 3.0 and higher

- `encoding=NONE` means connection encoding `NONE` and interpret columns with character set `NONE` using the default JVM encoding, and interpret columns with an explicit character set in their equivalent Java character set

- `encoding=NONE&charSet=ISO-8859-1` the same, but instead of the JVM default, use `ISO-8859-1`

#### 3.2.2.2 Jaybird 2.2 and earlier

- `encoding=NONE` means use connection encoding `NONE` and interpret everything using the default JVM encoding

- `encoding=NONE&charSet=ISO-8859-1` the same, but instead of the JVM default, use `ISO-8859-1`

### 3.2.3 What happens if no connection character set is specified?

When no character set has been specified explicitly, Jaybird 2.2 and earlier, and Jaybird 3.0.2 and higher default to connection character set `NONE`. See How does character set `NONE` work? for details on character set `NONE`.

Jaybird 3.0.0 and 3.0.1, however, will reject the connection, see How can I solve the error "Connection rejected: No connection character set specified".

In Jaybird 3 it is possible to override the default connection character set by specifying system property `org.firebirdsql.jdbc.defaultConnectionEncoding` with a valid Firebird character set name.

Jaybird 3.0.2 introduces the system property `org.firebirdsql.jdbc.requireConnectionEncoding`, which - when set to `true` - will reject connections without a character set (which was the default behavior in Jaybird 3.0.0 and 3.0.1).

### 3.2.4 How can I solve the error "Connection rejected: No connection character set specified"

If no character set has been set, Jaybird 3 will reject the connection with an `SQLNonTransientConnectionException` with message "Connection rejected: No connection character set specified (property lc_ctype, encoding, charSet or localEncoding). Please specify a connection character set (eg property charSet=utf-8) or consult the Jaybird documentation for more information."

In Jaybird 3.0.0 and 3.0.1 this error will be thrown if the character set has not been set explicitly. In Jaybird 3.0.2 and higher this error will only be thrown if system property `org.firebirdsql.jdbc.requireConnectionEncoding` has been set to `true`.

To address this error, you can set the default connection character set using one of the following options:

- Use connection property `encoding` (alias: `lc_ctype`) with a Firebird character set name.

  Use `encoding=NONE` for the default behavior (with some caveats, see How does character set `NONE` work?).

- Use connection property `charSet` (alias: `localEncoding`) with a Java character set name.

- Use a combination of `encoding` and `charSet`, if you want to reinterpret a Firebird character set in a Java character set other than the default mapping.

- By providing a default Firebird character set with system property `org.firebirdsql.jdbc.defaultConnectionEncoding`. Jaybird will apply the specified character set as the default when no character set is specified in the connection properties.

  This property only supports Firebird character set names.

  Use `-Dorg.firebirdsql.jdbc.defaultConnectionEncoding=NONE` to revert to the default behavior (with some caveats, see How does character set `NONE` work?). With Jaybird 3.0.2 or higher, it is better to just not set system property `org.firebirdsql.jdbc.requireConnectionEncoding` if you want to apply `NONE`.

## 3.3 How can I enable the Windows "TCP Loopback Fast Path" introduced in Firebird 3.0.2?

NOTE: Microsoft has deprecated the `SIO_LOOPBACK_FAST_PATH` option and recommends not to use it. Support was removed in Firebird 5.0

Firebird 3.0.2 adds support for "TCP Loopback Fast Path" (`SIO_LOOPBACK_FAST_PATH` socket option); support was removed in Firebird 5.0. This is available in Windows 8 / Windows Server 2012 and higher. This feature enables performance optimizations when connecting through localhost (127.0.0.1 / ::1). It requires support on both client and server side.

Java support for "TCP Loopback Fast Path" was introduced in Java 8 update 60, it can be enabled by specifying the system property `jdk.net.useFastTcpLoopback` with value `true` (e.g. specify `-Djdk.net.useFastTcpLoopback=true` in your Java commandline).

Unfortunately, Java only has an 'all-or-nothing' support for the "TCP Loopback Fast Path", so Jaybird cannot enable this for you: you must specify this property on JVM startup. On the other hand, this has the benefit that this works for all Jaybird versions, as long as you use Java 8 update 60 or higher (and Firebird 3.0.2 or higher, but before 5.0.0).

## 3.4 Common connection errors

### 3.4.1 Your user name and password are not defined. Ask your database administrator to set up a Firebird login. (335544472)

This error means that the user does not exist, or that the specified password is not correct.

When connecting to Firebird 3 and higher, this error can also mean that the user does exist (with that password), but not for the authentication plugins tried for this connection.

For example, Jaybird 2.2.x and earlier only support legacy authentication, if you try to log in as a user created for SRP authentication, you will get the same error.

### 3.4.2 Incompatible wire encryption levels requested on client and server (335545064)

With Jaybird 3.0.0 - 3.0.3 connecting to Firebird 3 or higher, this usually means that the setting `WireCrypt` is set to its (default) value of `Required`.

Upgrade to Jaybird 3.0.4 or higher, or relax this setting (in `firebird.conf`) to `WireCrypt = Enabled`.

See also Jaybird Wiki - Jaybird and Firebird 3

With Jaybird 3.0.4 or higher, or Jaybird 4, this error means that you have requested a connection with a mismatch in encryption settings. For example, you specified connection property `wireCrypt=required` while Firebird is set to `WireCrypt = Disabled` (or vice versa).

### 3.4.3 connection rejected by remote interface (335544421)

In general this error means that Jaybird requested a connection with properties not supported by Firebird. It can have other causes than described below.

#### 3.4.3.1 Cause: username or password is null

With Jaybird 3 and higher connecting to Firebird 3 or higher, leaving username or password null will lead to Jaybird not trying any authentication plugin, and as a result, Firebird will reject the connection.

With Firebird 2.5 and earlier, or Jaybird 2.2, this situation will normally yield error "Your user name and password are not defined. Ask your database administrator to set up a Firebird login.".

#### 3.4.3.2 Cause: wirecrypt required

With Jaybird 2.2.x connecting to Firebird 3 or higher, this usually means that the setting `WireCrypt` is set to its (default) value of `Required`.

Relax this setting (in `firebird.conf`) to `WireCrypt = Enabled`.

See also Jaybird Wiki - Jaybird and Firebird 3

Make sure you check the other settings mentioned in that article, otherwise you'll get the next error.

### 3.4.4 Error occurred during login, please check server firebird.log for details (335545106)

If the logging contains something like

    SERVER  Sat Oct 28 10:07:26 2017
        Authentication error
        No matching plugins on server

with Jaybird 2.2.x connecting to Firebird 3 or higher, this means that the setting `AuthServer` does not include the `Legacy_Auth` plugin.

Enable `Legacy_Auth` (in `firebird.conf`) by adding this value to the property `AuthServer`, for example: `AuthServer = Srp, Legacy_Auth`.

With Jaybird 4 and higher this can also mean that none of the default authentication plugins, or those specified using connection property `authPlugins`, are listed in the `AuthServer` setting. Either revise the Firebird configuration, or explicitly configure connection property `authPlugins` with authentication plugins that are configured in Firebird.

You also need to make sure your user is created with the legacy user manager, see Jaybird Wiki - Jaybird and Firebird 3 for details.

### 3.4.5 Encryption key did not meet algorithm requirements of Symmetric/Arc4 (337248282)

If the exception cause is java.security.InvalidKeyException: Illegal key size or default parameters, this means that your Java install applies a security policy that does not allow ARCFOUR with a 160 bit encryption key.

If `wireCrypt=ENABLED` (the default), this is just logged as a warning. The connection will succeed, but it does mean that the connection will not be encrypted. If `wireCrypt=REQUIRED`, this is thrown as an exception, and the connection will fail.

This could indicate that your Java version applies the limited strength Cryptographic Jurisdiction Policy (this was the default in Java 8 Update 152 and earlier), or has been explicitly configured to apply the limited policy, or has a custom security policy to restrict the cryptographic key size.

Solutions and workarounds:

- Apply the unlimited Cryptographic Jurisdiction Policy, see this Stack Overflow answer
- Relax your custom security policy to allow 160 bit keys for ARCFOUR
- Disable wire encryption for Firebird by setting `WireCrypt = Disabled` in `firebird.conf`
- Set `wireCrypt=DISABLED` in the connection properties

Be aware that the first two options may have legal implications depending on the local law in your country regarding cryptography.

# 4 JDBC Support

## 4.1 How much of JDBC is supported by Jaybird?

WARNING The information in this section is not 100% up-to-date

Jaybird 3 follows the JDBC 4.3 specification with some features and methods not implemented as they are not supported by Firebird.

Implemented features:

- Most useful JDBC functionality ("useful" in the opinion of the developers).
- XA transactions with true two phase commit when used via `javax.sql.XADataSource` implementation.
- `ObjectFactory` implementation for use in environments with JNDI but no `TransactionManager`.
- `DataSource` implementations without pooling.
- Complete access to all Firebird database parameter block and transaction parameter block settings.
- JMX mbean for database management (so far just database create and drop).

## 4.2 What parts of JDBC are NOT supported by Jaybird?

WARNING The information in this section is outdated

The following optional features are NOT supported:

The following optional features and the methods that support it are not implemented:

- Ref and Array types.
  - `java.sql.PreparedStatement`
    - `setRef(int i, Ref x)`
    - `setArray(int i, Array x)`
  - `java.sql.ResultSet`
    - `getArray(int i)`
    - `getArray(String columnName)`
    - `getRef(int i)`
    - `getRef(String columnName)`
- User Defined Types/Type Maps.
  - `java.sql.ResultSet`
    - `getObject(int i, java.util.Map map)`
    - `getObject(String columnName, java.util.Map map)`
  - `java.sql.Connection`
    - `getTypeMap()`
    - `setTypeMap(java.util.Map map)`

Excluding the unsupported features, the following methods are not yet implemented:

- `java.sql.Blob`
  - `length()`
  - `getBytes(long pos, int length)`
  - `position(byte pattern[], long start)`
  - `position(Blob pattern, long start)`

The following methods are implemented, but do not work as expected:

- `java.sql.Statement`
  - `get/setMaxFieldSize` does nothing
  - `get/setQueryTimeout` supported since Jaybird 4 with Firebird 4.0 and higher
- `java.sql.PreparedStatement`
  - `setObject(index,object,type)` This method is implemented but behaves as `setObject(index,object)`
  - `setObject(index,object,type,scale)` This method is implemented but behaves as `setObject(index,object)`
- `java.sql.CallableStatement`
  - `getBigDecimal(index,scale)` This method is implemented but behaves as `getBigDecimal(index)`. The method is deprecated, and we suggest using `getBigDecimal(index)` and adjust the scale of the returned `BigDecimal` using `BigDecimal.setScale(newScale,roundingMode)`
- `java.sql.ResultSetMetaData`
  - `isReadOnly(i)` always returns false
  - `isWritable(i)` always returns true
  - `isDefinitivelyWritable(i)` always returns true
- `java.sql.ResultSet`
  - `getBigDecimal(index,scale)` This method is implemented but behaves as `getBigDecimal(index)`. The method is deprecated, and we suggest using `getBigDecimal(index)` and adjust the scale of the returned `BigDecimal` using `BigDecimal.setScale(newScale,roundingMode)`

# 5 Features

## 5.1 Does Jaybird support connection pooling?

Jaybird itself no longer provides connection pooling. Earlier versions had a `DataSource` implementation with connection pooling, but this implementation had severe bugs. This implementation (and all other classes in `org.firebirdsql.pool`) was deprecated in 2.2 and dropped in 3.0.

Jaybird provides a basic `DataSource` implementation and a `ConnectionPoolDataSource` implementation. Contrary to its name the latter does not provide a connection pool, but is intended to be used by a connection pool (as implemented in an application server) to create connections for the connection pool.

If your application is built on a Java EE application server, we suggest you use the connection pooling provided by the application server using the `javax.sql.ConnectionPoolDataSource` implementation `org.firebirdsql.ds.FBConnectionPoolDataSource`, or using the `javax.sql.XADataSource` implementation `org.firebirdsql.ds.FBXADataSource`.

If you develop standalone applications, or you use an application server without connection pooling, we suggest you use third-party libraries like:

- HikariCP
- c3p0
- Apache DBCP

# 6 Compatibility notes

## 6.1 Wildfly

The minimal `module.xml` to use Jaybird 3 under Wildfly is:

    <?xml version="1.0" encoding="UTF-8"?>
    <module xmlns="urn:jboss:module:1.0" name="org.firebirdsql">
      <resources>
        <resource-root path="jaybird-3.0.x.jar"/>
      </resources>
      <dependencies>
        <module name="javax.api"/>
        <module name="javax.transaction.api"/>
        <module name="javax.resource.api"/>
      </dependencies>
    </module>

With Jaybird 3.0.4 and higher for Java 7 (but not Java 8!) in Wildfly (or JBoss), you will need to add the module `javax.xml.bind.api` to your module:

    <?xml version="1.0" encoding="UTF-8"?>
    <module xmlns="urn:jboss:module:1.0" name="org.firebirdsql">
      <resources>
        <resource-root path="jaybird-3.0.x.jar"/>
      </resources>
      <dependencies>
        <module name="javax.api"/>
        <module name="javax.transaction.api"/>
        <module name="javax.resource.api"/>
        <module name="javax.xml.bind.api"/> <!-- Add this -->
      </dependencies>
    </module>

Alternatively, use Jaybird for Java 8 (or higher).