Module datafusion::logical_expr

source ·
Expand description

re-export of datafusion_expr crate

Modules

Macros

Structs

  • Aggregate
    Aggregates its input based on a set of grouping and aggregate expressions (e.g. SUM).
  • AggregateUDF
    Logical representation of a user-defined aggregate function (UDAF).
  • Analyze
    Runs the actual plan, and then prints the physical plan with with execution metrics.
  • Between
    BETWEEN expression
  • BinaryExpr
    Binary expression
  • Case
    CASE expression
  • Cast
    Cast expression
  • CreateCatalog
    Creates a catalog (aka “Database”).
  • CreateCatalogSchema
    Creates a schema.
  • CreateExternalTable
    Creates an external table.
  • CreateMemoryTable
    Creates an in memory table.
  • CreateView
    Creates a view.
  • CrossJoin
    Apply Cross Join to two logical plans
  • DescribeTable
    Describe the schema of table
  • Distinct
    Removes duplicate rows from the input
  • DmlStatement
    The operator that modifies the content of a database (adapted from substrait WriteRel)
  • DropCatalogSchema
    Drops a schema
  • DropTable
    Drops a table.
  • DropView
    Drops a view.
  • EmptyRelation
    Produces no rows: An empty relation with an empty schema
  • Explain
    Produces a relation with string representations of various parts of the plan
  • Extension
    Extension operator defined outside of DataFusion
  • Filter
    Filters rows from its input that do not match an expression (essentially a WHERE clause with a predicate expression).
  • GetIndexedField
    Returns the field of a arrow::array::ListArray or arrow::array::StructArray by key
  • Join
    Join two logical plans on one or more join columns
  • Like
    LIKE expression
  • Limit
    Produces the first n tuples from its input and discards the rest.
  • LogicalPlanBuilder
    Builder for logical plans
  • Prepare
    Prepare a statement but do not execute it. Prepare statements can have 0 or more Expr::Placeholder expressions that are filled in during execution
  • Projection
    Evaluates an arbitrary list of expressions (essentially a SELECT with an expression list) on its input.
  • Repartition
    Repartition the plan based on a partitioning scheme.
  • ScalarUDF
    Logical representation of a UDF.
  • SetVariable
    Set a Variable’s value – value in ConfigOptions
  • Signature
    The signature of a function defines the supported argument types and its volatility.
  • Sort
    Sorts its input according to a list of sort expressions.
  • StringifiedPlan
    Represents some sort of execution plan, in String form
  • Subquery
    Subquery
  • SubqueryAlias
    Aliased subquery
  • TableScan
    Produces rows from a table provider by reference or from the context
  • TransactionEnd
    Indicator that any current transaction should be terminated
  • TransactionStart
    Indicator that the following statements should be committed or rolled back atomically
  • TryCast
    TryCast Expression
  • Union
    Union multiple inputs
  • Unnest
    Unnest a column that contains a nested list type.
  • Values
    Values expression. See Postgres VALUES documentation for more details.
  • Window
    Window its input based on a set of window spec and window function (e.g. SUM or RANK)
  • WindowFrame
    The frame-spec determines which output rows are read by an aggregate window function.
  • WindowUDF
    Logical representation of a user-defined window function (UDWF) A UDWF is different from a UDF in that it is stateful across batches.

Enums

Constants

Statics

  • SUPPORTED_NULLIF_TYPES
    Currently supported types by the nullif function. The order of these types correspond to the order on which coercion applies This should thus be from least informative to most informative

Traits

  • Accumulator
    Describes an aggregate functions’s state.
  • ExprSchemable
    trait to allow expr to typable with respect to a schema
  • Literal
    Trait for converting a type to a Literal literal expression.
  • PartitionEvaluator
    Partition evaluator for Window Functions
  • TableSource
    The TableSource trait is used during logical query planning and optimizations and provides access to schema information and filter push-down capabilities. This trait provides a subset of the functionality of the TableProvider trait in the core datafusion crate. The TableProvider trait provides additional capabilities needed for physical query execution (such as the ability to perform a scan). The reason for having two separate traits is to avoid having the logical plan code be dependent on the DataFusion execution engine. Other projects may want to use DataFusion’s logical plans and have their own execution engine.
  • TimestampLiteral
    Trait for converting a type to a literal timestamp
  • ToStringifiedPlan
    Trait for something that can be formatted as a stringified plan
  • UserDefinedLogicalNode
    This defines the interface for LogicalPlan nodes that can be used to extend DataFusion with custom relational operators.
  • UserDefinedLogicalNodeCore
    This trait facilitates implementation of the UserDefinedLogicalNode.

Functions

  • abs
    absolute value
  • acos
    inverse cosine
  • acosh
    inverse hyperbolic cosine
  • and
    Return a new expression with a logical AND
  • approx_distinct
    Returns the approximate number of distinct input values. This function provides an approximation of count(DISTINCT x). Zero is returned if all input values are null. This function should produce a standard error of 0.81%, which is the standard deviation of the (approximately normal) error distribution over all possible sets. It does not guarantee an upper bound on the error for any specific input set.
  • approx_median
    Calculate an approximation of the median for expr.
  • approx_percentile_cont
    Calculate an approximation of the specified percentile for expr.
  • approx_percentile_cont_with_weight
    Calculate an approximation of the specified percentile for expr and weight_expr.
  • array
    returns an Arrow array using the specified input expressions.
  • array_append
    appends an element to the end of an array.
  • array_concat
    concatenates arrays.
  • array_contains
    returns true, if each element of the second array appearing in the first array, otherwise false.
  • array_dims
    returns an array of the array’s dimensions.
  • array_fill
    returns an array filled with copies of the given value.
  • array_length
    returns the length of the array dimension.
  • array_ndims
    returns the number of dimensions of the array.
  • array_position
    searches for an element in the array, returns first occurrence.
  • array_positions
    searches for an element in the array, returns all occurrences.
  • array_prepend
    prepends an element to the beginning of an array.
  • array_remove
    removes all elements equal to the given value from the array.
  • array_replace
    replaces a specified element with another specified element.
  • array_to_string
    converts each element to its text representation.
  • arrow_typeof
    data type
  • ascii
    ASCII code value of the character
  • asin
    inverse sine
  • asinh
    inverse hyperbolic sine
  • atan
    inverse tangent
  • atan2
    inverse tangent of a division given in the argument
  • atanh
    inverse hyperbolic tangent
  • avg
    Create an expression to represent the avg() aggregate function
  • binary_expr
    Return a new expression left <op> right
  • bit_length
    the number of bits in the string
  • bitwise_and
    Return a new expression with bitwise AND
  • bitwise_or
    Return a new expression with bitwise OR
  • bitwise_shift_left
    Return a new expression with bitwise SHIFT LEFT
  • bitwise_shift_right
    Return a new expression with bitwise SHIFT RIGHT
  • bitwise_xor
    Return a new expression with bitwise XOR
  • btrim
    removes all characters, spaces by default, from both sides of a string
  • build_join_schema
    Creates a schema for a join operation. The fields from the left side are first
  • call_fn
    Calls a named built in function
  • cardinality
    returns the total number of elements in the array.
  • case
    Create a CASE WHEN statement with literal WHEN expressions for comparison to the base expression.
  • cast
    Create a cast expression
  • cbrt
    cube root of a number
  • ceil
    nearest integer greater than or equal to argument
  • character_length
    the number of characters in the string
  • chr
    converts the Unicode code point to a UTF8 character
  • coalesce
    returns coalesce(args...), which evaluates to the value of the first Expr which is not NULL
  • col
    Create a column expression based on a qualified or unqualified column name. Will normalize unquoted identifiers according to SQL rules (identifiers will become lowercase).
  • concat
    Concatenates the text representations of all the arguments. NULL arguments are ignored.
  • concat_expr
    concatenates several strings
  • concat_ws
    Concatenates all but the first argument, with separators. The first argument is used as the separator. NULL arguments in values are ignored.
  • concat_ws_expr
    concatenates several strings, placing a seperator between each one
  • cos
    cosine
  • cosh
    hyperbolic cosine
  • cot
    cotangent
  • count
    Create an expression to represent the count() aggregate function
  • count_distinct
    Create an expression to represent the count(distinct) aggregate function
  • create_udaf
    Creates a new UDAF with a specific signature, state type and return type. The signature and state type must match the Accumulator's implementation.
  • create_udf
    Creates a new UDF with a specific signature and specific return type. This is a helper function to create a new UDF. The function create_udf returns a subset of all possible ScalarFunction:
  • create_udwf
    Creates a new UDWF with a specific signature, state type and return type.
  • cube
    Create a grouping set for all combination of exprs
  • current_date
    returns current UTC date as a DataType::Date32 value
  • current_time
    returns current UTC time as a DataType::Time64 value
  • date_bin
    coerces an arbitrary timestamp to the start of the nearest specified interval
  • date_part
    extracts a subfield from the date
  • date_trunc
    truncates the date to a specified level of precision
  • decode
    decode theinput, using the encoding. encoding can be base64 or hex
  • degrees
    converts radians to degrees
  • digest
    compute the binary hash of input, using the algorithm
  • display_schema
    Print the schema in a compact representation to buf
  • encode
    encode the input, using the encoding. encoding can be base64 or hex
  • exists
    Create an EXISTS subquery expression
  • exp
    exponential
  • factorial
    factorial
  • floor
    nearest integer less than or equal to argument
  • from_unixtime
    returns the unix time in format
  • gcd
    greatest common divisor
  • grouping_set
    Create a grouping set
  • ident
    Create an unqualified column expression from the provided name, without normalizing the column.
  • in_list
    Create an in_list expression
  • in_subquery
    Create an IN subquery expression
  • initcap
    converts the first letter of each word in string in uppercase and the remaining characters in lowercase
  • is_false
    Create is false expression
  • is_not_false
    Create is not false expression
  • is_not_true
    Create is not true expression
  • is_not_unknown
    Create is not unknown expression
  • is_null
    Create is null expression
  • is_true
    Create is true expression
  • is_unknown
    Create is unknown expression
  • lcm
    least common multiple
  • left
    returns the first n characters in the string
  • lit
    Create a literal expression
  • lit_timestamp_nano
    Create a literal timestamp expression
  • ln
    natural logarithm
  • log
    logarithm of a x for a particular base
  • log2
    base 2 logarithm
  • log10
    base 10 logarithm
  • lower
    convert the string to lower case
  • lpad
    fill up a string to the length by prepending the characters
  • ltrim
    removes all characters, spaces by default, from the beginning of a string
  • max
    Create an expression to represent the max() aggregate function
  • md5
    returns the MD5 hash of a string
  • median
    Calculate the median for expr.
  • min
    Create an expression to represent the min() aggregate function
  • not_exists
    Create a NOT EXISTS subquery expression
  • not_in_subquery
    Create a NOT IN subquery expression
  • now
    returns current timestamp in nanoseconds, using the same value for all instances of now() in same statement
  • nullif
    returns NULL if value1 equals value2; otherwise it returns value1. This can be used to perform the inverse operation of the COALESCE expression.
  • octet_length
    returns the number of bytes of a string
  • or
    Return a new expression with a logical OR
  • out_ref_col
    Create an out reference column which hold a reference that has been resolved to a field outside of the current plan.
  • pi
    Returns an approximate value of π
  • power
    base raised to the power of exponent
  • radians
    converts degrees to radians
  • random
    Returns a random value in the range 0.0 <= x < 1.0
  • regexp_match
    matches a regular expression against a string and returns matched substrings.
  • regexp_replace
    replace strings that match a regular expression
  • repeat
    repeats the string to n times
  • replace
    replaces all occurrences of from with to in the string
  • reverse
    reverses the string
  • right
    returns the last n characters in the string
  • rollup
    Create a grouping set for rollup
  • round
    round to nearest integer
  • rpad
    fill up a string to the length by appending the characters
  • rtrim
    removes all characters, spaces by default, from the end of a string
  • scalar_subquery
    Create a scalar subquery expression
  • sha224
    SHA-224 hash
  • sha256
    SHA-256 hash
  • sha384
    SHA-384 hash
  • sha512
    SHA-512 hash
  • signum
    sign of the argument (-1, 0, +1)
  • sin
    sine
  • sinh
    hyperbolic sine
  • split_part
    splits a string based on a delimiter and picks out the desired field based on the index.
  • sqrt
    square root of a number
  • starts_with
    whether the string starts with the prefix
  • stddev
    Create an expression to represent the stddev() aggregate function
  • strpos
    finds the position from where the substring matches the string
  • substr
    substring from the position to the end
  • substring
    substring from the position with length characters
  • sum
    Create an expression to represent the sum() aggregate function
  • table_scan
    Create a LogicalPlanBuilder representing a scan of a table with the provided name and schema. This is mostly used for testing and documentation.
  • tan
    tangent
  • tanh
    hyperbolic tangent
  • to_hex
    returns the hexdecimal representation of an integer
  • to_timestamp_micros
    converts a string to a Timestamp(Microseconds, None)
  • to_timestamp_millis
    converts a string to a Timestamp(Milliseconds, None)
  • to_timestamp_seconds
    converts a string to a Timestamp(Seconds, None)
  • translate
    replaces the characters in from with the counterpart in to
  • trim
    removes all characters, space by default from the string
  • trim_array
    removes the last n elements from the array.
  • trunc
    truncate toward zero, with optional precision
  • try_cast
    Create a try cast expression
  • union
    Union two logical plans.
  • upper
    converts the string to upper case
  • uuid
    returns uuid v4 as a string value
  • when
    Create a CASE WHEN statement with boolean WHEN expressions and no base expression.
  • wrap_projection_for_join_if_necessary
    Wrap projection for a plan, if the join keys contains normal expression.

Type Definitions