diff --git a/src/documentation/faq.md b/src/documentation/faq.md index b1e2301498..e2648e99cc 100644 --- a/src/documentation/faq.md +++ b/src/documentation/faq.md @@ -8,24 +8,25 @@ Where do I get Jaybird? #### Jaybird 4 #### -NOTE: Jaybird 4 is in beta. Use [Jaybird 3.0] for production. +NOTE: Jaybird 4 is in beta. Use [Jaybird 3.0](#jaybird-3.0) for production. Jaybird 4 is available from Maven central: Groupid: `org.firebirdsql.jdbc`, Artifactid: `jaybird-XX` (where `XX` is `jdk17`, `jdk18` or `java11`) -Version: `4.0.0-beta-1` +Version: `4.0.0.javaXX-beta-1` (where `XX` is `7`, `8` or `11`) -For ease of use, we also provide a Maven relocation artifact with artifact id -`jaybird`. For Jaybird 4 this relocation artifact points to `jaybird-jdk18`. +For backwards compatibility, we also provide a Maven relocation artifact with +artifact id `jaybird-XX` (with `XX` `jdk17`, `jdk18` or `java11`. However, we +recommend switching to the `jaybird` artifact. For example, for Java 8: ~~~ {.xml} org.firebirdsql.jdbc - jaybird-jdk18 - 4.0.0-beta-1 + jaybird + 4.0.0.java8-beta-1 ~~~ @@ -36,8 +37,8 @@ dependency: ~~~ {.xml} org.firebirdsql.jdbc - jaybird-jdk18 - 4.0.0-beta-1 + jaybird + 4.0.0.java8-beta-1 javax.resource @@ -65,6 +66,8 @@ explicitly include JNA 5.3.0 as a dependency: ~~~ #### Jaybird 3.0 #### + + Jaybird 3.0 is available from Maven central: @@ -294,7 +297,7 @@ Contributing There are several ways you can contribute to Jaybird or Firebird in general: * Participate on the mailing lists (see ) -* Report bugs or submit patches on the tracker (see [Reporting Bugs]) +* Report bugs or submit patches on the tracker (see [Reporting Bugs](#reporting-bugs)) * Create pull requests on GitHub () * Become a developer (for Jaybird contact us on firebird-java, for Firebird in general, use the Firebird-devel mailing list) @@ -460,6 +463,8 @@ the database is used from different locales. When used as a connection character set, Jaybird handles `NONE` as follows: #### Jaybird 3.0 {#none-jaybird3} + + - `encoding=NONE` means connection encoding `NONE` and interpret columns with character set `NONE` using the default JVM encoding, and interpret columns @@ -469,6 +474,8 @@ When used as a connection character set, Jaybird handles `NONE` as follows: use `ISO-8859-1` #### Jaybird 2.2 and earlier {#none-jaybird2-2} + + - `encoding=NONE` means use connection encoding `NONE` and interpret everything using the default JVM encoding @@ -480,10 +487,11 @@ When used as a connection character set, Jaybird handles `NONE` as follows: 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`. +[How does character set `NONE` work?](#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"]. +[How can I solve the error "Connection rejected: No connection character set specified"](#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 @@ -514,7 +522,7 @@ one of the following options: set name. Use `encoding=NONE` for the default behavior (with some caveats, see - [How does character set `NONE` work?]). + [How does character set `NONE` work?](#how-does-character-set-none-work)). * Use connection property `charSet` (alias: `localEncoding`) with a Java character set name. @@ -531,7 +539,7 @@ one of the following options: 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?]). + default behavior (with some caveats, see [How does character set `NONE` work?](#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`.