Skip to content

Commit 3670905

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 8f6b750 commit 3670905

File tree

98 files changed

+1830
-685
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1830
-685
lines changed

‎_generated-doc/main/config/quarkus-cache-redis-config-group-redis-cache-build-time-config.adoc‎

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,93 @@ endif::add-copy-button-to-env-var[]
8282
--|string
8383
|
8484

85-
|===
85+
86+
a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`
87+
88+
89+
[.description]
90+
--
91+
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
92+
93+
ifdef::add-copy-button-to-env-var[]
94+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++[]
95+
endif::add-copy-button-to-env-var[]
96+
ifndef::add-copy-button-to-env-var[]
97+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++`
98+
endif::add-copy-button-to-env-var[]
99+
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
100+
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
101+
|
102+
103+
104+
a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-access]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-access[quarkus.cache.redis."cache-name".expire-after-access]`
105+
106+
107+
[.description]
108+
--
109+
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.
110+
111+
ifdef::add-copy-button-to-env-var[]
112+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++[]
113+
endif::add-copy-button-to-env-var[]
114+
ifndef::add-copy-button-to-env-var[]
115+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++`
116+
endif::add-copy-button-to-env-var[]
117+
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
118+
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
119+
|
120+
121+
122+
a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-prefix]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-prefix[quarkus.cache.redis."cache-name".prefix]`
123+
124+
125+
[.description]
126+
--
127+
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
128+
129+
ifdef::add-copy-button-to-env-var[]
130+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++[]
131+
endif::add-copy-button-to-env-var[]
132+
ifndef::add-copy-button-to-env-var[]
133+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++`
134+
endif::add-copy-button-to-env-var[]
135+
--|string
136+
|
137+
138+
139+
a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking[quarkus.cache.redis."cache-name".use-optimistic-locking]`
140+
141+
142+
[.description]
143+
--
144+
Whether the access to the cache should be using optimistic locking. See link:https://redis.io/docs/manual/transactions/#optimistic-locking-using-check-and-set[Redis Optimistic Locking] for details. Default is `false`.
145+
146+
ifdef::add-copy-button-to-env-var[]
147+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__USE_OPTIMISTIC_LOCKING+++[]
148+
endif::add-copy-button-to-env-var[]
149+
ifndef::add-copy-button-to-env-var[]
150+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__USE_OPTIMISTIC_LOCKING+++`
151+
endif::add-copy-button-to-env-var[]
152+
--|boolean
153+
|
154+
155+
|===
156+
ifndef::no-duration-note[]
157+
[NOTE]
158+
[id='duration-note-anchor-{summaryTableId}']
159+
.About the Duration format
160+
====
161+
To write duration values, use the standard `java.time.Duration` format.
162+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
163+
164+
You can also use a simplified format, starting with a number:
165+
166+
* If the value is only a number, it represents time in seconds.
167+
* If the value is a number followed by `ms`, it represents time in milliseconds.
168+
169+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
170+
171+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
172+
* If the value is a number followed by `d`, it is prefixed with `P`.
173+
====
174+
endif::no-duration-note[]

‎_generated-doc/main/config/quarkus-cache-redis-config-group-redis-cache-runtime-config.adoc‎

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -85,40 +85,6 @@ h|[[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-re
8585
h|Type
8686
h|Default
8787

88-
a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-value-type]]`link:#quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-value-type[quarkus.cache.redis."cache-name".value-type]`
89-
90-
91-
[.description]
92-
--
93-
The default type of the value stored in the cache.
94-
95-
ifdef::add-copy-button-to-env-var[]
96-
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++[]
97-
endif::add-copy-button-to-env-var[]
98-
ifndef::add-copy-button-to-env-var[]
99-
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++`
100-
endif::add-copy-button-to-env-var[]
101-
--|string
102-
|
103-
104-
105-
a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-key-type]]`link:#quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-key-type[quarkus.cache.redis."cache-name".key-type]`
106-
107-
108-
[.description]
109-
--
110-
The key type, `String` by default.
111-
112-
ifdef::add-copy-button-to-env-var[]
113-
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++[]
114-
endif::add-copy-button-to-env-var[]
115-
ifndef::add-copy-button-to-env-var[]
116-
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++`
117-
endif::add-copy-button-to-env-var[]
118-
--|string
119-
|
120-
121-
12288
a| [[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`
12389

12490

‎_generated-doc/main/config/quarkus-cache-redis-redis-caches-build-time-config.adoc‎

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,93 @@ endif::add-copy-button-to-env-var[]
9999
--|string
100100
|
101101

102-
|===
102+
103+
a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`
104+
105+
106+
[.description]
107+
--
108+
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
109+
110+
ifdef::add-copy-button-to-env-var[]
111+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++[]
112+
endif::add-copy-button-to-env-var[]
113+
ifndef::add-copy-button-to-env-var[]
114+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++`
115+
endif::add-copy-button-to-env-var[]
116+
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
117+
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
118+
|
119+
120+
121+
a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-access]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-access[quarkus.cache.redis."cache-name".expire-after-access]`
122+
123+
124+
[.description]
125+
--
126+
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.
127+
128+
ifdef::add-copy-button-to-env-var[]
129+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++[]
130+
endif::add-copy-button-to-env-var[]
131+
ifndef::add-copy-button-to-env-var[]
132+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++`
133+
endif::add-copy-button-to-env-var[]
134+
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
135+
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
136+
|
137+
138+
139+
a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-prefix]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-prefix[quarkus.cache.redis."cache-name".prefix]`
140+
141+
142+
[.description]
143+
--
144+
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
145+
146+
ifdef::add-copy-button-to-env-var[]
147+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++[]
148+
endif::add-copy-button-to-env-var[]
149+
ifndef::add-copy-button-to-env-var[]
150+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++`
151+
endif::add-copy-button-to-env-var[]
152+
--|string
153+
|
154+
155+
156+
a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking[quarkus.cache.redis."cache-name".use-optimistic-locking]`
157+
158+
159+
[.description]
160+
--
161+
Whether the access to the cache should be using optimistic locking. See link:https://redis.io/docs/manual/transactions/#optimistic-locking-using-check-and-set[Redis Optimistic Locking] for details. Default is `false`.
162+
163+
ifdef::add-copy-button-to-env-var[]
164+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__USE_OPTIMISTIC_LOCKING+++[]
165+
endif::add-copy-button-to-env-var[]
166+
ifndef::add-copy-button-to-env-var[]
167+
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__USE_OPTIMISTIC_LOCKING+++`
168+
endif::add-copy-button-to-env-var[]
169+
--|boolean
170+
|
171+
172+
|===
173+
ifndef::no-duration-note[]
174+
[NOTE]
175+
[id='duration-note-anchor-{summaryTableId}']
176+
.About the Duration format
177+
====
178+
To write duration values, use the standard `java.time.Duration` format.
179+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
180+
181+
You can also use a simplified format, starting with a number:
182+
183+
* If the value is only a number, it represents time in seconds.
184+
* If the value is a number followed by `ms`, it represents time in milliseconds.
185+
186+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
187+
188+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
189+
* If the value is a number followed by `d`, it is prefixed with `P`.
190+
====
191+
endif::no-duration-note[]

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

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -85,40 +85,6 @@ h|[[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-caches-config-ad
8585
h|Type
8686
h|Default
8787

88-
a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-value-type]]`link:#quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-value-type[quarkus.cache.redis."cache-name".value-type]`
89-
90-
91-
[.description]
92-
--
93-
The default type of the value stored in the cache.
94-
95-
ifdef::add-copy-button-to-env-var[]
96-
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++[]
97-
endif::add-copy-button-to-env-var[]
98-
ifndef::add-copy-button-to-env-var[]
99-
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++`
100-
endif::add-copy-button-to-env-var[]
101-
--|string
102-
|
103-
104-
105-
a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-key-type]]`link:#quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-key-type[quarkus.cache.redis."cache-name".key-type]`
106-
107-
108-
[.description]
109-
--
110-
The key type, `String` by default.
111-
112-
ifdef::add-copy-button-to-env-var[]
113-
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++[]
114-
endif::add-copy-button-to-env-var[]
115-
ifndef::add-copy-button-to-env-var[]
116-
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++`
117-
endif::add-copy-button-to-env-var[]
118-
--|string
119-
|
120-
121-
12288
a| [[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`
12389

12490

‎_generated-doc/main/config/quarkus-core.adoc‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -77,25 +77,6 @@ endif::add-copy-button-to-env-var[]
7777
|`Build system locale`
7878

7979

80-
a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]`
81-
82-
83-
[.description]
84-
--
85-
The arguments passed to the command line.
86-
87-
We don't make it a list as the args are separated by a space, not a comma.
88-
89-
ifdef::add-copy-button-to-env-var[]
90-
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
91-
endif::add-copy-button-to-env-var[]
92-
ifndef::add-copy-button-to-env-var[]
93-
Environment variable: `+++QUARKUS_ARGS+++`
94-
endif::add-copy-button-to-env-var[]
95-
--|string
96-
|
97-
98-
9980
a| [[quarkus-core_quarkus-profile]]`link:#quarkus-core_quarkus-profile[quarkus.profile]`
10081

10182

@@ -218,6 +199,25 @@ endif::add-copy-button-to-env-var[]
218199
|`false`
219200

220201

202+
a| [[quarkus-core_quarkus-args]]`link:#quarkus-core_quarkus-args[quarkus.args]`
203+
204+
205+
[.description]
206+
--
207+
The arguments passed to the command line.
208+
209+
We don't make it a list as the args are separated by a space, not a comma.
210+
211+
ifdef::add-copy-button-to-env-var[]
212+
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
213+
endif::add-copy-button-to-env-var[]
214+
ifndef::add-copy-button-to-env-var[]
215+
Environment variable: `+++QUARKUS_ARGS+++`
216+
endif::add-copy-button-to-env-var[]
217+
--|string
218+
|
219+
220+
221221
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]]`link:#quarkus-core_quarkus-analytics-disabled[quarkus.analytics.disabled]`
222222

223223

0 commit comments

Comments
 (0)