Struct ScrollRequest 

pub struct ScrollRequest {
    pub offset: Option<ExtendedPointId>,
    pub limit: Option<usize>,
    pub filter: Option<Filter>,
    pub with_payload: Option<WithPayloadInterface>,
    pub with_vector: WithVector,
    pub order_by: Option<OrderByInterface>,
}

Scroll request — paginate over all points which match the given conditions.

Fields

offset: Option<ExtendedPointId>

Start ID to read points from.

limit: Option<usize>

Page size. Default: 10.

filter: Option<Filter>

Look only for points which satisfy these conditions. If not provided — all points.

with_payload: Option<WithPayloadInterface>

Select which payload to return with the response. Default is true.

with_vector: WithVector

Options for specifying which vectors to include into the response. Default is false.

order_by: Option<OrderByInterface>

Order the records by a payload field instead of by id.

Implementations

impl ScrollRequest

pub fn new() -> Self

pub fn load_profile(&self) -> LoadProfile

Request-specific LoadProfile for opening a read-only shard to serve exactly this scroll: no vector components are warmed, and only the field indexes the filter and order_by read keep their configured placement.

Trait Implementations

impl Clone for ScrollRequest

fn clone(&self) -> ScrollRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollRequest

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

Formats the value using the given formatter.

impl Default for ScrollRequest

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ScrollRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScrollRequest