1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
//! Client which can read and write data from InfluxDB.
//!
//! # Arguments
//!
//! * `url`: The URL where InfluxDB is running (ex. `http://localhost:8086`).
//! * `database`: The Database against which queries and writes will be run.
//!
//! # Examples
//!
//! ```rust
//! use influxdb::client::InfluxDbClient;
//!
//! let client = InfluxDbClient::new("http://localhost:8086", "test");
//!
//! assert_eq!(client.database_name(), "test");
//! ```
use futures::{Future, Stream};
use reqwest::r#async::{Client, Decoder};
use std::mem;
use crate::error::InfluxDbError;
use crate::query::{InfluxDbQuery, QueryType};
use url::form_urlencoded;
/// Internal Representation of a Client
pub struct InfluxDbClient {
url: String,
database: String,
// auth: Option<InfluxDbAuthentication>
}
impl InfluxDbClient {
/// Instantiates a new [`InfluxDbClient`](crate::client::InfluxDbClient)
///
/// # Arguments
///
/// * `url`: The URL where InfluxDB is running (ex. `http://localhost:8086`).
/// * `database`: The Database against which queries and writes will be run.
///
/// # Examples
///
/// ```rust
/// use influxdb::client::InfluxDbClient;
///
/// let _client = InfluxDbClient::new("http://localhost:8086", "test");
/// ```
pub fn new<S1, S2>(url: S1, database: S2) -> Self
where
S1: ToString,
S2: ToString,
{
InfluxDbClient {
url: url.to_string(),
database: database.to_string(),
}
}
/// Returns the name of the database the client is using
pub fn database_name(&self) -> &str {
&self.database
}
/// Returns the URL of the InfluxDB installation the client is using
pub fn database_url(&self) -> &str {
&self.url
}
/// Pings the InfluxDB Server
///
/// Returns a tuple of build type and version number
pub fn ping(&self) -> impl Future<Item = (String, String), Error = InfluxDbError> {
Client::new()
.get(format!("{}/ping", self.url).as_str())
.send()
.map(|res| {
let build = res
.headers()
.get("X-Influxdb-Build")
.unwrap()
.to_str()
.unwrap();
let version = res
.headers()
.get("X-Influxdb-Version")
.unwrap()
.to_str()
.unwrap();
(String::from(build), String::from(version))
})
.map_err(|err| InfluxDbError::ProtocolError {
error: format!("{}", err),
})
}
/// Sends a [`InfluxDbReadQuery`](crate::query::read_query::InfluxDbReadQuery) or [`InfluxDbWriteQuery`](crate::query::write_query::InfluxDbWriteQuery) to the InfluxDB Server.InfluxDbError
///
/// A version capable of parsing the returned string is available under the [serde_integration](crate::integrations::serde_integration)
///
/// # Arguments
///
/// * `q`: Query of type [`InfluxDbReadQuery`](crate::query::read_query::InfluxDbReadQuery) or [`InfluxDbWriteQuery`](crate::query::write_query::InfluxDbWriteQuery)
///
/// # Examples
///
/// ```rust
/// use influxdb::client::InfluxDbClient;
/// use influxdb::query::InfluxDbQuery;
///
/// let client = InfluxDbClient::new("http://localhost:8086", "test");
/// let _future = client.query(
/// InfluxDbQuery::write_query("weather")
/// .add_field("temperature", 82)
/// );
/// ```
pub fn query<Q>(&self, q: Q) -> Box<dyn Future<Item = String, Error = InfluxDbError>>
where
Q: InfluxDbQuery,
{
use futures::future;
let q_type = q.get_type();
let query = match q.build() {
Err(err) => {
let error = InfluxDbError::InvalidQueryError {
error: format!("{}", err),
};
return Box::new(future::err::<String, InfluxDbError>(error));
}
Ok(query) => query,
};
let client = match q_type {
QueryType::ReadQuery => {
let read_query = query.get();
let encoded: String = form_urlencoded::Serializer::new(String::new())
.append_pair("db", self.database_name())
.append_pair("q", &read_query)
.finish();
let http_query_string = format!(
"{url}/query?{encoded}",
url = self.database_url(),
encoded = encoded
);
if read_query.contains("SELECT") || read_query.contains("SHOW") {
Client::new().get(http_query_string.as_str())
} else {
Client::new().post(http_query_string.as_str())
}
}
QueryType::WriteQuery => Client::new()
.post(
format!(
"{url}/write?db={db}",
url = self.database_url(),
db = self.database_name(),
)
.as_str(),
)
.body(query.get()),
};
Box::new(
client
.send()
.and_then(|mut res| {
let body = mem::replace(res.body_mut(), Decoder::empty());
body.concat2()
})
.map_err(|err| InfluxDbError::ProtocolError {
error: format!("{}", err),
})
.and_then(|body| {
if let Ok(utf8) = std::str::from_utf8(&body) {
let s = utf8.to_owned();
// todo: improve error parsing without serde
if s.contains("\"error\"") {
return futures::future::err(InfluxDbError::DatabaseError {
error: format!("influxdb error: \"{}\"", s),
});
}
return futures::future::ok(s);
}
futures::future::err(InfluxDbError::DeserializationError {
error: "response could not be converted to UTF-8".to_string(),
})
}),
)
}
}