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

Retention periods

The minimum retention period is one hour. Valid --retention units:

  • nanoseconds (ns)
  • microseconds (us or µs)
  • milliseconds (ms)
  • seconds (s)
  • minutes (m)
  • hours (h)
  • days (d)
  • weeks (w)

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

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

InfluxDB Cloud powered by TSM