Struct RepositoryOptions 

pub struct RepositoryOptions<U = NoUser>
where
    U: BaseEntity + Clone + Send + Sync + 'static,
{
    pub limit: usize,
    pub cursor: Option<String>,
    pub distinct: bool,
    pub detach: bool,
    pub user: Option<U>,
    pub user_id: Option<i64>,
    pub correlation: Option<Arc<CorrelationContext>>,
    pub txn: Option<Arc<DatabaseTransaction>>,
}

Per-request settings for repository queries.

U is the caller identity type and must implement BaseEntity; it defaults to NoUser. An identity can be supplied either as a full entity (user) or as a raw id (user_id).

An optional database transaction can be attached via RepositoryOptions::with_transaction. When present, repository operations run against that transaction; otherwise they use the repository’s own connection.

Fields

limit: usize

Maximum rows for limited reads; default is 15.

cursor: Option<String>

Opaque cursor from a previous page, if continuing pagination.

distinct: bool

Whether selects use SELECT DISTINCT.

detach: bool

Detach flag carried alongside the query; default is true.

user: Option<U>

Caller identity as an entity, if supplied.

user_id: Option<i64>

Caller identity as a raw id, if supplied.

correlation: Option<Arc<CorrelationContext>>

Request correlation propagated with the query, if supplied.

txn: Option<Arc<DatabaseTransaction>>

Optional transaction used as the query executor when set.

Held behind an Arc so the options stay cheaply cloneable even though DatabaseTransaction itself is neither Clone nor Send-free to move. Share with Arc::new(txn) — note a begun transaction cannot be cloned out of SeaORM, so callers typically wrap it at begin time (see RepositoryOptions::with_transaction).

Implementations

impl<U> RepositoryOptions<U>

where U: BaseEntity + Clone + Send + Sync + 'static,

pub fn new() -> Self

Creates options with defaults: limit 15, no cursor, distinct false, detach true.

pub fn with_limit(self, limit: usize) -> Self

Sets the maximum rows for limited reads.

pub fn with_cursor(self, cursor: impl Into<String>) -> Self

Sets the pagination cursor to continue from.

pub fn with_user(self, user: U) -> Self

Sets the caller identity as an entity; also records its id as user_id.

pub fn with_user_id(self, user_id: i64) -> Self

Sets the caller identity as a raw id without an entity.

pub fn with_correlation(self, ctx: Arc<CorrelationContext>) -> Self

Attaches request correlation context to the options.

pub fn distinct(self) -> Self

Enables SELECT DISTINCT for the query.

pub fn with_detach(self, detach: bool) -> Self

Sets the detach flag carried alongside the query.

pub fn with_transaction(self, txn: Arc<DatabaseTransaction>) -> Self

Attaches a transaction used as the executor for database operations.

When set, repository methods run against this transaction instead of the repository’s own connection. When unset, they fall back to the repository connection.

pub fn with_txn(self, txn: Arc<DatabaseTransaction>) -> Self

Alias for RepositoryOptions::with_transaction.

pub fn without_transaction(self) -> Self

Removes any attached transaction, restoring execution on the repository connection.

pub fn transaction(&self) -> Option<&DatabaseTransaction>

Returns the attached transaction, if any.

pub fn has_transaction(&self) -> bool

Returns true when a transaction is attached.

pub fn user_id(&self) -> Option<i64>

Returns the effective caller id: user_id when set, else the user entity id.

pub fn join(self, other: Self) -> Self

Overlays other on top of self, joining two parameter sets as you please.

Scalar fields (limit, distinct, detach) are taken from other; optional fields (cursor, user, user_id, correlation, txn) fall back to self when other leaves them unset. A replaced user entity clears a stale inherited user_id (the id is still derivable from the entity via RepositoryOptions::user_id).

Typical use: request-derived base joined with caller overrides — RepositoryOptions::from_ctx(ctx).join(RepositoryOptions::new().with_limit(50)).

impl RepositoryOptions<NoUser>

pub fn from_ctx(ctx: Arc<CorrelationContext>) -> Self

Builds options from the request context: pagination limit and cursor, the numeric user id when the context carries one, and the correlation itself. Join caller overrides on top via RepositoryOptions::join.

pub fn with_user_entity<U>(self, user: U) -> RepositoryOptions<U>

where U: BaseEntity + Clone + Send + Sync + 'static,

Replaces the NoUser identity with the given entity, keeping other settings.

Trait Implementations

impl<U> Clone for RepositoryOptions<U>

where U: BaseEntity + Clone + Send + Sync + 'static + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<U> Debug for RepositoryOptions<U>

where U: BaseEntity + Clone + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<U> Default for RepositoryOptions<U>

where U: BaseEntity + Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.