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.ingest("my-dataset", vec![
      json!({
        "foo": "bar",
        "bar": "baz"
      }),
    ]).await?;

    let res = client.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.

Client

Provides methods to work with Axiom datasets, including ingesting and querying. If you’re looking for the ingest and query methods, those are at the top-level client.

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.

LegacyQuery

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

LegacyQueryOptions

The parameters for a query.

LegacyQueryResult

The legacy result of a query.

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 analytics, check out Query.

QueryMessage

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

QueryOptions

The optional parameters to APL query methods.

QueryResult

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

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.