Package org.neo4j.ogm.annotation
Annotation Interface CompositeIndex
@Retention(RUNTIME)
@Target(TYPE)
@Repeatable(CompositeIndexes.class)
@Inherited
public @interface CompositeIndex
This annotation is kept as a marker interface and for API reasons.
It currently does not get picked up by Neo4j-OGM in any form.
- Author:
- Frantisek Hartman, Michael J. Simons
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionString[]
Names of the properties on which a composite index should be created.boolean
Indicates whether to apply a node key constraints on the properties.String[]
Alias forproperties()
-
Element Details
-
value
String[] valueAlias forproperties()
- Default:
- {}
-
properties
String[] propertiesNames of the properties on which a composite index should be created.All property names must match an existing property in the class or one of its super classes. If a property name is overridden by @Property annotation this name must be used.
Order of the properties matters, check Neo4j documentation for composite indexes for details.
- Default:
- {}
-
unique
boolean uniqueIndicates whether to apply a node key constraints on the properties. Defaults to false.- Default:
- false
-