Skip to content
Kadyapam edited this page Jun 1, 2026 · 16 revisions

noetl-tools

Shared tool registry for the NoETL Rust runtime. Hosts the concrete Tool implementations the CLI and worker dispatch through, plus the supporting auth resolver, template engine, and result envelope types.

What this crate is

The execution layer of the Rust runtime split:

  • noetl-tools (this crate) — concrete tool implementations. Each tool ships a ToolConfig schema, an async execute() method, and a ToolResult envelope.
  • noetl-executor — shared utilities + types the CLI and worker call into (template rendering, condition evaluation, capability validation, event envelope, tool dispatch bridge).
  • noetl-worker — NATS pull consumer.
  • noetl (cli) — local-mode runner + workspace member for noetl-executor.

The CLI and worker both depend on noetl-tools directly (alongside noetl-executor). The dispatch flow:

noetl CLI's tree walker      worker's NATS pull loop
        │                            │
        └─── noetl-executor ─────────┘
                  │
                  └─── noetl-tools::ToolRegistry
                              │
                              ├── RhaiTool         ┐
                              ├── ShellTool        │
                              ├── HttpTool         │
                              ├── DuckdbTool       ├── concrete tool kinds
                              ├── PostgresTool     │
                              ├── SnowflakeTool    │
                              ├── TransferTool     │
                              ├── PythonTool       │
                              └── ScriptTool       ┘

Tool kinds

Tool Source Purpose
RhaiTool tools::rhai Embedded Rhai scripting; HTTP helpers, sleep, get_gcp_token, log/print/parse_json.
ShellTool tools::shell Spawn shell commands; capture stdout/stderr/exit_code.
HttpTool tools::http Direct reqwest calls; JSON / form / binary bodies; GCP ADC bearer auth.
DuckdbTool tools::duckdb In-process DuckDB query execution; SELECT returns {columns, rows, row_count}; non-SELECT returns {affected_rows}.
PostgresTool tools::postgres Connection-pooled PG; same envelope shape as DuckDB.
SnowflakeTool tools::snowflake Snowflake-specific connection params (account / warehouse / database / schema).
TransferTool tools::transfer Database-to-database transfer (snowflake / postgres / http source → snowflake / postgres / duckdb target). Modes: append / replace / upsert.
PythonTool tools::python Spawn Python subprocesses (script execution).
ScriptTool tools::script Generic script-as-string execution.

Supporting modules

Module Purpose
registry ToolRegistry, Tool trait, ToolConfig, AuthConfig + AuthType enum.
context ExecutionContext — per-execution variable + secret + worker-id state. execution_id: i64 mirrors Python noetl.event.execution_id.
auth AuthResolver + concrete providers. GcpAuth uses the gcp_auth crate; supports workload identity on GKE + gcloud fallback on dev hosts.
template TemplateEngine{{ workload.x }} substitution; render_value(json, ctx) for nested templates.
result ToolResult + ToolStatus (Success / Error / Timeout).
error ToolError enum covering all tool-side failures.
arrow_codec Apache Arrow encode/decode (R-2 data plane). As of 2.10.0 also exposes try_encode_tabular_json(value) -> Option<TabularEncoding> for the worker's R-2.2 shm-cache fast path: detects DuckDB / Postgres / Snowflake {columns, rows} JSON (top-level or nested under data), infers per-column Arrow types (Int64 / Float64 / Boolean / Utf8 with mixed-type fallback to Utf8), and encodes as a Feather V2 / IPC stream tagged with ARROW_STREAM_MEDIA_TYPE = "application/vnd.apache.arrow.stream" (mirrors Python's noetl.core.storage.arrow_ipc.ARROW_STREAM_MEDIA_TYPE).

Pages

  • Tool kinds overview — per-tool config schema + result envelope reference.
  • Consumers — who calls into this crate and how (CLI tree walker via noetl-executor::tools_bridge, worker via noetl-executor::dispatch_via_registry).

Versioning

Currently published on crates.io as noetl-tools = "2.10.0". noetl-worker pins ^2.10 to pick up arrow_codec::try_encode_tabular_json; noetl-executor still pins ^2.8 (it doesn't need the R-2.2 helper). The version track was realigned in 2.9.0 to skip past the yanked 2.8.7 publish — see CHANGELOG.md for the full history.

Related

Clone this wiki locally