Materialize documentation

This is the home of Materialize's internal API documentation.

Important crates

mz	The Materialize command-line interface (CLI).
mz-adapter	Materialize's adapter layer.
mz-adapter-types	Types for Materialize's adapter layer.
mz-alloc	Activates the best memory allocator for the target platform.
mz-arrow-util	Arrow / Parquet utility library.
mz-audit-log	Audit log data structures.
mz-avro	Library for working with Apache Avro in Rust
mz-aws-secrets-controller	null
mz-aws-util	AWS utilities.
mz-balancerd	Balancer service.
mz-build-info	Metadata about a Materialize build.
mz-build-tools	Provides access to tools required in build scripts.
mz-catalog	Materialize's catalog layer.
mz-ccsr	Confluent-compatible schema registry API client.
mz-cloud-api	API interfaces to Cloud.
mz-cloud-resources	Controller for cloud resources.
mz-cluster	Tools for storage and compute.
mz-cluster-client	The public API for both compute and storage.
mz-compute	Materialize's compute layer.
mz-compute-client	The public API for the compute layer.
mz-compute-types	Shared types for the `mz-compute*` crates
mz-controller	Controller for unified storage and compute layers.
mz-controller-types	Shared types for the `mz-controller` crate
mz-dyncfg	Dynamically updatable configuration.
mz-dyncfgs	A registry of every mz_dyncfg.
mz-environmentd	Manages a single Materialize environment.
mz-expr	The core expression language for Materialize.
mz-expr-parser	Utilities for creating objects in the expr crate for testing
mz-expr-test-util	Utilities for creating objects in the expr crate for testing
mz-fivetran-destination	Fivetran destination for Materialize.
mz-frontegg-auth	Authentication interfaces to Frontegg.
mz-frontegg-client	Client to interact with Frontegg.
mz-frontegg-mock	Frontegg mock server.
mz-http-util	Utilities for running HTTP servers in Materialize.
mz-interchange	Translations for various data serialization formats.
mz-kafka-util	Utilities for working with Kafka.
mz-lowertest	Utilities for testing lower layers of the Materialize stack
mz-lsp-server	The Materialize Language Server Protocol (LSP) Server implementation.
mz-metabase	An API client for Metabase.
mz-metrics	Internal metrics libraries for Materialize.
mz-mysql-util	MySQL utility library.
mz-npm	A lightweight JavaScript package manager, like npm.
mz-orchestrator	Service orchestration.
mz-orchestrator-kubernetes	Service orchestration via Kubernetes.
mz-orchestrator-process	Service orchestration via local processes for development.
mz-orchestrator-tracing	Service orchestration for tracing-aware services.
mz-ore	Internal utility libraries for Materialize.
mz-persist	Abstraction for Materialize dataplane persistence.
mz-persist-client	Client for Materialize pTVC durability system
mz-persist-txn	Atomic multi-shard mz_persist_client writes
mz-persist-types	Types for the persist crate.
mz-pgcopy	Encoding/decoding of PostgreSQL COPY formats.
mz-pgrepr	Representation of and serialization for PostgreSQL data types.
mz-pgrepr-consts	Constant definitions for representation of and serialization for PostgreSQL data types.
mz-pgtest	Postgres wire protocol test framework.
mz-pgtz	PostgreSQL-compatible timezone handling.
mz-pgwire	A server for the PostgreSQL wire protocol.
mz-pgwire-common	Common logic for the PostgreSQL wire protocol.
mz-pid-file	PID file management.
mz-postgres-client	A Postgres client that uses deadpool as a connection pool.
mz-postgres-util	PostgreSQL utility library.
mz-proc	Utility for introspecting the running process.
mz-prof	CPU and memory profiling tools.
mz-prof-http	Route HTTP requests to various profiling functions
mz-proto	Protocol buffer libraries for Materialize.
mz-regexp	Regexp utils.
mz-repr	The core data types for Materialize.
mz-repr-test-util	Utilities for creating objects in the repr crate for testing
mz-rocksdb	A wrapper for RocksDB.
mz-rocksdb-types	Shared types for the `mz-rocksdb` crate
mz-secrets	Secrets Controller
mz-segment	Segment library for Rust.
mz-server-core	Core functions for serving.
mz-service	Common code for services orchestrated by environmentd.
mz-sql	SQL–dataflow translation.
mz-sql-lexer	The lexer for Materialize's SQL dialect.
mz-sql-parser	The parser for Materialize's SQL dialect.
mz-sql-pretty	The pretty printer for Materialize's SQL dialect.
mz-sqllogictest	A driver for sqllogictest, a SQL correctness testing framework.
mz-ssh-util	SSH utility library.
mz-storage	Materialize's storage layer.
mz-storage-client	The public API for the storage layer.
mz-storage-controller	Implementation of the Storage controller API.
mz-storage-operators	Shared Storage dataflow operators
mz-storage-types	Shared types for the `mz-storage*` crates
mz-test-util	Utilities for testing Materialize
mz-testdrive	Integration test driver for Materialize.
mz-timely-util	Utilities for working with Timely.
mz-timestamp-oracle	Materialize's Timestamp Oracle.
mz-tls-util	A tiny utility crate for making TLS connectors.
mz-tracing	A tracing library for Materialize.
mz-transform	Transformations of Materialize expressions.
mz-walkabout	AST visitor generation.
workspace-hack	workspace-hack package, managed by hakari