influx bucket-schema create

  • influx CLI 2.1.0+
  • InfluxDB Cloud only

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.1.

The influx bucket-schema create command sets the schema for a measurement in an InfluxDB bucket that has the explicit schema-type.

Usage

  1. 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 the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

Create a schema using the influx CLI

  1. influx bucket-schema create \
  2. --bucket example-bucket \
  3. --name temperature \
  4. --columns-file columns.csv

Create a schema and print column information

  1. influx bucket-schema create \
  2. --bucket example-bucket \
  3. --name cpu \
  4. --columns-file columns.csv \
  5. --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.

  1. influx bucket-schema create \
  2. --bucket example-bucket \
  3. --name cpu \
  4. --columns-file columns.json \
  5. --columns-format ndjson
  1. influx bucket-schema create \
  2. --bucket example-bucket \
  3. --name cpu \
  4. --columns-file columns.txt \
  5. --columns-format csv