Struct ScanParameters

pub struct ScanParameters {
    pub columns: Vec<String>,
    pub on_missing_columns: i32,
    pub filter: Option<String>,
    pub limit_offset: Option<i64>,
    pub limit_len: Option<i64>,
    pub order_by: Option<ScanParametersOrderClause>,
    pub explain_plan: bool,
    pub explain_filter: bool,
}

Generic parameters that will influence the behavior of the Lance scanner.

TODO(zehiko, cmc): This should be available for every endpoint that queries data in one way or another.

Fields

columns: Vec<String>

List of columns to project. If empty, all columns will be projected.

on_missing_columns: i32

filter: Option<String>

An arbitrary filter expression that will be passed to the Lance scanner as-is.

scanner.filter(filter)

limit_offset: Option<i64>

An arbitrary offset that will be passed to the Lance scanner as-is.

scanner.limit(_, limit_offset)

limit_len: Option<i64>

An arbitrary limit that will be passed to the Lance scanner as-is.

scanner.limit(limit_len, _)

order_by: Option<ScanParametersOrderClause>

An arbitrary order clause that will be passed to the Lance scanner as-is.

scanner.order_by(…)

explain_plan: bool

If set, the output of scanner.explain_plan will be dumped to the server’s log.

explain_filter: bool

If set, the final scanner.filter will be dumped to the server’s log.

Implementations

impl ScanParameters

pub fn on_missing_columns(&self) -> IfMissingBehavior

Returns the enum value of on_missing_columns, or the default if the field is set to an invalid enum value.

pub fn set_on_missing_columns(&mut self, value: IfMissingBehavior)

Sets on_missing_columns to the provided enum value.

pub fn filter(&self) -> &str

Returns the value of filter, or the default value if filter is unset.

pub fn limit_offset(&self) -> i64

Returns the value of limit_offset, or the default value if limit_offset is unset.

pub fn limit_len(&self) -> i64

Returns the value of limit_len, or the default value if limit_len is unset.

Trait Implementations

impl Clone for ScanParameters

fn clone(&self) -> ScanParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScanParameters

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

Formats the value using the given formatter.

impl Default for ScanParameters

fn default() -> Self

Returns the “default value” for a type.

impl From<ScanParameters> for ScanParameters

fn from(value: ScanParameters) -> Self

Converts to this type from the input type.

impl Message for ScanParameters

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for ScanParameters

const NAME: &'static str = "ScanParameters"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "rerun.common.v1alpha1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for ScanParameters

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<ScanParameters> for ScanParameters

type Error = Status

The type returned in the event of a conversion error.

fn try_from(value: ScanParameters) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ScanParameters