Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 4, 2024
1 parent 98efb5f commit 826e42a
Show file tree
Hide file tree
Showing 3 changed files with 252 additions and 0 deletions.
84 changes: 84 additions & 0 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64654,6 +64654,48 @@ endif::add-copy-button-to-env-var[]
a|`discover`, `static`
|`discover`

a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]##

[.description]
--
The client name used to identify the connection.

If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

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`]##

[.description]
--
Whether it should set the client name while connecting with Redis.

This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.

This property can be used with `RedisClientConfig++#++clientName()` configuration.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
Expand Down Expand Up @@ -65109,6 +65151,48 @@ endif::add-copy-button-to-env-var[]
a|`discover`, `static`
|`discover`

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`]##

[.description]
--
The client name used to identify the connection.

If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

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`]##

[.description]
--
Whether it should set the client name while connecting with Redis.

This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.

This property can be used with `RedisClientConfig++#++clientName()` configuration.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
Expand Down
84 changes: 84 additions & 0 deletions _generated-doc/main/config/quarkus-redis-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,48 @@ endif::add-copy-button-to-env-var[]
a|`discover`, `static`
|`discover`

a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]##

[.description]
--
The client name used to identify the connection.

If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

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`]##

[.description]
--
Whether it should set the client name while connecting with Redis.

This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.

This property can be used with `RedisClientConfig++#++clientName()` configuration.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
Expand Down Expand Up @@ -911,6 +953,48 @@ endif::add-copy-button-to-env-var[]
a|`discover`, `static`
|`discover`

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`]##

[.description]
--
The client name used to identify the connection.

If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

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`]##

[.description]
--
Whether it should set the client name while connecting with Redis.

This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.

This property can be used with `RedisClientConfig++#++clientName()` configuration.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
Expand Down
84 changes: 84 additions & 0 deletions _generated-doc/main/config/quarkus-redis-client_quarkus.redis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,48 @@ endif::add-copy-button-to-env-var[]
a|`discover`, `static`
|`discover`

a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]##

[.description]
--
The client name used to identify the connection.

If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

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`]##

[.description]
--
Whether it should set the client name while connecting with Redis.

This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.

This property can be used with `RedisClientConfig++#++clientName()` configuration.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
Expand Down Expand Up @@ -911,6 +953,48 @@ endif::add-copy-button-to-env-var[]
a|`discover`, `static`
|`discover`

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`]##

[.description]
--
The client name used to identify the connection.

If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation.

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

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`]##

[.description]
--
Whether it should set the client name while connecting with Redis.

This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}.

This property can be used with `RedisClientConfig++#++clientName()` configuration.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

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`]##

[.description]
Expand Down

0 comments on commit 826e42a

Please sign in to comment.