Crate oxide_batch_cli

Expand description

The minimal guarded operator command line for OxideBatch.

This crate is a thin client over the portable operator, explorer, and retention services. It owns no correctness rule of its own: every guard, every compare-and-swap, every idempotency record, and every audit row belongs to the services it calls. Removing this crate removes no correctness capability.

The crate is both a library and a binary. The shipped oxide-batch binary serves every command that a repository alone can answer. launch and execution restart additionally need the job’s canonical DefinitionIdentity, which only the owning application can construct, so a host application embeds this crate and supplies a DefinitionCatalog.

§Boundaries

The CLI adds no hosted API, no identity system, no scheduler, and no user interface. It never writes metadata directly, and repository state rather than CLI output or process state is authoritative.

Structs§

Arguments: One parsed invocation of the closed grammar.
BackendFailure: A failure to open the repository.
ConfigError: Every safe-to-display configuration conflict found in one pass.
ConfigIssue: One rejected configuration value.
Configuration: The effective configuration of one invocation.
DefinitionCatalog: The job definitions one embedding application authorizes for launch.
Diagnostic: One bounded, redacted diagnostic record.
EffectiveValue: One row of config show.
NoSchema: A repository that reports no durable schema, such as the in-memory adapter.
OutputFailure: A failure to write the result.
PageInfo: Pagination fields of a paginated command.
Plan: One parsed and validated invocation awaiting dispatch.
ProcessHost: The real process host.
Resolved: One effective value together with the source that supplied it.
Response: The complete result of one invocation.
SchemaState: The durable schema state one repository reports.
Secret: A configuration value whose text must never reach output.
Services: The portable services one invocation calls.
Writer: Renders responses in the selected form.

Enums§

ActionClass: The separately authorizable class of one command.
ArgumentError: A rejected invocation.
CatalogError: A rejected catalog registration.
Command: One command of the closed oxide-batch <noun> <verb> grammar.
DirectiveArg: The recovery disposition requested by execution recover.
ExitCategory: One stable process exit category.
Outcome: The outcome field of the versioned JSON envelope.
OutputForm: The requested output form.
RecordArg: The record family selected by execution history.
Source: Where one effective value came from.
TlsSetting: Transport security selected for the repository connection.

Constants§

CONFIG_VERSION: Configuration schema version accepted in a configuration file.
MAX_OUTPUT_BYTES: Largest encoded response written for one invocation.
OUTPUT_SCHEMA_VERSION: The integer CLI output schema version.

Traits§

Host: The process services one invocation requires.
RecoveryProposalPort: Produces the current evidence-bound recovery proposal for the CLI.
SchemaReport: Reports the durable schema version without changing it.

Functions§

connect: Opens the repository and binds the portable services.
connection_config: Builds the connection configuration from resolved settings.
default_config_path: Returns the canonical configuration file path a deployment may use.
dispatch: Runs one command against the portable services.
environment_variable: Returns the environment variable that supplies one configuration key.
known_keys: Returns every accepted configuration key in canonical order.
local: Answers the commands that require no repository connection.
prepare: Parses the grammar and resolves configuration.

Type Aliases§

PostgresServices: The services one PostgreSQL deployment provides.