influx bucket create
This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version. View this page in the v2.6 documentation.
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 (
usorµ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, --orgor--org-id: InfluxDB organization name or ID-t, --token: InfluxDB API token
- Create a bucket with infinite data retention
- Create a bucket that retains data for 30 days
- Create a bucket with a description
- Create a bucket with a custom shard group duration
- Create a bucket with an explicit schema
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!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.