ScalarExpr

Enum ScalarExpr 

Source
pub enum ScalarExpr<F> {
Show 13 variants Column(F), Literal(Literal), Binary { left: Box<ScalarExpr<F>>, op: BinaryOp, right: Box<ScalarExpr<F>>, }, Not(Box<ScalarExpr<F>>), IsNull { expr: Box<ScalarExpr<F>>, negated: bool, }, Aggregate(AggregateCall<F>), GetField { base: Box<ScalarExpr<F>>, field_name: String, }, Cast { expr: Box<ScalarExpr<F>>, data_type: DataType, }, Compare { left: Box<ScalarExpr<F>>, op: CompareOp, right: Box<ScalarExpr<F>>, }, Coalesce(Vec<ScalarExpr<F>>), ScalarSubquery(ScalarSubqueryExpr), Case { operand: Option<Box<ScalarExpr<F>>>, branches: Vec<(ScalarExpr<F>, ScalarExpr<F>)>, else_expr: Option<Box<ScalarExpr<F>>>, }, Random,
}
Expand description

Arithmetic scalar expression that can reference multiple fields.

Variants§

§

Column(F)

§

Literal(Literal)

§

Binary

Fields

§left: Box<ScalarExpr<F>>
§right: Box<ScalarExpr<F>>
§

Not(Box<ScalarExpr<F>>)

Logical NOT returning 1 for falsey inputs, 0 for truthy inputs, and NULL for NULL inputs.

§

IsNull

NULL test returning 1 when the operand is NULL (or NOT NULL when negated is true) and 0 otherwise. Returns NULL when the operand cannot be determined.

Fields

§expr: Box<ScalarExpr<F>>
§negated: bool
§

Aggregate(AggregateCall<F>)

Aggregate function call (e.g., COUNT(), SUM(col), etc.) This is used in expressions like COUNT() + 1

§

GetField

Extract a field from a struct expression. For example: user.address.city would be represented as GetField { base: GetField { base: Column(user), field_name: “address” }, field_name: “city” }

Fields

§base: Box<ScalarExpr<F>>
§field_name: String
§

Cast

Explicit type cast to an Arrow data type.

Fields

§expr: Box<ScalarExpr<F>>
§data_type: DataType
§

Compare

Comparison producing a boolean (1/0) result.

Fields

§left: Box<ScalarExpr<F>>
§right: Box<ScalarExpr<F>>
§

Coalesce(Vec<ScalarExpr<F>>)

First non-null expression in the provided list.

§

ScalarSubquery(ScalarSubqueryExpr)

Scalar subquery evaluated per input row.

§

Case

SQL CASE expression with optional operand and ELSE branch.

Fields

§operand: Option<Box<ScalarExpr<F>>>

Optional operand for simple CASE (e.g., CASE x WHEN ...).

§branches: Vec<(ScalarExpr<F>, ScalarExpr<F>)>

Ordered (WHEN, THEN) branches.

§else_expr: Option<Box<ScalarExpr<F>>>

Optional ELSE result.

§

Random

Random number generator returning a float in [0.0, 1.0).

Follows the PostgreSQL/DuckDB standard: each evaluation produces a new pseudo-random value. No seed control is exposed at the SQL level.

Implementations§

Source§

impl<F> ScalarExpr<F>

Source

pub fn column(field: F) -> ScalarExpr<F>

Source

pub fn literal<L>(lit: L) -> ScalarExpr<F>
where L: Into<Literal>,

Source

pub fn binary( left: ScalarExpr<F>, op: BinaryOp, right: ScalarExpr<F>, ) -> ScalarExpr<F>

Source

pub fn logical_not(expr: ScalarExpr<F>) -> ScalarExpr<F>

Source

pub fn is_null(expr: ScalarExpr<F>, negated: bool) -> ScalarExpr<F>

Source

pub fn aggregate(call: AggregateCall<F>) -> ScalarExpr<F>

Source

pub fn get_field(base: ScalarExpr<F>, field_name: String) -> ScalarExpr<F>

Source

pub fn cast(expr: ScalarExpr<F>, data_type: DataType) -> ScalarExpr<F>

Source

pub fn compare( left: ScalarExpr<F>, op: CompareOp, right: ScalarExpr<F>, ) -> ScalarExpr<F>

Source

pub fn coalesce(exprs: Vec<ScalarExpr<F>>) -> ScalarExpr<F>

Source

pub fn scalar_subquery(id: SubqueryId, data_type: DataType) -> ScalarExpr<F>

Source

pub fn case( operand: Option<ScalarExpr<F>>, branches: Vec<(ScalarExpr<F>, ScalarExpr<F>)>, else_expr: Option<ScalarExpr<F>>, ) -> ScalarExpr<F>

Source

pub fn random() -> ScalarExpr<F>

Source§

impl<F> ScalarExpr<F>
where F: Display + Copy,

Source

pub fn format_display(&self) -> String

Render a scalar expression as a human-readable string.

Trait Implementations§

Source§

impl<F> Clone for ScalarExpr<F>
where F: Clone,

Source§

fn clone(&self) -> ScalarExpr<F>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F> Debug for ScalarExpr<F>
where F: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F> ScalarExprTypeExt<F> for ScalarExpr<F>
where F: Hash + Eq + Copy,

Auto Trait Implementations§

§

impl<F> Freeze for ScalarExpr<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for ScalarExpr<F>
where F: RefUnwindSafe,

§

impl<F> Send for ScalarExpr<F>
where F: Send,

§

impl<F> Sync for ScalarExpr<F>
where F: Sync,

§

impl<F> Unpin for ScalarExpr<F>
where F: Unpin,

§

impl<F> UnwindSafe for ScalarExpr<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,