Materialize documentation

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

Important crates

mzThe Materialize command-line interface (CLI).
mz-adapterMaterialize's adapter layer.
mz-adapter-typesTypes for Materialize's adapter layer.
mz-allocActivates the best memory allocator for the target platform.
mz-arrow-utilArrow / Parquet utility library.
mz-audit-logAudit log data structures.
mz-avroLibrary for working with Apache Avro in Rust
mz-aws-utilAWS utilities.
mz-balancerdBalancer service.
mz-build-infoMetadata about a Materialize build.
mz-build-toolsProvides access to tools required in build scripts.
mz-catalogMaterialize's catalog layer.
mz-ccsrConfluent-compatible schema registry API client.
mz-cloud-apiAPI interfaces to Cloud.
mz-cloud-resourcesController for cloud resources.
mz-clusterTools for storage and compute.
mz-cluster-clientThe public API for both compute and storage.
mz-computeMaterialize's compute layer.
mz-compute-clientThe public API for the compute layer.
mz-compute-typesShared types for the `mz-compute*` crates
mz-controllerController for unified storage and compute layers.
mz-controller-typesShared types for the `mz-controller` crate
mz-dyncfgDynamically updatable configuration.
mz-dyncfgsA registry of every mz_dyncfg.
mz-environmentdManages a single Materialize environment.
mz-exprThe core expression language for Materialize.
mz-expr-parserUtilities for creating objects in the expr crate for testing
mz-expr-test-utilUtilities for creating objects in the expr crate for testing
mz-fivetran-destinationFivetran destination for Materialize.
mz-frontegg-authAuthentication interfaces to Frontegg.
mz-frontegg-clientClient to interact with Frontegg.
mz-frontegg-mockFrontegg mock server.
mz-http-utilUtilities for running HTTP servers in Materialize.
mz-interchangeTranslations for various data serialization formats.
mz-kafka-utilUtilities for working with Kafka.
mz-lowertestUtilities for testing lower layers of the Materialize stack
mz-lsp-serverThe Materialize Language Server Protocol (LSP) Server implementation.
mz-metabaseAn API client for Metabase.
mz-metricsInternal metrics libraries for Materialize.
mz-mysql-utilMySQL utility library.
mz-npmA lightweight JavaScript package manager, like npm.
mz-orchestratorService orchestration.
mz-orchestrator-kubernetesService orchestration via Kubernetes.
mz-orchestrator-processService orchestration via local processes for development.
mz-orchestrator-tracingService orchestration for tracing-aware services.
mz-oreInternal utility libraries for Materialize.
mz-persistAbstraction for Materialize dataplane persistence.
mz-persist-clientClient for Materialize pTVC durability system
mz-persist-txnAtomic multi-shard mz_persist_client writes
mz-persist-typesTypes for the persist crate.
mz-pgcopyEncoding/decoding of PostgreSQL COPY formats.
mz-pgreprRepresentation of and serialization for PostgreSQL data types.
mz-pgrepr-constsConstant definitions for representation of and serialization for PostgreSQL data types.
mz-pgtestPostgres wire protocol test framework.
mz-pgtzPostgreSQL-compatible timezone handling.
mz-pgwireA server for the PostgreSQL wire protocol.
mz-pgwire-commonCommon logic for the PostgreSQL wire protocol.
mz-pid-filePID file management.
mz-postgres-clientA Postgres client that uses deadpool as a connection pool.
mz-postgres-utilPostgreSQL utility library.
mz-procUtility for introspecting the running process.
mz-profCPU and memory profiling tools.
mz-prof-httpRoute HTTP requests to various profiling functions
mz-protoProtocol buffer libraries for Materialize.
mz-regexpRegexp utils.
mz-reprThe core data types for Materialize.
mz-repr-test-utilUtilities for creating objects in the repr crate for testing
mz-rocksdbA wrapper for RocksDB.
mz-rocksdb-typesShared types for the `mz-rocksdb` crate
mz-secretsSecrets Controller
mz-segmentSegment library for Rust.
mz-server-coreCore functions for serving.
mz-serviceCommon code for services orchestrated by environmentd.
mz-sqlSQL–dataflow translation.
mz-sql-lexerThe lexer for Materialize's SQL dialect.
mz-sql-parserThe parser for Materialize's SQL dialect.
mz-sql-prettyThe pretty printer for Materialize's SQL dialect.
mz-sqllogictestA driver for sqllogictest, a SQL correctness testing framework.
mz-ssh-utilSSH utility library.
mz-storageMaterialize's storage layer.
mz-storage-clientThe public API for the storage layer.
mz-storage-controllerImplementation of the Storage controller API.
mz-storage-operatorsShared Storage dataflow operators
mz-storage-typesShared types for the `mz-storage*` crates
mz-test-utilUtilities for testing Materialize
mz-testdriveIntegration test driver for Materialize.
mz-timely-utilUtilities for working with Timely.
mz-timestamp-oracleMaterialize's Timestamp Oracle.
mz-tls-utilA tiny utility crate for making TLS connectors.
mz-tracingA tracing library for Materialize.
mz-transformTransformations of Materialize expressions.
mz-walkaboutAST visitor generation.
workspace-hackworkspace-hack package, managed by hakari