io.micronaut.data.jpa.annotation

Annotation Type EntityGraph

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

Allows configuring JPA 2.1 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 and Description
java.lang.String[]	attributePaths The attributes paths to include in the entity graph.
java.lang.String	hint
java.lang.String	name Specifies the name of the entity graph.
java.lang.String	value Same as name().

Element Detail

value

@AliasFor(member="name")
public abstract java.lang.String value

Same as name().

Returns:

The name of the entity graph.

Default:

""

name

@AliasFor(member="value")
public abstract java.lang.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

public abstract java.lang.String hint

Returns:

The name of the hint to use.

See Also:

JPA 2.1 Specification: 3.7.4.2 Load Graph Semantics

Default:

"javax.persistence.fetchgraph"

attributePaths

public abstract java.lang.String[] attributePaths

The attributes paths to include in the entity graph.

Returns:

The attributes paths

Default:

{}