Struct OpenSearchSchemaProvider 

pub struct OpenSearchSchemaProvider { /* private fields */ }

One OpenSearch cluster as a DataFusion schema: every non-system index is a table whose Arrow schema is derived from its _mapping the first time it is referenced (and cached). SHOW TABLES lists them when the session has information_schema enabled.

use std::sync::Arc;
use datafusion::prelude::SessionContext;
use datafusion_opensearch::{OpenSearchClient, OpenSearchSchemaProvider};

let ctx = SessionContext::new();
let os = OpenSearchSchemaProvider::connect(OpenSearchClient::new("http://localhost:9200")).await?;
ctx.catalog("datafusion").unwrap().register_schema("os", Arc::new(os))?;
ctx.sql("SELECT count(*) FROM os.\"my-index\"").await?.show().await?;

Implementations

impl OpenSearchSchemaProvider

pub async fn connect(client: OpenSearchClient) -> Result<Self>

List the cluster’s indices now; tables are built lazily on first reference.

pub async fn refresh(&self) -> Result<()>

Re-list the indices and drop cached tables for indices that no longer exist.

pub fn client(&self) -> &OpenSearchClient

The client the schema talks through.

Trait Implementations

impl Debug for OpenSearchSchemaProvider

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

Formats the value using the given formatter.

impl SchemaProvider for OpenSearchSchemaProvider

fn table_names(&self) -> Vec<String>

Retrieves the list of available table names in this schema.

fn table<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = DataFusionResult<Option<Arc<dyn TableProvider>>>> + Send + 'async_trait>>

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

Retrieves a specific table from the schema by name, if it exists, otherwise returns None.

fn table_exist(&self, name: &str) -> bool

Returns true if table exist in the schema provider, false otherwise.

fn owner_name(&self) -> Option<&str>

Returns the owner of the Schema, default is None. This value is reported as part of `information_tables.schemata

fn table_type<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<TableType>, DataFusionError>> + Send + 'async_trait>>

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

Retrieves the type of a specific table from the schema by name, if it exists, otherwise returns None. Implementations for which this operation is cheap but Self::table is expensive can override this to improve operations that only need the type, e.g. SELECT * FROM information_schema.tables.

fn register_table( &self, name: String, table: Arc<dyn TableProvider>, ) -> Result<Option<Arc<dyn TableProvider>>, DataFusionError>

If supported by the implementation, adds a new table named name to this schema.

fn deregister_table( &self, name: &str, ) -> Result<Option<Arc<dyn TableProvider>>, DataFusionError>

If supported by the implementation, removes the name table from this schema and returns the previously registered TableProvider, if any.