Package com.apple.foundationdb.relational.api

Enum Options.Name

java.lang.Object
java.lang.Enum<Options.Name>
com.apple.foundationdb.relational.api.Options.Name
All Implemented Interfaces:
Serializable, Comparable<Options.Name>, java.lang.constant.Constable
Enclosing class:
Options
public static enum Options.Name extends Enum<Options.Name>

  • Enum Constant Details

    • CONTINUATION

      public static final Options.Name CONTINUATION
      Continuation. Scope: Direct Access API

    • INDEX_HINT

      public static final Options.Name INDEX_HINT

    • MAX_ROWS

      public static final Options.Name MAX_ROWS
      Limit the maximum number of records to return before prompting for continuation. This can also be set via JDBC's setMaxRows Scope: Connection, Direct Access API.

    • REQUIRED_METADATA_TABLE_VERSION

      public static final Options.Name REQUIRED_METADATA_TABLE_VERSION
      When set, only tables which were created at or before the specified version can be opened. If this is set to -1, then it only requires that a version number exists.

      This is something of a weird carryover from development work which happened before Relational existed, and should only be used sparingly except in those specific use-cases. Scope: Direct Access API

    • TRANSACTION_TIMEOUT

      public static final Options.Name TRANSACTION_TIMEOUT
      Transaction timeout in milliseconds. Scope: Connection

    • REPLACE_ON_DUPLICATE_PK

      public static final Options.Name REPLACE_ON_DUPLICATE_PK
      During insertion, if the primary key of the inserted row is already in the table, replace the old row with the new row. Scope: Direct Access API

    • PLAN_CACHE_PRIMARY_MAX_ENTRIES

      public static final Options.Name PLAN_CACHE_PRIMARY_MAX_ENTRIES
      Limit of Relational's primary plan cache. Settings the limit to zero effectively disables the plan cache. Scope: Engine

    • PLAN_CACHE_SECONDARY_MAX_ENTRIES

      public static final Options.Name PLAN_CACHE_SECONDARY_MAX_ENTRIES
      Limit of Relational's secondary plan cache. Scope: Engine

    • PLAN_CACHE_TERTIARY_MAX_ENTRIES

      public static final Options.Name PLAN_CACHE_TERTIARY_MAX_ENTRIES
      Limit of Relational's tertiary plan cache. Scope: Engine

    • PLAN_CACHE_PRIMARY_TIME_TO_LIVE_MILLIS

      public static final Options.Name PLAN_CACHE_PRIMARY_TIME_TO_LIVE_MILLIS
      Read time-to-live duration (in milliseconds) of items in the primary cache. Scope: Engine

    • PLAN_CACHE_SECONDARY_TIME_TO_LIVE_MILLIS

      public static final Options.Name PLAN_CACHE_SECONDARY_TIME_TO_LIVE_MILLIS
      Write time-to-live duration (in milliseconds) of items living in the secondary cache. Scope: Engine

    • PLAN_CACHE_TERTIARY_TIME_TO_LIVE_MILLIS

      public static final Options.Name PLAN_CACHE_TERTIARY_TIME_TO_LIVE_MILLIS
      Write time-to-live duration (in milliseconds) of items living in the tertiary cache. Scope: Engine

    • INDEX_FETCH_METHOD

      public static final Options.Name INDEX_FETCH_METHOD
      An indicator for the index fetch method to use for a query or an index scan. Possible values are: Scope: Connection

    • DISABLED_PLANNER_RULES

      public static final Options.Name DISABLED_PLANNER_RULES
      A set of planner rules (by name) that the query planner should not execute. By default, no rules are disabled, and the user should be able to leave this unset. This is intended as an escape hatch in case the introduction of a new planner rule causes trouble for an existing query. Scope: Connection, Query

    • DISABLE_PLANNER_REWRITING

      public static final Options.Name DISABLE_PLANNER_REWRITING
      A boolean indicating if the query planner should disable planner rewrite rules. If this is set to true, then the planner will skip all of the rules used in the rewrite phase of the planner. This can result in sub-optimal plans, as the planning phase may now need to match a more complicated query, but it can be used as a way to disable the rewrite phase if certain queries either encounter an error or take too much time exploring different rewrites. Scope: Connection, Query

    • LOG_QUERY

      public static final Options.Name LOG_QUERY
      A boolean indicating if a query should be logged or not. Scope: Connection, Query

    • LOG_SLOW_QUERY_THRESHOLD_MICROS

      public static final Options.Name LOG_SLOW_QUERY_THRESHOLD_MICROS
      Log a query at info level if it is slower than `LOG_SLOW_QUERY_THRESHOLD` microseconds. Scope: Engine

    • EXECUTION_TIME_LIMIT

      public static final Options.Name EXECUTION_TIME_LIMIT
      Set a time limit per transaction. If the limit is hit, a `SCAN_LIMIT_REACHED` SQLException is thrown. The continuation in the result can be used to resume. Scope: Connection

    • EXECUTION_SCANNED_BYTES_LIMIT

      public static final Options.Name EXECUTION_SCANNED_BYTES_LIMIT
      Set a scanned bytes limit per transaction. If the limit is hit, a `SCAN_LIMIT_REACHED` SQLException is thrown. The continuation in the result set can be used to resume. Scope: Connection

    • EXECUTION_SCANNED_ROWS_LIMIT

      public static final Options.Name EXECUTION_SCANNED_ROWS_LIMIT
      Set a scanned row limit per transaction. If the limit is hit, a `SCAN_LIMIT_REACHED` SQLException is thrown. The continuation in the result set can be used to resume. Scope: Connection

    • DRY_RUN

      public static final Options.Name DRY_RUN
      Execute this insert / update / delete without persisting data to disk. Scope: Query

    • CASE_SENSITIVE_IDENTIFIERS

      public static final Options.Name CASE_SENSITIVE_IDENTIFIERS
      Treat identifiers as-is in terms of case without upper-casing non-quoted ones. Scope: Connection

    • CURRENT_PLAN_HASH_MODE

      public static final Options.Name CURRENT_PLAN_HASH_MODE
      Current plan hash mode. Must be a valid version or assumed current if not set.

    • VALID_PLAN_HASH_MODES

      public static final Options.Name VALID_PLAN_HASH_MODES
      Acceptable plan hash modes (string-delimited list). Allows the plan validation to utilize and accept an older plan hash mode.

    • CONTINUATIONS_CONTAIN_COMPILED_STATEMENTS

      public static final Options.Name CONTINUATIONS_CONTAIN_COMPILED_STATEMENTS
      Boolean indicator if continuations generated for query responses may contain serialized compiled statements that can be used in EXECUTE CONTINUATION statements.

    • ASYNC_OPERATIONS_TIMEOUT_MILLIS

      public static final Options.Name ASYNC_OPERATIONS_TIMEOUT_MILLIS
      Timeout for asynchronous operations in milliseconds, this is usually used to set an upperbound time limit for operations interacting with FDB. Scope: Engine

  • Method Details

    • values

      public static Options.Name[] 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 Options.Name 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