Struct GraphqlSelect 

pub struct GraphqlSelect { /* private fields */ }

GraphQL query builder — produces a query document + variables map.

Construct via GraphqlSelect::new and the chainable with_* builders, or through the Selectable trait (table.select()). Designed to be generic in shape: most servers wrap their list field with a filter arg (where:, find:, …) plus pagination args, and the renderer handles both dialects shipped here.

Grouping and DISTINCT have no GraphQL spelling: the Selectable methods for them are no-ops.

Implementations

impl GraphqlSelect

pub fn with_root_field(self, name: impl Into<String>) -> Self

Set the root field on the Query type (launches).

pub fn with_operation_name(self, name: impl Into<String>) -> Self

Name the operation: query <name>(…) { … }.

pub fn with_dialect(self, dialect: FilterDialect) -> Self

Pick the dialect conditions render in.

pub fn with_filter_arg_name(self, name: impl Into<String>) -> Self

Override the filter argument name (the dialect’s where / find).

pub fn with_field(self, name: impl Into<String>) -> Self

Add a terminal (scalar) field to the selection set. A dotted path (rocket.name) renders as a nested selection.

pub fn with_root_args(self, args: Value) -> Self

Literal arguments always passed to the root field. Expects a JSON object; anything else is ignored at render time.

pub fn with_response_path(self, path: Vec<String>) -> Self

Envelope the rows sit inside — ["edges", "node"] wraps the selection set in edges { node { … } }.

pub fn with_sub_selection( self, name: impl Into<String>, child: GraphqlSelect, ) -> Self

Add a nested selection set under name, rendered with its own inline filter and paging arguments.

pub fn with_condition(self, condition: GraphqlCondition) -> Self

Add a condition; every condition is ANDed into the filter argument.

pub fn with_order(self, field: impl Into<String>, order: Order) -> Self

Add a sort key (rendered as order_by: on Hasura only).

pub fn with_limit(self, limit: Option<i64>, skip: Option<i64>) -> Self

Set the page size and offset, sent as $limit / $offset.

impl GraphqlSelect

pub async fn render(&self) -> Result<RenderedQuery>

Produce a (query, variables) pair. Async because conditions may carry Deferred branches that resolve at fetch time.

Every name spliced into the document is checked against the GraphQL Name grammar first; an invalid one is an error, never a request.

pub fn preview(&self) -> String

The document render would produce, built synchronously so it can be shown without sending anything.

Mirrors render arm for arm — same filter, same order, same selection set, same response envelope — and differs in exactly two ways, both forced by not being allowed to do any work:

1. A deferred condition renders as a **deferred(...) marker rather than being awaited. Resolving one means asking the caller for a value that only exists mid-fetch.
2. Pagination is inlined (limit: 5) instead of going through the $limit variable, so the document reads standalone. The server is told the same numbers either way.

Everything else is the query that gets sent, and pastes into a GraphQL client as-is.

impl GraphqlSelect

pub fn new() -> Self

An empty select: no root field, no fields, Generic dialect.

pub fn root_field(&self) -> Option<&str>

The root field on the Query type, once set.

pub fn fields(&self) -> &[String]

The selected field paths, in selection order.

pub fn conditions(&self) -> &[GraphqlCondition]

The conditions combined into the filter argument.

pub fn dialect(&self) -> FilterDialect

The filter dialect conditions render in.

Trait Implementations

impl Clone for GraphqlSelect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphqlSelect

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

Formats the value using the given formatter.

impl Default for GraphqlSelect

fn default() -> Self

Returns the “default value” for a type.

impl Expressive<AnyGraphqlType> for GraphqlSelect

fn expr(&self) -> Expression<AnyGraphqlType>

Convert this construct into an Expression<T>.

fn preview(&self) -> String

where T: Debug + Display,

Preview the expression as a formatted string.

impl Selectable<AnyGraphqlType, GraphqlCondition> for GraphqlSelect

fn set_distinct(&mut self, _distinct: bool)

No GraphQL spelling: ignored.

fn add_group_by(&mut self, _expression: impl Expressive<AnyGraphqlType>)

No GraphQL spelling: ignored.

fn add_source( &mut self, source: impl Into<SourceRef<AnyGraphqlType>>, _alias: Option<String>, )

Adds a data source to the FROM clause (table name, subquery, etc.). This is additive — calling it multiple times adds comma-separated sources.

fn add_field(&mut self, field: impl Into<String>)

Adds a column name to the SELECT clause.

fn add_expression(&mut self, _expression: impl Expressive<AnyGraphqlType>)

Adds a complex expression to the SELECT clause.

fn add_where_condition(&mut self, condition: impl Into<GraphqlCondition>)

Adds a condition to the WHERE clause.

fn add_order_by(&mut self, order: impl Into<GraphqlCondition>, direction: Order)

Adds an ORDER BY clause with direction and optional null handling.

fn set_limit(&mut self, limit: Option<i64>, skip: Option<i64>)

Sets LIMIT and OFFSET for result pagination.

fn clear_fields(&mut self)

Removes all fields from the SELECT clause.

fn clear_where_conditions(&mut self)

Removes all WHERE conditions.

fn clear_order_by(&mut self)

Removes all ORDER BY clauses.

fn clear_group_by(&mut self)

Removes all GROUP BY clauses.

fn has_fields(&self) -> bool

Returns true if any fields have been added to SELECT clause.

fn has_where_conditions(&self) -> bool

Returns true if any WHERE conditions have been added.

fn has_order_by(&self) -> bool

Returns true if any ORDER BY clauses have been added.

fn has_group_by(&self) -> bool

Returns true if any GROUP BY clauses have been added.

fn is_distinct(&self) -> bool

Returns true if DISTINCT mode is enabled.

fn get_limit(&self) -> Option<i64>

Returns the current LIMIT value, if set.

fn get_skip(&self) -> Option<i64>

Returns the current OFFSET/SKIP value, if set.

fn as_field(&self, _field: impl Into<String>) -> Expression<AnyGraphqlType>

Creates a single-field subquery expression from this query configuration.

fn as_count(&self) -> Expression<AnyGraphqlType>

Creates a COUNT(*) expression from this query configuration.

fn as_sum( &self, column: impl Expressive<AnyGraphqlType>, ) -> Expression<AnyGraphqlType>

Creates a SUM(column) expression from this query configuration.

fn as_max( &self, column: impl Expressive<AnyGraphqlType>, ) -> Expression<AnyGraphqlType>

Creates a MAX(column) expression from this query configuration.

fn as_min( &self, column: impl Expressive<AnyGraphqlType>, ) -> Expression<AnyGraphqlType>

Creates a MIN(column) expression from this query configuration.

fn with_source(self, source: impl Into<SourceRef<T>>) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_source without alias.

fn with_source_as( self, source: impl Into<SourceRef<T>>, alias: impl Into<String>, ) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_source with alias.

fn with_condition(self, condition: impl Into<C>) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_where_condition.

fn with_order(self, order: impl Into<C>, direction: Order) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_order_by.

fn with_field(self, field: impl Into<String>) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_field.

fn with_expression(self, expression: impl Expressive<T>) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_expression.

fn with_group_by(self, expression: impl Expressive<T>) -> Self

where Self: Sized,

Builder pattern method identical to Self::add_group_by.

fn with_distinct(self, distinct: bool) -> Self

where Self: Sized,

Builder pattern method identical to Self::set_distinct.

fn with_limit(self, limit: Option<i64>, skip: Option<i64>) -> Self

where Self: Sized,

Builder pattern method identical to Self::set_limit.