Bases: _Weakrefable
A logical expression to be evaluated against some input.
To create an expression:
Use the factory function pyarrow.compute.scalar()
to create a scalar (not necessary when combined, see example below).
Use the factory function pyarrow.compute.field()
to reference a field (column in table).
Compare fields and scalars with <
, <=
, ==
, >=
, >
.
Combine expressions using python operators &
(logical and), |
(logical or) and ~
(logical not). Note: python keywords and
, or
and not
cannot be used to combine expressions.
Create expression predicates using Expression methods such as pyarrow.compute.Expression.isin()
.
Examples
>>> import pyarrow.compute as pc >>> (pc.field("a") < pc.scalar(3)) | (pc.field("b") > 7) <pyarrow.compute.Expression ((a < 3) or (b > 7))> >>> pc.field('a') != 3 <pyarrow.compute.Expression (a != 3)> >>> pc.field('a').isin([1, 2, 3]) <pyarrow.compute.Expression is_in(a, {value_set=int64:[ 1, 2, 3 ], null_matching_behavior=MATCH})>
Methods
Explicitly set or change the expressionâs data type.
This creates a new expression equivalent to calling the cast compute function on this expression.
DataType
, default None
Type to cast array to.
True
Whether to check for conversion errors such as overflow.
CastOptions
, default None
Additional checks pass by CastOptions
Expression
pyarrow.dataset.Expression
Deserialize an expression from Substrait
The serialized message must be an ExtendedExpression message that has only a single expression. The name of the expression and the schema the expression was bound to will be ignored. Use pyarrow.substrait.deserialize_expressions if this information is needed or if the message might contain multiple expressions.
bytes
or Buffer
or a
protobuf
Message
The Substrait message to deserialize
Expression
The deserialized expression
Check whether the expression is NaN.
This creates a new expression equivalent to calling the is_nan compute function on this expression.
Expression
Check whether the expression is null.
This creates a new expression equivalent to calling the is_null compute function on this expression.
False
Whether floating-point NaNs are considered null.
Expression
Check whether the expression is not-null (valid).
This creates a new expression equivalent to calling the is_valid compute function on this expression.
Expression
Check whether the expression is contained in values.
This creates a new expression equivalent to calling the is_in compute function on this expression.
Array
or iterable
The values to check for.
Expression
A new expression that, when evaluated, checks whether this expressionâs value is contained in values.
Serialize the expression using Substrait
The expression will be serialized as an ExtendedExpression message that has a single expression named âexpressionâ
Schema
The input schema the expression will be bound to
False
If False then only functions that are part of the core Substrait function definitions will be allowed. Set this to True to allow pyarrow-specific functions but the result may not be accepted by other compute libraries.
Buffer
A buffer containing the serialized Protobuf plan.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4