jiacai2050 commented on code in PR #140:
URL: https://github.com/apache/horaedb-docs/pull/140#discussion_r1805969527


##########
content/en/docs/design/wal_on_disk.md:
##########
@@ -0,0 +1,142 @@
+---
+title: "WAL on Disk"
+---
+
+## Architecture
+
+This section introduces the implementation of a standalone Write-Ahead Log 
(WAL, hereinafter referred to as "the log") based on a local disk. In this 
implementation, the log is managed at the region level.
+
+```
+            ┌────────────────────────────┐
+            │          HoraeDB           │
+            │                            │
+            │ ┌────────────────────────┐ │
+            │ │          WAL           │ │         ┌────────────────────────┐
+            │ │                        │ │         │                        │
+            │ │         ......         │ │         │      File System       │
+            │ │                        │ │         │                        │
+            │ │ ┌────────────────────┐ │ │ manage  │ ┌────────────────────┐ │
+ Write ─────┼─┼─►       Region       ├─┼─┼─────────┼─►     Region Dir     │ │
+            │ │ │                    │ │ │         │ │                    │ │
+ Read  ─────┼─┼─►   ┌────────────┐   │ │ │  mmap   │ │ ┌────────────────┐ │ │
+            │ │ │   │  Segment 0 ├───┼─┼─┼─────────┼─┼─► Segment File 0 │ │ │
+            │ │ │   └────────────┘   │ │ │         │ │ └────────────────┘ │ │
+Delete ─────┼─┼─►   ┌────────────┐   │ │ │  mmap   │ │ ┌────────────────┐ │ │
+            │ │ │   │  Segment 1 ├───┼─┼─┼─────────┼─┼─► Segment File 1 │ │ │
+            │ │ │   └────────────┘   │ │ │         │ │ └────────────────┘ │ │
+            │ │ │   ┌────────────┐   │ │ │  mmap   │ │ ┌────────────────┐ │ │
+            │ │ │   │  Segment 2 ├───┼─┼─┼─────────┼─┼─► Segment File 2 │ │ │
+            │ │ │   └────────────┘   │ │ │         │ │ └────────────────┘ │ │
+            │ │ │       ......       │ │ │         │ │       ......       │ │
+            │ │ └────────────────────┘ │ │         │ └────────────────────┘ │
+            │ │         ......         │ │         │         ......         │
+            │ └────────────────────────┘ │         └────────────────────────┘
+            └────────────────────────────┘
+```
+
+## Data Model
+
+### File Paths
+
+Each region has its own directory to manage all segments for that region. The 
directory is named after the region's ID. Each segment is named using the 
format `segment_<id>.wal`, with IDs starting from 0 and incrementing.

Review Comment:
   ```suggestion
   Each region has its own directory to manage all segments for that region. 
The directory is named after the region's ID. Each segment is named using the 
format `seg_<id>`, with IDs starting from 0 and incrementing.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to