2 releases
0.1.1 | Feb 28, 2023 |
---|---|
0.1.0 | Aug 28, 2022 |
#57 in #influx-db
3,062 downloads per month
Used in 5 crates
(2 directly)
23KB
519 lines
influxdb2
This is a Rust client to InfluxDB using the 2.0 API.
Setup
Add this to cargo.toml
:
influxdb2 = "0.3"
influxdb2-structmap = "0.2"
num-traits = "0.2"
Usage
Querying
use chrono::{DateTime, FixedOffset};
use influxdb2::{Client, FromDataPoint};
use influxdb2::models::Query;
#[derive(Debug, FromDataPoint)]
pub struct StockPrice {
ticker: String,
value: f64,
time: DateTime<FixedOffset>,
}
impl Default for StockPrice {
fn default() -> Self {
Self {
ticker: "".to_string(),
value: 0_f64,
time: chrono::MIN_DATETIME.with_timezone(&chrono::FixedOffset::east(7 * 3600)),
}
}
}
async fn example() -> Result<(), Box<dyn std::error::Error>> {
let host = std::env::var("INFLUXDB_HOST").unwrap();
let org = std::env::var("INFLUXDB_ORG").unwrap();
let token = std::env::var("INFLUXDB_TOKEN").unwrap();
let client = Client::new(host, org, token);
let qs = format!("from(bucket: \"stock-prices\")
|> range(start: -1w)
|> filter(fn: (r) => r.ticker == \"{}\")
|> last()
", "AAPL");
let query = Query::new(qs.to_string());
let res: Vec<StockPrice> = client.query::<StockPrice>(Some(query))
.await?;
println!("{:?}", res);
Ok(())
}
Writing
#[derive(Default, WriteDataPoint)]
#[measurement = "cpu_load_short"]
struct CpuLoadShort {
#[influxdb(tag)]
host: Option<String>,
#[influxdb(tag)]
region: Option<String>,
#[influxdb(field)]
value: f64,
#[influxdb(timestamp)]
time: i64,
}
async fn example() -> Result<(), Box<dyn std::error::Error>> {
use chrono::Utc;
use futures::prelude::*;
use influxdb2::models::DataPoint;
use influxdb2::Client;
use influxdb2_derive::WriteDataPoint;
let host = std::env::var("INFLUXDB_HOST").unwrap();
let org = std::env::var("INFLUXDB_ORG").unwrap();
let token = std::env::var("INFLUXDB_TOKEN").unwrap();
let bucket = std::env::var("INFLUXDB_BUCKET").unwrap();
let client = Client::new(host, org, token);
let points = vec![
CpuLoadShort {
host: Some("server01".to_owned()),
region: Some("us-west".to_owned()),
value: 0.64,
time: Utc::now().timestamp_nanos(),
},
CpuLoadShort {
host: Some("server02".to_owned()),
region: None,
value: 0.64,
time: Utc::now().timestamp_nanos(),
},
];
client.write(bucket, stream::iter(points)).await?;
Ok(())
}
Supported Data Types
InfluxDB data point doesn't support every data types supported by Rust. So, the derive macro only allows for a subset of data types which is also supported in InfluxDB.
Supported struct field types:
- bool
- f64
- i64
- u64 - DEPRECATED, will be removed in version 0.4
- String
- Vec
- chrono::Duration
- DateTime
Features
Implemented API
- Query API
- Write API
- Delete API
- Bucket API (partial: only list, create, delete)
- Organization API (partial: only list)
- Task API (partial: only list, create, delete)
TLS Implementations
This crate uses reqwest under the
hood. You can choose between native-tls
and rustls
with the features
provided with this crate. native-tls
is chosen as the default, like reqwest
does.
# Usage for native-tls (the default).
influxdb2 = "0.3"
# Usage for rustls.
influxdb2 = { version = "0.3", features = ["rustls"], default-features = false }
Development Status
This project is still at alpha status and all the bugs haven't been ironed yet. With that said, use it at your own risk and feel free to create an issue or pull request.
lib.rs
:
Implements the functionality to enable conversion between a struct type a map container type in Rust through the use of a procedural macros.
Dependencies
~3.5–5MB
~95K SLoC