upd to clarify supported durations in CLI
parent
9aa7af7537
commit
ecff5c24f5
|
@ -42,7 +42,6 @@ There are two places you can create a bucket in the UI.
|
||||||
- **Older than** to choose a specific retention policy.
|
- **Older than** to choose a specific retention policy.
|
||||||
5. Click **Create** to create the bucket.
|
5. Click **Create** to create the bucket.
|
||||||
|
|
||||||
|
|
||||||
## Create a bucket using the influx CLI
|
## Create a bucket using the influx CLI
|
||||||
|
|
||||||
Use the [`influx bucket create` command](/v2.0/reference/cli/influx/bucket/create)
|
Use the [`influx bucket create` command](/v2.0/reference/cli/influx/bucket/create)
|
||||||
|
@ -50,7 +49,7 @@ to create a new bucket. A bucket requires the following:
|
||||||
|
|
||||||
- bucket name
|
- bucket name
|
||||||
- organization name or ID
|
- organization name or ID
|
||||||
- retention period duration (`ns`, `us`, `ms`, `s`, or `h`)
|
- retention period duration (`ns`, `us` (or `µs`), `ms`, `s`, `m` or `h`)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Syntax
|
# Syntax
|
||||||
|
|
|
@ -21,7 +21,6 @@ Note that updating an bucket's name will affect any assets that reference the bu
|
||||||
|
|
||||||
If you change a bucket name, be sure to update the bucket in the above places as well.
|
If you change a bucket name, be sure to update the bucket in the above places as well.
|
||||||
|
|
||||||
|
|
||||||
## Update a bucket's name in the InfluxDB UI
|
## Update a bucket's name in the InfluxDB UI
|
||||||
|
|
||||||
1. In the navigation menu on the left, select **Data (Load Data)** > **Buckets**.
|
1. In the navigation menu on the left, select **Data (Load Data)** > **Buckets**.
|
||||||
|
@ -52,6 +51,7 @@ to update a bucket. Updating a bucket requires the following:
|
||||||
- The name or ID of the organization the bucket belongs to.
|
- The name or ID of the organization the bucket belongs to.
|
||||||
|
|
||||||
##### Update the name of a bucket
|
##### Update the name of a bucket
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Syntax
|
# Syntax
|
||||||
influx bucket update -i <bucket-id> -o <org-name> -n <new-bucket-name>
|
influx bucket update -i <bucket-id> -o <org-name> -n <new-bucket-name>
|
||||||
|
@ -61,6 +61,9 @@ influx bucket update -i 034ad714fdd6f000 -o my-org -n my-new-bucket
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Update a bucket's retention policy
|
##### Update a bucket's retention policy
|
||||||
|
|
||||||
|
Valid retention policy units are `ns`, `us` (or `µs`), `ms`, `s`, `m` or `h`.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Syntax
|
# Syntax
|
||||||
influx bucket update -i <bucket-id> -r <retention period in nanoseconds>
|
influx bucket update -i <bucket-id> -r <retention period in nanoseconds>
|
||||||
|
|
|
@ -25,6 +25,6 @@ influx bucket create [flags]
|
||||||
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
|
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
|
||||||
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
|
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
|
||||||
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
|
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
|
||||||
| `-r` | `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
|
| `-r` | `--retention` | Duration the bucket will retain data (0 is infinite, default is 0). Valid units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, and `h`. | duration | |
|
||||||
|
|
||||||
{{% cli/influx-global-flags %}}
|
{{% cli/influx-global-flags %}}
|
||||||
|
|
|
@ -24,6 +24,6 @@ influx bucket update [flags]
|
||||||
| `-i` | `--id` | **(Required)** Bucket ID | string | |
|
| `-i` | `--id` | **(Required)** Bucket ID | string | |
|
||||||
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
|
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
|
||||||
| `-n` | `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
|
| `-n` | `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
|
||||||
| `-r` | `--retention` | New duration bucket will retain data | duration | |
|
| `-r` | `--retention` | New duration that the bucket will retain data—valid units include: `ns`, `us` (or `µs`), `ms`, `s`, `m`, and `h`. | duration | |
|
||||||
|
|
||||||
{{% cli/influx-global-flags %}}
|
{{% cli/influx-global-flags %}}
|
||||||
|
|
Loading…
Reference in New Issue