Struct CreateTableIndexRequest 

pub struct CreateTableIndexRequest {

    pub identity: Option<Box<Identity>>,
    pub context: Option<HashMap<String, String>>,
    pub id: Option<Vec<String>>,
    pub branch: Option<String>,
    pub column: String,
    pub index_type: String,
    pub name: Option<String>,
    pub distance_type: Option<String>,
    pub num_partitions: Option<i32>,
    pub num_sub_vectors: Option<i32>,
    pub num_bits: Option<i32>,
    pub sample_rate: Option<i32>,
    pub max_iterations: Option<i32>,
    pub target_partition_size: Option<i32>,
    pub m: Option<i32>,
    pub ef_construction: Option<i32>,
    pub with_position: Option<bool>,
    pub base_tokenizer: Option<String>,
    pub language: Option<String>,
    pub max_token_length: Option<i32>,
    pub lower_case: Option<bool>,
    pub stem: Option<bool>,
    pub remove_stop_words: Option<bool>,
    pub ascii_folding: 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.

column: String

Lance field path to create the index on. 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.

index_type: String

Type of index to create (e.g., BTREE, BITMAP, LABEL_LIST, IVF_FLAT, IVF_PQ, IVF_HNSW_SQ, FTS)

name: Option<String>

Optional name for the index. If not provided, a name will be auto-generated.

distance_type: Option<String>

Distance metric type for vector indexes (e.g., l2, cosine, dot)

num_partitions: Option<i32>

Optional vector index parameter for the number of IVF partitions. Applies to all IVF index types.

num_sub_vectors: Option<i32>

Optional vector index parameter for the number of PQ sub-vectors. Applies to IVF_PQ only.

num_bits: Option<i32>

Optional vector index parameter for the number of bits used by the quantizer.

sample_rate: Option<i32>

Optional vector index parameter for the per-partition sample rate used during IVF training.

max_iterations: Option<i32>

Optional vector index parameter for the maximum number of IVF k-means training iterations.

target_partition_size: Option<i32>

Optional vector index parameter for the target partition size. Alternative to num_partitions.

m: Option<i32>

Optional vector index parameter for the number of edges per node in the HNSW graph. Applies to HNSW index types.

ef_construction: Option<i32>

Optional vector index parameter for the number of candidates evaluated during HNSW graph construction. Applies to HNSW index types.

with_position: Option<bool>

Optional FTS parameter for position tracking

base_tokenizer: Option<String>

Optional FTS parameter for base tokenizer

language: Option<String>

Optional FTS parameter for language

max_token_length: Option<i32>

Optional FTS parameter for maximum token length

lower_case: Option<bool>

Optional FTS parameter for lowercase conversion

stem: Option<bool>

Optional FTS parameter for stemming

remove_stop_words: Option<bool>

Optional FTS parameter for stop word removal

ascii_folding: Option<bool>

Optional FTS parameter for ASCII folding

Implementations

impl CreateTableIndexRequest

pub fn new(column: String, index_type: String) -> CreateTableIndexRequest

Trait Implementations

impl Clone for CreateTableIndexRequest

fn clone(&self) -> CreateTableIndexRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTableIndexRequest

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

Formats the value using the given formatter.

impl Default for CreateTableIndexRequest

fn default() -> CreateTableIndexRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateTableIndexRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateTableIndexRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CreateTableIndexRequest

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 CreateTableIndexRequest