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 crate::catalog_item_id::CatalogItemId;

pub use crate::global_id::GlobalId;

pub use crate::timestamp::Timestamp;

pub use crate::timestamp::TimestampManipulation;

Modules

adt

Abstract data types.

bytes

catalog_item_id

explain

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

fixed_length

Provides abstractions for types that can append their datums to a vector. Row is the most obvious implementor, but other trace types that may use more advanced representations only need to commit to implementing this trait.

global_id

namespaces

Namespace constants to share between high- and low-levels of the system.

network_policy_id

optimize

Facilities for defining optimizer feature flags.

refresh_schedule

role_id

stats

Persist Stats for non-primitive types.

strconv

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

timestamp

user

Structs

ArrayRustType

A new type that wraps a Vec that is used to differentiate the target Datum between Arrays and Lists. The target of this type is Array.

ColumnIndex

Stable index of a column in a RelationDesc.

ColumnName

The name of a column in a RelationDesc.

DatumDictTypedIter

DatumList

A sequence of Datums

DatumListTypedIter

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.

ExcludeNull

A wrapper type that excludes NULL values, even if B allows them.

Int2Vector

PostgreSQL’s int2vector type: a thin wrapper over a 1-dimensional Array of int2, kept distinct from a regular int2[] array because it forbids NULL elements.

KeyDiff

A difference in the keys of two RelationDescs.

NotNullViolation

Expression violated not-null constraint on named column

OptionalArg

Wrapper to distinguish “argument may not be present” from Option<T> (nullable).

PropArray

PropDict

PropList

ProtoColumnName

ProtoColumnType

ProtoNumeric

See [dec::to_packed_bcd] and http://speleotrove.com/decimal/dnpack.html for more information on this format.

ProtoRelationDesc

ProtoRelationType

ProtoRow

ProtoScalarType

RelationDesc

A description of the shape of a relation.

RelationDescBuilder

A builder for a RelationDesc.

RelationDescDiff

The result of comparing two RelationDescs.

RelationVersion

The version a given column was added at.

ReprColumnType

ReprRelationType

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.

RowArenaBuf

A growable, writeable byte buffer that builds a value into a RowArena’s scratch space.

RowColumnarDecoder

A ColumnDecoder for a Row.

RowColumnarEncoder

A ColumnEncoder for a Row.

RowPacker

Packs datums into a Row.

RowRef

A contiguous slice of bytes that are row data.

Rows

A packed representation of a set of rows.

RowsBuilder

See Rows.

SharedRow

A thread-local row, which can be borrowed and returned.

SharedSlice

An immutable, shared slice. Morally, this is bytes::Bytes but with fewer features and supporting arbitrary types.

SqlColumnType

The type of a Datum.

SqlRelationType

The type of a relation.

UpdateCollection

A collection of row-time-diff updates in a columnar format.

UpdateCollectionBuilder

Variadic

A wrapper type for variadic arguments that consumes the remaining iterator.

VersionedRelationDesc

A wrapper around RelationDesc that provides an interface for adding columns and generating new versions.

Enums

ColumnDiff

A difference in a column between two RelationDescs.

Datum

A single value.

DatumKind

PropDatum

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

PropRelationDescDiff

Diffs that can be generated proptest and applied to a RelationDesc to exercise schema migrations.

RelationVersionSelector

Describes a RelationDesc at a specific version of a VersionedRelationDesc.

ReprScalarBaseType

ReprScalarType

The type of a Datum as it is represented.

SemanticType

Semantic type annotation for a column in a builtin catalog relation.

SqlScalarBaseType

SqlScalarType

The type of a Datum.

Constants

UNKNOWN_COLUMN_NAME

Default name of a column (when no other information is known).

Traits

AsColumnType

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

FromDatum

Infallible conversion from a Datum to a typed value.

InputDatumType

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

IntoRowIterator

Convert a type into a RowIterator.

OutputDatumType

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

RowIterator

An iterator that can borrow from self and yield RowRefs.

SqlContainerType

Trait for SQL container types whose element/value type can be extracted from or wrapped into a SqlScalarType.

Functions

arb_datum

Generate an arbitrary PropDatum.

arb_datum_for_column

Generates an arbitrary PropDatum for the provided SqlColumnType.

arb_datum_for_scalar

Generates an arbitrary PropDatum for the provided SqlScalarType.

arb_range_type

arb_relation_desc_diff

Generates a set of PropRelationDescDiffs based on some source RelationDesc.

arb_relation_desc_projection

Returns a Strategy that generates a projection of the provided RelationDesc.

arb_row_for_relation

Returns a Strategy that yields arbitrary Rows for the provided RelationDesc.

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. This is used to optimistically pre-allocate buffers for packing rows.

datums_size

Number of bytes required by a sequence of datums.

preserves_order

Returns true iff the ordering of the “raw” and Persist-encoded versions of this columm would match: ie. sort(encode(column)) == encode(sort(column)). This encoding has been designed so that this is true for many types.

read_datum^⚠

Read a datum starting at byte offset.

row_size

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

Type Aliases

Diff

System-wide record count difference type.