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 #1850 from influxdata/dbrp-cli 

DBRP cli
pull/1862/head
noramullen1 2020-11-18 09:59:51 -08:00 committed by GitHub
parent 8cd5922c81 d7607f3f3a
commit 37fdef02ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 191 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
content/influxdb/v2.0/reference/cli/influx/v1/_index.md
View File

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

34
content/influxdb/v2.0/reference/cli/influx/v1/dbrp/_index.md Normal file
View File

@ -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 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 DBRP mappings |
| [`update`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/update/) | Update a DBRP mapping |
## Flags
| Flag | | Description |
|:-----|:---------|:--------------------------------|
| `-h` | `--help` | Help for the `v1 dbrp ` command |

50
content/influxdb/v2.0/reference/cli/influx/v1/dbrp/create.md Normal file
View File

@ -0,0 +1,50 @@
---
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` |
| | `--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'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` |
| | `--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 to map from | | |
| | `--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
```

33
content/influxdb/v2.0/reference/cli/influx/v1/dbrp/delete.md Normal file
View File

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

38
content/influxdb/v2.0/reference/cli/influx/v1/dbrp/list.md Normal file
View File

@ -0,0 +1,38 @@
---
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]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|------|-------------------|--------------------------------------------------------------------------------------------|------------|-------------------------|
| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` |
| | `--bucket-id` | Bucket ID | | |
| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` |
| | `--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` |
| | `--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` |

35
content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md Normal file
View File

@ -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` |
| | `--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` |
| | `--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 to map from | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `$INFLUX_TOKEN` |