Document `influxd upgrade` command

pull/1645/head
pierwill 2020-10-09 11:16:38 -07:00
parent c6ce793292
commit 33ec7a617a
4 changed files with 95 additions and 7 deletions

View File

@ -29,11 +29,12 @@ For information about other available InfluxDB configuration methods, see
## Commands
| Command | Description |
|:------- |:----------- |
| [generate](/influxdb/v2.0/reference/cli/influxd/generate) | Generate time series data sets using TOML schema. |
| [inspect](/influxdb/v2.0/reference/cli/influxd/inspect) | Inspect on-disk database data. |
|:----------------------------------------------------------|:-------------------------------------------------|
| [generate](/influxdb/v2.0/reference/cli/influxd/generate) | Generate time series data sets using TOML schema |
| [inspect](/influxdb/v2.0/reference/cli/influxd/inspect) | Inspect on-disk database data |
| [restore](/influxdb/v2.0/reference/cli/influxd/restore) | Restore data and metadata from a backup file set |
| [run](/influxdb/v2.0/reference/cli/influxd/run) | Start the influxd server _**(default)**_ |
| [upgrade](/influxdb/v2.0/reference/cli/influxd/upgrade) | Upgrade a 1.x version of InfluxDB to 2.0 |
| [version](/influxdb/v2.0/reference/cli/influxd/version) | Output the current version of InfluxDB |
## Flags

View File

@ -0,0 +1,40 @@
---
title: influxd upgrade
description: The `influxd upgrade` command upgrades a InfluxdDB 1.x instance to 2.0.
menu:
influxdb_2_0_ref:
parent: influxd
weight: 201
products: [oss]
---
Use the `influxd upgrade` command to upgrade an instance of InfluxDB 1.x to InfluxDB 2.0.
This will copy all data in [databases](/influxdb/v1.8/concepts/glossary/#database) and
[retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) (used in 1.x)
over to [buckets](/influxdb/v2.0/reference/glossary/#bucket) (used in 2.0).
{{% warn %}}
Be sure to backup all data before upgrading with `influx upgrade`.
{{% /warn %}}
## Usage
```
influxd upgrade [flags]
influxd upgrade [command]
```
## Subcommands
| Subcommand | Description |
|:---------------------------------------------------------------------------|:---------------------------------|
| [v1-dump-meta](/influxdb/v2.0/reference/cli/influxd/upgrade/v1-dump-meta/) | Dump InfluxDB 1.x `meta.db` |
| [v2-dump-meta](/influxdb/v2.0/reference/cli/influxd/upgrade/v2-dump-meta/) | Dump InfluxDB 2.x `influxd.bolt` |
## Flags
| Flag | | Description | Input type |
|:-----|:-----------------|:----------------------------------------------------------------------------------------------|:----------:|
| `-h` | `--help` | Help for the `upgrade` command | |
| | `--config` | (Optional) Custom InfluxDB Path to 1.x config file to upgrade (default: `~/.influxdbv2/conf`) | string |
| | `--v1-meta-dir` | Path to 1.x meta.db directory (default: `~/.influxdb/meta`) | string |
| | `--v2-bolt-path` | Path to 2.0 metadata (default: `~/.influxdbv2/influxd.bolt`) | string |

View File

@ -0,0 +1,23 @@
---
title: influxd upgrade v1-dump-meta
description: >
Output 1.x metadata
influxdb/v2.0/tags: []
menu:
influxdb_2_0_ref:
parent: influxd upgrade
weight: 301
products: [oss]
---
The `influxd upgrade v1-dump-meta` command prints the contents of `meta.db` to the standard output.
## Usage
```sh
influxd upgrade v1-dump-meta
```
## Flags
| Flag | | Description | Input Type |
|:-----|:---------|:----------------------------------------------------|:----------:|
| `-h` | `--help` | Help for the `influx upgrade v1-dump-meta` command. | |

View File

@ -0,0 +1,24 @@
---
title: influxd upgrade v2-dump-meta
description: >
Output 2.0 boltdb metadata
influxdb/v2.0/tags: []
menu:
influxdb_2_0_ref:
parent: influxd upgrade
weight: 301
products: [oss]
---
The `influxd upgrade v2-dump-meta` command prints the contents of `influxdb.bolt` to the standard output.
## Usage
```sh
influxd upgrade v2-dump-meta
```
## Flags
| Flag | | Description | Input Type |
|:-----|:---------|:----------------------------------------------------|:----------:|
| `-h` | `--help` | Help for the `influx upgrade v2-dump-meta` command. | |