Skip to main content

RelationBuilder

Struct RelationBuilder 

Source
pub struct RelationBuilder<E>
where E: Entity + Clone + Send + Sync,
{ /* private fields */ }
Expand description

Builder for loading relationships on entities

This builder provides a fluent API for loading relationships with automatic batching to prevent N+1 queries.

§Example

use ormkit::relations::{RelationBuilder, BelongsTo, Loaded};

// Load users for posts
let posts_with_users = RelationBuilder::for_entities(posts)
    .load::<User>(&pool)
    .await?;

for post_with_user in posts_with_users {
    let post = post_with_user.entity();
    let user = post_with_user.relation();
    println!("Post: {:?}, User: {:?}", post, user);
}

Implementations§

Source§

impl<E> RelationBuilder<E>
where E: Entity + Clone + Send + Sync,

Source

pub fn for_entities(entities: Vec<E>) -> Self

Create a new RelationBuilder for the given entities

§Arguments
  • entities - The entities to load relationships for
Source

pub fn with_strategy(self, strategy: LoadStrategy) -> Self

Set the loading strategy

§Arguments
  • strategy - The loading strategy to use
Source

pub async fn load_belongs_to<P>( self, pool: &PgPool, ) -> Result<Vec<Loaded<E, Option<P>>>, LoadError>
where E: BelongsTo<P>, P: Entity + Debug + Clone + for<'r> FromRow<'r, PgRow> + Send + Unpin,

Load a BelongsTo relationship

§Type Parameters
  • P - The parent entity type
§Arguments
  • pool - The database connection pool
§Returns

A vector of entities with loaded parent relationships

Source

pub async fn load_has_many<C>( self, pool: &PgPool, ) -> Result<Vec<Loaded<E, HasManyLoaded<C>>>, LoadError>
where E: HasMany<C>, C: Entity + Debug + Clone + for<'r> FromRow<'r, PgRow> + Send + Unpin,

Load a HasMany relationship

§Type Parameters
  • C - The child entity type
§Arguments
  • pool - The database connection pool
§Returns

A vector of entities with loaded children relationships

Source

pub async fn load<P>( self, pool: &PgPool, ) -> Result<Vec<Loaded<E, Option<P>>>, LoadError>
where E: BelongsTo<P>, P: Entity + Debug + Clone + for<'r> FromRow<'r, PgRow> + Send + Unpin,

Generic load method that infers the relationship type

This is a convenience method that attempts to infer the relationship type based on the trait bounds

Auto Trait Implementations§

§

impl<E> Freeze for RelationBuilder<E>

§

impl<E> RefUnwindSafe for RelationBuilder<E>
where E: RefUnwindSafe,

§

impl<E> Send for RelationBuilder<E>

§

impl<E> Sync for RelationBuilder<E>

§

impl<E> Unpin for RelationBuilder<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for RelationBuilder<E>

§

impl<E> UnwindSafe for RelationBuilder<E>
where E: UnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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