Skip to main content

ScrollStmt

Struct ScrollStmt 

Source
pub struct ScrollStmt {
    pub collection: String,
    pub limit: u64,
    pub filter: Option<Box<FilterExpr>>,
    pub after: Option<PointId>,
    pub order_by: Option<ScrollOrderBy>,
    pub shard_key: Option<ShardKey>,
    pub with_payload: Option<PayloadSelector>,
    pub with_vector: Option<VectorSelector>,
    pub limit_param: Option<String>,
    pub limit_span: Option<Span>,
}
Expand description

SCROLL FROM <collection> … LIMIT n — cursor-based point iteration.

Fields§

§collection: String

Collection to scroll.

§limit: u64

Maximum number of points per page.

§filter: Option<Box<FilterExpr>>

Optional WHERE filter.

§after: Option<PointId>

AFTER cursor — resume scrolling after this point ID.

§order_by: Option<ScrollOrderBy>

Optional ORDER BY payload ordering (OpenAPI order_by).

§shard_key: Option<ShardKey>

SHARD '<key>' routing key.

§with_payload: Option<PayloadSelector>

Optional WITH PAYLOAD selector. Defaults to all payload when None.

§with_vector: Option<VectorSelector>

Optional WITH VECTOR selector. Defaults to no vectors when None.

§limit_param: Option<String>

Optional limit parameter placeholder (:limit or ?).

§limit_span: Option<Span>

Source span of the limit parameter placeholder, if unbound.

Trait Implementations§

Source§

impl Clone for ScrollStmt

Source§

fn clone(&self) -> ScrollStmt

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 ScrollStmt

Source§

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

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

impl PartialEq for ScrollStmt

Source§

fn eq(&self, other: &ScrollStmt) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScrollStmt

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

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.