Documentation

influx bucket-schema update

Works with InfluxDB Cloud bucket schemas

influx bucket-schema and its subcommands work with InfluxDB Cloud bucket schemas. This feature is not available in InfluxDB OSS v2.3.

The influx bucket-schema update command updates the schema of an InfluxDB bucket that has the explicit schema-type.

bucket-schema update requires a bucket with at least one defined schema.

Usage

influx bucket-schema update [flags]
Supported operations
  • Adding new columns to a schema
Unsupported operations
  • Modify existing columns in a schema
  • Delete columns from a schema

Flags

Flag Description Input type Maps to ?
-c --active-config CLI configuration to use for command string
-n --bucket (Required) Bucket name (mutually exclusive with --bucket-id) string
-i --bucket-id (Required) Bucket ID (mutually exclusive with --bucket) string
--columns-file (Required) Path to column definitions file. For more information, see Create a columns file. string
--columns-format Columns file format (csv, ndjson, json, default: auto). For more information, see Update a schema with columns format string
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-x --extended-output Print column information for each measurement schema (default: false)
-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
--json Output data as JSON (default false) INFLUX_OUTPUT_JSON
-n --name (Required) Measurement name string
-o --org Organization name (mutually exclusive with --org-id) string INFLUX_ORG
--org-id Organization ID (mutually exclusive with --org) string INFLUX_ORG_ID
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
-t --token API token string INFLUX_TOKEN

Examples

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

Update a schema using the influx CLI

influx bucket-schema update \
  --bucket example-bucket \
  --name temperature \
  --columns-file columns.csv

Update a schema and print column information

influx bucket-schema update \
  --bucket example-bucket \
  --name cpu \
  --columns-file columns.csv \
  -extended-output

Update a schema with columns format

By default, InfluxDB attempts to detect the columns file format. If your file’s extension doesn’t match the format, set the format with the columns-format flag.

influx bucket-schema update \
  --bucket example-bucket \
  --name cpu \
  --columns-file columns.json \
  --columns-format ndjson
influx bucket-schema update \
  --bucket example-bucket \
  --name cpu \
  --columns-file columns.txt \
  --columns-format csv

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: