Annotation Interface SpaceIndex

@Target(METHOD) @Retention(RUNTIME) @Repeatable(SpaceIndexes.class) public @interface SpaceIndex
Defines a space index.
Can be defined on the property getter or as part of @SpaceIndexes when multiple indexes are
used.

Indexes on nested object properties are defined on the nested object getter.

For example:


 To index the 'socialSecurity' property using extended indexing:
 1. @SpaceIndex(type = IndexType.EXTENDED)
    public long getSocialSecurity() {
return socialSecurity;
}

To index 'personalInfo.name':
 2. @SpaceIndex(path = "name")
    public Info getPersonalInfo() {
return personalInfo;
}
Since:
7.1
Author:
Anna Pavtulov

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EMPTY
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    path
    Defines the index property path.
    SpaceIndexType
    type
    The type of the index - default is EQUAL index
    boolean
    unique
    Indicates if unique constraint is applied for this index.

  • Field Details

  • Element Details

    • path

      String path
      Defines the index property path. The path specifies which property path is indexed. If none is defined - the property itself is indexed.
      Default:
      ""

    • type

      SpaceIndexType type
      The type of the index - default is EQUAL index
      Default:
      EQUAL

    • unique

      boolean unique
      Indicates if unique constraint is applied for this index. The constraint is per partition. default is false
      Default:
      false