Struct ReadPlan 

pub struct ReadPlan {
    pub select: Vec<CoercibleSelectField>,
    pub from: QualifiedIdentifier,
    pub from_alias: Option<String>,
    pub where_clauses: Vec<CoercibleLogicTree>,
    pub order: Vec<CoercibleOrderTerm>,
    pub range: Range,
    pub rel_name: String,
    pub rel_to_parent: Option<Relationship>,
    pub rel_join_conds: Vec<JoinCondition>,
    pub rel_join_type: Option<JoinType>,
    pub rel_select: Vec<RelSelectField>,
    pub depth: u32,
}

A read plan for a single table/view.

Fields

select: Vec<CoercibleSelectField>

Columns to select

from: QualifiedIdentifier

Source table

from_alias: Option<String>

Table alias

where_clauses: Vec<CoercibleLogicTree>

WHERE conditions

order: Vec<CoercibleOrderTerm>

ORDER BY terms

range: Range

Pagination range

rel_name: String

Relation name (for embedding)

rel_to_parent: Option<Relationship>

Relationship to parent (if embedded)

rel_join_conds: Vec<JoinCondition>

Join conditions

rel_join_type: Option<JoinType>

Join type

rel_select: Vec<RelSelectField>

Embedded relations to select

depth: u32

Nesting depth

Implementations

impl ReadPlan

pub fn from_request( request: &ApiRequest, table: &Table, schema_cache: &SchemaCache, ) -> Result<Self>

Create a read plan from an API request.

pub fn for_mutation( request: &ApiRequest, table: &Table, schema_cache: &SchemaCache, ) -> Result<Self>

Create a read plan for returning mutation results.

pub fn has_where(&self) -> bool

Check if this plan has any where clauses.

pub fn has_order(&self) -> bool

Check if this plan has any order terms.

pub fn has_pagination(&self) -> bool

Check if this plan has pagination.

Trait Implementations

impl Clone for ReadPlan

fn clone(&self) -> ReadPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadPlan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ReadPlan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.