diff --git a/docs/dev/src/SUMMARY.md b/docs/dev/src/SUMMARY.md index 382cc0f80fec8..37a1484f0f36b 100644 --- a/docs/dev/src/SUMMARY.md +++ b/docs/dev/src/SUMMARY.md @@ -26,29 +26,27 @@ # Specialized topics - [Develop Connectors](./connector/intro.md) + - [Source](./connector/source.md) - [Continuous Integration](./ci.md) --- # Design docs - - - [Architecture Design](./design/architecture-design.md) -- [An Overview of RisingWave Streaming Engine](./design/streaming-overview.md) -- [An Overview of RisingWave State Store](./design/state-store-overview.md) +- [Streaming Engine](./design/streaming-overview.md) + - [Checkpoint](./design/checkpoint.md) + - [Aggregation](./design/aggregation.md) + - [MView on Top of MView](./design/mv-on-mv.md) + - [Backfill](./design/backfill.md) +- [State Store](./design/state-store-overview.md) + - [Shared Buffer](./design/shared-buffer.md) + - [Relational Table](./design/relational-table.md) + - [Multiple Object Storage Backends](./design/multi-object-store.md) - [Meta Service](./design/meta-service.md) -- [Create MView on Top of MView](./design/mv-on-mv.md) -- [Checkpoint](./design/checkpoint.md) -- [Design of Data Source](./design/data-source.md) - [Data Model and Encoding](./design/data-model-and-encoding.md) -- [Design of Batch Local Execution Mode](./design/batch-local-execution-mode.md) +- [Batch Local Execution Mode](./design/batch-local-execution-mode.md) - [Consistent Hash](./design/consistent-hash.md) -- [Build RisingWave with Multiple Object Storage Backends](./design/multi-object-store.md) -- [Backfill](./design/backfill.md) -- [Aggregation](./design/aggregation.md) -- [Shared Buffer](./design/shared-buffer.md) -- [Relational Table](./design/relational-table.md) - [Keys](./design/keys.md) + ## Components RisingWave's data source covers four parts: connectors, enumerators, ConnectorSource and SourceExecutor. @@ -41,7 +37,7 @@ pub trait SplitReader: Sized { ### Enumerators -`Enumerator` periodically requests upstream to discover changes in splits, and in most cases the number of splits only increases. The enumerator is a separate task that runs on the [meta](./meta-service.md). If the upstream split changes, the enumerator notifies the connector by means of config change to change the subscription relationship. +`Enumerator` periodically requests upstream to discover changes in splits, and in most cases the number of splits only increases. The enumerator is a separate task that runs on the [meta](../design/meta-service.md). If the upstream split changes, the enumerator notifies the connector by means of config change to change the subscription relationship. All enumerators need to implement the following trait. diff --git a/docs/dev/src/design/data-model-and-encoding.md b/docs/dev/src/design/data-model-and-encoding.md index 580a885bc79f9..c2a70c40909c6 100644 --- a/docs/dev/src/design/data-model-and-encoding.md +++ b/docs/dev/src/design/data-model-and-encoding.md @@ -1,11 +1,6 @@ # Data Model and Encoding -- [Data Model and Encoding](#data-model-and-encoding) - - [Data Model](#data-model) - - [In-Memory Encoding](#in-memory-encoding) - - [On-Disk Encoding](#on-disk-encoding) - - + ## Data Model @@ -26,7 +21,7 @@ Primitive data types: - Strings: `VARCHAR` - Temporals: `DATE`, `TIMESTAMP`, `TIMESTAMP WITH TIME ZONE`, `TIME`, `INTERVAL` -Composite data types (WIP): +Composite data types: - `Struct`: A structure with a list of named, strong-typed fields. - `List`: A variable-length list of values with same data type. diff --git a/docs/dev/src/design/meta-service.md b/docs/dev/src/design/meta-service.md index bab66c6077e9c..4ec7b01d10e4f 100644 --- a/docs/dev/src/design/meta-service.md +++ b/docs/dev/src/design/meta-service.md @@ -1,14 +1,6 @@ # Meta Service -- [Meta Service](#meta-service) - - [Background](#background) - - [Meta Store](#meta-store) - - [Types of Metadata](#types-of-metadata) - - [Catalog](#catalog) - - [Storage](#storage) - - [Push on Updates](#push-on-updates) - - + ## Background diff --git a/docs/dev/src/design/multi-object-store.md b/docs/dev/src/design/multi-object-store.md index 4ac6ef1a41805..699cd036f419d 100644 --- a/docs/dev/src/design/multi-object-store.md +++ b/docs/dev/src/design/multi-object-store.md @@ -1,7 +1,6 @@ # Build RisingWave with Multiple Object Storage Backends - - + ## Overview As a cloud-neutral database, RisingWave supports running on different (object) storage backends. Currently, these storage products include diff --git a/docs/dev/src/design/mv-on-mv.md b/docs/dev/src/design/mv-on-mv.md index 8f810a6a62f33..d1091c0c0ac82 100644 --- a/docs/dev/src/design/mv-on-mv.md +++ b/docs/dev/src/design/mv-on-mv.md @@ -1,4 +1,4 @@ -# Create MView on Top of MView +# MView on Top of MView ## Background diff --git a/docs/dev/src/design/shared-buffer.md b/docs/dev/src/design/shared-buffer.md index 7c7dac8f06e2d..846d8bd1d064a 100644 --- a/docs/dev/src/design/shared-buffer.md +++ b/docs/dev/src/design/shared-buffer.md @@ -1,14 +1,6 @@ # The Hummock Shared Buffer -Table of contents: - -- [Introduction](#introduction) -- [Part 1: Async Checkpoint](#part-1-async-checkpoint) - - [Write Path](#write-path) - - [Read Path](#read-path) -- [Part 2: Write Anytime / Async Flush](#part-2-write-anytime--async-flush) - - [A New Merge Iterator](#a-new-merge-iterator) - - [Considerations](#considerations) + ## Introduction diff --git a/docs/dev/src/design/state-store-overview.md b/docs/dev/src/design/state-store-overview.md index be8f3491550fc..a11d9528d2586 100644 --- a/docs/dev/src/design/state-store-overview.md +++ b/docs/dev/src/design/state-store-overview.md @@ -1,18 +1,6 @@ # An Overview of RisingWave State Store -- [An Overview of RisingWave State Store](#an-overview-of-risingwave-state-store) - - [Overview](#overview) - - [Architecture](#architecture) - - [The Hummock User API](#the-hummock-user-api) - - [Hummock Internals](#hummock-internals) - - [Storage Format](#storage-format) - - [Write Path](#write-path) - - [Read Path](#read-path) - - [Compaction](#compaction) - - [Transaction Management with Hummock Manager](#transaction-management-with-hummock-manager) - - [Checkpointing in Streaming](#checkpointing-in-streaming) - - + ## Overview diff --git a/docs/dev/src/design/streaming-overview.md b/docs/dev/src/design/streaming-overview.md index b24eeaba51cb9..d4a80c2a66c48 100644 --- a/docs/dev/src/design/streaming-overview.md +++ b/docs/dev/src/design/streaming-overview.md @@ -1,16 +1,6 @@ # An Overview of the RisingWave Streaming Engine -- [An Overview of the RisingWave Streaming Engine](#an-overview-of-risingwave-streaming-engine) - - [Overview](#overview) - - [Architecture](#architecture) - - [Actors, executors, and states](#actors-executors-and-states) - - [Actors](#actors) - - [Executors](#executors) - - [Checkpoint, Consistency, and Fault tolerance](#checkpoint-consistency-and-fault-tolerance) - - [Barrier based checkpoint](#barrier-based-checkpoint) - - [Fault tolerance](#fault-tolerance) - - + ## Overview