influxdb/influxdb_iox_client
Andrew Lamb 3a53923684
feat: Management API + CLI command to close a chunk and move to read buffer (#1002)
* feat: Management API + CLI command to close a  chunk and move to read buffer

* refactor: Less copy-pasta

* fix: track only once, use `let _` instead of `.ok()`

* docs: Apply suggestions from code review

fix comments ( 🤦‍♀️  for copy/pasta)

Co-authored-by: Carol (Nichols || Goulding) <193874+carols10cents@users.noreply.github.com>

* docs: Update server/src/lib.rs

Co-authored-by: Carol (Nichols || Goulding) <193874+carols10cents@users.noreply.github.com>

* refactor: Use DatabaseName rather than impl Into<String>

* fix: Fixup logical merge conflicts

Co-authored-by: Carol (Nichols || Goulding) <193874+carols10cents@users.noreply.github.com>
2021-03-17 15:25:27 +00:00
..
src feat: Management API + CLI command to close a chunk and move to read buffer (#1002) 2021-03-17 15:25:27 +00:00
Cargo.toml feat: add longrunning operations client (#981) 2021-03-16 13:19:44 +00:00
README.md docs: Create a README that explains the two clients and the feature 2021-02-10 10:30:06 -05:00

README.md

InfluxDB IOx Client

This is the official Rust client library for connecting to InfluxDB IOx.

Using the HTTP API

If you only want to use the HTTP API, create an influxdb_iox_client::Client. Here is an example of creating an instance that connects to an IOx server running at http://127.0.0.1:8080 and creating a database named telemetry:

#[tokio::main]
fn main() {
    use data_types::database_rules::DatabaseRules;
    use influxdb_iox_client::ClientBuilder;

    let client = ClientBuilder::default()
        .build("http://127.0.0.1:8080")
        .expect("client should be valid");

    client
        .create_database("telemetry", &DatabaseRules::default())
        .await
        .expect("failed to create database");
}

Using the Arrow Flight API

IOx supports an Arrow Flight gRPC API. To use it, enable the flight feature, which is off by default:

[dependencies]
influxdb_iox_client = { version = "[..]", features = ["flight"] }

Then you can create an influxdb_iox_client::FlightClient by using the FlightClientBuilder. Here is an example of creating an instance that connects to an IOx server with its gRPC services available at http://localhost:8082 and using it to perform a query:

#[tokio::main]
fn main() {
    use data_types::database_rules::DatabaseRules;
    use influxdb_iox_client::FlightClientBuilder;

    let client = FlightClientBuilder::default()
        .build("http://127.0.0.1:8082")
        .expect("client should be valid");

    let mut query_results = client
        .perform_query(scenario.database_name(), sql_query)
        .await;

    let mut batches = vec![];

    while let Some(data) = query_results.next().await {
        batches.push(data);
    }
}