Struct BitmapIndexPlugin 

pub struct BitmapIndexPlugin;

Implementations

impl BitmapIndexPlugin

pub async fn train_bitmap_index( data: SendableRecordBatchStream, index_store: &dyn IndexStore, ) -> Result<()>

Trait Implementations

impl Debug for BitmapIndexPlugin

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

Formats the value using the given formatter.

impl Default for BitmapIndexPlugin

fn default() -> BitmapIndexPlugin

Returns the “default value” for a type.

impl ScalarIndexPlugin for BitmapIndexPlugin

fn load_index<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, index_store: Arc<dyn IndexStore>, _index_details: &'life1 Any, frag_reuse_index: Option<Arc<FragReuseIndex>>, cache: &'life2 LanceCache, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn ScalarIndex>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Load an index from storage

fn name(&self) -> &str

A short name for the index

fn new_training_request( &self, _params: &str, field: &Field, ) -> Result<Box<dyn TrainingRequest>>

Creates a new training request from the given parameters

fn provides_exact_answer(&self) -> bool

Returns true if the index returns an exact answer (e.g. not AtMost)

fn version(&self) -> u32

The version of the index plugin

fn new_query_parser( &self, index_name: String, _index_details: &Any, ) -> Option<Box<dyn ScalarQueryParser>>

Returns a new query parser for the index

fn train_index<'life0, 'life1, 'async_trait>( &'life0 self, data: SendableRecordBatchStream, index_store: &'life1 dyn IndexStore, _request: Box<dyn TrainingRequest>, fragment_ids: Option<Vec<u32>>, ) -> Pin<Box<dyn Future<Output = Result<CreatedIndex>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Train a new index

fn load_statistics<'life0, 'life1, 'async_trait>( &'life0 self, index_store: Arc<dyn IndexStore>, _index_details: &'life1 Any, ) -> Pin<Box<dyn Future<Output = Result<Option<Value>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Optional hook allowing a plugin to provide statistics without loading the index.

fn attach_registry(&self, _registry: Arc<IndexPluginRegistry>)

Optional hook that plugins can use if they need to be aware of the registry

fn details_as_json(&self, _details: &Any) -> Result<Value>

Returns a JSON string representation of the provided index details