Struct ScalarCalculate

pub struct ScalarCalculate {
    start: Millisecond,
    end: Millisecond,
    interval: Millisecond,
    time_index: String,
    tag_columns: Vec<String>,
    field_column: String,
    input: LogicalPlan,
    output_schema: DFSchemaRef,
}

ScalarCalculate is the custom logical plan to calculate scalar in PromQL, return NaN when have multiple time series.

Return the time series as scalar value when only have one time series.

Fields

start: Millisecond

end: Millisecond

interval: Millisecond

time_index: String

tag_columns: Vec<String>

field_column: String

input: LogicalPlan

output_schema: DFSchemaRef

Implementations

impl ScalarCalculate

pub fn new( start: Millisecond, end: Millisecond, interval: Millisecond, input: LogicalPlan, time_index: &str, tag_colunms: &[String], field_column: &str, table_name: Option<&str>, ) -> Result<Self>

create a new ScalarCalculate plan

pub const fn name() -> &'static str

The name of this custom plan

pub fn to_execution_plan( &self, exec_input: Arc<dyn ExecutionPlan>, ) -> DataFusionResult<Arc<dyn ExecutionPlan>>

Create a new execution plan from ScalarCalculate

pub fn serialize(&self) -> Vec<u8>

pub fn deserialize(bytes: &[u8]) -> Result<Self>

Trait Implementations

impl Clone for ScalarCalculate

fn clone(&self) -> ScalarCalculate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarCalculate

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

Formats the value using the given formatter.

impl Hash for ScalarCalculate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScalarCalculate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ScalarCalculate

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl UserDefinedLogicalNodeCore for ScalarCalculate

fn name(&self) -> &str

Return the plan’s name.

fn inputs(&self) -> Vec<&LogicalPlan>

Return the logical plan’s inputs.

fn schema(&self) -> &DFSchemaRef

Return the output schema of this logical plan node.

fn expressions(&self) -> Vec<Expr>

Returns all expressions in the current logical plan node. This should not include expressions of any inputs (aka non-recursively). These expressions are used for optimizer passes and rewrites.

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

Write a single line, human readable string to f for use in explain plan.

fn with_exprs_and_inputs( &self, exprs: Vec<Expr>, inputs: Vec<LogicalPlan>, ) -> DataFusionResult<Self>

Create a new UserDefinedLogicalNode with the specified children and expressions. This function is used during optimization when the plan is being rewritten and a new instance of the UserDefinedLogicalNode must be created.

fn prevent_predicate_push_down_columns(&self) -> HashSet<String>

A list of output columns (e.g. the names of columns in self.schema()) for which predicates can not be pushed below this node without changing the output.

fn from_template(&self, exprs: &[Expr], inputs: &[LogicalPlan]) -> Self

👎Deprecated since 39.0.0: use with_exprs_and_inputs instead

fn necessary_children_exprs( &self, _output_columns: &[usize], ) -> Option<Vec<Vec<usize>>>

Returns the necessary input columns for this node required to compute the columns in the output schema

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this UserDefinedLogicalNode node.

impl Eq for ScalarCalculate

impl StructuralPartialEq for ScalarCalculate