influx scripts create
- influx CLI 2.4.0+
- InfluxDB Cloud only
The influx scripts create
command creates an invokable script in InfluxDB.
Usage
influx scripts create [flags]
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-c | —active-config | CLI configuration to use for command | string | |
—configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs ) | string | INFLUX_CONFIGS_PATH | |
-d | —description | (Required) Purpose or functionality of the script | string | |
-f | —file | Path to file containing the script to be executed | string | |
-h | —help | Help for the create command | ||
—hide-headers | Hide table headers (default false ) | INFLUX_HIDE_HEADERS | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
—http-debug | Inspect communication with InfluxDB servers | string | ||
—json | Output data as JSON (default false ) | INFLUX_OUTPUT_JSON | ||
-l | —language | (Required) Language the script is written in | string | |
-n | —name | (Required) Script name of the script | string | |
-s | —script | Contents of the script to be executed | string | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_TOKEN |
Example
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST
, INFLUX_ORG
, and INFLUX_TOKEN
). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host
: InfluxDB host-o, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token
Create a script using raw Flux
export FLUX_SCRIPT='
from(bucket: "example-bucket")
|> range(start: -10h)
|> filter(fn: (r) => r._measurement == "m")
|> aggregateWindow(every: 1h, fn: mean)
|> to(bucket: "default-ds-1d", org: "my-org")
'
influx scripts create \
-n "example-script" \
-d "a simple example" \
-l "flux" \
-s $FLUX_SCRIPT
Create a script from a file
influx scripts create \
-n "example-script" \
-d "a simple example" \
-l "flux" \
-f /path/to/example-script.flux
Related
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions
- Invoke custom scripts as API endpoints