fdb v5.1.7-2 FDB.KeySelector View Source

Refer KeySelector section for the semantics. A partial or prefix key could refer to multiple keys in the database. The prefix option controls whether it should be resolved to the first or last key with the given prefix.

Supported Options

All the functions in this module support the following options

  • :or_equal - (boolean) the default value differs for each function.
  • :offset - (integer) could be either positive or negative. Defaults to 0.
  • :prefix - (atom)

    • :first - the first key with the given prefix
    • :last - the last key with the given prefix
    • :none - specifies this is not a prefix key. Default value.

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %FDB.KeySelector{
  key: any(),
  offset: integer(),
  or_equal: boolean() | integer(),
  prefix: :none | :first | :last
}

Link to this section Functions

Link to this function first_greater_or_equal(key, options \\ %{}) View Source
first_greater_or_equal(any(), map()) :: t()
Link to this function first_greater_than(key, options \\ %{}) View Source
first_greater_than(any(), map()) :: t()
Link to this function last_less_or_equal(key, options \\ %{}) View Source
last_less_or_equal(any(), map()) :: t()
Link to this function last_less_than(key, options \\ %{}) View Source
last_less_than(any(), map()) :: t()