Module spring.data.neo4j

Package org.springframework.data.neo4j.core.schema

Annotation Interface GeneratedValue

@Retention(RUNTIME)
@Target({FIELD,ANNOTATION_TYPE})
@Documented
@Inherited
@API(status=STABLE,
     since="6.0")
public @interface GeneratedValue

Indicates a generated id. Ids can be generated internally. by the database itself or by an external generator. This annotation defaults to the internally generated ids.

An internal id has no corresponding property on a node. It can only be retrieved via the built-in Cypher function id().

To use an external id generator, specify on the

Since:

6.0

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GeneratedValue.InternalIdGenerator	This IdGenerator does nothing.
static final class	GeneratedValue.UUIDGenerator	This generator is automatically applied when a field of type UUID is annotated with @Id and @GeneratedValue.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends IdGenerator<?>>	generatorClass
String	generatorRef
Class<? extends IdGenerator<?>>	value

Element Details

value

@AliasFor("generatorClass")
Class<? extends IdGenerator<?>> value

Returns:

The generator to use.

See Also:

• generatorClass()

Default:

org.springframework.data.neo4j.core.schema.GeneratedValue.InternalIdGenerator.class

generatorClass

@AliasFor("value")
Class<? extends IdGenerator<?>> generatorClass

Returns:

The generator to use. Defaults to GeneratedValue.InternalIdGenerator, which indicates database generated values.

Default:

org.springframework.data.neo4j.core.schema.GeneratedValue.InternalIdGenerator.class

generatorRef

String generatorRef

Returns:

An optional reference to a bean to be used as ID generator.

Default:

""