Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

InfluxDB 2.x streaming client.

This client executes Flux queries and returns results as an async stream, allowing you to process millions of rows without loading them all into memory.

§Example

use influxdb_stream::Client;
use futures::StreamExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new("http://localhost:8086", "my-org", "my-token");

    let mut stream = client.query_stream(r#"
        from(bucket: "sensors")
        |> range(start: -1h)
        |> filter(fn: (r) => r._measurement == "temperature")
    "#).await?;

    while let Some(record) = stream.next().await {
        let record = record?;
        println!("Got: {:?}", record);
    }

    Ok(())
}

Implementations§

Source§

impl Client

Source

pub fn new( url: impl Into<String>, org: impl Into<String>, token: impl Into<String>, ) -> Self

Create a new InfluxDB client.

§Arguments
  • url - Base URL of the InfluxDB server (e.g., “http://localhost:8086”)
  • org - Organization name
  • token - Authentication token
§Panics

Panics if the provided URL is invalid.

Source

pub fn with_http_client( http: Client, url: impl Into<String>, org: impl Into<String>, token: impl Into<String>, ) -> Self

Create a new client with a custom reqwest client.

This allows you to configure timeouts, proxies, TLS settings, etc.

Source

pub fn url(&self) -> &Url

Get the base URL.

Source

pub fn org(&self) -> &str

Get the organization name.

Source

pub async fn query_stream( &self, query: impl Into<String>, ) -> Result<Pin<Box<dyn Stream<Item = Result<FluxRecord>> + Send>>>

Execute a Flux query and return results as an async stream.

This is the primary method for querying InfluxDB. Results are streamed one record at a time, so you can process arbitrarily large result sets without running out of memory.

§Arguments
  • query - Flux query string
§Returns

A stream of Result<FluxRecord>. Each item is either a successfully parsed record or an error.

§Example
use futures::StreamExt;

let mut stream = client.query_stream("from(bucket: \"test\") |> range(start: -1h)").await?;

let mut count = 0;
while let Some(result) = stream.next().await {
    let record = result?;
    count += 1;
}
println!("Processed {} records", count);
Source

pub async fn query(&self, query: impl Into<String>) -> Result<Vec<FluxRecord>>

Execute a Flux query and collect all results into a Vec.

Warning: This loads all results into memory. For large result sets, use query_stream() instead to process records one at a time.

§Arguments
  • query - Flux query string
§Returns

A vector of all records from the query.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more