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	Chooses a global memory allocator based on Cargo features.
mz_alloc_default	Activates the best default global memory allocator for the platform.
mz_arrow_util	Arrow / Parquet utility library.
mz_audit_log	Audit log data structures.
mz_auth	Shared authentication logic.
mz_authenticator	null
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_catalog_protos	null
mz_ccsr	Confluent-compatible schema registry API client.
mz_cloud_api	API interfaces to Cloud.
mz_cloud_provider	Representation of a cloud provider
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_clusterd	Materialize's cluster server.
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_durable_cache	A durable cache built on top of a persist shard
mz_dyncfg	Dynamically updatable configuration.
mz_dyncfg_file	A dyncfg::ConfigSet backed by local files.
mz_dyncfg_launchdarkly	A dyncfg::ConfigSet backed by LaunchDarkly.
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_derive_impl	Implementations of derives for 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_license_keys	Implementation of license keys for Materialize.
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_orchestratord	Kubernetes operator for Materialize regions
mz_ore	Internal utility libraries for Materialize.
mz_ore_build	Internal utility libraries used in Build Scripts for Materialize.
mz_persist	Abstraction for Materialize dataplane persistence.
mz_persist_client	Client for Materialize pTVC durability system
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_postgres_client	A Postgres client that uses deadpool as a connection pool.
mz_postgres_util	PostgreSQL utility library.
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_sql_server_util	SQL Server utility library.
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_txn_wal	Atomic multi-shard mz_persist_client writes
mz_walkabout	AST visitor generation.
workspace_hack	workspace-hack package, managed by hakari