Documentation

influx bucket create

The influx bucket create command creates a bucket in InfluxDB.

Usage

influx bucket create [flags]

Flags

Flag Description Input type Maps to ?
-c --active-config CLI configuration to use for command string
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-d --description Bucket description string
-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
--http-debug Inspect communication with InfluxDB servers. string
--json Output data as JSON (default false) INFLUX_OUTPUT_JSON
-n --name Bucket name string INFLUX_BUCKET_NAME
-o --org Organization name (mutually exclusive with --org-id) string INFLUX_ORG
--org-id Organization ID (mutually exclusive with --org) string INFLUX_ORG_ID
-r --retention Duration bucket retains data (0 is infinite, default is 0) duration
--schema-type Bucket schema type (explicit, default implicit) (Cloud only). For more information, see Manage bucket schema. string
--shard-group-duration Bucket shard group duration (OSS only) string
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
-t --token API token string INFLUX_TOKEN

Valid --retention units are nanoseconds (ns), microseconds (us or µs), milliseconds (ms), seconds (s), minutes (m), hours (h), days (d), and weeks (w).

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 bucket with infinite data retention
influx bucket create --name example-bucket
Create a bucket that retains data for 30 days
influx bucket create \
  --name example-bucket \
  --retention 30d
Create a bucket with a description
influx bucket create \
  --name example-bucket \
  --description "Example bucket description"
Create a bucket with a custom shard group duration

Custom shard group durations are only supported in InfluxDB OSS. The shard group duration must be shorter than the bucket’s retention period. For more information, see InfluxDB shards and shard groups.

influx bucket create \
  --name example-bucket \
  --retention 30d \
  --shard-group-duration 2d
Create a bucket with an explicit schema

Explicit bucket schemas are only supported in InfluxDB Cloud. For more information, see Manage bucket schema.

influx bucket create \
  --name my_schema_bucket \
  --schema-type explicit


Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.