Documentation

influx bucket-schema create

This page documents an earlier version of InfluxDB. InfluxDB v2.5 is the latest stable version. View this page in the v2.5 documentation.

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 create command sets the schema for a measurement in an InfluxDB bucket that has the explicit schema-type.

Usage

influx bucket-schema create [flags]

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 Create 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 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 schema using the influx CLI

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

Create a schema and print column information

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

Create 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 create \
  --bucket example-bucket \
  --name cpu \
  --columns-file columns.json \
  --columns-format ndjson
influx bucket-schema create \
  --bucket example-bucket \
  --name cpu \
  --columns-file columns.txt \
  --columns-format csv

Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.