Skip to content

Commit

Permalink
Update content about the InfluxQL shell in 2.4 migration guide (influ…
Browse files Browse the repository at this point in the history
…xdata#4484)

* updated content about the influxql shell in 2.4 migration guide

* added influxql content to other upgrade docs

* Apply suggestions from code review

Co-authored-by: kelseiv <[email protected]>

Co-authored-by: kelseiv <[email protected]>
  • Loading branch information
sanderson and kelseiv authored Oct 5, 2022
1 parent 353f947 commit d2d8710
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 2 deletions.
16 changes: 15 additions & 1 deletion content/influxdb/v2.4/upgrade/v1-to-v2/automatic-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Consider whether you need to address any of the following before upgrading.
- [Other data](#other-data)
- [Secure by default](#secure-by-default)
- [`inmem` indexing option](#in-memory-indexing-option)
- [Interactive shell](#interactive-shell)

### Available operating system, container, and platform support

Expand Down Expand Up @@ -174,7 +175,20 @@ InfluxDB {{< current-version >}} doesn't support [in-memory (`inmem`) indexing](

### Interactive shell

The InfluxDB 2.x `influx` CLI does not include an interactive shell for executing InfluxQL queries or Flux queries. For information about executing InfluxQL queries, see [Query data with InfluxQL](/influxdb/v2.4/query-data/influxql/). To build an interactive shell to execute Flux queries, [compile and build a command line Flux REPL from source](https://github.com/influxdata/flux/blob/master/README.md#getting-started).
The InfluxDB {{< current-version >}} `influx` CLI includes an interactive **InfluxQL shell** for executing InfluxQL queries.
To start an InfluxQL shell:

1. Download and install in the [`influx` CLI](/influxdb/v2.4/tools/influx-cli/).
2. Set up your [`influx` CLI authentication credentials](/influxdb/v2.4/tools/influx-cli/#set-up-the-influx-cli).
3. Run the `influx v1 shell` command.

For more information see:

- [Use the InfluxQL shell](/influxdb/v2.4/tools/influxql-shell/)
- [Query data with InfluxQL](/influxdb/v2.4/query-data/influxql/)

To build an interactive shell to execute **Flux** queries,
[compile and build a command line Flux REPL from source](https://github.com/influxdata/flux/blob/master/README.md#getting-started).

## Perform the upgrade

Expand Down
39 changes: 39 additions & 0 deletions content/influxdb/v2.4/upgrade/v1-to-v2/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ to update InfluxDB 1.x Docker deployments to InfluxDB 2.x.
- [Minimal upgrade](#minimal-upgrade)
- [Upgrade with a custom InfluxDB 1.x configuration file](#upgrade-with-a-custom-influxdb-1-x-configuration-file)
- [Upgrade with custom paths](#upgrade-with-custom-paths)
- [Use new InfluxDB tools](#use-new-influxdb-tools)

{{% note %}}
#### Export continuous queries before upgrading
Expand Down Expand Up @@ -249,3 +250,41 @@ docker run -p 8086:8086 \
{{% /tab-content %}}
<!--------------------------- END USE 2.x DEFAULTS ---------------------------->
{{< /tabs-wrapper >}}

## Use new InfluxDB tools

Once upgraded, use InfluxDB {{< current-version >}} tools to work with your time series data.

- [Migrate continuous queries to tasks](#migrate-continuous-queries-to-tasks)
- [Use the interactive InfluxQL shell](#use-the-interactive-influxql-shell)

### Migrate continuous queries to tasks

InfluxDB {{< current-version >}} replaces continuous queries with **tasks**.
By default, the upgrade process writes all continuous queries to `~/continuous_queries.txt`.
To convert continuous queries to InfluxDB tasks, see
[Migrate continuous queries to tasks](/influxdb/v2.4/upgrade/v1-to-v2/migrate-cqs/).

### Use the interactive InfluxQL shell

The InfluxDB {{< current-version >}} `influx` CLI includes an interactive **InfluxQL shell** for executing InfluxQL queries.
The InfluxDB {{< current-version >}} Docker image includes the `influx` CLI.

To start an InfluxQL shell:

1. Start a bash session in your InfluxDB container:

```sh
docker exec -it influxdb /bin/bash
```

2. Set up your [`influx` CLI authentication credentials](/influxdb/v2.4/tools/influx-cli/#set-up-the-influx-cli).
3. Run the `influx v1 shell` command.

For more information, see:

- [Use the InfluxQL shell](/influxdb/v2.4/tools/influxql-shell/)
- [Query data with InfluxQL](/influxdb/v2.4/query-data/influxql/)

To build an interactive shell to execute **Flux** queries,
[compile and build a command line Flux REPL from source](https://github.com/influxdata/flux/blob/master/README.md#getting-started).
9 changes: 8 additions & 1 deletion content/influxdb/v2.4/upgrade/v1-to-v2/manual-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ To manually upgrade from InfluxDB 1.x to InfluxDB {{< current-version >}}:
4. [Create authorizations](#create-authorizations)
5. [Migrate time series data](#migrate-time-series-data)
6. [Migrate continuous queries](#migrate-continuous-queries)
7. [Query data with InfluxQL](#query-data-with-influxql)

## Install InfluxDB {{< current-version >}}
[Download, install, and set up InfluxDB {{< current-version >}}](/influxdb/v2.4/get-started/).
Expand Down Expand Up @@ -75,7 +76,7 @@ If you're using custom configuration settings in your InfluxDB 1.x instance, do
| | |
| **[http]** | |
| flux-enabled | |
| flux-log-enabled | |
| flux-log-enabled | [flux-log-enabled](/influxdb/v2.4/reference/config-options/#flux-log-enabled) |
| bind-address | [http-bind-address](/influxdb/v2.4/reference/config-options/#http-bind-address) |
| auth-enabled | |
| realm | |
Expand Down Expand Up @@ -337,3 +338,9 @@ To migrate time series data from your InfluxDB 1.x instance to InfluxDB {{< curr
## Migrate continuous queries
For information about migrating InfluxDB 1.x continuous queries to InfluxDB {{< current-version >}} tasks,
see [Migrate continuous queries to tasks](/influxdb/v2.4/upgrade/v1-to-v2/migrate-cqs/).
## Query data with InfluxQL
InfluxDB {{< current-version >}} supports querying data with both Flux and InfluxQL.
For more information about querying InfluxDB {{< current-version >}} with InfluxQL,
see [Query data with InfluxQL](/influxdb/v2.4/query-data/influxql/).

0 comments on commit d2d8710

Please sign in to comment.