Crate influxdb3_plugin_cli 

Public embedding surface for the InfluxDB 3 plugin CLI.

PluginConfig is a clap-derived, semver-stable type intended to be mounted as a subcommand variant by a host binary (e.g. influxdb_pro).

Schema-type re-exports route through this crate so embedding consumers depend only on influxdb3-plugin-cli, preventing parser drift from a parallel direct dependency on influxdb3-plugin-schemas.

Structs

ArtifactHash

SHA-256 artifact hash, stored in the canonical form sha256:<64 lowercase hex chars>.

ArtifactsUrl

Registry artifact-base URL. Scheme is restricted to https, http, or file.

Dependencies

[dependencies] section of the manifest.

Description

One-line plugin description. 1–200 characters.

FieldPath

A dotted-and-indexed path identifying a field inside a parsed manifest or index (e.g., plugin.name, plugins[3].dependencies.python[0]). Build by chaining from FieldPath::root().

Index

A parsed plugin registry index.

IndexEntry

One per-version entry inside an index’s plugins[] array.

IndexSchemaVersion

The index_schema_version top-level field. Mirrors ManifestSchemaVersion: format <major>.<minor>, unsupported majors rejected.

Manifest

A parsed plugin manifest.

ManifestSchemaVersion

The manifest_schema_version top-level field, format <major>.<minor>.

PluginConfig

Top-level embeddable CLI config for the influxdb3-plugin binary.

PluginMetadata

[plugin] section of the manifest.

PluginName

Validated plugin name matching [a-zA-Z][a-zA-Z0-9_-]* (1-64 ASCII characters, starting with an ASCII letter). Case-preserving in storage. Windows reserved device names (con, prn, aux, nul, com0-9, lpt0-9) are rejected case-insensitively. Collisions inside a single index use the canonical form.

PythonRequirement

A PEP 508 Python package requirement string (e.g., requests>=2.31,<3). Validated for parseability at construction; stored in its canonical string form.

ReportedError

A SchemaError paired with the field path at which it was detected.

SchemaErrors

Collection of ReportedErrors returned by Manifest::parse_toml and Index::parse_json.

Enums

PluginId

Global plugin identity: the tuple (source, name, version) where source is either a registry URL or a local directory. Two PluginIds are equal when all three components match.

SchemaError

Errors produced during schema parsing and validation.

TriggerType

Closed set of supported trigger types. Manifests are rejected if any trigger identifier is outside this set.