Skip to content

Commit

Permalink
Update Jaybird version with Jaybird 6 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mrotteveel committed Dec 27, 2024
1 parent 8ef4a54 commit d865883
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 33 deletions.
24 changes: 3 additions & 21 deletions src/docs/asciidoc/appendices/jaybirdversions/jaybird6.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
[[jb6]]
=== Jaybird 6

Jaybird 6 is currently in development.
The following information is tentative and may change before general availability.

Snapshot versions are intended for evaluation and testing purposes only.
We do not recommend their use in production environments.

[[jb6-java]]
==== Java support

Jaybird 6 supports Java 17 and higher (JDBC 4.3).

Given the limited support period for non-LTS Java versions, we limit support to Java 17 and the most recent LTS version after Java 17, and the latest Java release.
Currently, that means we support Java 17, 21, and 23.
Currently, that means we support Java 17, Java 21, and Java 23.

Jaybird 6 provides libraries compiled against Java 17, which also work on higher Java versions.

Expand All @@ -31,7 +25,7 @@ native and embedded protocol implementation using JNA (artifact `org.firebirdsql
[[jb6-firebird]]
==== Firebird support

Jaybird 6 supports Firebird 3.0 and higher.
Jaybird 6 supports Firebird 3.0, Firebird 4.0, and Firebird 5.0.

Jaybird 6 will -- by default -- not connect to Firebird 2.5 or older.
To connect to earlier versions, unsupported protocols have to be enabled explicitly, see <<ref-enable-protocol>> for details.
Expand Down Expand Up @@ -91,8 +85,6 @@ For native or embedded connections, the `jaybird-native` artifact and `jna-jpms`

For ChaCha64 wire encryption, the `chacha64-plugin` artifact and `bcprov-jdk18on` {jaybird6-bc-version} (Bouncy Castle JCE provider) need to be on the classpath.

////
// No downloads available at this time
[[jb6-distribution-package]]
===== Distribution package

Expand Down Expand Up @@ -121,23 +113,13 @@ Requires `lib/jna-jpms-{jaybird6-jna-version}.jar`.
|Optional dependency, required if you want to use Type 2 native, or embedded protocols (with `jaybird-native`)

|===
////

[[jb6-distribution-maven]]
===== Maven

Alternatively, you can use Maven to automatically download Jaybird and its dependencies.

//Jaybird 6 is available from Maven central:

Snapshot versions of Jaybird 6 are available for testing from https://oss.sonatype.org/content/repositories/snapshots/[^].
You will need to add this as a snapshot repository to your Maven configuration.

[NOTE]
====
These snapshots are released irregularly by a manual deploy.
Contact us on https://groups.google.com/g/firebird-java[firebird-java^] if you need a newer snapshot than available.
====
Jaybird 6 is available from Maven central:

[horizontal]
groupId:: `org.firebirdsql.jdbc`
Expand Down
21 changes: 15 additions & 6 deletions src/docs/asciidoc/chapters/introduction/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Jaybird {jaybird-version} is available from Maven central:

Groupid: `org.firebirdsql.jdbc`, +
Artifactid: `jaybird`, +
Version: `{jaybird-template-version}` (where `<java>` is `java11` or `java8`)
Version: `{jaybird-template-version}`

For example:

Expand All @@ -83,18 +83,27 @@ For example:
</dependency>
----

If you want to use Type 2 support (native or embedded), you need to explicitly include JNA {jna-version} as a dependency:
If you want to use ChaCha64 wire encryption, you need to explicitly include `chacha64-plugin` as a dependency:

[source,xml,subs="verbatim,attributes"]
----
<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna</artifactId>
<version>{jna-version}</version>
<groupId>org.firebirdsql.jdbc</groupId>
<artifactId>chacha64-plugin</artifactId>
<version>{jaybird-example-version}</version>
</dependency>
----

In Jaybird 6, native and embedded support will be in a separate library.
If you want to use Type 2 support (native or embedded), you need to explicitly include `jaybird-native` as a dependency:

[source,xml,subs="verbatim,attributes"]
----
<dependency>
<groupId>org.firebirdsql.jdbc</groupId>
<artifactId>jaybird-native</artifactId>
<version>{jaybird-example-version}</version>
</dependency>
----

The Firebird client library is available as a Maven dependencies, see <<driver-native-maven>>.
In the future, a Maven dependency for Firebird embedded may become available as well.
Expand Down
12 changes: 6 additions & 6 deletions src/docs/asciidoc/jaybird_manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Roman Rokytskyy; Mark Rotteveel
:outlinelevels: 6:1
:imagesdir: images
:icons: font
:jaybird6-full-version: 6.0.0-SNAPSHOT
:jaybird6-jna-version: 5.15.0
:jaybird6-full-version: 6.0.0
:jaybird6-jna-version: 5.16.0
:jaybird6-bc-version: 1.79
:jaybird5-full-version: 5.0.6
:jaybird5-template-version: {jaybird5-full-version}.<java>
Expand All @@ -23,10 +23,10 @@ Roman Rokytskyy; Mark Rotteveel
:jaybird3-full-version: 3.0.12
:jaybird22-full-version: 2.2.15
:jaybird-fbclient-version: 5.0.1.1
:jaybird-version: 5
:jaybird-full-version: {jaybird5-full-version}
:jaybird-example-version: {jaybird5-example-version}
:jaybird-template-version: {jaybird5-template-version}
:jaybird-version: 6
:jaybird-full-version: {jaybird6-full-version}
:jaybird-example-version: {jaybird6-full-version}
:jaybird-template-version: {jaybird6-full-version}
:jna-version: {jaybird5-jna-version}
:min-support-firebird: 2.5
:fb-canonical-html: https://firebirdsql.github.io/jaybird-manual/jaybird_manual.html
Expand Down

0 comments on commit d865883

Please sign in to comment.