Package com.apple.foundationdb.record

Enum IndexFetchMethod

java.lang.Object
java.lang.Enum<IndexFetchMethod>
com.apple.foundationdb.record.IndexFetchMethod
All Implemented Interfaces:
Serializable, Comparable<IndexFetchMethod>, java.lang.constant.Constable
@API(EXPERIMENTAL) public enum IndexFetchMethod extends Enum<IndexFetchMethod>
An indicator for the index fetch method to use for a query or an index scan. Possible values are:
  • SCAN_AND_FETCH use regular index scan followed by fetch
  • USE_REMOTE_FETCH use remote fetch feature from FDB
  • USE_REMOTE_FETCH_WITH_FALLBACK use remote fetch ability with fallback to regular scan and fetch in case of failure. This is a safety measure meant to be used while the remote fetch mechanism is being tested

  • Enum Constant Details

    • SCAN_AND_FETCH

      public static final IndexFetchMethod SCAN_AND_FETCH

    • USE_REMOTE_FETCH

      public static final IndexFetchMethod USE_REMOTE_FETCH

    • USE_REMOTE_FETCH_WITH_FALLBACK

      public static final IndexFetchMethod USE_REMOTE_FETCH_WITH_FALLBACK

  • Method Details

    • values

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

    • valueOf

      public static IndexFetchMethod valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • toProto

      @Nonnull public com.apple.foundationdb.record.planprotos.PIndexFetchMethod toProto(@Nonnull PlanSerializationContext serializationContext)

    • fromProto

      @Nonnull public static IndexFetchMethod fromProto(@Nonnull PlanSerializationContext serializationContext, @Nonnull com.apple.foundationdb.record.planprotos.PIndexFetchMethod indexFetchMethodProto)