Skip to content

Commit 826e42a

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 98efb5f commit 826e42a

File tree

3 files changed

+252
-0
lines changed

3 files changed

+252
-0
lines changed

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

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64654,6 +64654,48 @@ endif::add-copy-button-to-env-var[]
6465464654
a|`discover`, `static`
6465564655
|`discover`
6465664656

64657+
a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]##
64658+
64659+
[.description]
64660+
--
64661+
The client name used to identify the connection.
64662+
64663+
If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.
64664+
64665+
If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding.
64666+
64667+
64668+
ifdef::add-copy-button-to-env-var[]
64669+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[]
64670+
endif::add-copy-button-to-env-var[]
64671+
ifndef::add-copy-button-to-env-var[]
64672+
Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++`
64673+
endif::add-copy-button-to-env-var[]
64674+
--
64675+
|string
64676+
|
64677+
64678+
a| [[quarkus-redis-client_quarkus-redis-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-configure-client-name[`quarkus.redis.configure-client-name`]##
64679+
64680+
[.description]
64681+
--
64682+
Whether it should set the client name while connecting with Redis.
64683+
64684+
This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.
64685+
64686+
This property can be used with `RedisClientConfig++#++clientName()` configuration.
64687+
64688+
64689+
ifdef::add-copy-button-to-env-var[]
64690+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[]
64691+
endif::add-copy-button-to-env-var[]
64692+
ifndef::add-copy-button-to-env-var[]
64693+
Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++`
64694+
endif::add-copy-button-to-env-var[]
64695+
--
64696+
|boolean
64697+
|`false`
64698+
6465764699
a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]##
6465864700

6465964701
[.description]
@@ -65109,6 +65151,48 @@ endif::add-copy-button-to-env-var[]
6510965151
a|`discover`, `static`
6511065152
|`discover`
6511165153

65154+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-name[`quarkus.redis."redis-client-name".client-name`]##
65155+
65156+
[.description]
65157+
--
65158+
The client name used to identify the connection.
65159+
65160+
If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.
65161+
65162+
If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding.
65163+
65164+
65165+
ifdef::add-copy-button-to-env-var[]
65166+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[]
65167+
endif::add-copy-button-to-env-var[]
65168+
ifndef::add-copy-button-to-env-var[]
65169+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++`
65170+
endif::add-copy-button-to-env-var[]
65171+
--
65172+
|string
65173+
|
65174+
65175+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name[`quarkus.redis."redis-client-name".configure-client-name`]##
65176+
65177+
[.description]
65178+
--
65179+
Whether it should set the client name while connecting with Redis.
65180+
65181+
This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.
65182+
65183+
This property can be used with `RedisClientConfig++#++clientName()` configuration.
65184+
65185+
65186+
ifdef::add-copy-button-to-env-var[]
65187+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[]
65188+
endif::add-copy-button-to-env-var[]
65189+
ifndef::add-copy-button-to-env-var[]
65190+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++`
65191+
endif::add-copy-button-to-env-var[]
65192+
--
65193+
|boolean
65194+
|`false`
65195+
6511265196
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]##
6511365197

6511465198
[.description]

‎_generated-doc/main/config/quarkus-redis-client.adoc‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,48 @@ endif::add-copy-button-to-env-var[]
456456
a|`discover`, `static`
457457
|`discover`
458458

459+
a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]##
460+
461+
[.description]
462+
--
463+
The client name used to identify the connection.
464+
465+
If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.
466+
467+
If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding.
468+
469+
470+
ifdef::add-copy-button-to-env-var[]
471+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[]
472+
endif::add-copy-button-to-env-var[]
473+
ifndef::add-copy-button-to-env-var[]
474+
Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++`
475+
endif::add-copy-button-to-env-var[]
476+
--
477+
|string
478+
|
479+
480+
a| [[quarkus-redis-client_quarkus-redis-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-configure-client-name[`quarkus.redis.configure-client-name`]##
481+
482+
[.description]
483+
--
484+
Whether it should set the client name while connecting with Redis.
485+
486+
This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.
487+
488+
This property can be used with `RedisClientConfig++#++clientName()` configuration.
489+
490+
491+
ifdef::add-copy-button-to-env-var[]
492+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[]
493+
endif::add-copy-button-to-env-var[]
494+
ifndef::add-copy-button-to-env-var[]
495+
Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++`
496+
endif::add-copy-button-to-env-var[]
497+
--
498+
|boolean
499+
|`false`
500+
459501
a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]##
460502

461503
[.description]
@@ -911,6 +953,48 @@ endif::add-copy-button-to-env-var[]
911953
a|`discover`, `static`
912954
|`discover`
913955

956+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-name[`quarkus.redis."redis-client-name".client-name`]##
957+
958+
[.description]
959+
--
960+
The client name used to identify the connection.
961+
962+
If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.
963+
964+
If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding.
965+
966+
967+
ifdef::add-copy-button-to-env-var[]
968+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[]
969+
endif::add-copy-button-to-env-var[]
970+
ifndef::add-copy-button-to-env-var[]
971+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++`
972+
endif::add-copy-button-to-env-var[]
973+
--
974+
|string
975+
|
976+
977+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name[`quarkus.redis."redis-client-name".configure-client-name`]##
978+
979+
[.description]
980+
--
981+
Whether it should set the client name while connecting with Redis.
982+
983+
This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.
984+
985+
This property can be used with `RedisClientConfig++#++clientName()` configuration.
986+
987+
988+
ifdef::add-copy-button-to-env-var[]
989+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[]
990+
endif::add-copy-button-to-env-var[]
991+
ifndef::add-copy-button-to-env-var[]
992+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++`
993+
endif::add-copy-button-to-env-var[]
994+
--
995+
|boolean
996+
|`false`
997+
914998
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]##
915999

9161000
[.description]

‎_generated-doc/main/config/quarkus-redis-client_quarkus.redis.adoc‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,48 @@ endif::add-copy-button-to-env-var[]
456456
a|`discover`, `static`
457457
|`discover`
458458

459+
a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]##
460+
461+
[.description]
462+
--
463+
The client name used to identify the connection.
464+
465+
If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.
466+
467+
If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding.
468+
469+
470+
ifdef::add-copy-button-to-env-var[]
471+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[]
472+
endif::add-copy-button-to-env-var[]
473+
ifndef::add-copy-button-to-env-var[]
474+
Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++`
475+
endif::add-copy-button-to-env-var[]
476+
--
477+
|string
478+
|
479+
480+
a| [[quarkus-redis-client_quarkus-redis-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-configure-client-name[`quarkus.redis.configure-client-name`]##
481+
482+
[.description]
483+
--
484+
Whether it should set the client name while connecting with Redis.
485+
486+
This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.
487+
488+
This property can be used with `RedisClientConfig++#++clientName()` configuration.
489+
490+
491+
ifdef::add-copy-button-to-env-var[]
492+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[]
493+
endif::add-copy-button-to-env-var[]
494+
ifndef::add-copy-button-to-env-var[]
495+
Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++`
496+
endif::add-copy-button-to-env-var[]
497+
--
498+
|boolean
499+
|`false`
500+
459501
a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]##
460502

461503
[.description]
@@ -911,6 +953,48 @@ endif::add-copy-button-to-env-var[]
911953
a|`discover`, `static`
912954
|`discover`
913955

956+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-name[`quarkus.redis."redis-client-name".client-name`]##
957+
958+
[.description]
959+
--
960+
The client name used to identify the connection.
961+
962+
If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.
963+
964+
If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding.
965+
966+
967+
ifdef::add-copy-button-to-env-var[]
968+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[]
969+
endif::add-copy-button-to-env-var[]
970+
ifndef::add-copy-button-to-env-var[]
971+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++`
972+
endif::add-copy-button-to-env-var[]
973+
--
974+
|string
975+
|
976+
977+
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name[`quarkus.redis."redis-client-name".configure-client-name`]##
978+
979+
[.description]
980+
--
981+
Whether it should set the client name while connecting with Redis.
982+
983+
This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.
984+
985+
This property can be used with `RedisClientConfig++#++clientName()` configuration.
986+
987+
988+
ifdef::add-copy-button-to-env-var[]
989+
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[]
990+
endif::add-copy-button-to-env-var[]
991+
ifndef::add-copy-button-to-env-var[]
992+
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++`
993+
endif::add-copy-button-to-env-var[]
994+
--
995+
|boolean
996+
|`false`
997+
914998
a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]##
915999

9161000
[.description]

0 commit comments

Comments
 (0)