Skip to main content

Module config

Module config 

Source
Expand description

Engine configuration via jpx.toml.

Provides declarative configuration for the jpx engine, supporting function filtering, query libraries, and engine settings. Configuration is loaded from multiple sources with layered overrides:

  1. DefaultsEngineConfig::default() (strict=false, all functions enabled)
  2. Global~/.config/jpx/jpx.toml (via dirs::config_dir())
  3. Project-local – Walk up from CWD looking for jpx.toml
  4. Env override$JPX_CONFIG points to a specific file
  5. Programmatic – CLI flags, MCP args, builder calls

§Example

[engine]
strict = false

[functions]
disabled_categories = ["geo", "phonetic"]
disabled_functions = ["env"]

[queries]
libraries = ["~/.config/jpx/common.jpx"]

[queries.inline]
active-users = { expression = "users[?active].name", description = "Get active user names" }

Structs§

EngineBuilder
Builds a JpxEngine from configuration with programmatic overrides.
EngineConfig
Top-level configuration for the jpx engine.
EngineSection
Engine-level settings.
FunctionsSection
Function filtering configuration.
InlineQuery
An inline named query defined in the config file.
QueriesSection
Query configuration.

Functions§

build_runtime_from_config
Builds a Runtime and FunctionRegistry from function configuration.
load_queries_into_store
Loads query libraries and inline queries into a query store.