Skip to content

Commit 261030b

Browse files
committed
Sync documentation of main branch
1 parent 445002b commit 261030b

9 files changed

+73
-12
lines changed

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.redis.runtime.client.config.RedisClientConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.redis.runtime.client.config.RedisConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61859,7 +61859,7 @@ a| [[quarkus-redis-client_quarkus-redis-protocol-negotiation]]`link:#quarkus-red
6185961859

6186061860
[.description]
6186161861
--
61862-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
61862+
Should the client perform `RESP` protocol negotiation during the connection handshake.
6186361863

6186461864
ifdef::add-copy-button-to-env-var[]
6186561865
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_PROTOCOL_NEGOTIATION+++[]
@@ -62354,7 +62354,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation]]
6235462354

6235562355
[.description]
6235662356
--
62357-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
62357+
Should the client perform `RESP` protocol negotiation during the connection handshake.
6235862358

6235962359
ifdef::add-copy-button-to-env-var[]
6236062360
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION+++[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ a| [[quarkus-redis-client-config-redis-config_quarkus-redis-protocol-negotiation
307307

308308
[.description]
309309
--
310-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
310+
Should the client perform `RESP` protocol negotiation during the connection handshake.
311311

312312
ifdef::add-copy-button-to-env-var[]
313313
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_PROTOCOL_NEGOTIATION+++[]
@@ -616,7 +616,7 @@ a| [[quarkus-redis-client-config-redis-config_quarkus-redis-redis-client-name-pr
616616

617617
[.description]
618618
--
619-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
619+
Should the client perform `RESP` protocol negotiation during the connection handshake.
620620

621621
ifdef::add-copy-button-to-env-var[]
622622
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION+++[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ a| [[quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-
307307

308308
[.description]
309309
--
310-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
310+
Should the client perform `RESP` protocol negotiation during the connection handshake.
311311

312312
ifdef::add-copy-button-to-env-var[]
313313
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_PROTOCOL_NEGOTIATION+++[]
@@ -616,7 +616,7 @@ a| [[quarkus-redis-config-group-client-config-redis-client-config_quarkus-redis-
616616

617617
[.description]
618618
--
619-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
619+
Should the client perform `RESP` protocol negotiation during the connection handshake.
620620

621621
ifdef::add-copy-button-to-env-var[]
622622
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION+++[]

_generated-doc/main/config/quarkus-redis-general-config-items.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ a| [[quarkus-redis-general-config-items_quarkus-redis-protocol-negotiation]]`lin
459459

460460
[.description]
461461
--
462-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
462+
Should the client perform `RESP` protocol negotiation during the connection handshake.
463463

464464
ifdef::add-copy-button-to-env-var[]
465465
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_PROTOCOL_NEGOTIATION+++[]
@@ -954,7 +954,7 @@ a| [[quarkus-redis-general-config-items_quarkus-redis-redis-client-name-protocol
954954

955955
[.description]
956956
--
957-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
957+
Should the client perform `RESP` protocol negotiation during the connection handshake.
958958

959959
ifdef::add-copy-button-to-env-var[]
960960
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION+++[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ a| [[quarkus-redis_quarkus-redis-protocol-negotiation]]`link:#quarkus-redis_quar
476476

477477
[.description]
478478
--
479-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
479+
Should the client perform `RESP` protocol negotiation during the connection handshake.
480480

481481
ifdef::add-copy-button-to-env-var[]
482482
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_PROTOCOL_NEGOTIATION+++[]
@@ -971,7 +971,7 @@ a| [[quarkus-redis_quarkus-redis-redis-client-name-protocol-negotiation]]`link:#
971971

972972
[.description]
973973
--
974-
Should the client perform ++{++@code RESP protocol negotiation during the connection handshake.
974+
Should the client perform `RESP` protocol negotiation during the connection handshake.
975975

976976
ifdef::add-copy-button-to-env-var[]
977977
Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION+++[]

_versions/main/guides/hibernate-orm-panache.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -939,6 +939,36 @@ PanacheQuery<DogDto> query = Dog.findAll().project(DogDto.class);
939939
----
940940
<1> The `ownerName` DTO constructor's parameter will be loaded from the `owner.name` HQL property.
941941

942+
In case you want to project an entity in a class with nested classes, you can use the `@NestedProjectedClass` annotation on those nested classes.
943+
944+
[source,java]
945+
----
946+
@RegisterForReflection
947+
public class DogDto {
948+
public String name;
949+
public PersonDto owner;
950+
951+
public DogDto(String name, PersonDto owner) {
952+
this.name = name;
953+
this.owner = owner;
954+
}
955+
956+
@NestedProjectedClass // <1>
957+
public static class PersonDto {
958+
public String name;
959+
960+
public PersonDto(String name) {
961+
this.name = name;
962+
}
963+
}
964+
}
965+
966+
PanacheQuery<DogDto> query = Dog.findAll().project(DogDto.class);
967+
----
968+
969+
<1> This annotation can be used when you want to project `@Embedded` entity or `@ManyToOne`, `@OneToOne` relation.
970+
It does not support `@OneToMany` or `@ManyToMany` relation.
971+
942972
It is also possible to specify a HQL query with a select clause. In this case, the projection class must have a constructor
943973
matching the values returned by the select clause:
944974

_versions/main/guides/hibernate-reactive-panache.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -690,6 +690,37 @@ PanacheQuery<DogDto> query = Dog.findAll().project(DogDto.class);
690690
----
691691
<1> The `ownerName` DTO constructor's parameter will be loaded from the `owner.name` HQL property.
692692

693+
In case you want to project an entity in a class with nested classes, you can use the `@NestedProjectedClass` annotation on those nested classes.
694+
695+
[source,java]
696+
----
697+
698+
@RegisterForReflection
699+
public class DogDto {
700+
public String name;
701+
public PersonDto owner;
702+
703+
public DogDto(String name, PersonDto owner) {
704+
this.name = name;
705+
this.owner = owner;
706+
}
707+
708+
@NestedProjectedClass // <1>
709+
public static class PersonDto {
710+
public String name;
711+
712+
public PersonDto(String name) {
713+
this.name = name;
714+
}
715+
}
716+
}
717+
718+
PanacheQuery<DogDto> query = Dog.findAll().project(DogDto.class);
719+
----
720+
721+
<1> This annotation can be used when you want to project `@Embedded` entity or `@ManyToOne`, `@OneToOne` relation.
722+
It does not support `@OneToMany` or `@ManyToMany` relation.
723+
693724
It is also possible to specify a HQL query with a select clause. In this case, the projection class must have a constructor
694725
matching the values returned by the select clause:
695726

0 commit comments

Comments
 (0)