org.neo4j.ogm.annotation

Annotation Type Index

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Index

Fields and properties marked with this annotation will notify the OGM that they should be used as part of an index and/or for use during lookups and merging. Fields marked with unique=false and primary=true will be ignored. Only one index per class hierarchy may be marked as primary. If index auto generation is turned on then classes containing @Index will be used. Indexes will always be generated with the containing class's label and the annotated property's name. Index generation behaviour can be defined in ogm.properties by defining a property called: indexes.auto and providing a value of:

• assert: drop all indexes and constraints then create constraints and indexes on startup. No indexes or constraints will be dropped on shutdown.
• validate: confirm that the required indexes and constraints defined already exist on startup otherwise abort startup
• dump: will generate a file in the current directory with the cypher commands to create indexes and constraints. Before doing this it will run the same behaviour as validate.
• none: do not generate any constraints or indexes [default]

Author:

Mark Angrish

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	primary Deprecated. Use @Id instead.
boolean	unique Indicates whether to apply a unique constraint on this property, defaults to false.

Element Detail

unique

public abstract boolean unique

Indicates whether to apply a unique constraint on this property, defaults to false.

Default:

false

primary

@Deprecated
public abstract boolean primary

Deprecated. Use @Id instead.

Indicates this constraint (unique index) should be used as the key for merges and loading by id.

Default:

false