Struct TermContext 

pub struct TermContext { /* private fields */ }

A managed DataFusion context for Term validation operations.

TermContext wraps DataFusion’s SessionContext and provides:

• Optimized default settings for data validation workloads
• Memory management with configurable limits
• Table registration helpers with tracking
• Automatic resource cleanup

Examples

use term_guard::core::TermContext;

// Create context with default settings
let ctx = TermContext::new()?;

// Register a table
ctx.register_csv("users", "data/users.csv").await?;

// Use the underlying SessionContext for queries
let df = ctx.inner().sql("SELECT COUNT(*) FROM users").await?;

Implementations

impl TermContext

pub fn new() -> Result<Self>

Creates a new context with default configuration.

Examples

use term_guard::core::TermContext;

let ctx = TermContext::new()?;

pub fn with_config(config: TermContextConfig) -> Result<Self>

Creates a new context with custom configuration.

Examples

use term_guard::core::{TermContext, TermContextConfig};

let config = TermContextConfig {
    batch_size: 16384,
    max_memory: 4 * 1024 * 1024 * 1024, // 4GB
    ..Default::default()
};

let ctx = TermContext::with_config(config)?;

pub fn inner(&self) -> &SessionContext

Returns a reference to the underlying DataFusion SessionContext.

This allows direct access to all DataFusion functionality while still benefiting from Term’s resource management.

Examples

let df = ctx.inner().sql("SELECT * FROM data").await?;

pub fn inner_mut(&mut self) -> &mut SessionContext

Returns a mutable reference to the underlying SessionContext.

pub fn config(&self) -> &TermContextConfig

Returns the configuration used to create this context.

pub fn registered_tables(&self) -> Vec<&str>

Returns the names of all registered tables.

Examples

let tables = ctx.registered_tables();
println!("Registered tables: {:?}", tables);

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

Checks if a table is registered.

Examples

if ctx.has_table("users") {
    println!("Users table is registered");
}

pub async fn register_csv(&mut self, name: &str, path: &str) -> Result<()>

Registers a CSV file as a table.

This is a convenience method that reads a CSV file and registers it as a table in the context.

Examples

let mut ctx = TermContext::new()?;
ctx.register_csv("users", "data/users.csv").await?;

pub async fn register_parquet(&mut self, name: &str, path: &str) -> Result<()>

Registers a Parquet file as a table.

Examples

let mut ctx = TermContext::new()?;
ctx.register_parquet("events", "data/events.parquet").await?;

pub fn deregister_table(&mut self, name: &str) -> Result<()>

Deregisters a table from the context.

Examples

ctx.deregister_table("users")?;

pub async fn register_table_provider( &mut self, name: &str, provider: Arc<dyn TableProvider>, ) -> Result<()>

Registers a table directly and tracks it.

This is a lower-level method that allows registering any TableProvider directly. The table is automatically tracked for cleanup.

Examples

ctx.register_table_provider("data", table).await?;

pub fn clear_tables(&mut self) -> Result<()>

Clears all registered tables.

This is useful for resetting the context between validation runs.

Examples

ctx.clear_tables()?;

Trait Implementations

impl Drop for TermContext

Ensure proper cleanup when the context is dropped.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.