Struct Tql

Source

pub struct Tql { /* private fields */ }

Expand description

Main TQL query interface

Provides a high-level API for parsing and executing TQL queries against JSON data.

§Examples

use tql::Tql;
use serde_json::json;

let tql = Tql::new();

let records = vec![
    json!({"name": "Alice", "age": 30}),
    json!({"name": "Bob", "age": 25}),
];

let results = tql.query(&records, "age > 25").unwrap();
assert_eq!(results.len(), 1);

Implementations§

Source §

impl Tql

Source

pub fn new() -> Self

Create a new TQL instance with default settings

Source

pub fn with_max_depth(max_depth: usize) -> Self

Create a new TQL instance with custom parser depth limit

Source

pub fn query<'a>( &self, records: &'a [JsonValue], query: &str, ) -> Result<Vec<&'a JsonValue>>

Execute a TQL query against a list of records

§Arguments

records - A slice of JSON values to query against
query - The TQL query string

§Returns

A vector of references to matching records

§Examples

use tql::Tql;
use serde_json::json;

let tql = Tql::new();
let records = vec![
    json!({"name": "Alice", "age": 30}),
    json!({"name": "Bob", "age": 20}),
];

let results = tql.query(&records, "age >= 25").unwrap();
assert_eq!(results.len(), 1);

Source

pub fn query_enriched( &self, records: &[JsonValue], query: &str, ) -> Result<Vec<JsonValue>>

Execute a TQL query with enrichment (applies field mutators to results)

§Arguments

records - A slice of JSON values to query against
query - The TQL query string

§Returns

A vector of owned records with mutators applied

Source

pub fn count(&self, records: &[JsonValue], query: &str) -> Result<usize>

Count the number of records matching a query

§Arguments

records - A slice of JSON values to query against
query - The TQL query string

§Returns

The number of matching records

Source

pub fn matches(&self, record: &JsonValue, query: &str) -> Result<bool>

Evaluate a query against a single record

§Arguments

record - A JSON value to evaluate against
query - The TQL query string

§Returns

true if the record matches the query, false otherwise

Source

pub fn parse(&self, query: &str) -> Result<AstNode>

Parse a TQL query into an AST without executing it

Useful for pre-compiling queries or validating syntax

Source

pub fn is_stats_query(&self, query: &str) -> Result<bool>

Check if a query contains stats expressions

§Arguments

query - The TQL query string

§Returns

true if the query contains stats aggregations

Source

pub fn evaluate_stats( &self, records: &[JsonValue], query: &str, ) -> Result<JsonValue>

Execute a stats query against a list of records

§Arguments

records - A slice of JSON values to aggregate
query - The TQL query string containing stats expression

§Returns

Aggregated results as a JSON value

§Examples

use tql::Tql;
use serde_json::json;

let tql = Tql::new();
let records = vec![
    json!({"name": "Alice", "status": "active"}),
    json!({"name": "Bob", "status": "active"}),
    json!({"name": "Charlie", "status": "inactive"}),
];

let results = tql.evaluate_stats(&records, "| stats count() by status").unwrap();