139 releases (51 breaking)

0.52.3 Jan 21, 2025
0.51.4 Jan 10, 2025
0.50.4 Dec 27, 2024
0.49.1 Nov 25, 2024
0.1.0 Mar 5, 2022

#100 in Encoding

Download history 149504/week @ 2024-10-09 147011/week @ 2024-10-16 273760/week @ 2024-10-23 173727/week @ 2024-10-30 168228/week @ 2024-11-06 150369/week @ 2024-11-13 134683/week @ 2024-11-20 51844/week @ 2024-11-27 111719/week @ 2024-12-04 155626/week @ 2024-12-11 84737/week @ 2024-12-18 34405/week @ 2024-12-25 108239/week @ 2025-01-01 155480/week @ 2025-01-08 116348/week @ 2025-01-15 104086/week @ 2025-01-22

492,532 downloads per month
Used in 12 crates (3 directly)

Apache-2.0

72KB
1.5K SLoC

substrait-rs

substrait

crates.io docs.rs

Rust crate for Substrait: Cross-Language Serialization for Relational Algebra.

Documentation


lib.rs:

Substrait: Cross-Language Serialization for Relational Algebra

Serialization and deserialization

This crate provides generated types to serialize and deserialize Substrait data.

Protobuf

Protobuf serialization and deserialization are provided via [prost] in the [proto] module.

Example

Serialize and deserialize a plan

use prost::Message;
use substrait::proto::Plan;

let plan = Plan::default();

// Serialize the plan
let encoded = plan.encode_to_vec();

// Deserialize the buffer to a Plan
let decoded = Plan::decode(encoded.as_slice())?;

assert_eq!(plan, decoded);

Serde support

The serde feature generates serde implementations that match the Protobuf JSON Mapping via pbjson.

Example
Deserialize a plan version using the serde feature
use substrait::proto::Version;

let version_json = r#"{
  "minorNumber": 21
}"#;

let version = serde_json::from_str::<Version>(version_json)?;
assert_eq!(
  version,
  Version {
    minor_number: 21,
    ..Default::default()
  }
);

Text

Substrait defines a YAML schema for extensions. Types with serialization and deserialization support for these are provided via typify in the [text] module.

Example

Read a simple extension

use substrait::text::simple_extensions::SimpleExtensions;

let simple_extension_yaml = r#"
%YAML 1.2
---
scalar_functions:
  -
    name: "add"
    description: "Add two values."
    impls:
      - args:
         - name: x
           value: i8
         - name: y
           value: i8
        options:
          overflow:
            values: [ SILENT, SATURATE, ERROR ]
        return: i8
"#;

let simple_extension = serde_yaml::from_str::<SimpleExtensions>(simple_extension_yaml)?;

assert_eq!(simple_extension.scalar_functions.len(), 1);
assert_eq!(simple_extension.scalar_functions[0].name, "add");

Dependencies

~4–8.5MB
~171K SLoC