Skip to content

Commit

Permalink
Removed the sample dataset (#3596)
Browse files Browse the repository at this point in the history
Co-authored-by: Iain Cox <[email protected]>
  • Loading branch information
atovpeko and billy-the-fish authored Nov 26, 2024
1 parent 5fd20c2 commit 84ef930
Showing 1 changed file with 24 additions and 49 deletions.
73 changes: 24 additions & 49 deletions self-hosted/migration/migrate-influxdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ migrations. It pipes exported data directly to Timescale, and manages schema
discovery, validation, and creation.

<Highlight type="important">

Outflux works with earlier versions of InfluxDB. It does not work with InfluxDB
version 2 and later.

</Highlight>

## Prerequisites
Expand All @@ -24,19 +26,15 @@ Before you start, make sure you have:

* A running instance of InfluxDB and a means to connect to it.
* An [installation of Timescale][install] and a means to connect to it.
* Data in your InfluxDB instance. If you need to import some sample data for a
test, see the instructions for [importing sample data][import-data].
* Data in your InfluxDB instance.

## Procedures

To import data from Outflux, follow these procedures:

1. [Install Outflux](#install-outflux)
1. [Import sample data](#import-sample-data-into-influxdb) to InfluxDB if you
don't have existing data.
1. [Discover, validate, and transfer
schema](#discover-validate-and-transfer-schema) to Timescale (optional)
1. [Migrate data to Timescale](#migrate-data-to-timescaledb)
1. [Install Outflux][install-outflux]
1. [Discover, validate, and transfer schema][discover-validate-and-transfer-schema] to Timescale (optional)
1. [Migrate data to Timescale][migrate-data-to-timescale]

## Install Outflux

Expand All @@ -52,48 +50,17 @@ and MacOS.
1. Extract it to a preferred location.

<Highlight type="note">
If you prefer to build Outflux from source, see the [Outflux
README](https://github.com/timescale/outflux/blob/master/README.md) for

If you prefer to build Outflux from source, see the [Outflux README][outflux-readme] for
instructions.

</Highlight>

</Procedure>

To get help with Outflux, you can run `./outflux --help` from the directory
To get help with Outflux, run `./outflux --help` from the directory
where you installed it.

## Import sample data into InfluxDB

If you don't have an existing InfluxDB database, or if you want to test on a
sample instance, you can try Outflux by importing sample data. We provide an
example file with data written in the Influx Line Protocol.

<Procedure>

### Importing sample data into InfluxDB

1. Download the sample data:
<Tag type="download">
[Outflux taxi data](https://timescaledata.blob.core.windows.net/datasets/outflux_taxi.txt)
</Tag>
1. Use the [Influx CLI client][influx-cmd] to load the data into InfluxDB.

```bash
influx -import -path=outflux_taxi.txt -database=outflux_tutorial
```

This command imports the data into a new database named `outflux_tutorial`.

<Highlight type="note">
The sample data has no timestamp, so the time of the Influx server is used at
data insert. All data points belong to one measurement, `taxi`. The points are
tagged with `location`, `rating`, and `vendor`. Four fields are recorded:
`fare`, `mta_tax`, `tip`, and `tolls`. The Influx client assumes the server is
available at `http://localhost:8086`.
</Highlight>

</Procedure>

## Discover, validate, and transfer schema

Outflux can:
Expand All @@ -105,10 +72,12 @@ Outflux can:
exists

<Highlight type="note">

Outflux's `migrate` command does schema transfer and data migration in one step.
For more information, see the [migrate](#migrate-data-to-timescaledb) section.
For more information, see the [migrate][migrate-data-to-timescale] section.
Use this section if you want to validate and transfer your schema independently
of data migration.

</Highlight>

To transfer your schema from InfluxDB to Timescale, run `outflux
Expand All @@ -124,9 +93,11 @@ To transfer all measurements from the database, leave out the measurement name
argument.

<Highlight type="note">

This example uses the `postgres` user and database to connect to the Timescale
database. For other connection options and configuration, see the [Outflux
Github repo](https://github.com/timescale/outflux#connection).
Github repo][outflux-gitbuh].

</Highlight>

### Schema transfer options
Expand Down Expand Up @@ -166,8 +137,8 @@ outflux migrate <DATABASE_NAME> <INFLUX_MEASUREMENT_NAME> \
```

The schema strategy and connection options are the same as for
`schema-transfer`. For more information, see the
[`schema-transfer`](#discover-validate-and-transfer-schema) section.
`schema-transfer`. For more information, see
[Discover, validate, and transfer schema][discover-validate-and-transfer-schema].

In addition, `outflux migrate` also takes the following flags:

Expand All @@ -187,9 +158,13 @@ migrate`][outflux-migrate]. Alternatively, see the command line help:
outflux migrate --help
```

[import-data]: #import-sample-data-into-influxdb
[influx-cmd]: https://docs.influxdata.com/influxdb/v1.7/tools/shell/
[install]: /getting-started/latest/
[install]: /getting-started/:currentVersion:/
[outflux-migrate]: https://github.com/timescale/outflux#migrate
[outflux-releases]: https://github.com/timescale/outflux/releases
[outflux]: https://github.com/timescale/outflux
[install-outflux]: /self-hosted/:currentVersion:/migration/migrate-influxdb/#install-outflux
[discover-validate-and-transfer-schema]: /self-hosted/:currentVersion:/migration/migrate-influxdb/#discover-validate-and-transfer-schema
[migrate-data-to-timescale]: /self-hosted/:currentVersion:/migration/migrate-influxdb/#migrate-data-to-timescale
[outflux-gitbuh]: https://github.com/timescale/outflux#connection
[outflux-readme]: https://github.com/timescale/outflux/blob/master/README.md

0 comments on commit 84ef930

Please sign in to comment.