Skip to main content

IncludeRelation

Struct IncludeRelation 

Source
pub struct IncludeRelation {
    pub where_: Option<Expr>,
    pub order_by: Vec<OrderBy>,
    pub take: Option<i32>,
    pub skip: Option<u32>,
    pub cursor: Option<HashMap<String, Value>>,
    pub distinct: Vec<String>,
    pub include: HashMap<String, IncludeRelation>,
}
Expand description

Arguments for eagerly loading a single relation in a query.

include: { posts: { where: { published: true } } }

Fields§

§where_: Option<Expr>

Optional filter to apply to the included child records.

§order_by: Vec<OrderBy>

ORDER BY clauses to apply to the included child records.

§take: Option<i32>

Maximum number of child rows to include.

§skip: Option<u32>

Number of child rows to skip.

§cursor: Option<HashMap<String, Value>>

Optional cursor for child pagination.

§distinct: Vec<String>

Columns to deduplicate child rows on.

§include: HashMap<String, IncludeRelation>

Nested relations to include under this child relation.

Implementations§

Source§

impl IncludeRelation

Source

pub fn plain() -> Self

Create a plain include with no child filter.

Source

pub fn with_filter(filter: Expr) -> Self

Create an include with a child filter.

Source

pub fn with_order_by(self, order: OrderBy) -> Self

Append an ORDER BY clause for the included child records.

Source

pub fn with_take(self, take: i32) -> Self

Set the child LIMIT.

Source

pub fn with_skip(self, skip: u32) -> Self

Set the child OFFSET.

Source

pub fn with_cursor(self, cursor: HashMap<String, Value>) -> Self

Set the child cursor.

Source

pub fn with_distinct(self, distinct: Vec<String>) -> Self

Set child DISTINCT columns.

Source

pub fn with_include( self, relation: impl Into<String>, include: IncludeRelation, ) -> Self

Add a nested relation include.

Trait Implementations§

Source§

impl Clone for IncludeRelation

Source§

fn clone(&self) -> IncludeRelation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IncludeRelation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IncludeRelation

Source§

fn default() -> IncludeRelation

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.