Struct influxdb2::Client

source · [−]

pub struct Client {
    pub url: String,
    pub org: String,
    /* private fields */
}

Expand description

Client to a server supporting the InfluxData 2.0 API.

Fields

url: String

The base URL this client sends requests to

org: String

The organization tied to this client

Implementations

source

impl Client

source

pub async fn create_bucket(
&self,
post_bucket_request: Option<PostBucketRequest>
) -> Result<(), RequestError>

Create a new bucket in the organization specified by the 16-digit hexadecimal org_id and with the bucket name bucket.

source

impl Client

source

pub async fn delete(
 &self,
 bucket: &str,
 start: NaiveDateTime,
 stop: NaiveDateTime,
 predicate: Option<String>
) -> Result<(), RequestError>

Delete data points from a bucket matching specified parameters.

source

impl Client

source

pub async fn health(&self) -> Result<HealthCheck, RequestError>

Get health of an instance

source

impl Client

source

pub async fn labels(&self) -> Result<LabelsResponse, RequestError>

List all Labels

source

pub async fn labels_by_org(
&self,
org_id: &str
) -> Result<LabelsResponse, RequestError>

List all Labels by organization ID

source

pub async fn find_label(
&self,
label_id: &str
) -> Result<LabelResponse, RequestError>

Retrieve a label by ID

source

pub async fn create_label(
 &self,
 org_id: &str,
 name: &str,
 properties: Option<HashMap<String, String>>
) -> Result<LabelResponse, RequestError>

Create a Label

source

pub async fn update_label(
 &self,
 name: Option<String>,
 properties: Option<HashMap<String, String>>,
 label_id: &str
) -> Result<LabelResponse, RequestError>

Update a Label

source

pub async fn delete_label(&self, label_id: &str) -> Result<(), RequestError>

Delete a Label

source

impl Client

source

pub async fn list_organizations(
&self,
request: ListOrganizationRequest
) -> Result<Organizations, RequestError>

List all organizations.

source

impl Client

source

pub async fn query_suggestions(&self) -> Result<FluxSuggestions, RequestError>

Get Query Suggestions

source

pub async fn query_suggestions_name(
&self,
name: &str
) -> Result<FluxSuggestion, RequestError>

Query Suggestions with name

source

pub async fn query<T: FromMap>(
&self,
query: Option<Query>
) -> Result<Vec<T>, RequestError>

Query

source

pub async fn query_analyze(
&self,
query: Option<Query>
) -> Result<AnalyzeQueryResponse, RequestError>

Analyze Query

source

pub async fn query_ast(
&self,
language_request: Option<LanguageRequest>
) -> Result<AstResponse, RequestError>

Get Query AST Repsonse

source

impl Client

source

pub async fn ready(&self) -> Result<bool, RequestError>

Get the readiness of an instance at startup

source

impl Client

source

pub async fn is_onboarding_allowed(&self) -> Result<bool, RequestError>

Check if database has default user, org, bucket

source

pub async fn onboarding(
 &self,
 username: &str,
 org: &str,
 bucket: &str,
 password: Option<String>,
 retention_period_hrs: Option<i32>,
 retention_period_seconds: Option<i32>
) -> Result<OnboardingResponse, RequestError>

Set up initial user, org and bucket

source

pub async fn post_setup_user(
 &self,
 username: &str,
 org: &str,
 bucket: &str,
 password: Option<String>,
 retention_period_hrs: Option<i32>,
 retention_period_seconds: Option<i32>
) -> Result<OnboardingResponse, RequestError>

Set up a new user, org and bucket

source

impl Client

source

pub async fn list_tasks(
&self,
request: ListTasksRequest
) -> Result<Tasks, RequestError>

List all tasks.

source

pub async fn create_task(
&self,
request: CreateTaskRequest
) -> Result<(), RequestError>

Create a new task.

source

pub async fn delete_task(&self, task_id: &str) -> Result<(), RequestError>

Delete a task specified by task_id.

source

impl Client

source

pub async fn write_line_protocol(
 &self,
 org: &str,
 bucket: &str,
 body: impl Into<Body> + Send
) -> Result<(), RequestError>

Write line protocol data to the specified organization and bucket.

source

pub async fn write(
 &self,
 bucket: &str,
 body: impl Stream<Item = impl WriteDataPoint> + Send + Sync + 'static
) -> Result<(), RequestError>

Write a Stream of DataPoints to the specified organization and bucket.

source

impl Client

source

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

Create a new client pointing to the URL specified in protocol://server:port format and using the specified token for authorization.

Example

let client = influxdb2::Client::new("http://localhost:8888", "org", "my-token");

Trait Implementations

source

impl Clone for Client

source

fn clone(&self) -> Client

Returns a copy 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

Auto Trait Implementations

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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> ToOwned for T where
T: Clone,

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct influxdb2::Client

Fields

Implementations

impl Client

pub async fn create_bucket( &self, post_bucket_request: Option<PostBucketRequest>) -> Result<(), RequestError>

impl Client

pub async fn delete( &self, bucket: &str, start: NaiveDateTime, stop: NaiveDateTime, predicate: Option<String>) -> Result<(), RequestError>

impl Client

pub async fn health(&self) -> Result<HealthCheck, RequestError>

impl Client

pub async fn labels(&self) -> Result<LabelsResponse, RequestError>

pub async fn labels_by_org( &self, org_id: &str) -> Result<LabelsResponse, RequestError>

pub async fn find_label( &self, label_id: &str) -> Result<LabelResponse, RequestError>

pub async fn create_label( &self, org_id: &str, name: &str, properties: Option<HashMap<String, String>>) -> Result<LabelResponse, RequestError>

pub async fn update_label( &self, name: Option<String>, properties: Option<HashMap<String, String>>, label_id: &str) -> Result<LabelResponse, RequestError>

pub async fn delete_label(&self, label_id: &str) -> Result<(), RequestError>

impl Client

pub async fn list_organizations( &self, request: ListOrganizationRequest) -> Result<Organizations, RequestError>

impl Client

pub async fn query_suggestions(&self) -> Result<FluxSuggestions, RequestError>

pub async fn query_suggestions_name( &self, name: &str) -> Result<FluxSuggestion, RequestError>

pub async fn query<T: FromMap>( &self, query: Option<Query>) -> Result<Vec<T>, RequestError>

pub async fn query_analyze( &self, query: Option<Query>) -> Result<AnalyzeQueryResponse, RequestError>

pub async fn query_ast( &self, language_request: Option<LanguageRequest>) -> Result<AstResponse, RequestError>

impl Client

pub async fn ready(&self) -> Result<bool, RequestError>

impl Client

pub async fn is_onboarding_allowed(&self) -> Result<bool, RequestError>

pub async fn onboarding( &self, username: &str, org: &str, bucket: &str, password: Option<String>, retention_period_hrs: Option<i32>, retention_period_seconds: Option<i32>) -> Result<OnboardingResponse, RequestError>

pub async fn post_setup_user( &self, username: &str, org: &str, bucket: &str, password: Option<String>, retention_period_hrs: Option<i32>, retention_period_seconds: Option<i32>) -> Result<OnboardingResponse, RequestError>

impl Client

pub async fn list_tasks( &self, request: ListTasksRequest) -> Result<Tasks, RequestError>

pub async fn create_task( &self, request: CreateTaskRequest) -> Result<(), RequestError>

pub async fn delete_task(&self, task_id: &str) -> Result<(), RequestError>

impl Client

pub async fn write_line_protocol( &self, org: &str, bucket: &str, body: impl Into<Body> + Send) -> Result<(), RequestError>

pub async fn write( &self, bucket: &str, body: impl Stream<Item = impl WriteDataPoint> + Send + Sync + 'static) -> Result<(), RequestError>

impl Client

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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

impl Debug for Client

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

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub async fn create_bucket(
&self,
post_bucket_request: Option<PostBucketRequest>
) -> Result<(), RequestError>

pub async fn delete(
&self,
bucket: &str,
start: NaiveDateTime,
stop: NaiveDateTime,
predicate: Option<String>
) -> Result<(), RequestError>

pub async fn labels_by_org(
&self,
org_id: &str
) -> Result<LabelsResponse, RequestError>

pub async fn find_label(
&self,
label_id: &str
) -> Result<LabelResponse, RequestError>

pub async fn create_label(
&self,
org_id: &str,
name: &str,
properties: Option<HashMap<String, String>>
) -> Result<LabelResponse, RequestError>

pub async fn update_label(
&self,
name: Option<String>,
properties: Option<HashMap<String, String>>,
label_id: &str
) -> Result<LabelResponse, RequestError>

pub async fn list_organizations(
&self,
request: ListOrganizationRequest
) -> Result<Organizations, RequestError>

pub async fn query_suggestions_name(
&self,
name: &str
) -> Result<FluxSuggestion, RequestError>

pub async fn query<T: FromMap>(
&self,
query: Option<Query>
) -> Result<Vec<T>, RequestError>

pub async fn query_analyze(
&self,
query: Option<Query>
) -> Result<AnalyzeQueryResponse, RequestError>

pub async fn query_ast(
&self,
language_request: Option<LanguageRequest>
) -> Result<AstResponse, RequestError>

pub async fn onboarding(
&self,
username: &str,
org: &str,
bucket: &str,
password: Option<String>,
retention_period_hrs: Option<i32>,
retention_period_seconds: Option<i32>
) -> Result<OnboardingResponse, RequestError>

pub async fn post_setup_user(
&self,
username: &str,
org: &str,
bucket: &str,
password: Option<String>,
retention_period_hrs: Option<i32>,
retention_period_seconds: Option<i32>
) -> Result<OnboardingResponse, RequestError>

pub async fn list_tasks(
&self,
request: ListTasksRequest
) -> Result<Tasks, RequestError>

pub async fn create_task(
&self,
request: CreateTaskRequest
) -> Result<(), RequestError>

pub async fn write_line_protocol(
&self,
org: &str,
bucket: &str,
body: impl Into<Body> + Send
) -> Result<(), RequestError>

pub async fn write(
&self,
bucket: &str,
body: impl Stream<Item = impl WriteDataPoint> + Send + Sync + 'static
) -> Result<(), RequestError>

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

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

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

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

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

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

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

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