Struct SQLSchemaProvider 

pub struct SQLSchemaProvider { /* private fields */ }

An in-memory schema provider for SQL tables.

Implementations

impl SQLSchemaProvider

pub async fn new(provider: Arc<SQLFederationProvider>) -> Result<Self>

Creates a new SQLSchemaProvider from a SQLFederationProvider. Initializes the schema provider by fetching table names and schema from the federation provider’s executor,

pub async fn new_with_tables<T: AsRef<str>>( provider: Arc<SQLFederationProvider>, tables: impl IntoIterator<Item = T>, ) -> Result<Self>

Creates a new SQLSchemaProvider from a SQLFederationProvider and a list of table references. Fetches the schema for each table using the executor’s implementation.

pub fn new_with_custom_tables( provider: Arc<SQLFederationProvider>, tables: Vec<Arc<dyn SQLTable>>, ) -> Self

Creates a new SQLSchemaProvider from a SQLFederationProvider and a list of custom table instances.

pub async fn new_with_table_references( provider: Arc<SQLFederationProvider>, tables: Vec<RemoteTableRef>, ) -> Result<Self>

Trait Implementations

impl Debug for SQLSchemaProvider

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

Formats the value using the given formatter.

impl SchemaProvider for SQLSchemaProvider

fn as_any(&self) -> &dyn Any

Returns this SchemaProvider as Any so that it can be downcast to a specific implementation.

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 = Result<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.