Package org.springframework.data.aerospike.annotation

Annotation Interface Indexed

@Target(FIELD) @Retention(RUNTIME) public @interface Indexed
Marks a field to be indexed using Aerospike's secondary index. This will make spring-data-aerospike create index on application's startup.

For more details on Secondary index feature please refer to Aerospike Secondary index.

Creating a secondary index with context via @Indexed annotation is not supported at the moment - instead use: AerospikeOperations.createIndex(Class, String, String, IndexType, IndexCollectionType, CTX...) or for reactive flow: ReactiveAerospikeOperations.createIndex(Class, String, String, IndexType, IndexCollectionType, CTX...)

Author:
Taras Danylchuk

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    com.aerospike.client.query.IndexType
    type
    Underlying data type of secondary index.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    com.aerospike.client.query.IndexCollectionType
    collectionType
    Secondary index collection type.
    String
    name
    If not set, name will be automatically generated with pattern {setName}_{fieldName}_lowercase{type}_lowercase{collectionType}.

  • Element Details

    • type

      com.aerospike.client.query.IndexType type
      Underlying data type of secondary index.

    • name

      String name
      If not set, name will be automatically generated with pattern {setName}_{fieldName}_lowercase{type}_lowercase{collectionType}.

      Allows the actual value to be set using standard Spring property sources mechanism. Syntax is the same as for PropertyResolver.resolveRequiredPlaceholders(String). SpEL is NOT supported.

      Default:
      ""

    • collectionType

      com.aerospike.client.query.IndexCollectionType collectionType
      Secondary index collection type.
      Default:
      DEFAULT