Struct auditor::client::QueryBuilder

pub struct QueryBuilder {
    pub query_params: QueryParameters,
}

The QueryBuilder is used to construct QueryParameters using the builder pattern. It is used to fetch records using query parameters such as start_time, stop_time etc.

Examples

use auditor::client::{QueryBuilder, Operator, MetaQuery, ComponentQuery, SortBy};

// Create a new QueryBuilder instance.
let query_builder = QueryBuilder::new()
    .with_start_time(Operator::default()) // Set start time operator.
    .with_stop_time(Operator::default())  // Set stop time operator.
    .with_runtime(Operator::default())    // Set runtime operator.
    .with_meta_query(MetaQuery::new())    // Set meta query.
    .with_component_query(ComponentQuery::new())  // Set component query.
    .sort_by(SortBy::new()) // Set sort by options
    .limit(1000); // Limit the number of queries

// For querying all records, just create an empty QueryBuilder instance without operators
let query_builder = QueryBuilder::new();

// Build the query string.
let query_string = query_builder.build();
println!("Generated query string: {}", query_string);

Fields

query_params: QueryParameters

Query parameters to be built.

Implementations

impl QueryBuilder

pub fn new() -> Self

Creates a new instance of the QueryBuilder with default parameters.

pub fn with_record_id(self, record_id: String) -> Self

Sets the exact record to be queried from the database using record id

pub fn with_start_time(self, time_operator: Operator) -> Self

Sets the start time in the query parameters.

pub fn with_stop_time(self, time_operator: Operator) -> Self

Sets the stop time in the query parameters.

pub fn with_runtime(self, time_operator: Operator) -> Self

Sets the runtime in the query parameters.

pub fn with_meta_query(self, meta: MetaQuery) -> Self

Sets the meta query in the query parameters.

pub fn with_component_query(self, component: ComponentQuery) -> Self

Sets the component query in the query parameters.

pub fn sort_by(self, sort: SortBy) -> Self

Sets the sort_by option for the resulting query

pub fn limit(self, number: u64) -> Self

pub async fn get( &self, client: AuditorClient ) -> Result<Vec<Record>, ClientError>

Arguments

• client - An instance of the AuditorClient used to perform the query.

Returns

A Result containing the vector of records if successful, or a ClientError if an error occurs.

pub fn build(&self) -> String

Builds and returns the serialized query string

Trait Implementations

impl Clone for QueryBuilder

fn clone(&self) -> QueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryBuilder

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

Formats the value using the given formatter.

impl Default for QueryBuilder

fn default() -> Self

Returns the “default value” for a type.