Skip to main content

QueryBuilder

Struct QueryBuilder 

Source
pub struct QueryBuilder { /* private fields */ }
Expand description

Builder for GraphQL collection queries.

Produces Relay-style connection queries against pg_graphql.

§Example

let connection = client.collection("blogCollection")
    .select(&["id", "title", "createdAt"])
    .filter(GqlFilter::eq("status", "published"))
    .order_by("createdAt", OrderByDirection::DescNullsLast)
    .first(10)
    .total_count()
    .execute::<BlogRow>().await?;

Implementations§

Source§

impl QueryBuilder

Source

pub fn select(self, fields: &[&str]) -> Self

Set the fields to select in each node.

Source

pub fn filter(self, filter: GqlFilter) -> Self

Set a filter condition.

Source

pub fn order_by(self, column: &str, direction: OrderByDirection) -> Self

Add an order-by clause.

Source

pub fn first(self, n: i64) -> Self

Limit results to the first N items (forward pagination).

Source

pub fn last(self, n: i64) -> Self

Limit results to the last N items (backward pagination).

Source

pub fn after(self, cursor: &str) -> Self

Set the cursor for forward pagination.

Source

pub fn before(self, cursor: &str) -> Self

Set the cursor for backward pagination.

Source

pub fn offset(self, n: i64) -> Self

Set the offset for pagination.

Source

pub fn total_count(self) -> Self

Include the totalCount field in the response.

Source

pub fn build(&self) -> (String, Value)

Build the query string and variables without executing.

Returns (query_string, variables) for inspection or debugging.

Source

pub async fn execute<T: DeserializeOwned>( self, ) -> Result<Connection<T>, GraphqlError>

Execute the query and return a typed Connection<T>.

The response data field is expected to have the shape: { "collectionName": { "edges": [...], "pageInfo": {...}, "totalCount": ... } }

Trait Implementations§

Source§

impl Debug for QueryBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more