influx scripts create

  • influx CLI 2.4.0+
  • InfluxDB Cloud only

The influx scripts create command creates an invokable script in InfluxDB.

Usage

  1. influx scripts create [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-d—description(Required) Purpose or functionality of the scriptstring
-f—filePath to file containing the script to be executedstring
-h—helpHelp for the create command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
—http-debugInspect communication with InfluxDB serversstring
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-l—language(Required) Language the script is written instring
-n—name(Required) Script name of the scriptstring
-s—scriptContents of the script to be executedstring
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_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
  1. export FLUX_SCRIPT='
  2. from(bucket: "example-bucket")
  3. |> range(start: -10h)
  4. |> filter(fn: (r) => r._measurement == "m")
  5. |> aggregateWindow(every: 1h, fn: mean)
  6. |> to(bucket: "default-ds-1d", org: "my-org")
  7. '
  8. influx scripts create \
  9. -n "example-script" \
  10. -d "a simple example" \
  11. -l "flux" \
  12. -s $FLUX_SCRIPT
Create a script from a file
  1. influx scripts create \
  2. -n "example-script" \
  3. -d "a simple example" \
  4. -l "flux" \
  5. -f /path/to/example-script.flux