influx bucket-schema list
- Works with InfluxDB Cloud bucket schemas
Usage
Flags
Examples
- Authentication credentials
List all schemas of a bucket and print column information
Print column details for a single measurement
- Related

influx bucket-schema list

influx CLI 2.1.0+
InfluxDB Cloud only

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

List all schemas of a bucket and print column information

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

Print column details for a single measurement

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

Manage bucket schemas

influx bucket-schema list

influx bucket-schema list

Works with InfluxDB Cloud bucket schemas

Usage

Flags

Examples

Authentication credentials

List all schemas of a bucket and print column information

Print column details for a single measurement

Related