Struct JsonbObjectKeys 

pub struct JsonbObjectKeys { /* private fields */ }

A scalar UDF that extracts the keys from a JSONB object.

Accepts both Binary and Dictionary<Int32, Binary> inputs. Returns List<Utf8> containing the object keys, or null if input is not an object. A Dictionary<Int32, Binary> input takes a fast path that extracts each unique blob once (take-expanded to row count), since JSONB values (especially properties) are often repeated; the returned list is never dictionary-encoded — unnest() and SELECT DISTINCT need a plain list to work directly, without an arrow_cast workaround.

Implementations

impl JsonbObjectKeys

pub fn new() -> JsonbObjectKeys

Trait Implementations

impl Debug for JsonbObjectKeys

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

Formats the value using the given formatter.

impl Default for JsonbObjectKeys

fn default() -> JsonbObjectKeys

Returns the “default value” for a type.

impl Eq for JsonbObjectKeys

impl Hash for JsonbObjectKeys

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

where __H: Hasher,

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 JsonbObjectKeys

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

Equality operator ==.

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

Inequality operator !=.

impl ScalarUDFImpl for JsonbObjectKeys

fn name(&self) -> &str

Returns this function’s name

fn signature(&self) -> &Signature

Returns a [Signature] describing the argument types for which this function has an implementation, and the function’s Volatility.

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

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

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

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>

👎Deprecated since 50.0.0:

This method is unused and will be removed in a future release

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 with_updated_config(&self, _config: &ConfigOptions) -> Option<ScalarUDF>

Create a new instance of this function with updated configuration.

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 is_strict(&self) -> bool

Returns true if this function always returns NULL when any argument is NULL.

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

Optionally apply per-UDF simplification / rewrite rules.

fn preimage( &self, _args: &[Expr], _lit_expr: &Expr, _info: &SimplifyContext, ) -> Result<PreimageResult, DataFusionError>

Returns a single contiguous preimage for this function and the specified scalar expression, if any.

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 conditional_arguments<'a>( &self, args: &'a [Expr], ) -> Option<(Vec<&'a Expr>, Vec<&'a Expr>)>

Determines which of the arguments passed to this function are evaluated eagerly and which may be evaluated lazily.

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 strictly_order_preserving( &self, _inputs: &[ExprProperties], ) -> Result<bool, DataFusionError>

Returns true if the function is strictly order-preserving with respect to its Ordered inputs, i.e. a.cmp(b) == f(a).cmp(f(b)).

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 struct_field_mapping( &self, _literal_args: &[Option<ScalarValue>], ) -> Option<StructFieldMapping>

For struct-producing functions, return how output fields map to input arguments. This enables the optimizer to propagate orderings through struct projections.

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

Returns the documentation for this Scalar UDF.

fn placement(&self, _args: &[ExpressionPlacement]) -> ExpressionPlacement

Returns placement information for this function.

impl StructuralPartialEq for JsonbObjectKeys