Skip to main content

StorageBackend

Trait StorageBackend 

Source
pub trait StorageBackend:
    Send
    + Sync
    + 'static {
Show 16 methods // Required methods fn init<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait; fn prepare_sql<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn query_sql<'life0, 'life1, 'async_trait>( &'life0 self, statement_handle: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<RecordBatch, Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn new_with_options( connection_string: &str, options: &HashMap<String, String>, credentials: Option<&Credentials>, ) -> Result<Self, Status> where Self: Sized; fn create_table<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table_name: &'life1 str, schema: &'life2 Schema, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait; fn insert_into_table<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, batch: RecordBatch, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn create_view<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, definition: ViewDefinition, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn get_view<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ViewMetadata, Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn list_views<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Status>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait; fn list_tables<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Status>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait; fn get_table_schema<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Arc<Schema>, Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn drop_view<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn drop_table<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait; fn export_to_parquet<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table_name: &'life1 str, path: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait; fn import_from_parquet<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table_name: &'life1 str, path: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait; // Provided method fn execute_ddl<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait { ... }
}
Expand description

Storage backend trait for SQL database operations.

Required Methods§

Source

fn init<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Initialize the storage backend.

Source

fn prepare_sql<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Prepare a SQL query and return a handle. The handle can be used with query_sql to execute the prepared statement.

Source

fn query_sql<'life0, 'life1, 'async_trait>( &'life0 self, statement_handle: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<RecordBatch, Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Execute a prepared SQL query using its handle. Returns results as an Arrow record batch.

Source

fn new_with_options( connection_string: &str, options: &HashMap<String, String>, credentials: Option<&Credentials>, ) -> Result<Self, Status>
where Self: Sized,

Create a new instance with the given options.

Source

fn create_table<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table_name: &'life1 str, schema: &'life2 Schema, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Create a new table with the given schema

Source

fn insert_into_table<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, batch: RecordBatch, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Insert a record batch into a table

Source

fn create_view<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, definition: ViewDefinition, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Create a view with the given definition

Source

fn get_view<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ViewMetadata, Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Get view metadata

Source

fn list_views<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

List all views

Source

fn list_tables<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

List all tables

Source

fn get_table_schema<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Arc<Schema>, Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Get schema for a table

Source

fn drop_view<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Drop a view

Source

fn drop_table<'life0, 'life1, 'async_trait>( &'life0 self, table_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Drop a table

Source

fn export_to_parquet<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table_name: &'life1 str, path: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Export a table to Parquet format

Source

fn import_from_parquet<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table_name: &'life1 str, path: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Import a table from Parquet format

Provided Methods§

Source

fn execute_ddl<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Execute a DDL/administrative statement that produces no rows (e.g. ALTER TABLE ...). The default routes through prepare/query; backends with a dedicated DDL path should override it.

Trait Implementations§

Source§

impl AsRef<dyn StorageBackend> for StorageBackendType

Source§

fn as_ref(&self) -> &(dyn StorageBackend + 'static)

Converts this type into a shared reference of the (usually inferred) input type.

Implementors§