Package com.apple.foundationdb.record

Enum Class IndexState

java.lang.Object
java.lang.Enum<IndexState>
com.apple.foundationdb.record.IndexState
All Implemented Interfaces:
Serializable, Comparable<IndexState>, Constable
@API(UNSTABLE) public enum IndexState extends Enum<IndexState>
Different states an index might be in within a given store. These states might differ between record stores that have otherwise identical meta-data.

  • Enum Constant Details

    • READABLE

      public static final IndexState READABLE
      This is the default state for an index. It is safe to read this index and safe to use it for queries as the record store will maintain the index as new writes come in and the index has already been built.

    • WRITE_ONLY

      public static final IndexState WRITE_ONLY
      Indicates the index should not be read from but is written to. This is the state that an index should be in while it is being built but the build has not completed. Queries cannot use the index, but as records are added and removed, the index is updated.

    • DISABLED

      public static final IndexState DISABLED
      Indicates that this store does not use this index. The index cannot service reads or queries and it is not maintained by the record store.

    • READABLE_UNIQUE_PENDING

      public static final IndexState READABLE_UNIQUE_PENDING
      Indicates that this unique index is fully "indexed", but some uniqueness violations still exist. This may happen when the online indexer finds some duplicating records. In this mode, it is safe to consider an index as READABLE for queries as long as uniqueness is not assumed.

    • WRITE_ONLY_WITH_QUEUE

      public static final IndexState WRITE_ONLY_WITH_QUEUE
      Similar to WRITE_ONLY, but user updates are written to a write pending queue rather than directly into the index. Queries cannot use the index in this state. This index state is designed to prevent conflicts between the online indexer and user io.

  • Method Details

    • values

      public static IndexState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static IndexState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • code

      @Nonnull public Object code()
      Value corresponding to the state. When this state needs to be stored within a record store, this can be used as the code.
      Returns:
      the code to serialize to serialize this state

    • getLogName

      public String getLogName()

    • isReadable

      public boolean isReadable()
      Determine if an index in this state is readable.
      Returns:
      true if this state is READABLE and false otherwise

    • isReadableUniquePending

      public boolean isReadableUniquePending()
      Determine if an index in this state is readable-unique-pending. The readable-unique-pending index state may happen after a unique index is built, but duplications are found. The index will be maintained in this mode until the last duplication is resolved, then its state can be changed to READABLE.
      Returns:
      true if this state is READABLE_UNIQUE_PENDING and false otherwise

    • isScannable

      public boolean isScannable()
      Determine if an index in this state is scannable - i.e. either isReadable() or isReadableUniquePending().
      Returns:
      true if this state is scannable and false otherwise

    • isWriteOnlyNoQueue

      public boolean isWriteOnlyNoQueue()
      Determine if an index in this state is write-only (but not write-only-with-queue).
      Returns:
      true if this state is WRITE_ONLY and false otherwise

    • isWriteOnlyWithQueue

      public boolean isWriteOnlyWithQueue()
      Determine if an index in this state is write-only with a pending queue.
      Returns:
      true if this state is WRITE_ONLY_WITH_QUEUE and false otherwise

    • isWriteOnly

      public boolean isWriteOnly()
      Determine if an index in this state is write-only in any form (WRITE_ONLY or WRITE_ONLY_WITH_QUEUE).
      Returns:
      true if this state is write-only in any form and false otherwise

    • isDisabled

      public boolean isDisabled()
      Determine if an index in this state is disabled.
      Returns:
      true if this state is DISABLED and false otherwise

    • fromCode

      public static IndexState fromCode(@Nonnull Object code)