Documentation

influx bucket-schema update

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

FlagDescriptionInput typeMaps to ?
-c--active-configCLI configuration to use for commandstring
-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-formatColumns file format (csv, ndjson, json, default: auto). For more information, see Update a schema with columns formatstring
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-x--extended-outputPrint column information for each measurement schema (default: false)
-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
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-n--name(Required) Measurement namestring
-o--orgOrganization name (mutually exclusive with --org-id)stringINFLUX_ORG
--org-idOrganization ID (mutually exclusive with --org)stringINFLUX_ORG_ID
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t--tokenAPI tokenstringINFLUX_TOKEN

Examples

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

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

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.