Struct QueryTableRequest 

pub struct QueryTableRequest {

    pub identity: Option<Box<Identity>>,
    pub context: Option<HashMap<String, String>>,
    pub id: Option<Vec<String>>,
    pub branch: Option<String>,
    pub bypass_vector_index: Option<bool>,
    pub columns: Option<Box<QueryTableRequestColumns>>,
    pub distance_type: Option<String>,
    pub ef: Option<i32>,
    pub fast_search: Option<bool>,
    pub filter: Option<String>,
    pub full_text_query: Option<Box<QueryTableRequestFullTextQuery>>,
    pub k: i32,
    pub lower_bound: Option<f32>,
    pub nprobes: Option<i32>,
    pub offset: Option<i32>,
    pub prefilter: Option<bool>,
    pub refine_factor: Option<i32>,
    pub upper_bound: Option<f32>,
    pub vector: Box<QueryTableRequestVector>,
    pub vector_column: Option<String>,
    pub version: Option<i64>,
    pub with_row_id: Option<bool>,
}

Fields

identity: Option<Box<Identity>>

context: Option<HashMap<String, String>>

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation. On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller. REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix: - On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {\"header.Authorization\": \"Bearer abc\"} is sent as the request header Authorization: Bearer abc. - On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {\"header.x-request-id\": \"abc123\"}.

id: Option<Vec<String>>

branch: Option<String>

Branch to target. When not specified, the main branch is used.

bypass_vector_index: Option<bool>

Whether to bypass vector index

columns: Option<Box<QueryTableRequestColumns>>

distance_type: Option<String>

Distance metric to use

ef: Option<i32>

Search effort parameter for HNSW index

fast_search: Option<bool>

Whether to use fast search

filter: Option<String>

Optional SQL filter expression. Field references in the expression must use Lance field path syntax: nested fields use dot-separated segments, literal dots require backtick-quoted segments, and backticks inside quoted segments are doubled.

full_text_query: Option<Box<QueryTableRequestFullTextQuery>>

k: i32

Number of results to return

lower_bound: Option<f32>

Lower bound for search

nprobes: Option<i32>

Number of probes for IVF index

offset: Option<i32>

Number of results to skip

prefilter: Option<bool>

Whether to apply filtering before vector search

refine_factor: Option<i32>

Refine factor for search

upper_bound: Option<f32>

Upper bound for search

vector: Box<QueryTableRequestVector>

vector_column: Option<String>

Lance field path of the vector field to search. Nested fields use dot-separated segments; use backtick-quoted segments for literal dots and double backticks inside quoted segments. Use canonical full paths for display and errors; leaf names alone only identify top-level fields; invalid or unresolved paths should return InvalidInput or TableColumnNotFound.

version: Option<i64>

Table version to query

with_row_id: Option<bool>

If true, return the row id as a column called _rowid

Implementations

impl QueryTableRequest

pub fn new(k: i32, vector: QueryTableRequestVector) -> QueryTableRequest

Trait Implementations

impl Clone for QueryTableRequest

fn clone(&self) -> QueryTableRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryTableRequest

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

Formats the value using the given formatter.

impl Default for QueryTableRequest

fn default() -> QueryTableRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryTableRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<QueryTableRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QueryTableRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QueryTableRequest

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryTableRequest