Skip to content

Commit

Permalink
doc: readme - wording
Browse files Browse the repository at this point in the history
  • Loading branch information
nalgeon committed Apr 13, 2024
1 parent 25b66b4 commit a7f4dfe
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ SUNION SUNIONSTORE

### Hashes

Hashes are record types modeled as collections of field-value pairs. Redka supports the following hash-related commands:
Hashes are field-value (hash)maps. Redka supports the following hash-related commands:

| Command | Go API | Description |
| -------------- | ------------------------ | ------------------------------------------------ |
Expand Down Expand Up @@ -189,7 +189,7 @@ xattr -d com.apple.quarantine redka
chmod +x redka
```

Or pull with Docker as follows:
Or pull with Docker as follows (x86/ARM):

```shell
docker pull nalgeon/redka
Expand Down Expand Up @@ -357,6 +357,8 @@ updated count=2 err=<nil>

See the full example in [example/tx/main.go](example/tx/main.go).

See the [package documentation](https://pkg.go.dev/github.com/nalgeon/redka) for API reference.

## Persistence

Redka stores data in a SQLite database using the following tables:
Expand All @@ -366,20 +368,19 @@ rkey
---
id integer primary key
key text not null
type integer not null -- 1 string, 2 list, 3 set, 4 hash
-- 5 sorted set
type integer not null -- 1 string, 2 list, 3 set, 4 hash, 5 sorted set
version integer not null -- incremented when the key value is updated
etime integer -- expiration timestamp in unix milliseconds
mtime integer not null -- modification timestamp in unix milliseconds
rstring
---
key_id integer
key_id integer not null -- FK -> key.id
value blob not null
rhash
---
key_id integer
key_id integer not null -- FK -> key.id
field text not null
value blob not null
```
Expand Down

0 comments on commit a7f4dfe

Please # to comment.