Skip to content

Commit 67cadbd

Browse files
committed
Sync documentation of main branch
1 parent 57ae1b5 commit 67cadbd

File tree

11 files changed

+22
-59
lines changed

11 files changed

+22
-59
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ types:
6363
- io.quarkus:quarkus-reactive-db2-client
6464
- io.quarkus:quarkus-reactive-mssql-client
6565
- io.quarkus:quarkus-jdbc-db2
66-
- io.quarkus:quarkus-jdbc-derby
6766
- io.quarkus:quarkus-jdbc-h2
6867
- io.quarkus:quarkus-jdbc-mariadb
6968
- io.quarkus:quarkus-jdbc-mssql
@@ -1530,7 +1529,6 @@ types:
15301529
- io.quarkus:quarkus-reactive-oracle-client
15311530
- io.quarkus:quarkus-reactive-pg-client
15321531
- io.quarkus:quarkus-jdbc-db2
1533-
- io.quarkus:quarkus-jdbc-derby
15341532
- io.quarkus:quarkus-jdbc-h2
15351533
- io.quarkus:quarkus-jdbc-mariadb
15361534
- io.quarkus:quarkus-jdbc-mssql

_data/versioned/main/index/relations.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2967,7 +2967,7 @@
29672967
- title: Configure data sources in Quarkus
29682968
url: /guides/datasource
29692969
type: reference
2970-
matches: 12
2970+
matches: 11
29712971
- title: Reactive SQL Clients
29722972
url: /guides/reactive-sql-clients
29732973
type: guide
@@ -3122,7 +3122,7 @@
31223122
- title: Dev Services for Databases
31233123
url: /guides/databases-dev-services
31243124
type: guide
3125-
matches: 12
3125+
matches: 11
31263126
- title: Reactive SQL Clients
31273127
url: /guides/reactive-sql-clients
31283128
type: guide

_generated-doc/main/infra/quarkus-all-build-items.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6961,11 +6961,11 @@ _No Javadoc found_
69616961

69626962
_No Javadoc found_
69636963

6964-
`java.util.Map<String,Path> localizedFiles`
6964+
`java.util.Map<String,List<MessageFile>> localizedFiles`
69656965

69666966
_No Javadoc found_
69676967

6968-
`java.util.Map<String,Path> mergeCandidates`
6968+
`java.util.Map<String,List<MessageFile>> mergeCandidates`
69696969

69706970
_No Javadoc found_
69716971

_versions/main/guides/cli-tooling.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,6 @@ JDBC Driver - MariaDB quarkus-jdbc-mariadb
461461
JDBC Driver - Microsoft SQL Server quarkus-jdbc-mssql
462462
JDBC Driver - MySQL quarkus-jdbc-mysql
463463
JDBC Driver - Oracle quarkus-jdbc-oracle
464-
JDBC Driver - Derby quarkus-jdbc-derby
465464
Elytron Security JDBC quarkus-elytron-security-jdbc
466465
Agroal - Database connection pool quarkus-agroal
467466
----

_versions/main/guides/databases-dev-services.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
77
:categories: data, tooling
88
include::_attributes.adoc[]
99
:topics: dev-services,data,database,datasource,dev-mode,testing
10-
:extensions: io.quarkus:quarkus-agroal,io.quarkus:quarkus-reactive-mysql-client,io.quarkus:quarkus-reactive-oracle-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-jdbc-db2,io.quarkus:quarkus-jdbc-derby,io.quarkus:quarkus-jdbc-h2,io.quarkus:quarkus-jdbc-mariadb,io.quarkus:quarkus-jdbc-mssql,io.quarkus:quarkus-jdbc-mysql,io.quarkus:quarkus-jdbc-oracle,io.quarkus:quarkus-jdbc-postgresql
10+
:extensions: io.quarkus:quarkus-agroal,io.quarkus:quarkus-reactive-mysql-client,io.quarkus:quarkus-reactive-oracle-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-jdbc-db2,io.quarkus:quarkus-jdbc-h2,io.quarkus:quarkus-jdbc-mariadb,io.quarkus:quarkus-jdbc-mssql,io.quarkus:quarkus-jdbc-mysql,io.quarkus:quarkus-jdbc-oracle,io.quarkus:quarkus-jdbc-postgresql
1111

1212
When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services.
1313
Depending on your database type you may need Docker installed in order to use this feature.
1414
Dev Services is supported for the following databases:
1515

1616
* DB2 (container) (requires <<#license_acceptance,license acceptance>>)
17-
* Derby (in-process)
1817
* H2 (in-process)
1918
* MariaDB (container)
2019
* Microsoft SQL Server (container) (requires <<#license_acceptance,license acceptance>>)
@@ -43,7 +42,7 @@ quarkus.devservices.enabled=false
4342
quarkus.datasource.devservices.enabled=false
4443
----
4544

46-
Dev Services for databases relies on Docker to start the server (except for H2 and Derby which are run in process).
45+
Dev Services for databases relies on Docker to start the server (except for H2 which is run in process).
4746
If your environment does not support Docker, you will need to start the server manually, or connect to an already running server.
4847

4948
[[license_acceptance]]
@@ -90,7 +89,7 @@ Quarkus will (by default) stop all database Dev Services.
9089
[[reuse-across-executions]]
9190
=== Reusing Dev Service containers across runs
9291

93-
Assuming you rely on Dev Services based on containers (unlike H2 or Derby),
92+
Assuming you rely on Dev Services based on containers (unlike H2),
9493
if you want to keep Dev Service containers running *after a dev mode session or test suite execution*
9594
to reuse them in the next dev mode session or test suite execution,
9695
this is possible as well.

_versions/main/guides/datasource.adoc

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ include::_attributes.adoc[]
99
:diataxis-type: reference
1010
:categories: data,getting-started,reactive
1111
:topics: data,database,datasource,sql,jdbc,reactive
12-
:extensions: io.quarkus:quarkus-agroal,io.quarkus:quarkus-reactive-mysql-client,io.quarkus:quarkus-reactive-oracle-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-reactive-db2-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-reactive-mssql-client,io.quarkus:quarkus-jdbc-db2,io.quarkus:quarkus-jdbc-derby,io.quarkus:quarkus-jdbc-h2,io.quarkus:quarkus-jdbc-mariadb,io.quarkus:quarkus-jdbc-mssql,io.quarkus:quarkus-jdbc-mysql,io.quarkus:quarkus-jdbc-oracle,io.quarkus:quarkus-jdbc-postgresql
12+
:extensions: io.quarkus:quarkus-agroal,io.quarkus:quarkus-reactive-mysql-client,io.quarkus:quarkus-reactive-oracle-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-reactive-db2-client,io.quarkus:quarkus-reactive-pg-client,io.quarkus:quarkus-reactive-mssql-client,io.quarkus:quarkus-jdbc-db2,io.quarkus:quarkus-jdbc-h2,io.quarkus:quarkus-jdbc-mariadb,io.quarkus:quarkus-jdbc-mssql,io.quarkus:quarkus-jdbc-mysql,io.quarkus:quarkus-jdbc-oracle,io.quarkus:quarkus-jdbc-postgresql
1313

1414
Use a unified configuration model to define data sources for Java Database Connectivity (JDBC) and Reactive drivers.
1515

@@ -64,9 +64,6 @@ For more details and optional configurations, see xref:databases-dev-services.ad
6464
. Add the correct JDBC extension for the database of your choice.
6565

6666
* `quarkus-jdbc-db2`
67-
* `quarkus-jdbc-derby`
68-
+
69-
include::_includes/snip-note-derby.adoc[]
7067
* `quarkus-jdbc-h2`
7168
* `quarkus-jdbc-mariadb`
7269
* `quarkus-jdbc-mssql`
@@ -152,9 +149,6 @@ If the application operates with a single driver, this driver is detected automa
152149
Quarkus currently includes the following built-in database kinds:
153150
+
154151
* DB2: `db2`
155-
* Derby: `derby`
156-
+
157-
include::_includes/snip-note-derby.adoc[]
158152
* H2: `h2`
159153
* MariaDB: `mariadb`
160154
* Microsoft SQL Server: `mssql`
@@ -194,14 +188,11 @@ JDBC is the most common database connection pattern, typically needed when used
194188

195189
.. For use with a built-in JDBC driver, choose and add the Quarkus extension for your relational database driver from the list below:
196190
+
197-
* Derby - `quarkus-jdbc-derby`
198-
+
199-
include::_includes/snip-note-derby.adoc[]
200191
* H2 - `quarkus-jdbc-h2`
201192
+
202193
[NOTE]
203194
====
204-
You can configure H2 and Derby databases to run in "embedded mode"; however, the Derby extension does not support compiling the embedded database engine into native executables.
195+
You can configure H2 databases to run in "embedded mode"
205196
206197
For suggestions regarding integration testing, see <<in-memory-databases,Testing with in-memory databases>> .
207198
====
@@ -700,20 +691,17 @@ You will usually specify the `db-kind` property or explicitly enable Dev Service
700691
[[in-memory-databases]]
701692
=== Testing with in-memory databases
702693

703-
Some databases like H2 and Derby are commonly used in the _embedded mode_ as a facility to run integration tests quickly.
694+
Some databases like H2 are commonly used in the _embedded mode_ as a facility to run integration tests quickly.
704695

705696
The recommended approach is to use the database intended for production to get results as close as possible to a production environment.
706697
This is made easier by xref:databases-dev-services.adoc[Dev Services] because they require no configuration and start relatively quickly.
707698
However, it is also possible to use JVM-powered databases for scenarios when the ability to run simple integration tests is required.
708699

709700
==== Support and limitations
710701

711-
Embedded databases (H2 and Derby) work in JVM mode.
702+
Embedded databases (H2) work in JVM mode.
712703
For native mode, the following limitations apply:
713704

714-
* Derby cannot be embedded into the application in native mode.
715-
However, the Quarkus Derby extension allows native compilation of the Derby JDBC *client*, supporting *remote* connections.
716-
717705
* Embedding H2 within your native image is not recommended.
718706
Consider using an alternative approach, for example, using a remote connection to a separate database instead.
719707

@@ -723,14 +711,12 @@ ifndef::no-deprecated-test-resource[]
723711
. Add a dependency on the artifacts providing the additional tools that are under the following Maven coordinates:
724712
+
725713
* `io.quarkus:quarkus-test-h2` for H2
726-
* `io.quarkus:quarkus-test-derby` for Derby
727714
+
728715
This will allow you to test your application even when it is compiled into a native executable while the database will run as a JVM process.
729716

730717
. Add the following specific annotation on any class in your integration tests for running integration tests in both JVM or native executables:
731718
+
732719
* `@QuarkusTestResource(H2DatabaseTestResource.class)`
733-
* `@QuarkusTestResource(DerbyDatabaseTestResource.class)`
734720
+
735721
This ensures that the test suite starts and terminates the managed database in a separate process as required for test execution.
736722
+
@@ -783,17 +769,6 @@ Example:: `jdbc:db2://localhost:50000/MYDB:user=dbadm;password=dbadm;`
783769

784770
For more information on URL syntax and additional supported options, see the link:https://www.ibm.com/support/knowledgecenter/SSEPGG_11.5.0/com.ibm.db2.luw.apdv.java.doc/src/tpc/imjcc_r0052342.html[official documentation].
785771

786-
==== Derby
787-
788-
`jdbc:derby:[//serverName[:portNumber]/][memory:]databaseName[;property=value[;property=value]]`
789-
790-
Example:: `jdbc:derby://localhost:1527/myDB`, `jdbc:derby:memory:myDB;create=true`
791-
792-
Derby is an embedded database that can run as a server, based on a file, or can run completely in memory.
793-
All of these options are available as listed above.
794-
795-
For more information, see the link:https://db.apache.org/derby/docs/10.8/devguide/cdevdvlp17453.html#cdevdvlp17453[official documentation].
796-
797772
==== H2
798773

799774
`jdbc:h2:{ {.|mem:}[name] | [file:]fileName | {tcp|ssl}:[//]server[:port][,server2[:port]]/name }[;key=value...]`
@@ -882,12 +857,6 @@ a|* JDBC: `com.ibm.db2.jcc.DB2Driver`
882857

883858
* XA: `com.ibm.db2.jcc.DB2XADataSource`
884859

885-
|`derby`
886-
|`quarkus-jdbc-derby`
887-
a|* JDBC: `org.apache.derby.jdbc.ClientDriver`
888-
889-
* XA: `org.apache.derby.jdbc.ClientXADataSource`
890-
891860
|`h2`
892861
|`quarkus-jdbc-h2`
893862
a|* JDBC: `org.h2.Driver`

_versions/main/guides/dev-services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ and the database URL has not been configured. More information can be found in t
8080
xref:databases-dev-services.adoc[Databases Dev Services Guide].
8181

8282
Quarkus provides Dev Services for all databases it supports. Most of these are run in a container, except
83-
H2 and Derby which are run in-process. Dev Services are supported for both JDBC and reactive drivers.
83+
H2 which is run in-process. Dev Services are supported for both JDBC and reactive drivers.
8484

8585
Those relational databases that are running in a container are started using Testcontainers and support "reusable instances";
8686
this implies that if you add the property `testcontainers.reuse.enable=true` in your Testcontainers configuration file,

_versions/main/guides/extension-writing-dev-service.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Here, the https://hub.docker.com/_/hello-world[`hello-world`] image is used, but
4848

4949
[source,java]
5050
----
51-
@BuildStep(onlyIfNot = IsNormal.class, onlyIf = DevServicesConfig.Enabled.class)
51+
@BuildSteps(onlyIf = { IsDevServicesSupportedByLaunchMode.class, DevServicesConfig.Enabled.class })
5252
public DevServicesResultBuildItem createContainer() {
5353
DockerImageName dockerImageName = DockerImageName.parse("hello-world");
5454
GenericContainer container = new GenericContainer<>(dockerImageName)
@@ -118,7 +118,7 @@ For example,
118118

119119
[source,java]
120120
----
121-
@BuildStep(onlyIfNot = IsNormal.class, onlyIf = DevServicesConfig.Enabled.class)
121+
@BuildSteps(onlyIf = { IsDevServicesSupportedByLaunchMode.class, DevServicesConfig.Enabled.class })
122122
public DevServicesResultBuildItem createContainer(MyConfig config) {}
123123
----
124124

_versions/main/guides/flyway.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,6 @@ In your build file, add the following dependencies:
7575
<artifactId>flyway-database-db2</artifactId>
7676
</dependency>
7777
78-
<!-- Derby specific dependencies -->
79-
<dependency>
80-
<groupId>org.flywaydb</groupId>
81-
<artifactId>flyway-database-derby</artifactId>
82-
</dependency>
83-
8478
<!-- HSQLDB specific dependencies -->
8579
<dependency>
8680
<groupId>org.flywaydb</groupId>
@@ -160,8 +154,6 @@ implementation("org.flywaydb:flyway-database-oracle")
160154
implementation("org.flywaydb:flyway-database-postgresql")
161155
// Flyway DB2 specific dependencies
162156
implementation("org.flywaydb:flyway-database-db2")
163-
// Flyway Derby specific dependencies
164-
implementation("org.flywaydb:flyway-database-derby")
165157
// HSQLDB specific dependencies
166158
implementation("org.flywaydb:flyway-database-hsqldb")
167159
// Informix specific dependencies

_versions/main/guides/hibernate-orm.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Add the following dependencies to your project:
4242
* the Hibernate ORM extension: `io.quarkus:quarkus-hibernate-orm`
4343
* your JDBC driver extension; the following options are available:
4444
- `quarkus-jdbc-db2` for link:https://www.ibm.com/products/db2-database[IBM DB2]
45-
- `quarkus-jdbc-derby` for link:https://db.apache.org/derby/[Apache Derby]
4645
- `quarkus-jdbc-h2` for link:https://www.h2database.com/html/main.html[H2]
4746
- `quarkus-jdbc-mariadb` for link:https://mariadb.com/[MariaDB]
4847
- `quarkus-jdbc-mssql` for link:https://www.microsoft.com/en-gb/sql-server/[Microsoft SQL Server]

0 commit comments

Comments
 (0)