Struct QueryContext 

pub struct QueryContext<S = SessionContext>
where
    S: QuerySession,
{ /* private fields */ }

Query context for interactive data exploration.

Implementations

impl QueryContext<SessionContext>

pub fn new(registry: Arc<dyn ConnectorRegistry>) -> Self

Create a new query context backed by the provided connector registry.

impl<S> QueryContext<S>

where S: QuerySession,

pub fn with_session(session: S, registry: Arc<dyn ConnectorRegistry>) -> Self

Construct a query context from a custom session implementation.

pub fn session(&self) -> &SessionContext

Access the underlying DataFusion session.

pub async fn register( &self, connector_id: &str, ) -> Result<Vec<ConnectionMetadata>>

Register a connector to be queried

Errors

• If an error occurs while preparing the session.

pub async fn list_catalogs(&self) -> Vec<String>

List catalogs exposed by this connector.

pub async fn list_connectors(&self) -> Result<Vec<ConnectionMetadata>>

List available connectors.

Errors

• If an error occurs while listing connectors.

pub async fn list_registered(&self) -> Result<Vec<ConnectionMetadata>>

List available connectors.

Errors

• If an error occurs while listing connectors.

pub async fn list( &self, connector_id: &str, term: Option<&str>, ) -> Result<ListSummary>

List databases, or tables/files for a connector, if supported.

Errors

• If an error occurs while listing.

pub async fn execute_query( &self, connector_id: Option<&str>, sql: &str, ) -> Result<SendableRecordBatchStream>

Execute a SQL query through the provided connector.

Errors

• If an error occurs while executing the query.

Trait Implementations

impl<S> Clone for QueryContext<S>

where S: QuerySession + Clone,

fn clone(&self) -> QueryContext<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.