Struct QueryDefinition 

pub struct QueryDefinition {
    pub name: String,
    pub return_type: String,
    pub returns_list: bool,
    pub nullable: bool,
    pub arguments: Vec<ArgumentDefinition>,
    pub sql_source: Option<String>,
    pub description: Option<String>,
    pub auto_params: AutoParams,
    pub deprecation: Option<DeprecationInfo>,
    pub jsonb_column: String,
}

A query definition compiled from @fraiseql.query.

Queries are declarative bindings to database views/tables. They describe what to fetch, not how to fetch it.

Example

use fraiseql_core::schema::{QueryDefinition, AutoParams};

let query = QueryDefinition {
    name: "users".to_string(),
    return_type: "User".to_string(),
    returns_list: true,
    nullable: false,
    arguments: vec![],
    sql_source: Some("v_user".to_string()),
    description: Some("Get all users".to_string()),
    auto_params: AutoParams::default(),
    deprecation: None,
    jsonb_column: "data".to_string(),
};

Fields

name: String

Query name (e.g., “users”).

return_type: String

Return type name (e.g., “User”).

returns_list: bool

Does this query return a list?

nullable: bool

Is the return value nullable?

arguments: Vec<ArgumentDefinition>

Query arguments.

sql_source: Option<String>

SQL source table/view (for direct table queries).

description: Option<String>

Description.

auto_params: AutoParams

Auto-wired parameters (where, orderBy, limit, offset).

deprecation: Option<DeprecationInfo>

Deprecation information (from @deprecated directive). When set, this query is marked as deprecated in the schema.

jsonb_column: String

JSONB column name (e.g., “data”). Used to extract data from JSONB columns in query results.

Implementations

impl QueryDefinition

pub fn new(name: impl Into<String>, return_type: impl Into<String>) -> Self

Create a new query definition.

pub fn returning_list(self) -> Self

Set this query to return a list.

pub fn with_sql_source(self, source: impl Into<String>) -> Self

Set the SQL source.

pub fn deprecated(self, reason: Option<String>) -> Self

Mark this query as deprecated.

Example

use fraiseql_core::schema::QueryDefinition;

let query = QueryDefinition::new("oldUsers", "User")
    .deprecated(Some("Use 'users' instead".to_string()));
assert!(query.is_deprecated());

pub fn is_deprecated(&self) -> bool

Check if this query is deprecated.

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

Get the deprecation reason if deprecated.

Trait Implementations

impl Clone for QueryDefinition

fn clone(&self) -> QueryDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QueryDefinition

fn eq(&self, other: &QueryDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for QueryDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryDefinition