influxdb3-plugin-cli 0.5.0

InfluxDB 3 author-side CLI for templating, validating, and packaging InfluxDB 3 plugins.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//! `process_writes` template — plugin triggered by rows written to a DB.

use super::TemplateMetadata;
use crate::commands::new::{GlobalFlags, plugin_scaffold};
use clap::Args as ClapArgs;
use influxdb3_plugin_schemas::TriggerType;
use std::path::PathBuf;

pub(crate) const METADATA: TemplateMetadata = TemplateMetadata {
    name: "Process Writes Plugin",
    short_name: "process_writes",
    description: "Plugin triggered by rows written to a database.",
};

#[derive(Debug, ClapArgs)]
#[command(override_usage = "influxdb3-plugin new process_writes [OPTIONS] [PATH]")]
pub(crate) struct Args {
    #[command(flatten)]
    pub global: GlobalFlags,

    /// Target directory. Created if missing. Defaults to `.`.
    #[arg(default_value = ".")]
    pub path: PathBuf,

    /// Plugin name written into `manifest.toml`. Defaults to the basename
    /// of `[path]`.
    #[arg(long)]
    pub name: Option<String>,

    /// SemVer range for `dependencies.database_version`.
    #[arg(long)]
    pub database_version: Option<String>,
}

pub(crate) fn run(args: Args) -> anyhow::Result<()> {
    plugin_scaffold(
        &METADATA,
        TriggerType::ProcessWrites,
        args.global,
        args.path,
        args.name,
        args.database_version,
    )
}