Documentation

influx bucket-schema list

This page documents an earlier version of InfluxDB. InfluxDB v2.3 is the latest stable version. View this page in the v2.3 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.1.

The influx bucket-schema list command lists the schemas of an InfluxDB bucket that has the explicit schema-type.

Usage

influx bucket-schema list [flags]

Flags

Flag Description Input type Maps to ?
-c --active-config CLI configuration to use for command string
-n --bucket Bucket name (mutually exclusive with --bucket-id) string
-i --bucket-id Bucket ID (mutually exclusive with --bucket) 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 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 the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

List all schemas of a bucket and print column information

influx bucket-schema list \
  --bucket example-bucket
  --extended-output
influx bucket-schema list \
  --bucket example-bucket \
  --name cpu \
  --extended-output

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.