Struct LogicalPlan 

pub struct LogicalPlan {
    pub root: PlanNode,
    pub schema: GenomicSchema,
}

A lazy query plan that can be optimized before execution

LogicalPlan represents a series of operations (scan, filter, select, etc.) without actually performing them. This enables optimization passes that can reorder operations, combine filters, and push predicates down to readers.

Fields

root: PlanNode

The root node of the plan tree

schema: GenomicSchema

Schema information for this plan

Implementations

impl LogicalPlan

pub fn scan<P: Into<PathBuf>>(path: P, format: FileFormat) -> Self

Create a plan to scan a file

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::schema::FileFormat;

let plan = LogicalPlan::scan("data.vcf", FileFormat::Vcf);

pub fn filter(self, predicate: Expr) -> Self

Add a filter to the plan

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::expression::{col, lit};
use genomicframe_core::schema::FileFormat;

let plan = LogicalPlan::scan("variants.vcf", FileFormat::Vcf)
    .filter(col("qual").gt(lit(30.0)));

pub fn select(self, columns: &[&str]) -> Self

Select specific columns

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::schema::FileFormat;

let plan = LogicalPlan::scan("data.vcf", FileFormat::Vcf)
    .select(&["chrom", "pos", "ref", "alt"]);

pub fn with_column(self, name: &str, expr: Expr) -> Self

Add a computed column

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::expression::{col, Expr};
use genomicframe_core::schema::FileFormat;

let plan = LogicalPlan::scan("data.vcf", FileFormat::Vcf)
    .with_column("is_high_qual", col("qual").gt(lit(30.0)));

pub fn limit(self, count: usize) -> Self

Limit the number of records

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::schema::FileFormat;

let plan = LogicalPlan::scan("data.vcf", FileFormat::Vcf)
    .limit(1000);

pub fn max_scan(self, count: usize) -> Self

Limit the maximum number of records to scan from source (before filtering)

This is useful for sampling large files or preventing long-running queries on huge datasets. The scan limit is applied before any filters, so you may get fewer results than the scan limit if filters are selective.

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::schema::FileFormat;
use genomicframe_core::expression::{col, lit};

// Scan only first 10,000 records, then filter
let plan = LogicalPlan::scan("huge.vcf", FileFormat::Vcf)
    .max_scan(10_000)
    .filter(col("qual").gte(lit(30.0)));

pub fn format(&self) -> Option<FileFormat>

Get the file format of this plan’s source

impl LogicalPlan

pub fn optimize(self) -> Self

Optimize this plan

Applies multiple optimization passes:

1. Combine adjacent filters into single AND filter
2. Push filters down closer to scans
3. Prune unnecessary columns early

Examples

use genomicframe_core::plan::LogicalPlan;
use genomicframe_core::expression::{col, lit};
use genomicframe_core::schema::FileFormat;

let plan = LogicalPlan::scan("data.vcf", FileFormat::Vcf)
    .filter(col("qual").gt(lit(30.0)))
    .filter(col("chrom").eq(lit("chr1")));

// Before: Scan -> Filter(qual) -> Filter(chrom)
// After:  Scan -> Filter(qual AND chrom)
let optimized = plan.optimize();

pub fn combine_filters(self) -> Self

Combine adjacent filter operations into single filter with AND

pub fn push_down_filters(self) -> Self

Push filter operations down toward the scan

pub fn prune_columns(self) -> Self

Push column selection down (prune early)

pub fn explain(&self) -> String

Get a human-readable representation of the plan

Trait Implementations

impl Clone for LogicalPlan

fn clone(&self) -> LogicalPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogicalPlan

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

Formats the value using the given formatter.