Crate mz_repr

Fundamental data representation.

This module contains the types for representing data in Materialize that all layers of the stack can understand. Think of it as the lingua franca: individual layers may use different representations internally, but they all agree to use this representation at their boundaries.

• The core value type is the Datum enum, which represents a literal value.
• Row extends a Datum horizontally, and has features for efficiently doing so.
• RelationDesc describes what it takes to extend a Row vertically, and corresponds most closely to what is returned from querying our dataflows

Re-exports

pub use global_id::GlobalId;

Modules

adt

Abstract data types.

antichain

chrono

Custom proptest::strategy::Strategy implementations and Protobuf types for the chrono fields used in the codebase.

explain_new

A set of traits for modeling things that can be explained by a SQL EXPLAIN statement.

global_id

strconv

Routines for converting datum values to and from their string representation.

url

Custom Protobuf types for the url crate.

util

Utility routines for data representation.

Structs

ColumnName

The name of a column in a RelationDesc.

ColumnType

The type of a Datum.

DatumList

A sequence of Datums

DatumMap

A mapping from string keys to Datums

DatumVec

A re-useable vector of Datum with no particular lifetime.

DatumVecBorrow

A borrowed allocation of Datum with a specific lifetime.

NotNullViolation

Expression violated not-null constraint on named column

PropArray

PropDict

PropList

ProtoColumnName

ProtoColumnType

ProtoRelationDesc

ProtoRelationType

ProtoRow

ProtoScalarType

RelationDesc

A description of the shape of a relation.

RelationType

The type of a relation.

Row

A packed representation for Datums.

RowArena

RowArena is used to hold on to temporary Rows for functions like eval that need to create complex Datums but don’t have a Row to put them in yet.

RowPacker

Packs datums into a Row.

RowRef

A wrapper around a byte slice that guarantees the data are row-formatted.

Timestamp

System-wide timestamp type.

TimestampDecoder

Enums

Datum

A single value.

PropDatum

A mirror type for Datum that can be proptest-generated.

ScalarBaseType

ScalarType

The type of a Datum.

Traits

AsColumnType

Types that implement this trait can be stored in an SQL column with the specified ColumnType

DatumType

A bridge between native Rust types and SQL runtime types represented in Datums

Functions

arb_datum

Generate an arbitrary PropDatum.

datum_list_size

Number of bytes required by a list of datums. This computes the size that would be required if the given datums were packed into a list.

datum_size

Number of bytes required by the datum.

datums_size

Number of bytes required by a sequence of datums.

row_size

Return the number of bytes these Datums would use if packed as a Row.

Type Definitions

Diff

System-wide record count difference type.