#write-ahead-log #fifo-queue #wal #disk #operations #word #revert

qwal

A disk baced Write Ahead Log that can functuin as a FIFO queue

1 unstable release

0.1.0 Apr 10, 2024

#379 in Database interfaces

Download history 197/week @ 2024-04-04 167/week @ 2024-04-11 334/week @ 2024-04-18 19/week @ 2024-04-25 57/week @ 2024-05-02 207/week @ 2024-05-09 201/week @ 2024-05-16 276/week @ 2024-05-23 182/week @ 2024-05-30 289/week @ 2024-06-06 435/week @ 2024-06-13 339/week @ 2024-06-20 118/week @ 2024-06-27

1,192 downloads per month

Apache-2.0

50KB
1K SLoC

Rust 795 SLoC // 0.1% comments Shell 235 SLoC // 0.0% comments

Repository Template  Build Status Quality Checks License Checks Security Checks Code Coverage

Queue like disk backed WAL


Pronouced Quál - from the german word for agony - because it is.

features

tokio

uses the tokio types

async-std

uses async-std types

Operations

The basic concept is simple, qwal supports exactly 4 operations:

push

Appends a new entry to the end of the queue, returning its index.

pop

Reads the next index from the queue, returning the previous entry and its index if one exists, or none if the queue is empty.

ack

Acknowledges processing of an entry, confirming it is enqueued.

revert

Reverts back to the last acknowledged entry in the queue - will clear/drain any entry since that point.

Performance Characteristics

push

Writes the data to disk and performs a fsync. Also a seek might be executed if a pop was performed since the last push.

pop

Reads the data from disk. Also a seek is performed if a push since the alst reads.

ack

No disk operations are performed, ack's are persisted either during a push operation or as part of the shutdown sequence.

Operations

qwal provides all limits as soft limits, meaning they are considered reached after an operation has exceeded them, and not before.

chunk_size

To allow easier reclamation of space the WAL is stored in multiple chunks. The chunk size defines the limit. A chunk is considered full once a push makes it exceed the chunk_size

max_chunks

The soft limit of of chunks that can be active and open at the same time. The WAL is considered full when max_chunks + 1 would need to be created.

Dependencies

~2–14MB
~157K SLoC