Struct influx_db_client::client::Client

pub struct Client { /* fields omitted */ }

The client to influxdb

Implementations

impl Client

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

Create a new influxdb client with http

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.

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

Change the client’s database

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

Change the client’s user

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

Set the client’s jwt token

pub fn get_db(&self) -> &str

View the current db name

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

Query whether the corresponding database exists, return bool

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

Query the version of the database and return the version number

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

Write a point to the database

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

Write multiple points to the database

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

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

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

Drop measurement

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

Create a new database in InfluxDB.

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

Drop a database from InfluxDB.

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

Create a new user in InfluxDB.

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

Drop a user from InfluxDB.

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

Change the password of an existing user.

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

Grant cluster administration privileges to a user.

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

Revoke cluster administration privileges from a user.

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

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

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.

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

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Self

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