Skip to content

Commit

Permalink
stylefix
Browse files Browse the repository at this point in the history
  • Loading branch information
balazskreith committed Aug 7, 2024
1 parent 000f32f commit 3153d09
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
23 changes: 14 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
## User Manuals
- Hamok
- [HamokEmitter](./emitter.md)
- [HamokMap](./map.md)
- [HamokQueue](./queue.md)
- [HamokRecord](./record.md)
## User Manual
Hamok | [HamokEmitter](./emitter.md) | [HamokMap](./map.md) | [HamokQueue](./queue.md) | [HamokRecord](./record.md)

## Table of Contents
1. [Introduction](#introduction)
Expand Down Expand Up @@ -328,13 +324,22 @@ either explicitly remove logs or set the expiration time for logs. Additionally
to store the state of the instance along with the commitIndex a snapshot represents.
Therefore any new instance can start from the snapshot and apply only the logs after the snapshot.

### If I export a snapshot do I have to delete the logs?

Yes, if you don't have an expiration time set for logs,
you should delete the logs after exporting a snapshot.

### What is the difference between a map and a record?

A map is a key-value store, while a record is a single object with multiple fields.

### Is this an attempt to replace Redis?

No. Hamok is designed to be lightweight and its primary purpose is to manage
a leader within a cluster and share data atomically.
No. Hamok primary purpose is to give the RAFT consensus algorithm to your service cluster,
so you can manage a leader within a cluster and share data atomically.
It is more suitable for configuration sharing, leader election, and other small but significant
signals and data sharing, rather than acting as a full-fledged large and fast data sharing.
signals and data sharing, rather than acting as a full-fledged large and fast data storing and retrieving service.

In general, if you just want to share key-value map or queue between two instance and you need it fast use Redis.
If you need to apply distributed lock to access a key in redis, Hamok can come into the picture as RAFT gives you atomicity.
Hamok can also be used to elect a leader in the cluster giving some special management job to one instance amongst the replicated many.
8 changes: 2 additions & 6 deletions docs/map.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
## User Manuals
- [Hamok](./index.md)
- [HamokEmitter](./emitter.md)
- HamokMap
- [HamokQueue](./queue.md)
- [HamokRecord](./record.md)
## User Manual
[Hamok](./index.md) | [HamokEmitter](./emitter.md) | HamokMap | [HamokQueue](./queue.md) | [HamokRecord](./record.md)

## Table of Contents
* [Overview](#overview)
Expand Down

0 comments on commit 3153d09

Please sign in to comment.