Skip to content

Commit ef7c11c

Browse files
committed
Sync FAQ from master
1 parent 2286260 commit ef7c11c

File tree

1 file changed

+48
-19
lines changed

1 file changed

+48
-19
lines changed

src/docs/asciidoc/faq.adoc

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
:source-highlighter: prettify
88
:toc: left
99
:icons: font
10-
:jaybird6-full-version: 6.0.2
10+
:jaybird6-full-version: 6.0.3
1111
:jaybird6-jna-version: 5.17.0
12-
:jaybird5-full-version: 5.0.8
12+
:jaybird5-full-version: 5.0.9
1313
:jaybird5-template-version: {jaybird5-full-version}.<java>
1414
:jaybird5-example-version: {jaybird5-full-version}.java11
1515
:jaybird5-jna-version: 5.17.0
@@ -42,6 +42,9 @@ SPDX-License-Identifier: LicenseRef-PDL-1.0
4242
[#jaybird-6]
4343
==== Jaybird 6
4444

45+
Jaybird 6 requires Java 17 or higher.
46+
For older Java versions (Java and higher), use <<jaybird-5>>.
47+
4548
Jaybird 6 is available on Maven Central:
4649

4750
[horizontal.compact]
@@ -91,6 +94,8 @@ To enable the "`ChaCha64`" wire encryption support for pure Java connections, yo
9194
[#jaybird-5]
9295
==== Jaybird 5
9396

97+
Unless you need to use Java 8 or Java 11, we recommend upgrading to <<jaybird-6>>.
98+
9499
Jaybird 5 is available on Maven Central:
95100

96101
[horizontal.compact]
@@ -127,7 +132,7 @@ If you want to use Type 2 support (native or embedded), you need to explicitly i
127132
==== Jaybird 4
128133

129134
Jaybird 4 is end-of-life and will receive no further updates.
130-
We recommend upgrading to <<jaybird-5>>.
135+
We recommend upgrading to <<jaybird-6>>.
131136

132137
////
133138
// Stop showing Jaybird 4 Maven info, but keep available for now
@@ -195,7 +200,7 @@ If you want to use Type 2 support (native, local or embedded), you need to expli
195200
+++<a name="jaybird-3.0">++++++</a>+++
196201
197202
Jaybird 3 is end-of-life and will receive no further updates.
198-
We recommend upgrading to <<jaybird-5>>.
203+
We recommend upgrading to <<jaybird-6>>.
199204
200205
////
201206
// Stop showing Jaybird 3 Maven info, but keep available for now
@@ -260,7 +265,7 @@ If you want to use Type 2 support (native, local or embedded), you need to expl
260265
==== Jaybird 2.2
261266
262267
Jaybird 2.2 is end-of-life and will receive no further updates.
263-
We recommend upgrading to <<jaybird-5>>.
268+
We recommend upgrading to <<jaybird-6>>.
264269
265270
////
266271
// Stop showing Jaybird 2.2 Maven info, but keep available for now
@@ -293,15 +298,15 @@ When deploying to a JavaEE environment, exclude the `javax.resource connector-ap
293298
294299
Jaybird can be downloaded from the Firebird website, under Downloads, https://firebirdsql.org/en/jdbc-driver/[JDBC Driver].
295300
296-
Alternatively, you can go directly to GitHub and download Jaybird from the https://github.com/FirebirdSQL/jaybird/releases[jaybird releases].
301+
Alternatively, you can go directly to GitHub and download Jaybird from the https://github.com/FirebirdSQL/jaybird/releases[Jaybird releases].
297302
298303
[#where-can-i-get-the-sourcecode]
299304
== Where can I get the sourcecode?
300305
301306
All Jaybird distribution zips contain a `jaybird-<version>-sources.zip` with the sources used for that specific version.
302307
The Maven Central repository also has the `jaybird-<version>-sources.zip`, and your IDE will generally offer to download it for you if you navigate to any Jaybird class.
303308
304-
The full Jaybird sources are available from GitHub in the jaybird repository, {jaybird-repo}.
309+
The full Jaybird sources are available from GitHub in the Jaybird repository, {jaybird-repo}.
305310
Each release is tagged in the repository.
306311
307312
[#how-is-jaybird-licensed]
@@ -345,7 +350,7 @@ Jaybird 5 is the last version to support Java 8 and Java 11, support has been dr
345350
346351
[NOTE]
347352
====
348-
Jaybird 5 will serve as a form of long-term support for Java 8 and Java 11, with maintenance releases guaranteed at least until the release of Jaybird 7.
353+
Jaybird 5 serves as a "`long-term support`" version for Java 8 and Java 11, with maintenance releases at least until the release of Jaybird 7.
349354
350355
See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2022-03-java-17-minimum-version.md[jdp-2022-03: Java 17 minimum version].
351356
====
@@ -358,25 +363,31 @@ Jaybird 4 supports Java 7, Java 8, Java 11, Java 17 and Java 21.
358363
Support for Java 9 and higher is limited to Java 11, Java 17 and Java 21.
359364
360365
Jaybird 4 is the last version to support Java 7, support was dropped with Jaybird 5.
361-
Jaybird 4.0.10 is the last release of Jaybird 4, and is end-of-life.
362-
We recommend upgrading to Jaybird 5.
366+
Jaybird 4.0.10 is the last release of Jaybird 4.
367+
368+
Jaybird 4 is end-of-life.
369+
We recommend upgrading to Jaybird 6.
363370
364371
[#java-jaybird-3-0]
365372
[discrete]
366373
=== Jaybird 3
367374
368375
Jaybird 3 supports Java 7 and Java 8 and has basic support for Java 9 and higher using the Java 8 version of the driver.
369376
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 17footnote:[versions after Java 17 have not been tested].
370-
Jaybird 3.0.12 is the last release of Jaybird 3, and is end-of-life.
371-
We recommend upgrading to Jaybird 5.
377+
Jaybird 3.0.12 is the last release of Jaybird 3.
378+
379+
Jaybird 3 is end-of-life.
380+
We recommend upgrading to Jaybird 6.
372381
373382
[#java-jaybird-2-2]
374383
[discrete]
375384
=== Jaybird 2.2
376385
377386
Jaybird 2.2 supports Java 6, Java 7 and Java 8.
378-
Jaybird 2.2.15 is that last release of Jaybird 2.2, and is end-of-life.
379-
We recommend upgrading to Jaybird 5.
387+
Jaybird 2.2.15 is the last release of Jaybird 2.2.
388+
389+
Jaybird 2.2 is end-of-life.
390+
We recommend upgrading to Jaybird 6.
380391
381392
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.
382393
@@ -411,6 +422,15 @@ To ensure a stable module name, Jaybird 5 and older, since versions 2.2.14 and 3
411422
412423
Jaybird 6 supports Firebird 3.0, Firebird 4.0, and Firebird 5.0.
413424
425+
.No promises on Firebird 6.0 support
426+
[WARNING#firebird-jaybird-6-fb6]
427+
====
428+
Firebird 6.0 is still in development, and includes changes -- like schema support -- that impact Jaybird.
429+
430+
As a result -- at this time -- we make no promises on the support for Firebird 6.0 by Jaybird 6.
431+
We may delay support for Firebird 6.0 until Jaybird 7, or we may improve support during maintenance releases of Jaybird 6.
432+
====
433+
414434
By default, Jaybird 6 -- using the pure Java protocol -- will not connect to Firebird 2.5 and older.
415435
See <<connection-rejected-by-remote-interface-335544421>> for a workaround.
416436
@@ -420,6 +440,15 @@ See <<connection-rejected-by-remote-interface-335544421>> for a workaround.
420440
421441
Jaybird 5 supports Firebird 2.5, Firebird 3.0, Firebird 4.0, and Firebird 5.0.
422442
443+
.No promises on Firebird 6.0 support
444+
[WARNING#firebird-jaybird-5-fb6]
445+
====
446+
Firebird 6.0 is still in development, and includes changes -- like schema support -- that impact Jaybird.
447+
448+
As a result -- at this time -- we make no promises on the support for Firebird 6.0 by Jaybird 5.
449+
We may delay support for Firebird 6.0 until Jaybird 7, or we may improve support during maintenance releases of Jaybird 5 and/or Jaybird 6.
450+
====
451+
423452
Jaybird 5 is the last version to support Firebird 2.5.
424453
425454
[#firebird-jaybird-4]
@@ -472,7 +501,7 @@ Instead, we recommend building a webservice (e.g. REST-based) to mediate between
472501
Apart from this FAQ, you can get additional information from:
473502
474503
* https://firebirdsql.github.io/jaybird-manual/jaybird_manual.html[Jaybird JDBC Driver Java Programmer's Manual] (HTML, https://firebirdsql.github.io/jaybird-manual/jaybird_manual.pdf[PDF version]) (covers Jaybird 4 and higher)
475-
* https://www.firebirdsql.org/en/jdbc-driver/[Firebird website: Downloads, Connectivity, JDBC Driver]
504+
* https://firebirdsql.org/en/jdbc-driver/[Firebird website: Downloads, Connectivity, JDBC Driver]
476505
* https://firebirdsql.org/en/devel-jdbc-driver/[Firebird website: Development, JDBC Driver]
477506
* https://github.com/FirebirdSQL/jaybird/wiki/[Jaybird wiki]
478507
@@ -520,7 +549,7 @@ You can report bugs in the Jaybird bug tracker, {issues}.
520549
When reporting bugs, please provide a minimal, but complete reproduction, including databases and sourcecode to reproduce the problem.
521550
Patches to fix bugs are also appreciated.
522551
Make sure the patch is against a recent master version of the code.
523-
You can also fork the {jaybird-repo}[jaybird repository] and create pull requests.
552+
You can also fork the {jaybird-repo}[Jaybird repository] and create pull requests.
524553
525554
[#connecting-to-firebird]
526555
= Connecting to Firebird
@@ -575,7 +604,7 @@ Jaybird 4 and higher also support:
575604
576605
[NOTE]
577606
====
578-
This URL format is deprecated with jaybird 5 and was removed in Jaybird 6.
607+
This URL format is deprecated with Jaybird 5 and was removed in Jaybird 6.
579608
As a replacement, use the "`Firebird External`" option in LibreOffice Base.
580609
581610
See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2022-04-deprecate-ooremote.md[jdp-2022-04: Deprecate OOREMOTE (OpenOffice/LibreOffice driver) for removal].
@@ -729,7 +758,7 @@ It requires support on both client and server side.
729758
730759
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).
731760
732-
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.
761+
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.
733762
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).
734763
735764
[#common-connection-errors]
@@ -938,7 +967,7 @@ Jaybird itself no longer provides connection pooling.
938967
Earlier versions had a `DataSource` implementation with connection pooling, but this implementation had severe bugs.
939968
This implementation (and all other classes in `org.firebirdsql.pool`) was deprecated in Jaybird 2.2 and dropped in Jaybird 3.
940969
941-
Jaybird provides a basic `DataSource` implementation and a `ConnectionPoolDataSource` implementation.
970+
Jaybird provides a basic `DataSource`, an `XADataSource`, and a `ConnectionPoolDataSource` implementation.
942971
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_ a connection pool.
943972
944973
If your application is built on a Java EE/Jakarta 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`.

0 commit comments

Comments
 (0)