influx bucket-schema list

  • 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 list command lists the schemas of an InfluxDB bucket that has the explicit schema-type.

Usage

  1. influx bucket-schema list [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
-n—bucketBucket name (mutually exclusive with —bucket-id)string
-i—bucket-idBucket ID (mutually exclusive with —bucket)string
—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—nameMeasurement 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.

List all schemas of a bucket and print column information

  1. influx bucket-schema list \
  2. --bucket example-bucket
  3. --extended-output

Print column details for a single measurement

  1. influx bucket-schema list \
  2. --bucket example-bucket \
  3. --name cpu \
  4. --extended-output