Struct QueryBuilder 

pub struct QueryBuilder<'session> { /* private fields */ }

Fluent API for building GQL queries

QueryBuilder provides a convenient way to construct complex GQL queries without manually concatenating strings.

Examples

// Using the builder
let result = session.query_builder()
    .match_pattern("(p:Person)")
    .where_clause("p.age > 25")
    .return_clause("p.name, p.age")
    .execute()?;

// Equivalent to:
// "MATCH (p:Person) WHERE p.age > 25 RETURN p.name, p.age"

Implementations

impl<'session> QueryBuilder<'session>

pub fn match_pattern(self, pattern: &str) -> Self

Add a MATCH pattern

Can be called multiple times to add multiple MATCH patterns.

Arguments

• pattern - Graph pattern to match (without the MATCH keyword)

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .match_pattern("(p)-[:KNOWS]->(f:Person)")
    .return_clause("p.name, f.name");

pub fn where_clause(self, condition: &str) -> Self

Add a WHERE clause condition

Can be called multiple times - conditions are AND’ed together.

Arguments

• condition - Condition to add (without the WHERE keyword)

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .where_clause("p.age > 25")
    .where_clause("p.name STARTS WITH 'A'")
    .return_clause("p");

pub fn with_clause(self, clause: &str) -> Self

Add a WITH clause

WITH clauses are used for query chaining and intermediate results.

Arguments

• clause - WITH clause content (without the WITH keyword)

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .with_clause("p, p.age as age")
    .where_clause("age > 25")
    .return_clause("p.name");

pub fn return_clause(self, clause: &str) -> Self

Set the RETURN clause

Specifies what to return from the query. Required for MATCH queries.

Arguments

• clause - Return clause content (without the RETURN keyword)

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .return_clause("p.name, p.age");

pub fn order_by(self, clause: &str) -> Self

Set the ORDER BY clause

Arguments

• clause - Order by clause (without the ORDER BY keywords)

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .return_clause("p.name, p.age")
    .order_by("p.age DESC");

pub fn skip(self, n: usize) -> Self

Set the SKIP value

Skips the first N results.

Arguments

• n - Number of results to skip

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .return_clause("p")
    .skip(10);  // Skip first 10 results

pub fn limit(self, n: usize) -> Self

Set the LIMIT value

Limits the number of results returned.

Arguments

• n - Maximum number of results to return

Examples

session.query_builder()
    .match_pattern("(p:Person)")
    .return_clause("p")
    .limit(10);  // Return max 10 results

pub fn build(&self) -> Result<String>

Build the query string without executing

Returns the constructed GQL query as a string.

Examples

let query = session.query_builder()
    .match_pattern("(p:Person)")
    .where_clause("p.age > 25")
    .return_clause("p.name")
    .build()?;

assert_eq!(query, "MATCH (p:Person) WHERE p.age > 25 RETURN p.name");

pub fn execute(&self) -> Result<QueryResult>

Execute the query and return results

Builds and executes the query in one step.

Examples

let result = session.query_builder()
    .match_pattern("(p:Person)")
    .where_clause("p.age > 25")
    .return_clause("p.name, p.age")
    .limit(10)
    .execute()?;

for row in result.rows() {
    println!("{:?}", row);
}