Package io.micronaut.data.jpa.annotation

Annotation Interface EntityGraph

@Retention(RUNTIME)
@Target({METHOD,ANNOTATION_TYPE})
@Documented
public @interface EntityGraph

Allows configuring JPA 3.0 entity graphs on query methods. Largely based on the same annotation as in Spring Data.

Since:

1.0.0

Author:

graemerocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	attributePaths	The attributes paths to include in the entity graph.
String	hint
String	name	Specifies the name of the entity graph.
String	value	Same as name().

Element Details

value

@AliasFor(member="name")
String value

Same as name().

Returns:

The name of the entity graph.

Default:

""

name

@AliasFor(member="value")
String name

Specifies the name of the entity graph. If none is specified one will be created at runtime.

Returns:

The name of the entity graph to use.

Default:

""

hint

String hint

Returns:

The name of the hint to use.

See Also:

• JPA 2.1 Specification: 3.7.4.2 Load Graph Semantics

Default:

"jakarta.persistence.fetchgraph"

attributePaths

String[] attributePaths

The attributes paths to include in the entity graph.

Returns:

The attributes paths

Default:

{}