Substrait#

These functions allow you to execute Substrait plans against Arrow data

Query Execution#

run_query(plan, *[, table_provider, use_threads])

Execute a Substrait plan and read the results as a RecordBatchReader.

Expression Serialization#

These functions allow for serialization and deserialization of pyarrow compute expressions.

BoundExpressions()

A collection of named expressions and the schema they are bound to

deserialize_expressions(buf)

Deserialize an ExtendedExpression Substrait message into a BoundExpressions object

serialize_expressions(exprs, names, schema, *)

Serialize a collection of expressions into Substrait

serialize_schema(schema)

Serialize a schema into a SubstraitSchema object.

deserialize_schema(buf)

Deserialize a NamedStruct Substrait message or a SubstraitSchema object into an Arrow Schema object

SubstraitSchema(schema, expression)

A Schema encoded for Substrait usage.

Utility#

get_supported_functions()

Get a list of Substrait functions that the underlying engine currently supports.