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

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    properties
    Names of the properties on which a composite index should be created.
    boolean
    unique
    Indicates whether to apply a node key constraints on the properties.
    String[]
    value
    Alias for properties()

  • Element Details

    • value

      String[] value
      Alias for properties()
      Default:
      {}

    • properties

      String[] properties
      Names 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 unique
      Indicates whether to apply a node key constraints on the properties. Defaults to false.
      Default:
      false