Skip to content

Commit c549552

Browse files
committed
Sync documentation of main branch
1 parent a7378e8 commit c549552

File tree

3 files changed

+23
-143
lines changed

3 files changed

+23
-143
lines changed

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

Lines changed: 0 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -6413,121 +6413,6 @@ Validation parser hooks are never used at runtime.
64136413
_No Javadoc found_
64146414

64156415

6416-
|===
6417-
== Reactive DB2 Client
6418-
[.configuration-reference,cols=2*]
6419-
|===
6420-
h|Class Name
6421-
h|Attributes
6422-
6423-
6424-
6425-
6426-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-db2-client/deployment/src/main/java/io/quarkus/reactive/db2/client/deployment/DB2PoolBuildItem.java[`io.quarkus.reactive.db2.client.deployment.DB2PoolBuildItem`, window="_blank"]
6427-
[.description]
6428-
--
6429-
_No Javadoc found_
6430-
-- a|`java.lang.String dataSourceName`
6431-
6432-
_No Javadoc found_
6433-
6434-
`java.util.function.Function<SyntheticCreationalContext<DB2Pool>,DB2Pool> db2Pool`
6435-
6436-
_No Javadoc found_
6437-
6438-
6439-
|===
6440-
== Reactive Microsoft SQL Server Client
6441-
[.configuration-reference,cols=2*]
6442-
|===
6443-
h|Class Name
6444-
h|Attributes
6445-
6446-
6447-
6448-
6449-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-mssql-client/deployment/src/main/java/io/quarkus/reactive/mssql/client/deployment/MSSQLPoolBuildItem.java[`io.quarkus.reactive.mssql.client.deployment.MSSQLPoolBuildItem`, window="_blank"]
6450-
[.description]
6451-
--
6452-
_No Javadoc found_
6453-
-- a|`java.lang.String dataSourceName`
6454-
6455-
_No Javadoc found_
6456-
6457-
`java.util.function.Function<SyntheticCreationalContext<MSSQLPool>,MSSQLPool> mssqlPool`
6458-
6459-
_No Javadoc found_
6460-
6461-
6462-
|===
6463-
== Reactive MySQL Client
6464-
[.configuration-reference,cols=2*]
6465-
|===
6466-
h|Class Name
6467-
h|Attributes
6468-
6469-
6470-
6471-
6472-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-mysql-client/deployment/src/main/java/io/quarkus/reactive/mysql/client/deployment/MySQLPoolBuildItem.java[`io.quarkus.reactive.mysql.client.deployment.MySQLPoolBuildItem`, window="_blank"]
6473-
[.description]
6474-
--
6475-
_No Javadoc found_
6476-
-- a|`java.lang.String dataSourceName`
6477-
6478-
_No Javadoc found_
6479-
6480-
`java.util.function.Function<SyntheticCreationalContext<MySQLPool>,MySQLPool> mysqlPool`
6481-
6482-
_No Javadoc found_
6483-
6484-
6485-
|===
6486-
== Reactive Oracle Client
6487-
[.configuration-reference,cols=2*]
6488-
|===
6489-
h|Class Name
6490-
h|Attributes
6491-
6492-
6493-
6494-
6495-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-oracle-client/deployment/src/main/java/io/quarkus/reactive/oracle/client/deployment/OraclePoolBuildItem.java[`io.quarkus.reactive.oracle.client.deployment.OraclePoolBuildItem`, window="_blank"]
6496-
[.description]
6497-
--
6498-
_No Javadoc found_
6499-
-- a|`java.lang.String dataSourceName`
6500-
6501-
_No Javadoc found_
6502-
6503-
`java.util.function.Function<SyntheticCreationalContext<OraclePool>,OraclePool> oraclePool`
6504-
6505-
_No Javadoc found_
6506-
6507-
6508-
|===
6509-
== Reactive PostgreSQL Client
6510-
[.configuration-reference,cols=2*]
6511-
|===
6512-
h|Class Name
6513-
h|Attributes
6514-
6515-
6516-
6517-
6518-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-pg-client/deployment/src/main/java/io/quarkus/reactive/pg/client/deployment/PgPoolBuildItem.java[`io.quarkus.reactive.pg.client.deployment.PgPoolBuildItem`, window="_blank"]
6519-
[.description]
6520-
--
6521-
_No Javadoc found_
6522-
-- a|`java.lang.String dataSourceName`
6523-
6524-
_No Javadoc found_
6525-
6526-
`java.util.function.Function<SyntheticCreationalContext<PgPool>,PgPool> pgPool`
6527-
6528-
_No Javadoc found_
6529-
6530-
65316416
|===
65326417
== Reactive Routes
65336418
[.configuration-reference,cols=2*]

_versions/main/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
:logstash-image: docker.io/elastic/logstash:8.15.0
2020
:kibana-image: docker.io/elastic/kibana:8.15.0
2121
:keycloak-docker-image: quay.io/keycloak/keycloak:26.0.7
22-
:jandex-version: 3.2.6
22+
:jandex-version: 3.2.7
2323
:jandex-gradle-plugin-version: 1.0.0
2424
:kotlin-version: 2.0.21
2525
:grpc-version: 1.69.1

_versions/main/guides/reactive-sql-clients.adoc

Lines changed: 22 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ package org.acme.reactive.crud;
4444
4545
import io.smallrye.mutiny.Multi;
4646
import io.smallrye.mutiny.Uni;
47-
import io.vertx.mutiny.pgclient.PgPool;
47+
import io.vertx.mutiny.sqlclient.Pool;
4848
import io.vertx.mutiny.sqlclient.Row;
4949
import io.vertx.mutiny.sqlclient.RowSet;
5050
import io.vertx.mutiny.sqlclient.Tuple;
@@ -179,7 +179,7 @@ quarkus.datasource.password=quarkus_test
179179
quarkus.datasource.reactive.url=postgresql://localhost:5432/quarkus_test
180180
----
181181

182-
With that you can create your `FruitResource` skeleton and inject a `io.vertx.mutiny.pgclient.PgPool` instance:
182+
With that you can create your `FruitResource` skeleton and inject a `io.vertx.mutiny.sqlclient.Pool` instance:
183183

184184
[source,java]
185185
.src/main/java/org/acme/vertx/FruitResource.java
@@ -199,14 +199,14 @@ import jakarta.ws.rs.core.Response.Status;
199199
200200
import io.smallrye.mutiny.Multi;
201201
import io.smallrye.mutiny.Uni;
202-
import io.vertx.mutiny.pgclient.PgPool;
202+
import io.vertx.mutiny.sqlclient.Pool;
203203
204204
@Path("fruits")
205205
public class FruitResource {
206206
207-
private final PgPool client;
207+
private final Pool client;
208208
209-
public FruitResource(PgPool client) {
209+
public FruitResource(Pool client) {
210210
this.client = client;
211211
}
212212
}
@@ -226,7 +226,7 @@ But for development we can simply drop and create the tables on startup, and the
226226
package org.acme.reactive.crud;
227227
228228
import io.quarkus.runtime.StartupEvent;
229-
import io.vertx.mutiny.pgclient.PgPool;
229+
import io.vertx.mutiny.sqlclient.Pool;
230230
import org.eclipse.microprofile.config.inject.ConfigProperty;
231231
232232
import jakarta.enterprise.context.ApplicationScoped;
@@ -235,10 +235,10 @@ import jakarta.enterprise.event.Observes;
235235
@ApplicationScoped
236236
public class DBInit {
237237
238-
private final PgPool client;
238+
private final Pool client;
239239
private final boolean schemaCreate;
240240
241-
public DBInit(PgPool client, @ConfigProperty(name = "myapp.schema.create", defaultValue = "true") boolean schemaCreate) {
241+
public DBInit(Pool client, @ConfigProperty(name = "myapp.schema.create", defaultValue = "true") boolean schemaCreate) {
242242
this.client = client;
243243
this.schemaCreate = schemaCreate;
244244
}
@@ -293,7 +293,7 @@ To retrieve all the data, we will use the `query` method again:
293293
[source,java]
294294
./src/main/java/org/acme/reactive/crud/Fruit.java
295295
----
296-
public static Multi<Fruit> findAll(PgPool client) {
296+
public static Multi<Fruit> findAll(Pool client) {
297297
return client.query("SELECT id, name FROM fruits ORDER BY name ASC").execute()
298298
.onItem().transformToMulti(set -> Multi.createFrom().iterable(set)) // <1>
299299
.onItem().transform(Fruit::from); // <2>
@@ -350,7 +350,7 @@ Equipped with this tooling, we are able to safely use an `id` provided by the us
350350
[source,java]
351351
.src/main/java/org/acme/vertx/Fruit.java
352352
----
353-
public static Uni<Fruit> findById(PgPool client, Long id) {
353+
public static Uni<Fruit> findById(Pool client, Long id) {
354354
return client.preparedQuery("SELECT id, name FROM fruits WHERE id = $1").execute(Tuple.of(id)) // <1>
355355
.onItem().transform(RowSet::iterator) // <2>
356356
.onItem().transform(iterator -> iterator.hasNext() ? from(iterator.next()) : null); // <3>
@@ -381,7 +381,7 @@ The same logic applies when saving a `Fruit`:
381381
[source,java]
382382
.src/main/java/org/acme/vertx/Fruit.java
383383
----
384-
public Uni<Long> save(PgPool client) {
384+
public Uni<Long> save(Pool client) {
385385
return client.preparedQuery("INSERT INTO fruits (name) VALUES ($1) RETURNING id").execute(Tuple.of(name))
386386
.onItem().transform(pgRowSet -> pgRowSet.iterator().next().getLong("id"));
387387
}
@@ -412,7 +412,7 @@ Let's use this to support removal of fruits in the database:
412412
[source,java]
413413
.src/main/java/org/acme/vertx/Fruit.java
414414
----
415-
public static Uni<Boolean> delete(PgPool client, Long id) {
415+
public static Uni<Boolean> delete(Pool client, Long id) {
416416
return client.preparedQuery("DELETE FROM fruits WHERE id = $1").execute(Tuple.of(id))
417417
.onItem().transform(pgRowSet -> pgRowSet.rowCount() == 1); // <1>
418418
}
@@ -524,33 +524,28 @@ Navigate to http://localhost:8080/fruits.html and read/create/delete some fruits
524524
[[reactive-sql-clients-details]]
525525
== Database Clients details
526526

527-
[cols="10,40,40,10"]
527+
[cols="15,70,15"]
528528
|===
529-
|Database |Extension name |Pool class name |Placeholders
529+
|Database |Extension name |Placeholders
530530

531531
|IBM Db2
532532
|`quarkus-reactive-db2-client`
533-
|`io.vertx.mutiny.db2client.DB2Pool`
534533
|`?`
535534

536535
|MariaDB/MySQL
537536
|`quarkus-reactive-mysql-client`
538-
|`io.vertx.mutiny.mysqlclient.MySQLPool`
539537
|`?`
540538

541539
|Microsoft SQL Server
542540
|`quarkus-reactive-mssql-client`
543-
|`io.vertx.mutiny.mssqlclient.MSSQLPool`
544541
|`@p1`, `@p2`, etc.
545542

546543
|Oracle
547544
|`quarkus-reactive-oracle-client`
548-
|`io.vertx.mutiny.oracleclient.OraclePool`
549545
|`?`
550546

551547
|PostgreSQL
552548
|`quarkus-reactive-pg-client`
553-
|`io.vertx.mutiny.pgclient.PgPool`
554549
|`$1`, `$2`, etc.
555550
|===
556551

@@ -570,7 +565,7 @@ The following snippet shows how to run 2 insertions in the same transaction:
570565

571566
[source, java]
572567
----
573-
public static Uni<Void> insertTwoFruits(PgPool client, Fruit fruit1, Fruit fruit2) {
568+
public static Uni<Void> insertTwoFruits(Pool client, Fruit fruit1, Fruit fruit2) {
574569
return client.withTransaction(conn -> {
575570
Uni<RowSet<Row>> insertOne = conn.preparedQuery("INSERT INTO fruits (name) VALUES ($1) RETURNING id")
576571
.execute(Tuple.of(fruit1.name));
@@ -691,11 +686,11 @@ You can then inject the clients as follows:
691686
[source,java]
692687
----
693688
@Inject <1>
694-
PgPool defaultClient;
689+
Pool defaultClient;
695690
696691
@Inject
697692
@ReactiveDataSource("additional1") <2>
698-
PgPool additional1Client;
693+
Pool additional1Client;
699694
700695
@Inject
701696
@ReactiveDataSource("additional2")
@@ -830,18 +825,18 @@ import jakarta.inject.Singleton;
830825
831826
import io.quarkus.reactive.pg.client.PgPoolCreator;
832827
import io.vertx.pgclient.PgConnectOptions;
833-
import io.vertx.pgclient.PgPool;
828+
import io.vertx.sqlclient.Pool;
834829
import io.vertx.sqlclient.PoolOptions;
835830
836831
@Singleton
837832
public class CustomPgPoolCreator implements PgPoolCreator {
838833
839834
@Override
840-
public PgPool create(Input input) {
835+
public Pool create(Input input) {
841836
PgConnectOptions connectOptions = input.pgConnectOptions();
842837
PoolOptions poolOptions = input.poolOptions();
843838
// Customize connectOptions, poolOptions or both, as required
844-
return PgPool.pool(input.vertx(), connectOptions, poolOptions);
839+
return Pool.pool(input.vertx(), connectOptions, poolOptions);
845840
}
846841
}
847842
----
@@ -860,12 +855,12 @@ Here's an example for PostgreSQL:
860855
import jakarta.inject.Inject;
861856
862857
import io.smallrye.mutiny.Uni;
863-
import io.vertx.mutiny.pgclient.PgPool;
858+
import io.vertx.mutiny.sqlclient.Pool;
864859
865860
public class PipeliningExample {
866861
867862
@Inject
868-
PgPool client;
863+
Pool client;
869864
870865
public Uni<String> favoriteFruitAndVegetable() {
871866
// Explicitly acquire a connection

0 commit comments

Comments
 (0)