Skip to main content

TableClient

Struct TableClient 

Source
pub struct TableClient { /* private fields */ }
Expand description

Table-scoped CRUD operations.

Implementations§

Source§

impl TableClient

Source

pub fn model_name(&self) -> &str

The model name this client was opened with.

Source

pub fn table_name(&self) -> &str

The resolved physical table name.

Source

pub async fn find_many(&self, args: &FindManyArgs) -> Result<Vec<RowMap>>

Fetch rows matching the structured args.

Source

pub async fn find_first(&self, args: &FindManyArgs) -> Result<Option<RowMap>>

First row matching the args, or None.

Source

pub async fn find_unique(&self, args: &FindManyArgs) -> Result<Option<RowMap>>

Single row matching unique criteria.

Source

pub async fn count(&self, args: &CountArgs) -> Result<i64>

Total number of matching rows.

Source

pub async fn create(&self, data: &RowMap) -> Result<RowMap>

Insert one row and return it.

Uses the dialect’s returning clause (OUTPUT INSERTED.* on SQL Server, RETURNING * on PostgreSQL/SQLite) so database-generated columns such as an auto-increment id come back populated. Falls back to the submitted values when the engine does not support it.

Source

pub async fn create_many(&self, data: &[RowMap]) -> Result<u64>

Insert many rows, returning the number inserted.

Source

pub async fn update(&self, args: &UpdateArgs) -> Result<u64>

Update rows matching where with data.

Source

pub async fn update_many(&self, args: &UpdateManyArgs) -> Result<u64>

Alias of update kept for API parity with the other adapters.

Source

pub async fn delete_many(&self, args: &DeleteManyArgs) -> Result<u64>

Delete rows matching where.

Source

pub async fn upsert(&self, args: &UpsertArgs) -> Result<RowMap>

Update when a match exists, otherwise insert.

Source

pub async fn aggregate(&self, args: &AggregateArgs) -> Result<RowMap>

Aggregations over matching rows.

Source

pub async fn group_by(&self, args: &GroupByArgs) -> Result<Vec<RowMap>>

Group rows by one or more columns.

Vector similarity search.

Tries the database’s native distance function first and falls back to in-memory scoring when the engine does not provide one, mirroring the behaviour of the Go and TypeScript adapters.

Source

pub fn resolve_select_relations<'a>( &'a self, rows: &'a mut [RowMap], select: &'a Value, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>>

Eager-loads the requested relations onto each row.

Boxed because eager loading re-enters find_many on the related table, which would otherwise make this future infinitely sized.

Trait Implementations§

Source§

impl Clone for TableClient

Source§

fn clone(&self) -> Self

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

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> 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<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