Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #801 from influxdata/cli/retention-update 

CLI docs and '--retention' update
pull/810/head
Scott Anderson 2020-03-07 06:02:37 -07:00 committed by GitHub
parent c8619ba65d 4dfe00f7a8
commit 88c0d34723
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 37 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
content/v2.0/get-started.md
View File

@ -321,6 +321,11 @@ influx setup
InfluxDB is now initialized with a primary user, organization, and bucket.
You are ready to [write or collect data](/v2.0/write-data).
{{% note %}}
To automate the setup process, use [flags](/v2.0/reference/cli/influx/setup/#flags)
to provide the required information.
{{% /note %}}
{{% /tab-content %}}
<!------------------------------- END UI Setup -------------------------------->
{{< /tabs-wrapper >}}

2
content/v2.0/reference/cli/influx/auth/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx auth – Authorization management commands
title: influx auth
description: The 'influx auth' command and its subcommands manage authorizations in InfluxDB.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/backup/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx backup – Back up data in InfluxDB
title: influx backup
description: The 'influx backup' command backs up data stored in InfluxDB.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/bucket/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx bucket – Bucket management commands
title: influx bucket
description: The 'influx bucket' command and its subcommands manage buckets in InfluxDB.
menu:
v2_0_ref:

14
content/v2.0/reference/cli/influx/bucket/create.md
View File

@ -16,12 +16,12 @@ influx bucket create [flags]
```
## Flags
| Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for the `create` command | | |
| `-n`, `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o`, `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-r`, `--retention` | Duration bucket will retain data | duration | |
| Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for the `create` command | | |
| `-n`, `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o`, `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-r`, `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
{{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/delete/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx delete – Delete data from InfluxDB
title: influx delete
description: The 'influx delete' command deletes points from an InfluxDB bucket.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/help/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx help – Help command for the influx CLI
title: influx help
description: The 'influx help' command provides help for any command in the `influx` command line interface.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/org/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx org – Organization management commands
title: influx org
description: The 'influx org' command and its subcommands manage organization information in InfluxDB.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/ping/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx ping – Check the health of InfluxDB
title: influx ping
description: >
The `influx ping` command checks the health of a running InfluxDB instance by
querying the `/health` endpoint.

2
content/v2.0/reference/cli/influx/pkg/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx pkg – package management commands
title: influx pkg
description: The 'influx pkg' command and its subcommands manage packages in InfluxDB.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/query/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx query – Execute queries from the influx CLI
title: influx query
description: >
The 'influx query' command executes a literal Flux query provided as a string
or a literal Flux query contained in a file by specifying the file prefixed with an '@' sign.

2
content/v2.0/reference/cli/influx/repl/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx repl – Enter an interactive REPL
title: influx repl
description: >
The 'influx repl' command opens and interactive read-eval-print-loop (REPL)
from which you can run Flux commands.

2
content/v2.0/reference/cli/influx/secret/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx secret – Manage secrets
title: influx secret
description: The 'influx secret' command manages secrets.
menu:
v2_0_ref:

14
content/v2.0/reference/cli/influx/setup/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx setup – Run the initial InfluxDB setup
title: influx setup
description: >
The 'influx setup' command walks through the initial InfluxDB setup process,
creating a default user, organization, and bucket.
@ -20,8 +20,14 @@ influx setup [flags]
```
## Flags
| Flag | Description |
|:---- |:----------- |
| `-h`, `--help` | Help for the `setup` command |
| Flag | Description | Data type |
|:---- |:----------- |:---------:|
| `-b`, `--bucket` | Primary bucket name | string |
| `-f`, `--force` | Skip confirmation prompt | |
| `-h`, `--help` | Help for the `setup` command | |
| `-o`, `--org` | Primary organization name | string |
| `-p`, `--password` | Password for primary user | string |
| `-r`, `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration |
| `-u`, `--username` | Primary username | string |
{{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx task – Task management commands
title: influx task
description: The 'influx task' command and its subcommands manage tasks in InfluxDB.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/transpile/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx transpile – Transpile InfluxQL to Flux
title: influx transpile
description: >
The 'influx transpile' command transpiles an InfluxQL query to Flux source code.
menu:

2
content/v2.0/reference/cli/influx/user/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx user – User management commands
title: influx user
description: The 'influx user' command and its subcommands manage user information in InfluxDB.
menu:
v2_0_ref:

2
content/v2.0/reference/cli/influx/write/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx write – Write data to InfluxDB using the CLI
title: influx write
description: >
The 'influx write' command writes line protocol to InfluxDB either via a single
line of line protocol, or a via a file containing line protocol.