Module axiom_rs::datasets

Expand description

Manage datasets, ingest data and query it.

You’re probably looking for the Client.

Examples

use axiom_rs::{Client, Error};
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Error> {
    let client = Client::new()?;

    client.datasets.create("my-dataset", "").await?;

    client.datasets.ingest("my-dataset", vec![
      json!({
        "foo": "bar",
        "bar": "baz"
      }),
    ]).await?;

    let res = client.datasets.apl_query("['my-dataset'] | count", None).await?;
    assert_eq!(1, res.status.rows_matched);

    client.datasets.delete("my-dataset").await?;

    Ok(())
}

Structs

Aggregation

Aggregations are applied to a query.

AplOptions

The optional parameters to APL query methods.

AplQuery

A query that gets executed on a dataset. If you’re looking for the analytics, check out Query.

AplQueryResult

The result of an APL query. It embeds the APL request in the result it created.

Client

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

Dataset

An Axiom dataset.

DatasetCreateRequest

Used to create a dataset.

DatasetUpdateRequest

Used to update a dataset.

Entry

An event that matched a query and is thus part of the result set.

EntryGroup

A group of queried event.

EntryGroupAgg

An aggregation which is part of a group of queried events.

Field

A field of an Axiom dataset.

Filter

A filter is applied to a query.

Info

Details of the information stored inside a dataset including the fields.

IngestFailure

Ingestion failure of a single event.

IngestStatus

Returned on event ingestion operation.

Interval

The interval of queried time series.

Order

Specifies the order a queries result will be in.

Projection

A field that is projected to the query result.

Query

A query that gets executed on a dataset. If you’re looking for the APL query, check out AplQuery.

QueryMessage

A message that is returned in the status of a query.

QueryOptions

The parameters for a query.

QueryResult

The result of a query.

QueryStatus

The status of a query result.

Stat

Details of the information stored in a dataset.

Timeseries

A queried time series.

TrimResult

The result of a trim operation.

VirtualField

A VirtualField is not part of a dataset and its value is derived from an expression. Aggregations, filters and orders can reference this field like any other field.