Skip to content

Latest commit

 

History

History
 
 

developer

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
design
design
 
 
platform
platform
 
 
reference
reference
 
 
101-query-compilation.md
101-query-compilation.md
 
 
README.md
README.md
 
 
arrangements.md
arrangements.md
 
 
change-data-capture.md
change-data-capture.md
 
 
cloudbench.md
cloudbench.md
 
 
cloudtest.md
cloudtest.md
 
 
command-and-response-binary-encoding.md
command-and-response-binary-encoding.md
 
 
debugging.md
debugging.md
 
 
diagnostic-queries.md
diagnostic-queries.md
 
 
diagnostic-questions.md
diagnostic-questions.md
 
 
failpoints.md
failpoints.md
 
 
fast-compiles.md
fast-compiles.md
 
 
feature-benchmark.md
feature-benchmark.md
 
 
guide-changes.md
guide-changes.md
 
 
guide-testing.md
guide-testing.md
 
 
guide-tokio-console.md
guide-tokio-console.md
 
 
guide.md
guide.md
 
 
mzbuild.md
mzbuild.md
 
 
mzcompose.md
mzcompose.md
 
 
overview.md
overview.md
 
 
platform-checks.md
platform-checks.md
 
 
publishing-packages.md
publishing-packages.md
 
 
reading.md
reading.md
 
 
scratch.md
scratch.md
 
 
sqllogictest.md
sqllogictest.md
 
 
style.md
style.md
 
 
testdrive.md
testdrive.md
 
 
tracing.md
tracing.md
 
 
zippy.md
zippy.md
 
 

README.md

Developer documentation

This is the root directory of the Materialize developer documentation, which describes our engineering process and philosophy.

For a more general introduction to Materialize, see the user documentation. For API documentation, see dev.materialize.com.

New contributors

If you're a new contributor, we recommend reading the following chapters in the user documentation, if you haven't already:

  1. Get Started
  2. What Is Materialized?
  3. Architecture Overview

Then, once you're up to speed, dive into the developer guide. The guide is intended to be skimmed from start to finish, to give you the lay of the land, and then browsed as reference material as you skill up on the codebase.

Table of contents

  • change-data-capture.md describes our change data capture (CDC) requirements.

  • debugging.md is a guide to debugging Materialize using rust-gdb / rust-lldb.

  • Our diagnostics guide is a work in progress. The sections we have so far are themselves works in progress. Feel free to add to them if you think up of something useful.

    • diagnostic-queries.md has queries to find the specific, problematic Timely/Differential operators.
    • diagnostic-questions.md is a checklist of higher-level things to look for and think about if something is not working as expected.

  • fast-compiles.md describes various tricks for speeding up Rust compilation.

  • guide.md walks you through hacking on this codebase and our development philosophy.

    Several sections of the guide are important enough to warrant their own documents:

    • guide-changes.md describes practices and expectations for committing and reviewing code.
    • guide-testing.md describes our various test suites and our testing philosophy.

  • mzbuild.md describes the custom build system we use to manage our Docker images and Docker Compose configurations.

  • publishing.md details how to publish packages, like Rust crates or Docker images.

  • reading.md contains a reading list.

  • sqllogictest.md contains detailed information about our SQL logic testing framework.

  • tracing.md explains what tracing is, why we do it, and what our best practices are

  • We have basic introductions for developers for various parts of the system: