Providers on Orchard

External providers

Mon, 01 Jan 0001 00:00:00 +0000

External providers#

External providers are binaries that live outside the orchard tree and speak Orchard’s provider protocol over stdio. Scenarios use them exactly like built-in providers — the only difference is the source string.

If you want to build a custom provider, see Extending Orchard. This page covers how to use an existing external provider from a scenario.

Declaring an external provider#

required_providers {
 stripe = { source = "exec:./bin/orchard-stripe" }
}

The source format is exec:<path>, where <path> is an executable file:

exec

Mon, 01 Jan 0001 00:00:00 +0000

exec#

Source: builtin/exec

Shell command execution.

Provider configuration#

Name	Type	Required	Default	Description
`dir`	`string`	no	—	Default working directory for commands. Relative paths are resolved against the process cwd.
`env`	`map(string)`	no	—	Default environment variables merged into every action’s env.

Actions#

`exec_run`#

Run a program and capture stdout/stderr/exit_code.

Non-zero exit is an error by default — the action fails and downstream actions don’t run.

Run a program with explicit arguments.

http

Mon, 01 Jan 0001 00:00:00 +0000

http#

Source: builtin/http

HTTP request provider.

Provider configuration#

Name	Type	Required	Default	Description
`base_url`	`string`	no	—	Prepended to relative URLs in requests. When unset, URLs must be absolute.
`default_headers`	`map(string)`	no	—	Headers added to every request; per-request headers take precedence.
`timeout_seconds`	`number`	no	`30`	Per-request timeout in seconds applied to the full request/response round-trip.

Actions#

`http_request`#

Issue an HTTP request and capture the response.

Simple GET against a relative path resolved via base_url.

postgres

Mon, 01 Jan 0001 00:00:00 +0000

postgres#

Source: builtin/postgres

PostgreSQL data operations.

Provider configuration#

Name	Type	Required	Default	Description
`dsn`	`string`	yes	—	PostgreSQL connection string (e.g. `postgres://user:pass@host:5432/db`).

Actions#

`postgres_copy`#

Bulk-load rows into a table via PostgreSQL COPY FROM STDIN. Dramatically faster than row-by-row INSERT for fixture data — a 10,000-row CSV loads in a single network round-trip.

Provide data inline via data or reference a file via file. The two are mutually exclusive. file paths are resolved relative to the scenario file by the engine, so file = "./fixtures/merchants.csv" works from any cwd.

Providers on Orchard

External providers

External providers#

Declaring an external provider#

exec

exec#

Provider configuration#

Actions#

exec_run#

http

http#

Provider configuration#

Actions#

http_request#

postgres

postgres#

Provider configuration#

Actions#

postgres_copy#

`exec_run`#

`http_request`#

`postgres_copy`#