From e8a53ff52b311c51fa3509d721c525ce69deae48 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Tue, 17 Nov 2020 15:51:53 -0800 Subject: [PATCH 1/9] Add DBRP CLI commands (addresses #1849 ) --- .../v2.0/reference/cli/influx/v1/_index.md | 1 + .../reference/cli/influx/v1/dbrp/_index.md | 34 ++++++++++++++++ .../reference/cli/influx/v1/dbrp/create.md | 36 +++++++++++++++++ .../reference/cli/influx/v1/dbrp/delete.md | 33 +++++++++++++++ .../v2.0/reference/cli/influx/v1/dbrp/list.md | 40 +++++++++++++++++++ .../reference/cli/influx/v1/dbrp/update.md | 35 ++++++++++++++++ 6 files changed, 179 insertions(+) create mode 100644 content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md create mode 100644 content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md create mode 100644 content/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete.md create mode 100644 content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md create mode 100644 content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/_index.md b/content/influxdb/v2.0/reference/cli/influx/v1/_index.md index 3ef5cf1a9..143fcaf37 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/_index.md @@ -22,6 +22,7 @@ influx v1 [command] | Subcommand | Description | |:-----------------------------------------------------|:----------------------------------------------| | [auth](/influxdb/v2.0/reference/cli/influx/v1/auth/) | Authorization management commands for v1 APIs | +| [dbrp](/influxdb/v2.0/reference/cli/influx/v1/dbrp/) | Database retention policy mapping management commands for v1 APIs | ## Flags | Flag | | Description | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md new file mode 100644 index 000000000..6bd9bde19 --- /dev/null +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md @@ -0,0 +1,34 @@ +--- +title: influx v1 dbrp +description: > + The `influx v1 dbrp` subcommands provide database retention policy (DBRP) mapping management for the InfluxDB 1.x compatibility API. +menu: + influxdb_2_0_ref: + name: influx v1 dbrp + parent: influx v1 +weight: 101 +influxdb/v2.0/tags: [DBRP] +--- + +The `influx v1 dbrp` subcommands provide database retention policy (DBRP) management for the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). + +## Usage +``` +influx v1 dbrp [flags] +influx v1 dbrp [command] +``` + + +## Commands + +| Command | Description | +|:----------------------------------------------------------------------------|----------------------------------------------| +| [`create`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/create/) | Create DBRP | +| [`delete`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete/) | Delete DBRPs | +| [`list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/) | List DBRPs | +| [`update`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/update/) | Update a DBRP | + +## Flags +| Flag | | Description | +|:-----|:---------|:--------------------------------| +| `-h` | `--help` | Help for the `v1 dbrp ` command | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md new file mode 100644 index 000000000..b2285ff70 --- /dev/null +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md @@ -0,0 +1,36 @@ +--- +title: influx v1 dbrp create +description: > + The `influx v1 dbrp create` command creates a DBRP mapping in the InfluxDB 1.x compatibility API. +menu: + influxdb_2_0_ref: + name: influx v1 dbrp create + parent: influx v1 dbrp +weight: 101 +influxdb/v2.0/tags: [DBRP] +--- + +The `influx v1 dbrp create` command creates a DBRP mapping with the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). + +## Usage +``` +influx v1 dbrp create [flags] +``` + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|-------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| +| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | +| `-b` | `--bucket-id` | Bucket ID | | | +| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | +| `-d` | `--db` | V1 database to map from | | | +| | `--default` | Sets DBRP as the default | | | +| `-h` | `--help` | Help for the `create` command | | | +| | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | +| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | +| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | +| | `--read-bucket` | Bucket ID to assign read permissions to | | | +| `-r` | `--rp` | InfluxDB v1 retention policy | | | +| `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete.md new file mode 100644 index 000000000..6c0528d95 --- /dev/null +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete.md @@ -0,0 +1,33 @@ +--- +title: influx v1 dbrp delete +description: > + The `influx v1 dbrp delete` command deletes a DBRP mapping in the InfluxDB 1.x compatibility API. +menu: + influxdb_2_0_ref: + name: influx v1 dbrp delete + parent: influx v1 dbrp +weight: 101 +influxdb/v2.0/tags: [DBRP] +--- + +The `influx v1 dbrp delete` command deletes a DBRP mapping in the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). + +## Usage +``` +influx v1 dbrp delete [flags] +``` + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|------|-------------------|--------------------------------------------------------------------------|------------|-------------------------| +| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | +| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | +| `-h` | `--help` | Help for the `delete` command | | | +| | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | +| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | +| `-i` | `--id` | DBRP ID (required) | string | | +| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | +| | `--skip-verify` | Skip TLS certificate verification | | | +| `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md new file mode 100644 index 000000000..a699a55be --- /dev/null +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md @@ -0,0 +1,40 @@ +--- +title: influx v1 dbrp list +description: > + The `influx v1 dbrp list` command lists and searches DBRP mappings in the InfluxDB 1.x compatibility API. +menu: + influxdb_2_0_ref: + name: influx v1 dbrp list + parent: influx v1 dbrp +weight: 101 +influxdb/v2.0/tags: [dbrp] +--- + +The `influx v1 dbrp list` command lists and searches DBRP mappings in the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). + +## Usage +``` +influx v1 dbrp list [flags] +``` + +#### Aliases +`list`, `ls`, `find` + +## Flags + +| Flag | | Description | Input type | {{< cli/mapped >}} | +|------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| +| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | +| `-b` | `--bucket-id` | Bucket ID | | | +| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | +| `-d` | `--db` | InfluxDB v1 database to map from | | | +| | `--default` | Specify if this mapping represents the default retention policy for the database specified | | | +| `-h` | `--help` | Help for the `list` command | | | +| | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | +| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | +| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | +| `-r` | `--rp` | InfluxDB v1 retention policy | string | `$INFLUX_ORG` | +| | `--skip-verify` | Skip TLS certificate verification | | | +| `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md new file mode 100644 index 000000000..6cf6e7b66 --- /dev/null +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md @@ -0,0 +1,35 @@ +--- +title: influx v1 dbrp update +description: > + The `influx v1 dbrp update` command updates a DBRP mapping in the InfluxDB 1.x compatibility API. +menu: + influxdb_2_0_ref: + name: influx v1 dbrp set-active + parent: influx v1 dbrp +weight: 101 +influxdb/v2.0/tags: [DBRP] +--- + +The `influx v1 dbrp update` command updates a DBRP mapping in the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). + +## Usage +``` +influx v1 dbrp update [flags] +``` + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| +| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | +| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | +| `-d` | `--default` | Sets DBRP as the default | | | +| `-h` | `--help` | Help for the `update` command | | | +| | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | +| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | +| `-i` | `--id` | DBRP ID (required) | string | | +| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | +| `-r` | `--rp` | InfluxDB v1 retention policy | | | +| | `--skip-verify` | Skip TLS certificate verification | | | +| `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | From fa617f74386a9315e54c750e82fb6ee601cb4531 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Tue, 17 Nov 2020 15:55:30 -0800 Subject: [PATCH 2/9] Fix typo --- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md index a699a55be..f6ac416f6 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md @@ -17,9 +17,6 @@ The `influx v1 dbrp list` command lists and searches DBRP mappings in the [Influ influx v1 dbrp list [flags] ``` -#### Aliases -`list`, `ls`, `find` - ## Flags | Flag | | Description | Input type | {{< cli/mapped >}} | From a080346e540aeb8b230b9abc75621b0c785d4b85 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Tue, 17 Nov 2020 16:19:09 -0800 Subject: [PATCH 3/9] Address PR feedback --- .../v2.0/reference/cli/influx/v1/dbrp/_index.md | 8 ++++---- .../v2.0/reference/cli/influx/v1/dbrp/create.md | 10 +++++----- .../influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md | 2 +- .../v2.0/reference/cli/influx/v1/dbrp/update.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md index 6bd9bde19..1e696fa20 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md @@ -23,10 +23,10 @@ influx v1 dbrp [command] | Command | Description | |:----------------------------------------------------------------------------|----------------------------------------------| -| [`create`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/create/) | Create DBRP | -| [`delete`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete/) | Delete DBRPs | -| [`list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/) | List DBRPs | -| [`update`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/update/) | Update a DBRP | +| [`create`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/create/) | Create a DBRP mapping | +| [`delete`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete/) | Delete a DBRP mapping | +| [`list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/) | List a DBRP mapping | +| [`update`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/update/) | Update a DBRP mapping | ## Flags | Flag | | Description | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md index b2285ff70..6a4043400 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md @@ -21,16 +21,16 @@ influx v1 dbrp create [flags] | Flag | | Description | Input type | {{< cli/mapped >}} | |-------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| | `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | -| `-b` | `--bucket-id` | Bucket ID | | | +| `-b` | `--bucket-id` | Bucket ID to map to | | | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | -| `-d` | `--db` | V1 database to map from | | | -| | `--default` | Sets DBRP as the default | | | +| `-d` | `--db` | InfluxDB v1 database to map from | | | +| | `--default` | Set DBRP mapping as default | | | | `-h` | `--help` | Help for the `create` command | | | -| | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | +| | `--hide-headers` | Hide table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | | | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | -| | `--read-bucket` | Bucket ID to assign read permissions to | | | | `-r` | `--rp` | InfluxDB v1 retention policy | | | +| | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md index f6ac416f6..3e25ac904 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md @@ -24,7 +24,7 @@ influx v1 dbrp list [flags] | `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | | `-b` | `--bucket-id` | Bucket ID | | | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | -| `-d` | `--db` | InfluxDB v1 database to map from | | | +| `-d` | `--db` | Filter DBRP mappings by database | | | | | `--default` | Specify if this mapping represents the default retention policy for the database specified | | | | `-h` | `--help` | Help for the `list` command | | | | | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md index 6cf6e7b66..5f53ea67e 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md @@ -22,7 +22,7 @@ influx v1 dbrp update [flags] |------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| | `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | -| `-d` | `--default` | Sets DBRP as the default | | | +| | `--default` | Set DBRP mapping as default | | | | `-h` | `--help` | Help for the `update` command | | | | | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | | | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | From c06402b6f2b8ff8b7f24c21233cbe566e3eceed5 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Wed, 18 Nov 2020 08:37:20 -0800 Subject: [PATCH 4/9] Add create DBRP example --- .../v2.0/reference/cli/influx/v1/dbrp/create.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md index 6a4043400..dbc836212 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md @@ -34,3 +34,17 @@ influx v1 dbrp create [flags] | `-r` | `--rp` | InfluxDB v1 retention policy | | | | | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | + + +## Examples + +##### Create a DBRP mapping +``` +influx v1 dbrp create \ + --bucket-id 12ab34cd56ef \ + --database example-db \ + --rp example-rp \ + --org example-org \ + --token $INFLUX_TOKEN \ + --default +``` From 7684cedecbc7149bf488a2921c6a028de89ade46 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Wed, 18 Nov 2020 08:46:58 -0800 Subject: [PATCH 5/9] Update flags --- .../influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md | 8 ++++---- .../influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md | 9 +++++---- .../influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md | 2 +- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md index dbc836212..dbd6290ae 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md @@ -21,9 +21,9 @@ influx v1 dbrp create [flags] | Flag | | Description | Input type | {{< cli/mapped >}} | |-------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| | `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | -| `-b` | `--bucket-id` | Bucket ID to map to | | | +| | `--bucket-id` | Bucket ID to map to | | | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | -| `-d` | `--db` | InfluxDB v1 database to map from | | | +| | `--db` | InfluxDB v1 database to map from | | | | | `--default` | Set DBRP mapping as default | | | | `-h` | `--help` | Help for the `create` command | | | | | `--hide-headers` | Hide table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | @@ -31,8 +31,8 @@ influx v1 dbrp create [flags] | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | -| `-r` | `--rp` | InfluxDB v1 retention policy | | | -| | `--skip-verify` | Skip TLS certificate verification | | | +| | `--rp` | InfluxDB v1 retention policy | | | +| | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md index 3e25ac904..818f17037 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md @@ -22,16 +22,17 @@ influx v1 dbrp list [flags] | Flag | | Description | Input type | {{< cli/mapped >}} | |------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| | `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | -| `-b` | `--bucket-id` | Bucket ID | | | +| | `--bucket-id` | Bucket ID | | | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | -| `-d` | `--db` | Filter DBRP mappings by database | | | -| | `--default` | Specify if this mapping represents the default retention policy for the database specified | | | +| | `--db` | Filter DBRP mappings by database | | | +| | `--default` | Limit results to default mapping | | | | `-h` | `--help` | Help for the `list` command | | | | | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | | | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | +| | `--id` | Limit results to a specified mapping | string | | | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | -| `-r` | `--rp` | InfluxDB v1 retention policy | string | `$INFLUX_ORG` | +| | `--rp` | InfluxDB v1 retention policy | string | `$INFLUX_ORG` | | | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md index 5f53ea67e..bceed62e6 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md @@ -26,7 +26,7 @@ influx v1 dbrp update [flags] | `-h` | `--help` | Help for the `update` command | | | | | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | | | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | -| `-i` | `--id` | DBRP ID (required) | string | | +| | `--id` | DBRP ID (required) | string | | | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | From 453cae0e5ea2bf3779daa524e2f20cdfc509d324 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Wed, 18 Nov 2020 09:46:05 -0800 Subject: [PATCH 6/9] Update content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md Co-authored-by: Daniel Moran --- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md index 1e696fa20..29e3b5053 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md @@ -25,7 +25,7 @@ influx v1 dbrp [command] |:----------------------------------------------------------------------------|----------------------------------------------| | [`create`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/create/) | Create a DBRP mapping | | [`delete`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete/) | Delete a DBRP mapping | -| [`list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/) | List a DBRP mapping | +| [`list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/) | List DBRP mappings | | [`update`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/update/) | Update a DBRP mapping | ## Flags From 526b869e22af698fd15edd01dd5027d228df9eeb Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Wed, 18 Nov 2020 09:56:40 -0800 Subject: [PATCH 7/9] Update content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md Co-authored-by: Daniel Moran --- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md index bceed62e6..c889aa1f5 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md @@ -30,6 +30,6 @@ influx v1 dbrp update [flags] | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | -| `-r` | `--rp` | InfluxDB v1 retention policy | | | +| `-r` | `--rp` | InfluxDB v1 retention policy to map from | | | | | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | From 4528ee7224a97514271ba7d17e7443181b376a7b Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Wed, 18 Nov 2020 09:57:45 -0800 Subject: [PATCH 8/9] Update content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md Co-authored-by: Daniel Moran --- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md index dbd6290ae..7170140b0 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md @@ -31,7 +31,7 @@ influx v1 dbrp create [flags] | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | -| | `--rp` | InfluxDB v1 retention policy | | | +| | `--rp` | InfluxDB v1 retention policy to map from | | | | | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | From 8cde641255ce203391c2d8ee27a350590a1d19a1 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Wed, 18 Nov 2020 09:58:14 -0800 Subject: [PATCH 9/9] Address PR feedback --- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md | 2 +- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md | 2 +- content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md index dbd6290ae..17e142df8 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md @@ -24,7 +24,7 @@ influx v1 dbrp create [flags] | | `--bucket-id` | Bucket ID to map to | | | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | | | `--db` | InfluxDB v1 database to map from | | | -| | `--default` | Set DBRP mapping as default | | | +| | `--default` | Set DBRP mapping's retention policy as default | | | | `-h` | `--help` | Help for the `create` command | | | | | `--hide-headers` | Hide table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | | | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md index 818f17037..aa8c7a8b0 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md @@ -33,6 +33,6 @@ influx v1 dbrp list [flags] | | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` | | `-o` | `--org` | Organization name | string | `$INFLUX_ORG` | | | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` | -| | `--rp` | InfluxDB v1 retention policy | string | `$INFLUX_ORG` | +| | `--rp` | Filter DBRP mappings by InfluxDB v1 retention policy | string | `$INFLUX_ORG` | | | `--skip-verify` | Skip TLS certificate verification | | | | `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` | diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md index bceed62e6..e11ecad7c 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md @@ -22,7 +22,7 @@ influx v1 dbrp update [flags] |------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------| | `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` | | | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` | -| | `--default` | Set DBRP mapping as default | | | +| | `--default` | Set DBRP mapping's retention policy as default | | | | `-h` | `--help` | Help for the `update` command | | | | | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` | | | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |