pub struct RangeScanBuilder { /* private fields */ }Expand description
A pending range_scan, created with OxiaClient::range_scan.
.await it for all matching records at once (bounded by the request
timeout), or call stream for an incremental,
ordered RangeScanStream with bounded memory and no overall deadline.
Implementations§
Source§impl RangeScanBuilder
impl RangeScanBuilder
Sourcepub fn partition_key(self, partition_key: impl Into<String>) -> Self
pub fn partition_key(self, partition_key: impl Into<String>) -> Self
Restricts the scan to the shard owning partition_key.
Sourcepub fn use_index(self, index_name: impl Into<String>) -> Self
pub fn use_index(self, index_name: impl Into<String>) -> Self
Scans the named secondary index instead of the primary key space.
Sourcepub fn include_internal_keys(self, include: bool) -> Self
pub fn include_internal_keys(self, include: bool) -> Self
Also returns Oxia’s internal keys (hidden by default).
Sourcepub async fn stream(self) -> Result<RangeScanStream, OxiaError>
pub async fn stream(self) -> Result<RangeScanStream, OxiaError>
Opens an incremental, ordered stream of the matching records.
Trait Implementations§
Source§impl Debug for RangeScanBuilder
impl Debug for RangeScanBuilder
Source§impl IntoFuture for RangeScanBuilder
impl IntoFuture for RangeScanBuilder
Source§type Output = Result<Vec<GetResult>, OxiaError>
type Output = Result<Vec<GetResult>, OxiaError>
The output that the future will produce on completion.
Source§type IntoFuture = Pin<Box<dyn Future<Output = <RangeScanBuilder as IntoFuture>::Output> + Send>>
type IntoFuture = Pin<Box<dyn Future<Output = <RangeScanBuilder as IntoFuture>::Output> + Send>>
Which kind of future are we turning this into?
Source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for RangeScanBuilder
impl !UnwindSafe for RangeScanBuilder
impl Freeze for RangeScanBuilder
impl Send for RangeScanBuilder
impl Sync for RangeScanBuilder
impl Unpin for RangeScanBuilder
impl UnsafeUnpin for RangeScanBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request