Annotation Interface MongoIndexed

@Retention(RUNTIME) @Target({FIELD,METHOD,ANNOTATION_TYPE}) @Documented @Inherited public @interface MongoIndexed
Declares a simple MongoDB index for a property.
Since:
5.0.0
Author:
radovanradic

  • Element Details

    • name

      String name
      Returns:
      The index name.
      Default:
      ""

    • direction

      MongoIndexDirection direction
      Returns:
      The index direction.
      Default:
      ASC

    • unique

      boolean unique
      Returns:
      Whether the index is unique.
      Default:
      false

    • sparse

      boolean sparse
      Returns:
      Whether the index is sparse.
      Default:
      false

    • hidden

      boolean hidden
      Returns:
      Whether the index is hidden.
      Default:
      false

    • expireAfterSeconds

      int expireAfterSeconds
      Returns:
      The index expiration in seconds.
      Default:
      -1

    • partialFilterExpression

      String partialFilterExpression
      Returns:
      The partial filter expression as JSON.
      Default:
      ""

    • collation

      String collation
      Returns:
      The collation definition as JSON.
      Default:
      ""

    • comment

      String comment
      Returns:
      The index creation command comment.
      Default:
      ""

    • storageEngine

      String storageEngine
      Returns:
      The storage engine options as JSON.
      Default:
      ""