Skip to content

Commit 795fe14

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 95f761a commit 795fe14

File tree

6 files changed

+125
-24
lines changed

6 files changed

+125
-24
lines changed

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

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10009,6 +10009,35 @@ endif::add-copy-button-to-env-var[]
1000910009
|boolean
1001010010
|`+++true+++`
1001110011

10012+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-force-use-artifact-id-only-as-name]] [.property-path]##link:#quarkus-core_quarkus-package-jar-force-use-artifact-id-only-as-name[`quarkus.package.jar.force-use-artifact-id-only-as-name`]##
10013+
ifdef::add-copy-button-to-config-props[]
10014+
config_property_copy_button:+++quarkus.package.jar.force-use-artifact-id-only-as-name+++[]
10015+
endif::add-copy-button-to-config-props[]
10016+
10017+
10018+
[.description]
10019+
--
10020+
Indicates a list of dependency for which the jar will use artifactId.type filename scheme Each dependency needs to be expressed in the following format:
10021+
10022+
`groupId:artifactId++[++:++[++classifier++][++:++[++type++]]]++`
10023+
10024+
With the classifier and type being optional (note that the brackets (`++[]++`) denote optionality and are not a part of the syntax specification). The group ID and artifact ID must be present and non-empty.
10025+
10026+
If the type is missing, the artifact is assumed to be of type `jar`.
10027+
10028+
This parameter is optional; if absent, jar names will use groupId.artifactId++[++-version++][++-classifier++]++.type scheme Note that using this parameter is not recommended and only be used for specific corner cases when the jar name is enforced.
10029+
10030+
10031+
ifdef::add-copy-button-to-env-var[]
10032+
Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_FORCE_USE_ARTIFACT_ID_ONLY_AS_NAME+++[]
10033+
endif::add-copy-button-to-env-var[]
10034+
ifndef::add-copy-button-to-env-var[]
10035+
Environment variable: `+++QUARKUS_PACKAGE_JAR_FORCE_USE_ARTIFACT_ID_ONLY_AS_NAME+++`
10036+
endif::add-copy-button-to-env-var[]
10037+
--
10038+
|list of GACT
10039+
|`+++com.sap.conn.jco:sapjco3::jar+++`, `+++com.sap.conn.idoc:sapidoc3::jar+++`
10040+
1001210041
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-enabled[`quarkus.package.jar.appcds.enabled`]##
1001310042
ifdef::add-copy-button-to-config-props[]
1001410043
config_property_copy_button:+++quarkus.package.jar.appcds.enabled+++[]
@@ -94955,12 +94984,10 @@ endif::add-copy-button-to-config-props[]
9495594984
--
9495694985
Sets the ordered list of enabled TLS protocols.
9495794986

94958-
If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`.
94987+
If not set, it defaults to `"TLSv1.3"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To enable `TLSv1.3` and `TLSv1.2`, set the value to `to "TLSv1.3, TLSv1.2"`.
9495994988

9496094989
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
9496194990

94962-
Also, setting this replaces the default list of protocols.
94963-
9496494991

9496594992
ifdef::add-copy-button-to-env-var[]
9496694993
Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[]
@@ -94970,7 +94997,7 @@ Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++`
9497094997
endif::add-copy-button-to-env-var[]
9497194998
--
9497294999
|list of string
94973-
|`+++TLSv1.3+++`, `+++TLSv1.2+++`
95000+
|`+++TLSv1.3+++`
9497495001

9497595002
a| [[quarkus-tls-registry_quarkus-tls-handshake-timeout]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-handshake-timeout[`quarkus.tls.handshake-timeout`]##
9497695003
ifdef::add-copy-button-to-config-props[]
@@ -95910,12 +95937,10 @@ endif::add-copy-button-to-config-props[]
9591095937
--
9591195938
Sets the ordered list of enabled TLS protocols.
9591295939

95913-
If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`.
95940+
If not set, it defaults to `"TLSv1.3"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To enable `TLSv1.3` and `TLSv1.2`, set the value to `to "TLSv1.3, TLSv1.2"`.
9591495941

9591595942
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
9591695943

95917-
Also, setting this replaces the default list of protocols.
95918-
9591995944

9592095945
ifdef::add-copy-button-to-env-var[]
9592195946
Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[]
@@ -95925,7 +95950,7 @@ Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++`
9592595950
endif::add-copy-button-to-env-var[]
9592695951
--
9592795952
|list of string
95928-
|`+++TLSv1.3+++`, `+++TLSv1.2+++`
95953+
|`+++TLSv1.3+++`
9592995954

9593095955
a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout[`quarkus.tls."tls-bucket-name".handshake-timeout`]##
9593195956
ifdef::add-copy-button-to-config-props[]

‎_generated-doc/main/config/quarkus-core_quarkus.package.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,35 @@ endif::add-copy-button-to-env-var[]
231231
|boolean
232232
|`+++true+++`
233233

234+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-force-use-artifact-id-only-as-name]] [.property-path]##link:#quarkus-core_quarkus-package-jar-force-use-artifact-id-only-as-name[`quarkus.package.jar.force-use-artifact-id-only-as-name`]##
235+
ifdef::add-copy-button-to-config-props[]
236+
config_property_copy_button:+++quarkus.package.jar.force-use-artifact-id-only-as-name+++[]
237+
endif::add-copy-button-to-config-props[]
238+
239+
240+
[.description]
241+
--
242+
Indicates a list of dependency for which the jar will use artifactId.type filename scheme Each dependency needs to be expressed in the following format:
243+
244+
`groupId:artifactId++[++:++[++classifier++][++:++[++type++]]]++`
245+
246+
With the classifier and type being optional (note that the brackets (`++[]++`) denote optionality and are not a part of the syntax specification). The group ID and artifact ID must be present and non-empty.
247+
248+
If the type is missing, the artifact is assumed to be of type `jar`.
249+
250+
This parameter is optional; if absent, jar names will use groupId.artifactId++[++-version++][++-classifier++]++.type scheme Note that using this parameter is not recommended and only be used for specific corner cases when the jar name is enforced.
251+
252+
253+
ifdef::add-copy-button-to-env-var[]
254+
Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_FORCE_USE_ARTIFACT_ID_ONLY_AS_NAME+++[]
255+
endif::add-copy-button-to-env-var[]
256+
ifndef::add-copy-button-to-env-var[]
257+
Environment variable: `+++QUARKUS_PACKAGE_JAR_FORCE_USE_ARTIFACT_ID_ONLY_AS_NAME+++`
258+
endif::add-copy-button-to-env-var[]
259+
--
260+
|list of GACT
261+
|`+++com.sap.conn.jco:sapjco3::jar+++`, `+++com.sap.conn.idoc:sapidoc3::jar+++`
262+
234263
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-enabled[`quarkus.package.jar.appcds.enabled`]##
235264
ifdef::add-copy-button-to-config-props[]
236265
config_property_copy_button:+++quarkus.package.jar.appcds.enabled+++[]

‎_generated-doc/main/config/quarkus-tls-registry.adoc‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -696,12 +696,10 @@ endif::add-copy-button-to-config-props[]
696696
--
697697
Sets the ordered list of enabled TLS protocols.
698698

699-
If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`.
699+
If not set, it defaults to `"TLSv1.3"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To enable `TLSv1.3` and `TLSv1.2`, set the value to `to "TLSv1.3, TLSv1.2"`.
700700

701701
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
702702

703-
Also, setting this replaces the default list of protocols.
704-
705703

706704
ifdef::add-copy-button-to-env-var[]
707705
Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[]
@@ -711,7 +709,7 @@ Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++`
711709
endif::add-copy-button-to-env-var[]
712710
--
713711
|list of string
714-
|`+++TLSv1.3+++`, `+++TLSv1.2+++`
712+
|`+++TLSv1.3+++`
715713

716714
a| [[quarkus-tls-registry_quarkus-tls-handshake-timeout]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-handshake-timeout[`quarkus.tls.handshake-timeout`]##
717715
ifdef::add-copy-button-to-config-props[]
@@ -1651,12 +1649,10 @@ endif::add-copy-button-to-config-props[]
16511649
--
16521650
Sets the ordered list of enabled TLS protocols.
16531651

1654-
If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`.
1652+
If not set, it defaults to `"TLSv1.3"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To enable `TLSv1.3` and `TLSv1.2`, set the value to `to "TLSv1.3, TLSv1.2"`.
16551653

16561654
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
16571655

1658-
Also, setting this replaces the default list of protocols.
1659-
16601656

16611657
ifdef::add-copy-button-to-env-var[]
16621658
Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[]
@@ -1666,7 +1662,7 @@ Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++`
16661662
endif::add-copy-button-to-env-var[]
16671663
--
16681664
|list of string
1669-
|`+++TLSv1.3+++`, `+++TLSv1.2+++`
1665+
|`+++TLSv1.3+++`
16701666

16711667
a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout[`quarkus.tls."tls-bucket-name".handshake-timeout`]##
16721668
ifdef::add-copy-button-to-config-props[]

‎_generated-doc/main/config/quarkus-tls-registry_quarkus.tls.adoc‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -696,12 +696,10 @@ endif::add-copy-button-to-config-props[]
696696
--
697697
Sets the ordered list of enabled TLS protocols.
698698

699-
If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`.
699+
If not set, it defaults to `"TLSv1.3"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To enable `TLSv1.3` and `TLSv1.2`, set the value to `to "TLSv1.3, TLSv1.2"`.
700700

701701
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
702702

703-
Also, setting this replaces the default list of protocols.
704-
705703

706704
ifdef::add-copy-button-to-env-var[]
707705
Environment variable: env_var_with_copy_button:+++QUARKUS_TLS_PROTOCOLS+++[]
@@ -711,7 +709,7 @@ Environment variable: `+++QUARKUS_TLS_PROTOCOLS+++`
711709
endif::add-copy-button-to-env-var[]
712710
--
713711
|list of string
714-
|`+++TLSv1.3+++`, `+++TLSv1.2+++`
712+
|`+++TLSv1.3+++`
715713

716714
a| [[quarkus-tls-registry_quarkus-tls-handshake-timeout]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-handshake-timeout[`quarkus.tls.handshake-timeout`]##
717715
ifdef::add-copy-button-to-config-props[]
@@ -1651,12 +1649,10 @@ endif::add-copy-button-to-config-props[]
16511649
--
16521650
Sets the ordered list of enabled TLS protocols.
16531651

1654-
If not set, it defaults to `"TLSv1.3, TLSv1.2"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To only enable `TLSv1.3`, set the value to `to "TLSv1.3"`.
1652+
If not set, it defaults to `"TLSv1.3"`. The following list of protocols are supported: `TLSv1, TLSv1.1, TLSv1.2, TLSv1.3`. To enable `TLSv1.3` and `TLSv1.2`, set the value to `to "TLSv1.3, TLSv1.2"`.
16551653

16561654
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
16571655

1658-
Also, setting this replaces the default list of protocols.
1659-
16601656

16611657
ifdef::add-copy-button-to-env-var[]
16621658
Environment variable: env_var_with_copy_button:+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++[]
@@ -1666,7 +1662,7 @@ Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS+++`
16661662
endif::add-copy-button-to-env-var[]
16671663
--
16681664
|list of string
1669-
|`+++TLSv1.3+++`, `+++TLSv1.2+++`
1665+
|`+++TLSv1.3+++`
16701666

16711667
a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-handshake-timeout[`quarkus.tls."tls-bucket-name".handshake-timeout`]##
16721668
ifdef::add-copy-button-to-config-props[]

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2761,6 +2761,41 @@ a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/
27612761
--
27622762
A marker build item that is used to indicate that UPX compression was performed
27632763
-- a|None
2764+
|===
2765+
== Agroal
2766+
[.configuration-reference,cols=2*]
2767+
|===
2768+
h|Class Name
2769+
h|Attributes
2770+
2771+
2772+
2773+
2774+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/AggregatedDataSourceBuildTimeConfigBuildItem.java[`io.quarkus.agroal.deployment.AggregatedDataSourceBuildTimeConfigBuildItem`, window="_blank"]
2775+
[.description]
2776+
--
2777+
An aggregated build item holding the build time configuration for a given datasource, including both the build and the runtime datasource config.
2778+
-- a|`java.lang.String name`
2779+
2780+
_No Javadoc found_
2781+
2782+
`io.quarkus.datasource.runtime.DataSourceBuildTimeConfig dataSourceConfig`
2783+
2784+
_No Javadoc found_
2785+
2786+
`io.quarkus.agroal.runtime.DataSourceJdbcBuildTimeConfig jdbcConfig`
2787+
2788+
_No Javadoc found_
2789+
2790+
`java.lang.String dbKind`
2791+
2792+
_No Javadoc found_
2793+
2794+
`java.lang.String resolvedDriverClass`
2795+
2796+
_No Javadoc found_
2797+
2798+
27642799
|===
27652800
== Agroal - SPI
27662801
[.configuration-reference,cols=2*]
@@ -2845,6 +2880,25 @@ _No Javadoc found_
28452880

28462881

28472882

2883+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/agroal/spi/src/main/java/io/quarkus/agroal/spi/JdbcPropertyBuildItem.java[`io.quarkus.agroal.spi.JdbcPropertyBuildItem`, window="_blank"]
2884+
[.description]
2885+
--
2886+
A build item to represent a JDBC property to be set as an additional JDBC property when the datasource is setup.
2887+
-- a|`java.lang.String dataSourceName`
2888+
2889+
_No Javadoc found_
2890+
2891+
`java.lang.String propertyName`
2892+
2893+
_No Javadoc found_
2894+
2895+
`java.lang.String propertyValue`
2896+
2897+
_No Javadoc found_
2898+
2899+
2900+
2901+
28482902
a| https://github.com/quarkusio/quarkus/blob/main/extensions/agroal/spi/src/main/java/io/quarkus/agroal/spi/JdbcUpdateSQLGeneratorBuildItem.java[`io.quarkus.agroal.spi.JdbcUpdateSQLGeneratorBuildItem`, window="_blank"]
28492903
[.description]
28502904
--

‎_versions/main/guides/datasource.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,7 @@ When compiling a Quarkus application to a native image, the MySQL support for JM
815815

816816
* The lack of JMX support is a natural consequence of running in native mode and is unlikely to be resolved.
817817
* The integration with OCI is not supported.
818+
* The OpenTelemetry integration included in the MySQL Connector/J driver is disabled in favor of the one provided by Agroal. If you really need to use the OpenTelemetry integration provided by the MySQL Connector/J driver, enable it explicitly by setting `quarkus.datasource.jdbc.additional-jdbc-properties.openTelemetry=PREFERRED` (https://dev.mysql.com/doc/connector-j/en/connector-j-connp-props-debugging-profiling.html#cj-conn-prop_openTelemetry[documentation]). Be aware that by enabling it, if your application is using the `quarkus-opentelemetry` extension, the application will likely fail to start with an `java.lang.IllegalStateException: GlobalOpenTelemetry.set has already been called.` error.
818819

819820
==== Oracle
820821

0 commit comments

Comments
 (0)