Struct SessionOptions 

#[non_exhaustive]
pub struct SessionOptions {
    pub target: Option<BackendKind>,
    pub batch_size: Option<usize>,
}

Knobs a session is built with.

Every field has a default that matches the no-argument constructors, so SessionOptions::default() and OxideSession::local agree. The struct is #[non_exhaustive]: a knob added later is a minor release, not a broken build for anyone who used the builder methods.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target: Option<BackendKind>

Plan for this backend instead of the detected one (embedded only).

batch_size: Option<usize>

Rows per record batch. None leaves DataFusion’s default (8192), or oxidelake_storage::GPU_BATCH_SIZE when the placement target is a GPU.

Implementations

impl SessionOptions

pub fn new() -> SessionOptions

Defaults: detected backend, default batch size.

pub fn with_target(self, target: BackendKind) -> SessionOptions

Plans for target rather than the detected backend.

pub fn with_batch_size(self, rows: usize) -> SessionOptions

Sets the rows per record batch, overriding the CPU and GPU defaults.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionOptions

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

Formats the value using the given formatter.

impl Default for SessionOptions

fn default() -> SessionOptions

Returns the “default value” for a type.

impl Eq for SessionOptions

impl PartialEq for SessionOptions

fn eq(&self, other: &SessionOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SessionOptions