Zvex.Config (zvex v0.4.0)

Configuration builder for zvec initialization.

All fields are optional. nil values use zvec defaults.

Example

Zvex.Config.new()
|> Zvex.Config.memory_limit(1_073_741_824)
|> Zvex.Config.query_threads(4)
|> Zvex.Config.log(:console, level: :warn)

Summary

Types

t()

Functions

brute_force_by_keys_ratio(config, ratio)

Sets the key-count ratio threshold for falling back to brute-force search.

invert_to_forward_scan_ratio(config, ratio)

Sets the ratio threshold for switching from inverted index scan to forward scan.

log(config, atom, opts \\ [])

Configures console logging for the zvec engine.

memory_limit(config, bytes)

Sets the maximum memory usage in bytes for the zvec engine.

new()

Creates a new configuration with all fields set to nil (zvec defaults).

optimize_threads(config, count)

Sets the number of threads used for index optimization.

query_threads(config, count)

Sets the number of threads used for query execution.

to_native_map(config)

Converts the configuration to the flat map format expected by the NIF layer.

validate(config)

Validates the configuration using the Zoi schema. Returns {:ok, config} or an error.

Types

t()

@type t() :: %Zvex.Config{
  brute_force_by_keys_ratio: nil | nil | float(),
  invert_to_forward_scan_ratio: nil | nil | float(),
  log:
    nil
    | nil
    | {:console,
       %{optional(:level) => :debug | :info | :warn | :error | :fatal}},
  memory_limit: nil | nil | integer(),
  optimize_threads: nil | nil | integer(),
  query_threads: nil | nil | integer()
}

Functions

brute_force_by_keys_ratio(config, ratio)

@spec brute_force_by_keys_ratio(t(), float()) :: t()

Sets the key-count ratio threshold for falling back to brute-force search.

invert_to_forward_scan_ratio(config, ratio)

@spec invert_to_forward_scan_ratio(t(), float()) :: t()

Sets the ratio threshold for switching from inverted index scan to forward scan.

log(config, atom, opts \\ [])

@spec log(t(), :console, keyword()) :: t()

Configures console logging for the zvec engine.

Options

:level — minimum log level: :debug, :info, :warn, :error, or :fatal.

memory_limit(config, bytes)

@spec memory_limit(t(), pos_integer()) :: t()

Sets the maximum memory usage in bytes for the zvec engine.

new()

@spec new() :: t()

Creates a new configuration with all fields set to nil (zvec defaults).

optimize_threads(config, count)

@spec optimize_threads(t(), pos_integer()) :: t()

Sets the number of threads used for index optimization.

query_threads(config, count)

@spec query_threads(t(), pos_integer()) :: t()

Sets the number of threads used for query execution.

to_native_map(config)

@spec to_native_map(t()) :: map()

Converts the configuration to the flat map format expected by the NIF layer.

validate(config)

@spec validate(t()) :: {:ok, t()} | {:error, Zvex.Error.t()}

Validates the configuration using the Zoi schema. Returns {:ok, config} or an error.