RisingWave Developer Documentation

Welcome to an overview of the developer documentations of RisingWave!

§Developer Docs

To learn how to develop RisingWave, and access high-level design docs, see the RisingWave Developer Guide.

§Crate Docs

Here are the rustdocs of the core crates in RisingWave. You can read them to understand the implementation details of RisingWave.

There’s also a Dash docset feed containing all crate docs including dependencies, which might be handy for developing RisingWave: subscribe here

§Core Components

• Frontend
  • risingwave_sqlparser
  • risingwave_frontend
• Meta
  • risingwave_meta
• Compute
  • risingwave_expr
  • risingwave_batch
  • risingwave_stream
• Storage
  • risingwave_storage
  • risingwave_hummock_sdk
  • risingwave_object_store

§DML and Connectors (Source and Sink)

• risingwave_dml
• risingwave_connector

§Common

Common functionalities shared inside RisingWave.

• risingwave_common
• risingwave_common_service
• risingwave_rpc_client
• risingwave_pb: protobuf definitions generated by prost from src/proto
• risingwave_rt

§Utils

The crates under src/utils are several independent util crates which helps to simplify development. We plan to publish them to crates.io in future when they are more mature.

• local_stats_alloc
• memcomparable
• pgwire