Struct ProcedureStateFunction

pub(crate) struct ProcedureStateFunction {
    signature: Signature,
    func_ctx: FunctionContext,
}

A function to query procedure state by its id. Such as procedure_state(pid).

Fields

signature: Signature

func_ctx: FunctionContext

Implementations

impl ProcedureStateFunction

fn create(signature: Signature, func_ctx: FunctionContext) -> Self

Creates a new instance of the function with function context.

pub fn factory() -> impl Into<ScalarFunctionFactory>

Returns the [ScalarFunctionFactory] of the function.

Trait Implementations

impl AsyncScalarUDFImpl for ProcedureStateFunction

fn invoke_async_with_args<'life0, 'async_trait>( &'life0 self, args: ScalarFunctionArgs, ) -> Pin<Box<dyn Future<Output = Result<ColumnarValue>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Invoke the function asynchronously with the async arguments

fn ideal_batch_size(&self) -> Option<usize>

The ideal batch size for this function.

impl Debug for ProcedureStateFunction

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

Formats the value using the given formatter.

impl Display for ProcedureStateFunction

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

Formats the value using the given formatter.

impl From<ProcedureStateFunction> for ScalarFunctionFactory

Implement From trait for ScalarFunctionFactory

fn from(func: ProcedureStateFunction) -> Self

Converts to this type from the input type.

impl ScalarUDFImpl for ProcedureStateFunction

fn as_any(&self) -> &dyn Any

Returns this object as an Any trait object

fn name(&self) -> &str

Returns this function’s name

fn signature(&self) -> &Signature

Returns the function’s [Signature] for information about what input types are accepted and the function’s Volatility.

fn return_type(&self, _arg_types: &[DataType]) -> Result<DataType>

What [DataType] will be returned by this function, given the types of the arguments.

fn invoke_with_args(&self, _args: ScalarFunctionArgs) -> Result<ColumnarValue>

Invoke the function returning the appropriate result.

fn aliases(&self) -> &[String]

Returns any aliases (alternate names) for this function.

fn display_name(&self, args: &[Expr]) -> Result<String, DataFusionError>

Returns the user-defined display name of function, given the arguments

fn schema_name(&self, args: &[Expr]) -> Result<String, DataFusionError>

Returns the name of the column this expression would create

fn return_field_from_args( &self, args: ReturnFieldArgs<'_>, ) -> Result<Arc<Field>, DataFusionError>

What type will be returned by this function, given the arguments?

fn is_nullable(&self, _args: &[Expr], _schema: &dyn ExprSchema) -> bool

👎Deprecated since 45.0.0: Use return_field_from_args instead. if you use is_nullable that returns non-nullable with return_type, you would need to switch to return_field_from_args, you might have error

fn simplify( &self, args: Vec<Expr>, _info: &dyn SimplifyInfo, ) -> Result<ExprSimplifyResult, DataFusionError>

Optionally apply per-UDF simplification / rewrite rules.

fn short_circuits(&self) -> bool

Returns true if some of this exprs subexpressions may not be evaluated and thus any side effects (like divide by zero) may not be encountered.

fn evaluate_bounds( &self, _input: &[&Interval], ) -> Result<Interval, DataFusionError>

Computes the output [Interval] for a [ScalarUDFImpl], given the input intervals.

fn propagate_constraints( &self, _interval: &Interval, _inputs: &[&Interval], ) -> Result<Option<Vec<Interval>>, DataFusionError>

Updates bounds for child expressions, given a known [Interval]s for this function.

fn output_ordering( &self, inputs: &[ExprProperties], ) -> Result<SortProperties, DataFusionError>

Calculates the [SortProperties] of this function based on its children’s properties.

fn preserves_lex_ordering( &self, _inputs: &[ExprProperties], ) -> Result<bool, DataFusionError>

Returns true if the function preserves lexicographical ordering based on the input ordering.

fn coerce_types( &self, _arg_types: &[DataType], ) -> Result<Vec<DataType>, DataFusionError>

Coerce arguments of a function call to types that the function can evaluate.

fn equals(&self, other: &dyn ScalarUDFImpl) -> bool

Return true if this scalar UDF is equal to the other.

fn hash_value(&self) -> u64

Returns a hash value for this scalar UDF.

fn documentation(&self) -> Option<&Documentation>

Returns the documentation for this Scalar UDF.