Skip to content

Commit c90bfe0

Browse files
committed
Sync documentation of main branch
1 parent 944ee62 commit c90bfe0

15 files changed

+359
-240
lines changed

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

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77441,7 +77441,7 @@ endif::add-copy-button-to-config-props[]
7744177441

7744277442
[.description]
7744377443
--
77444-
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
77444+
The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:++{++cache-name`++}++" will be used. The variable "`++{++cache-name`++}++" is resolved from the value set in the cache annotations.
7744577445

7744677446

7744777447
ifdef::add-copy-button-to-env-var[]
@@ -77571,7 +77571,7 @@ endif::add-copy-button-to-config-props[]
7757177571

7757277572
[.description]
7757377573
--
77574-
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
77574+
The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:++{++cache-name`++}++" will be used. The variable "`++{++cache-name`++}++" is resolved from the value set in the cache annotations.
7757577575

7757677576

7757777577
ifdef::add-copy-button-to-env-var[]
@@ -83494,7 +83494,7 @@ endif::add-copy-button-to-config-props[]
8349483494

8349583495
[.description]
8349683496
--
83497-
The max HTTP ch unk size (8096 bytes by default).
83497+
The max HTTP chunk size (8096 bytes by default).
8349883498

8349983499
This property is not applicable to the RESTEasy Client.
8350083500

@@ -83551,6 +83551,27 @@ endif::add-copy-button-to-env-var[]
8355183551
|boolean
8355283552
|
8355383553

83554+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-disable-default-mapper]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-disable-default-mapper[`quarkus.rest-client."client".disable-default-mapper`]##
83555+
ifdef::add-copy-button-to-config-props[]
83556+
config_property_copy_button:+++quarkus.rest-client."client".disable-default-mapper+++[]
83557+
endif::add-copy-button-to-config-props[]
83558+
83559+
83560+
[.description]
83561+
--
83562+
If set to `true`, then this REST Client will not the default exception mapper which always throws an exception if HTTP response code >= 400. This property is not applicable to the RESTEasy Client.
83563+
83564+
83565+
ifdef::add-copy-button-to-env-var[]
83566+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__DISABLE_DEFAULT_MAPPER+++[]
83567+
endif::add-copy-button-to-env-var[]
83568+
ifndef::add-copy-button-to-env-var[]
83569+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__DISABLE_DEFAULT_MAPPER+++`
83570+
endif::add-copy-button-to-env-var[]
83571+
--
83572+
|boolean
83573+
|`${microprofile.rest.client.disable.default.mapper:false}`
83574+
8355483575

8355583576
h|[.extension-name]##REST Kotlin Serialization ##
8355683577
h|Type

_generated-doc/main/config/quarkus-redis-cache.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ endif::add-copy-button-to-config-props[]
120120

121121
[.description]
122122
--
123-
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
123+
The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:++{++cache-name`++}++" will be used. The variable "`++{++cache-name`++}++" is resolved from the value set in the cache annotations.
124124

125125

126126
ifdef::add-copy-button-to-env-var[]
@@ -250,7 +250,7 @@ endif::add-copy-button-to-config-props[]
250250

251251
[.description]
252252
--
253-
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
253+
The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:++{++cache-name`++}++" will be used. The variable "`++{++cache-name`++}++" is resolved from the value set in the cache annotations.
254254

255255

256256
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-redis-cache_quarkus.cache.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ endif::add-copy-button-to-config-props[]
120120

121121
[.description]
122122
--
123-
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
123+
The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:++{++cache-name`++}++" will be used. The variable "`++{++cache-name`++}++" is resolved from the value set in the cache annotations.
124124

125125

126126
ifdef::add-copy-button-to-env-var[]
@@ -250,7 +250,7 @@ endif::add-copy-button-to-config-props[]
250250

251251
[.description]
252252
--
253-
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
253+
The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:++{++cache-name`++}++" will be used. The variable "`++{++cache-name`++}++" is resolved from the value set in the cache annotations.
254254

255255

256256
ifdef::add-copy-button-to-env-var[]

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1590,7 +1590,7 @@ endif::add-copy-button-to-config-props[]
15901590

15911591
[.description]
15921592
--
1593-
The max HTTP ch unk size (8096 bytes by default).
1593+
The max HTTP chunk size (8096 bytes by default).
15941594

15951595
This property is not applicable to the RESTEasy Client.
15961596

@@ -1647,6 +1647,27 @@ endif::add-copy-button-to-env-var[]
16471647
|boolean
16481648
|
16491649

1650+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-disable-default-mapper]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-disable-default-mapper[`quarkus.rest-client."client".disable-default-mapper`]##
1651+
ifdef::add-copy-button-to-config-props[]
1652+
config_property_copy_button:+++quarkus.rest-client."client".disable-default-mapper+++[]
1653+
endif::add-copy-button-to-config-props[]
1654+
1655+
1656+
[.description]
1657+
--
1658+
If set to `true`, then this REST Client will not the default exception mapper which always throws an exception if HTTP response code >= 400. This property is not applicable to the RESTEasy Client.
1659+
1660+
1661+
ifdef::add-copy-button-to-env-var[]
1662+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__DISABLE_DEFAULT_MAPPER+++[]
1663+
endif::add-copy-button-to-env-var[]
1664+
ifndef::add-copy-button-to-env-var[]
1665+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__DISABLE_DEFAULT_MAPPER+++`
1666+
endif::add-copy-button-to-env-var[]
1667+
--
1668+
|boolean
1669+
|`${microprofile.rest.client.disable.default.mapper:false}`
1670+
16501671
|===
16511672

16521673
ifndef::no-memory-size-note[]

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1590,7 +1590,7 @@ endif::add-copy-button-to-config-props[]
15901590

15911591
[.description]
15921592
--
1593-
The max HTTP ch unk size (8096 bytes by default).
1593+
The max HTTP chunk size (8096 bytes by default).
15941594

15951595
This property is not applicable to the RESTEasy Client.
15961596

@@ -1647,6 +1647,27 @@ endif::add-copy-button-to-env-var[]
16471647
|boolean
16481648
|
16491649

1650+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-disable-default-mapper]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-disable-default-mapper[`quarkus.rest-client."client".disable-default-mapper`]##
1651+
ifdef::add-copy-button-to-config-props[]
1652+
config_property_copy_button:+++quarkus.rest-client."client".disable-default-mapper+++[]
1653+
endif::add-copy-button-to-config-props[]
1654+
1655+
1656+
[.description]
1657+
--
1658+
If set to `true`, then this REST Client will not the default exception mapper which always throws an exception if HTTP response code >= 400. This property is not applicable to the RESTEasy Client.
1659+
1660+
1661+
ifdef::add-copy-button-to-env-var[]
1662+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__DISABLE_DEFAULT_MAPPER+++[]
1663+
endif::add-copy-button-to-env-var[]
1664+
ifndef::add-copy-button-to-env-var[]
1665+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__DISABLE_DEFAULT_MAPPER+++`
1666+
endif::add-copy-button-to-env-var[]
1667+
--
1668+
|boolean
1669+
|`${microprofile.rest.client.disable.default.mapper:false}`
1670+
16501671
|===
16511672

16521673
ifndef::no-memory-size-note[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5693,7 +5693,7 @@ h|Attributes
56935693

56945694

56955695

5696-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/panache/mongodb-panache-common/deployment/src/main/java/io/quarkus/mongodb/panache/deployment/PanacheMongoEntityClassBuildItem.java[`io.quarkus.mongodb.panache.deployment.PanacheMongoEntityClassBuildItem`, window="_blank"]
5696+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/panache/mongodb-panache-common/deployment/src/main/java/io/quarkus/mongodb/panache/common/deployment/PanacheMongoEntityClassBuildItem.java[`io.quarkus.mongodb.panache.common.deployment.PanacheMongoEntityClassBuildItem`, window="_blank"]
56975697
[.description]
56985698
--
56995699
Represents a regular Panache entity class.

_versions/main/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
:jandex-version: 3.2.3
2323
:jandex-gradle-plugin-version: 1.0.0
2424
:kotlin-version: 2.0.21
25-
:grpc-version: 1.65.1
25+
:grpc-version: 1.68.2
2626
:protoc-version: 3.25.5
2727
:gcf-invoker-version: 1.3.0
2828
// Cannot simply use the name 'hibernate-*-version' here as it somehow gets

_versions/main/guides/cache-redis-reference.adoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ include::{includes}/extension-status.adoc[]
2121
When using Redis as the backend for Quarkus cache, each cached item will be stored in Redis:
2222

2323
- The backend uses the _<default>_ Redis client (if not configured otherwise), so make sure it's configured (or use the xref:redis-dev-services.adoc[Redis Dev Service])
24-
- the Redis key is built as follows: `cache:$cache-name:$cache-key`, where `cache-key` is the key the application uses.
24+
- the Redis key is built as follows: `cache:{cache-name}:{cache-key}`, where `cache-key` is the key the application uses and `cache:{cache-name}` the prefix.
2525
- the value is encoded to JSON if needed
2626

2727

@@ -118,10 +118,11 @@ include::{generated-dir}/config/quarkus-redis-cache.adoc[opts=optional, leveloff
118118

119119
== Configure the Redis key
120120

121-
By default, the Redis backend stores the entry using the following keys: `cache:$cache-name:$cache-key`, where `cache-key` is the key the application uses.
122-
So, you can find all the entries for a single cache using the Redis `KEYS` command: `KEYS cache:$cache-name:*`
121+
By default, the Redis backend stores the entry using the following keys pattern: `cache:{cache-name}:{cache-key}`, where `cache-key` is the key the application uses and `cache:{cache-name}` the prefix. The variable `{cache-name}` is resolved from the value set in the cache annotations.
122+
So, you can find all the entries for a single cache using the Redis `KEYS` command: `KEYS cache:{cache-name}:*`
123+
124+
The prefix can be configured by using the `prefix` property:
123125

124-
The `cache:$cache-name:` segment can be configured using the `prefix` property:
125126

126127

127128
[source, properties]
@@ -135,6 +136,16 @@ quarkus.cache.redis.expensiveResourceCache.prefix=my-expensive-cache
135136

136137
In these cases, you can find all the keys managed by the default cache using `KEYS my-cache:*`, and all the keys managed by the `expensiveResourceCache` cache using: `KEYS my-expensive-cache:*`.
137138

139+
140+
----
141+
# Default configuration
142+
# The variable "{cache-name}" is resolved from the value set in the cache annotations.
143+
quarkus.cache.redis.prefix=my-cache-{cache-name}
144+
----
145+
146+
In this latest example, you can find all the keys managed by the default cache using `KEYS my-cache-{cache-name}:*`.
147+
148+
138149
== Enable optimistic locking
139150

140151
The access to the cache can be _direct_ or use https://redis.io/docs/manual/transactions/#optimistic-locking-using-check-and-set[optimistic locking].

_versions/main/guides/datasource.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,11 @@ For more information about configuring JDBC, see <<jdbc-url,JDBC URL format refe
259259
[[other-databases]]
260260
===== Custom databases and drivers
261261

262-
If you need to connect to a database for which Quarkus does not provide an extension with the JDBC driver,
263-
you can use a custom driver instead. For example, if you are using the OpenTelemetry JDBC driver in your project.
262+
If Quarkus does not provide a JDBC extension for your database, or you need to use a different JDBC driver, such as one for OpenTelemetry, you can configure the JDBC driver explicitly.
264263

265-
Without an extension, the driver will work correctly in any Quarkus app running in JVM mode.
266-
However, the driver is unlikely to work when compiling your application to a native executable.
267-
If you plan to make a native executable, use the existing JDBC Quarkus extensions, or contribute one for your driver.
264+
Without an extension, JDBC drivers are expected to work correctly in JVM mode.
265+
However, they are unlikely to function when compiling your application into a native executable.
266+
To build a native executable, use an existing Quarkus JDBC extension or contribute a new extension for your driver.
268267

269268
.An example for defining access to a database with no built-in support in JVM mode:
270269

_versions/main/guides/logging.adoc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,25 @@ The fully qualified name of the class that calls the `Log` methods is used as a
115115
In this example, the logger name would be `com.example.MyService`.
116116
<3> Finally, all calls to `Log` methods are rewritten to regular JBoss Logging calls on the logger field during the application build.
117117

118-
WARNING: Only use the `Log` API in application classes, not in external dependencies.
119-
`Log` method calls that are not processed by Quarkus at build time will throw an exception.
120-
121118
[[log-api-extension-warning]]
122-
==== Important Note on Using `io.quarkus.logging.Log` in Extensions
119+
[WARNING]
120+
====
121+
Use the `Log` API only in application classes, not in external dependencies.
122+
`Log` method calls not processed by Quarkus at build time will result in an exception.
123123
124-
While the `Log` API simplifies logging in application classes, it should not be used in extension modules or external dependencies. The following considerations apply:
124+
.Using `io.quarkus.logging.Log` in extensions:
125125
126-
* `io.quarkus.logging.Log` depends on Quarkus bytecode transformations that occur at build time.
127-
* In extension modules, the use of `Log` may work if the module has a Jandex index. However, this behavior is not officially supported and might lead to unreliable logging.
126+
While the `Log` API simplifies logging in application classes, it is not recommended for use in extension modules or external dependencies.
128127
129-
For extension development:
128+
The following considerations apply:
130129
131-
* Use standard loggers like `org.jboss.logging.Logger.getLogger(String)` instead of `io.quarkus.logging.Log`.
132-
* This avoids potential performance issues caused by the stack walk fallback when Quarkus build-time processing is unavailable.
130+
* `io.quarkus.logging.Log` depends on Quarkus bytecode transformations that occur at build time.
131+
132+
* In extension modules, `Log` works only if the module includes a Jandex index.
133+
However, this behavior is unsupported and can lead to unreliable logging.
134+
+
135+
For extension development, use `org.jboss.logging.Logger.getLogger(String)` instead of `io.quarkus.logging.Log`.
136+
====
133137

134138

135139
[[injection-of-a-configured-logger]]

0 commit comments

Comments
 (0)