Skip to content

Commit

Permalink
Documentation: Fix README and doc/index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed May 8, 2024
1 parent 97a149d commit 52f3a27
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 62 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,17 @@ ctk --version

## Development

For installing a development sandbox, please refer to the [development sandbox
documentation].
Contributions are very much welcome. Please visit the [](#sandbox)
documentation to learn about how to spin up a sandbox environment on your
workstation, or create a [ticket][Issues] to report a bug or share an idea
about a possible feature.



[Changelog]: https://github.com/crate-workbench/cratedb-toolkit/blob/main/CHANGES.md
[Community Forum]: https://community.crate.io/
[CrateDB]: https://crate.io/products/cratedb
[CrateDB Cloud]: https://console.cratedb.cloud/
[development sandbox documentation]: https://github.com/crate-workbench/cratedb-toolkit/blob/main/doc/sandbox.md
[Documentation]: https://cratedb-toolkit.readthedocs.io/
[DWIM]: https://en.wikipedia.org/wiki/DWIM
[Issues]: https://github.com/crate-workbench/cratedb-toolkit/issues
Expand Down
59 changes: 0 additions & 59 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,65 +15,6 @@
:start-line: 12
```

## About

This software package includes a range of modules and subsystems to work
with CrateDB and CrateDB Cloud efficiently.

You can use CrateDB Toolkit to run data I/O procedures and automation tasks
of different kinds around CrateDB and CrateDB Cloud. It can be used both as
a standalone program, and as a library.

It aims for [DWIM]-like usefulness and [UX], and provides CLI and HTTP
interfaces, and others.


## Features

- **Capable:** Connect to the InfluxDB HTTP API, or read from an InfluxDB
TSM data directory directly.

- **Versatile:** Use it as a command-line program, pipeline element,
or as a library within your own applications.

- **Polyglot:** Support I/O operations between InfluxDB, any SQL database
supported by SQLAlchemy, file formats supported by pandas/Dask, and
the native InfluxDB line protocol (ILP), on both import and export
directions.


## Synopsis

```shell

# Export from API to database.
influxio copy \
"http://example:token@localhost:8086/testdrive/demo" \
"sqlite://export.sqlite?table=demo"

# Export from data directory to line protocol format.
influxio copy \
"file:///path/to/influxdb/engine?bucket-id=372d1908eab801a6&measurement=demo" \
"file://export.lp"
```


## Documentation

Please visit the [README](#readme) document to learn what you can do with
the `influxio` package. Effectively, it is all about the `influxio copy`
primitive, which accepts a range of variants on its `SOURCE` and `TARGET`
arguments, in URL formats.


## Development

Contributions are very much welcome. Please visit the [](#sandbox)
documentation to learn about how to spin up a sandbox environment on your
workstation, or create a [ticket][Issues] to report a bug or share an idea
about a possible feature.



```{toctree}
:maxdepth: 3
Expand Down

0 comments on commit 52f3a27

Please sign in to comment.