Struct Client

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

The client to influxdb

Implementations§

Source§

impl Client

Source

pub fn new<T>(host: Url, db: T) -> Self
where T: Into<String>,

Create a new influxdb client with http

Source

pub fn new_with_client<T>(host: Url, db: T, client: HttpClient) -> Self
where T: Into<String>,

Create a new influxdb client with custom reqwest’s client.

Source

pub fn switch_database<T>(&mut self, database: T)
where T: Into<String>,

Change the client’s database

Source

pub fn set_authentication<T>(self, user: T, passwd: T) -> Self
where T: Into<String>,

Change the client’s user

Source

pub fn set_jwt_token<T>(self, token: T) -> Self
where T: Into<String>,

Set the client’s jwt token

Source

pub fn get_db(&self) -> &str

View the current db name

Source

pub fn ping(&self) -> impl Future<Output = bool>

Query whether the corresponding database exists, return bool

Source

pub fn get_version(&self) -> impl Future<Output = Option<String>>

Query the version of the database and return the version number

Source

pub fn write_point<'a>( &self, point: Point<'a>, precision: Option<Precision>, rp: Option<&str>, ) -> impl Future<Output = Result<(), Error>> + 'a

Write a point to the database

Source

pub fn write_points<'a, T: IntoIterator<Item = impl Borrow<Point<'a>>>>( &self, points: T, precision: Option<Precision>, rp: Option<&str>, ) -> impl Future<Output = Result<(), Error>>

Write multiple points to the database

Source

pub fn query( &self, q: &str, epoch: Option<Precision>, ) -> impl Future<Output = Result<Option<Vec<Node>>, Error>>

Query and return data, the data type is Option<Vec<Node>>

Source

pub fn query_chunked( &self, q: &str, epoch: Option<Precision>, ) -> impl Future<Output = Result<ChunkedQuery<'static, IoRead<Cursor<Bytes>>>, Error>>

Query and return data, the data type is Option<Vec<Node>>

Source

pub fn drop_measurement( &self, measurement: &str, ) -> impl Future<Output = Result<(), Error>>

Drop measurement

Source

pub fn create_database( &self, dbname: &str, ) -> impl Future<Output = Result<(), Error>>

Create a new database in InfluxDB.

Source

pub fn drop_database( &self, dbname: &str, ) -> impl Future<Output = Result<(), Error>>

Drop a database from InfluxDB.

Source

pub fn create_user( &self, user: &str, passwd: &str, admin: bool, ) -> impl Future<Output = Result<(), Error>>

Create a new user in InfluxDB.

Source

pub fn drop_user(&self, user: &str) -> impl Future<Output = Result<(), Error>>

Drop a user from InfluxDB.

Source

pub fn set_user_password( &self, user: &str, passwd: &str, ) -> impl Future<Output = Result<(), Error>>

Change the password of an existing user.

Source

pub fn grant_admin_privileges( &self, user: &str, ) -> impl Future<Output = Result<(), Error>>

Grant cluster administration privileges to a user.

Source

pub fn revoke_admin_privileges( &self, user: &str, ) -> impl Future<Output = Result<(), Error>>

Revoke cluster administration privileges from a user.

Source

pub fn grant_privilege( &self, user: &str, db: &str, privilege: &str, ) -> impl Future<Output = Result<(), Error>>

Grant a privilege on a database to a user. :param privilege: the privilege to grant, one of ‘read’, ‘write’ or ‘all’. The string is case-insensitive

Source

pub fn revoke_privilege( &self, user: &str, db: &str, privilege: &str, ) -> impl Future<Output = Result<(), Error>>

Revoke a privilege on a database from a user. :param privilege: the privilege to grant, one of ‘read’, ‘write’ or ‘all’. The string is case-insensitive

Source

pub fn create_retention_policy( &self, name: &str, duration: &str, replication: &str, default: bool, db: Option<&str>, ) -> impl Future<Output = Result<(), Error>>

Create a retention policy for a database. :param duration: the duration of the new retention policy. Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported and mean 1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks, respectively. For infinite retention – meaning the data will never be deleted – use ‘INF’ for duration. The minimum retention period is 1 hour.

Source

pub fn drop_retention_policy( &self, name: &str, db: Option<&str>, ) -> impl Future<Output = Result<(), Error>>

Drop an existing retention policy for a database.

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
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Self

connecting for default database test and host http://localhost:8086

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,