ExSieve v0.8.2 ExSieve.Config View Source

Struct with ExSieve configuration options.

Link to this section Summary

Types

t()

ExSieve configuration options

Link to this section Types

Specs

t() :: %ExSieve.Config{
  except_predicates: [String.t() | :basic | :composite] | nil,
  ignore_errors: boolean(),
  max_depth: non_neg_integer() | :full,
  only_predicates: [String.t() | :basic | :composite] | nil
}

ExSieve configuration options:

  • :ignore_errors - when true recoverable errors are ignored. Recoverable errors include for instance missing attribute or missing predicate, in that case the query is returned without taking into account the filter causing the error. Defaults to true

  • :max_depth - the maximum level of nested relations that can be queried. Defaults to :full meaning no limit

  • :only_predicates - a list of allowed predicates. The list can contain :basic and :composite, in that case all corresponding predicates are added to the list. When not given or when nil no limit is applied. Defaults to nil

  • :except_predicates - a list of excluded predicates. The list can contain :basic and :composite, in that case all corresponding predicates are added to the list. When not given or when nil no limit is applied. If both :only_predicates and :except_predicates are given :only_predicates takes precedence and :except_predicates is ignored. Defaults to nil