Skip to content

Commit ad6eefa

Browse files
committed
Sync documentation of main branch
1 parent 5f85aaf commit ad6eefa

File tree

6 files changed

+123
-13
lines changed

6 files changed

+123
-13
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86617,9 +86617,9 @@ endif::add-copy-button-to-env-var[]
8661786617
|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]]
8661886618
|`+++8K+++`
8661986619

86620-
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-compression[`quarkus.rest-client."client".enable-compression`]##
86620+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-response-decompression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-response-decompression[`quarkus.rest-client."client".enable-response-decompression`]##
8662186621
ifdef::add-copy-button-to-config-props[]
86622-
config_property_copy_button:+++quarkus.rest-client."client".enable-compression+++[]
86622+
config_property_copy_button:+++quarkus.rest-client."client".enable-response-decompression+++[]
8662386623
endif::add-copy-button-to-config-props[]
8662486624

8662586625

@@ -86631,10 +86631,10 @@ This property is not applicable to the RESTEasy Client.
8663186631

8663286632

8663386633
ifdef::add-copy-button-to-env-var[]
86634-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++[]
86634+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_RESPONSE_DECOMPRESSION+++[]
8663586635
endif::add-copy-button-to-env-var[]
8663686636
ifndef::add-copy-button-to-env-var[]
86637-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++`
86637+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_RESPONSE_DECOMPRESSION+++`
8663886638
endif::add-copy-button-to-env-var[]
8663986639
--
8664086640
|boolean

_generated-doc/main/config/quarkus-rest-client-config.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1730,9 +1730,9 @@ endif::add-copy-button-to-env-var[]
17301730
|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]]
17311731
|`+++8K+++`
17321732

1733-
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-compression[`quarkus.rest-client."client".enable-compression`]##
1733+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-response-decompression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-response-decompression[`quarkus.rest-client."client".enable-response-decompression`]##
17341734
ifdef::add-copy-button-to-config-props[]
1735-
config_property_copy_button:+++quarkus.rest-client."client".enable-compression+++[]
1735+
config_property_copy_button:+++quarkus.rest-client."client".enable-response-decompression+++[]
17361736
endif::add-copy-button-to-config-props[]
17371737

17381738

@@ -1744,10 +1744,10 @@ This property is not applicable to the RESTEasy Client.
17441744

17451745

17461746
ifdef::add-copy-button-to-env-var[]
1747-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++[]
1747+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_RESPONSE_DECOMPRESSION+++[]
17481748
endif::add-copy-button-to-env-var[]
17491749
ifndef::add-copy-button-to-env-var[]
1750-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++`
1750+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_RESPONSE_DECOMPRESSION+++`
17511751
endif::add-copy-button-to-env-var[]
17521752
--
17531753
|boolean

_generated-doc/main/config/quarkus-rest-client-config_quarkus.rest-client.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1730,9 +1730,9 @@ endif::add-copy-button-to-env-var[]
17301730
|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]]
17311731
|`+++8K+++`
17321732

1733-
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-compression[`quarkus.rest-client."client".enable-compression`]##
1733+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-response-decompression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-response-decompression[`quarkus.rest-client."client".enable-response-decompression`]##
17341734
ifdef::add-copy-button-to-config-props[]
1735-
config_property_copy_button:+++quarkus.rest-client."client".enable-compression+++[]
1735+
config_property_copy_button:+++quarkus.rest-client."client".enable-response-decompression+++[]
17361736
endif::add-copy-button-to-config-props[]
17371737

17381738

@@ -1744,10 +1744,10 @@ This property is not applicable to the RESTEasy Client.
17441744

17451745

17461746
ifdef::add-copy-button-to-env-var[]
1747-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++[]
1747+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_RESPONSE_DECOMPRESSION+++[]
17481748
endif::add-copy-button-to-env-var[]
17491749
ifndef::add-copy-button-to-env-var[]
1750-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++`
1750+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_RESPONSE_DECOMPRESSION+++`
17511751
endif::add-copy-button-to-env-var[]
17521752
--
17531753
|boolean

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4987,6 +4987,21 @@ h|Attributes
49874987

49884988

49894989

4990+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/EntityToPersistenceUnitBuildItem.java[`io.quarkus.hibernate.reactive.panache.deployment.EntityToPersistenceUnitBuildItem`, window="_blank"]
4991+
[.description]
4992+
--
4993+
Used to record that a specific JPA entity is associated with a specific persistence unit
4994+
-- a|`java.lang.String entityClass`
4995+
4996+
_No Javadoc found_
4997+
4998+
`java.lang.String persistenceUnitName`
4999+
5000+
_No Javadoc found_
5001+
5002+
5003+
5004+
49905005
a| https://github.com/quarkusio/quarkus/blob/main/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/PanacheEntityClassBuildItem.java[`io.quarkus.hibernate.reactive.panache.deployment.PanacheEntityClassBuildItem`, window="_blank"]
49915006
[.description]
49925007
--

_generated-doc/main/infra/quarkus-maven-plugin-goals.adoc

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ a| [[quarkus-maven-plugin-goal-add-extension-project]] project
4343
|`MavenProject`
4444
|`${project}`
4545

46+
a| [[quarkus-maven-plugin-goal-add-extension-refresh]] refresh
47+
48+
[.description]
49+
--
50+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
51+
--
52+
|`boolean`
53+
|`false`
54+
4655
a| [[quarkus-maven-plugin-goal-add-extension-repoSession]] repoSession
4756
|`RepositorySystemSession`
4857
|`${repositorySystemSession}`
@@ -102,6 +111,15 @@ a| [[quarkus-maven-plugin-goal-add-extensions-project]] project
102111
|`MavenProject`
103112
|`${project}`
104113

114+
a| [[quarkus-maven-plugin-goal-add-extensions-refresh]] refresh
115+
116+
[.description]
117+
--
118+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
119+
--
120+
|`boolean`
121+
|`false`
122+
105123
a| [[quarkus-maven-plugin-goal-add-extensions-repoSession]] repoSession
106124
|`RepositorySystemSession`
107125
|`${repositorySystemSession}`
@@ -489,6 +507,15 @@ a| [[quarkus-maven-plugin-goal-create-projectVersion]] projectVersion
489507
|`String`
490508
|
491509

510+
a| [[quarkus-maven-plugin-goal-create-refresh]] refresh
511+
512+
[.description]
513+
--
514+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
515+
--
516+
|`boolean`
517+
|`false`
518+
492519
a| [[quarkus-maven-plugin-goal-create-repoSession]] repoSession
493520
|`RepositorySystemSession`
494521
|`${repositorySystemSession}`
@@ -2352,6 +2379,15 @@ a| [[quarkus-maven-plugin-goal-info-project]] project
23522379
|`MavenProject`
23532380
|`${project}`
23542381

2382+
a| [[quarkus-maven-plugin-goal-info-refresh]] refresh
2383+
2384+
[.description]
2385+
--
2386+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
2387+
--
2388+
|`boolean`
2389+
|`false`
2390+
23552391
a| [[quarkus-maven-plugin-goal-info-repoSession]] repoSession
23562392
|`RepositorySystemSession`
23572393
|`${repositorySystemSession}`
@@ -2402,6 +2438,15 @@ a| [[quarkus-maven-plugin-goal-list-categories-project]] project
24022438
|`MavenProject`
24032439
|`${project}`
24042440

2441+
a| [[quarkus-maven-plugin-goal-list-categories-refresh]] refresh
2442+
2443+
[.description]
2444+
--
2445+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
2446+
--
2447+
|`boolean`
2448+
|`false`
2449+
24052450
a| [[quarkus-maven-plugin-goal-list-categories-repoSession]] repoSession
24062451
|`RepositorySystemSession`
24072452
|`${repositorySystemSession}`
@@ -2479,6 +2524,15 @@ a| [[quarkus-maven-plugin-goal-list-extensions-project]] project
24792524
|`MavenProject`
24802525
|`${project}`
24812526

2527+
a| [[quarkus-maven-plugin-goal-list-extensions-refresh]] refresh
2528+
2529+
[.description]
2530+
--
2531+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
2532+
--
2533+
|`boolean`
2534+
|`false`
2535+
24822536
a| [[quarkus-maven-plugin-goal-list-extensions-repoSession]] repoSession
24832537
|`RepositorySystemSession`
24842538
|`${repositorySystemSession}`
@@ -2538,6 +2592,15 @@ a| [[quarkus-maven-plugin-goal-list-platforms-project]] project
25382592
|`MavenProject`
25392593
|`${project}`
25402594

2595+
a| [[quarkus-maven-plugin-goal-list-platforms-refresh]] refresh
2596+
2597+
[.description]
2598+
--
2599+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
2600+
--
2601+
|`boolean`
2602+
|`false`
2603+
25412604
a| [[quarkus-maven-plugin-goal-list-platforms-repoSession]] repoSession
25422605
|`RepositorySystemSession`
25432606
|`${repositorySystemSession}`
@@ -3331,6 +3394,15 @@ a| [[quarkus-maven-plugin-goal-remove-extension-project]] project
33313394
|`MavenProject`
33323395
|`${project}`
33333396

3397+
a| [[quarkus-maven-plugin-goal-remove-extension-refresh]] refresh
3398+
3399+
[.description]
3400+
--
3401+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
3402+
--
3403+
|`boolean`
3404+
|`false`
3405+
33343406
a| [[quarkus-maven-plugin-goal-remove-extension-repoSession]] repoSession
33353407
|`RepositorySystemSession`
33363408
|`${repositorySystemSession}`
@@ -3390,6 +3462,15 @@ a| [[quarkus-maven-plugin-goal-remove-extensions-project]] project
33903462
|`MavenProject`
33913463
|`${project}`
33923464

3465+
a| [[quarkus-maven-plugin-goal-remove-extensions-refresh]] refresh
3466+
3467+
[.description]
3468+
--
3469+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
3470+
--
3471+
|`boolean`
3472+
|`false`
3473+
33933474
a| [[quarkus-maven-plugin-goal-remove-extensions-repoSession]] repoSession
33943475
|`RepositorySystemSession`
33953476
|`${repositorySystemSession}`
@@ -4072,6 +4153,15 @@ a| [[quarkus-maven-plugin-goal-update-project]] project
40724153
|`MavenProject`
40734154
|`${project}`
40744155

4156+
a| [[quarkus-maven-plugin-goal-update-refresh]] refresh
4157+
4158+
[.description]
4159+
--
4160+
Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
4161+
--
4162+
|`boolean`
4163+
|`false`
4164+
40754165
a| [[quarkus-maven-plugin-goal-update-repoSession]] repoSession
40764166
|`RepositorySystemSession`
40774167
|`${repositorySystemSession}`

_versions/main/guides/hibernate-reactive-panache.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,10 @@ If no annotations are found.
772772

773773
== Multiple Persistence Units
774774

775-
Hibernate Reactive in Quarkus currently does not support multiple persistence units.
775+
Hibernate Reactive with Panache supports multiple persistence units.
776+
When using multiple persistence units, Panache automatically uses the correct persistence unit based on the entity's configuration.
777+
778+
For configuration details on setting up multiple persistence units, refer to the xref:hibernate-orm.adoc#multiple-persistence-units[Multiple Persistence Units] section in the Hibernate ORM guide.
776779

777780
[[transactions]]
778781
== Sessions and Transactions
@@ -783,13 +786,15 @@ For example, if a Panache entity method is invoked in a Jakarta REST resource me
783786
For other cases, there are both a declarative and a programmatic way to ensure the session is opened.
784787
You can annotate a CDI business method that returns `Uni` with the `@WithSession` annotation.
785788
The method will be intercepted and the returned `Uni` will be triggered within a scope of a reactive session.
789+
If you have multiple persistence units, you can specify which one to use by providing the persistence unit name as the annotation value: `@WithSession("my-persistence-unit")`. If not specified, the default persistence unit is used.
786790
Alternatively, you can use the `Panache.withSession()` method to achieve the same effect.
787791

788792
NOTE: Note that a Panache entity may not be used from a blocking thread. See also xref:getting-started-reactive.adoc[Getting Started With Reactive] guide that explains the basics of reactive principles in Quarkus.
789793

790794
Also make sure to wrap methods that modify the database or involve multiple queries (e.g. `entity.persist()`) within a transaction.
791795
You can annotate a CDI business method that returns `Uni` with the `@WithTransaction` annotation.
792796
The method will be intercepted and the returned `Uni` is triggered within a transaction boundary.
797+
If you have multiple persistence units, you can specify which one to use by providing the persistence unit name as the annotation value: `@WithTransaction("my-persistence-unit")`. If not specified, the default persistence unit is used.
793798
Alternatively, you can use the `Panache.withTransaction()` method for the same effect.
794799

795800
IMPORTANT: You cannot use the `@Transactional` annotation with Hibernate Reactive for your transactions: you must use `@WithTransaction`, and your annotated method must return a `Uni` to be non-blocking.

0 commit comments

Comments
 (0)