Enum Class QueryHint

java.lang.Object
java.lang.Enum<QueryHint>
com.kingsrook.qqq.backend.core.model.actions.tables.QueryHint
All Implemented Interfaces:
Serializable, Comparable<QueryHint>, Constable
public enum QueryHint extends Enum<QueryHint>
Information about the query that an application (or qqq service) may know and want to tell the backend, that can help influence how the backend processes query. For example, a query with potentially a large result set, for MySQL backend, we may want to configure the result set to stream results rather than do its default in-memory thing. See RDBMSQueryAction for usage.

  • Enum Constant Details

    • POTENTIALLY_LARGE_NUMBER_OF_RESULTS

      public static final QueryHint POTENTIALLY_LARGE_NUMBER_OF_RESULTS

    • MAY_USE_READ_ONLY_BACKEND

      public static final QueryHint MAY_USE_READ_ONLY_BACKEND

  • Method Details

    • values

      public static QueryHint[] 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 QueryHint 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