Struct axiom_rs::datasets::Client

pub struct Client { /* private fields */ }

Provides methods to work with Axiom datasets, including ingesting and querying.

Implementations

impl Client

pub async fn apl_query<S, O>(&self, apl: S, opts: O) -> Result<AplQueryResult> where
    S: Into<String> + FmtDebug,
    O: Into<Option<AplOptions>>, 

Executes the given query specified using the Axiom Processing Language (APL).

pub async fn create<N, D>(
    &self,
    dataset_name: N,
    description: D
) -> Result<Dataset> where
    N: Into<String> + FmtDebug,
    D: Into<String> + FmtDebug, 

Create a dataset with the given name and description.

pub async fn delete<N>(&self, dataset_name: N) -> Result<()> where
    N: Into<String> + FmtDebug, 

Delete the dataset with the given ID.

pub async fn get<N>(&self, dataset_name: N) -> Result<Dataset> where
    N: Into<String> + FmtDebug, 

Get a dataset by its id.

pub async fn info<N>(&self, dataset_name: N) -> Result<Info> where
    N: Into<String> + FmtDebug, 

Retrieve the information of the dataset identified by its id.

pub async fn ingest<N, I, E>(
    &self,
    dataset_name: N,
    events: I
) -> Result<IngestStatus> where
    N: Into<String> + FmtDebug,
    I: IntoIterator<Item = E>,
    E: Serialize, 

Ingest events into the dataset identified by its id. Restrictions for field names (JSON object keys) can be reviewed here: https://www.axiom.co/docs/usage/field-restrictions.

pub async fn ingest_raw<N, P>(
    &self,
    dataset_name: N,
    payload: P,
    content_type: ContentType,
    content_encoding: ContentEncoding
) -> Result<IngestStatus> where
    N: Into<String> + FmtDebug,
    P: Into<Bytes>, 

Ingest data into the dataset identified by its id. Restrictions for field names (JSON object keys) can be reviewed here: https://www.axiom.co/docs/usage/field-restrictions.

pub async fn ingest_stream<N, S, E>(
    &self,
    dataset_name: N,
    stream: S
) -> Result<IngestStatus> where
    N: Into<String> + FmtDebug,
    S: Stream<Item = E> + Send + Sync + 'static,
    E: Serialize, 

Ingest a stream of events into a dataset. Events will be ingested in chunks of 1000 items. If ingestion of a chunk fails, it will be retried with a backoff. Restrictions for field names (JSON object keys) can be reviewed here: https://www.axiom.co/docs/usage/field-restrictions.

pub async fn try_ingest_stream<N, S, I, E>(
    &self,
    dataset_name: N,
    stream: S
) -> Result<IngestStatus> where
    N: Into<String> + FmtDebug,
    S: Stream<Item = StdResult<I, E>> + Send + Sync + 'static,
    I: Serialize,
    E: Error + Send + Sync + 'static, 

Like Client::ingest_stream, but takes a stream that contains results.

pub async fn list(&self) -> Result<Vec<Dataset>>

List all available datasets.

pub async fn query<N, O>(
    &self,
    dataset_name: N,
    query: Query,
    opts: O
) -> Result<QueryResult> where
    N: Into<String> + FmtDebug,
    O: Into<Option<QueryOptions>>, 

Execute the given query on the dataset identified by its id.

pub async fn trim<N, D>(&self, dataset_name: N, duration: D) -> Result<TrimResult> where
    N: Into<String> + FmtDebug,
    D: TryInto<Duration, Error = Error> + FmtDebug, 

Trim the dataset identified by its id to a given length. The max duration given will mark the oldest timestamp an event can have. Older ones will be deleted from the dataset. The duration can either be a std::time::Duration or a chrono::Duration.

pub async fn update<N>(
    &self,
    dataset_name: N,
    req: DatasetUpdateRequest
) -> Result<Dataset> where
    N: Into<String> + FmtDebug, 

Update a dataset.

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.