Skip to content

Commit

Permalink
Merge pull request #86 from EchoVault/chore/update-docs
Browse files Browse the repository at this point in the history
Chore/update docs
  • Loading branch information
kelvinmwinuka authored Jul 4, 2024
2 parents bbd2f7e + 05b42a8 commit eb94269
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Features offered by EchoVault include:
7) Key Eviction Policies.
8) Command extension via shared object files.
9) Command extension via embedded API.
10) Multi-database support for key namespacing.

We are working hard to add more features to EchoVault to make it
much more powerful. Features in the roadmap include:
Expand Down Expand Up @@ -121,7 +122,6 @@ Redis clients.
# Supported Commands

## ACL
* [AUTH](https://echovault.io/docs/commands/acl/auth)
* [ACL CAT](https://echovault.io/docs/commands/acl/acl_cat)
* [ACL DELUSER](https://echovault.io/docs/commands/acl/acl_deluser)
* [ACL GETUSER](https://echovault.io/docs/commands/acl/acl_getuser)
Expand All @@ -144,19 +144,30 @@ Redis clients.
* [SAVE](https://echovault.io/docs/commands/admin/save)

## CONNECTION
* [AUTH](https://echovault.io/docs/commands/connection/auth)
* [HELLO](https://echovault.io/docs/commands/connection/hello)
* [PING](https://echovault.io/docs/commands/connection/ping)
* [SELECT](https://echovault.io/docs/commands/connection/select)
* [SWAPDB](https://echovault.io/docs/commands/connection/swapdb)

## GENERIC
* [DECR](https://echovault.io/docs/commands/generic/decr)
* [DECRBY](https://echovault.io/docs/commands/generic/decrby)
* [DEL](https://echovault.io/docs/commands/generic/del)
* [EXPIRE](https://echovault.io/docs/commands/generic/expire)
* [EXPIRETIME](https://echovault.io/docs/commands/generic/expiretime)
* [FLUSHALL](https://echovault.io/docs/commands/generic/flushall)
* [FLUSHDB](https://echovault.io/docs/commands/generic/flushdb)
* [GET](https://echovault.io/docs/commands/generic/get)
* [INCR](https://echovault.io/docs/commands/generic/incr)
* [INCRBY](https://echovault.io/docs/commands/generic/incrby)
* [MGET](https://echovault.io/docs/commands/generic/mget)
* [MSET](https://echovault.io/docs/commands/generic/mset)
* [PERSIST](https://echovault.io/docs/commands/generic/persist)
* [PEXPIRE](https://echovault.io/docs/commands/generic/pexpire)
* [PEXPIRETIME](https://echovault.io/docs/commands/generic/pexpiretime)
* [PTTL](https://echovault.io/docs/commands/generic/pttl)
* [RENAME](https://echovault.io/docs/commands/generic/rename)
* [SET](https://echovault.io/docs/commands/generic/set)
* [TTL](https://echovault.io/docs/commands/generic/ttl)

Expand Down
4 changes: 2 additions & 2 deletions internal/modules/connection/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ Otherwise, the server will return "PONG".`,
Module: constants.ConnectionModule,
Categories: []string{constants.FastCategory, constants.ConnectionCategory},
Description: `(HELLO [protover [AUTH username password] [SETNAME clientname]])
Switch to a different protocol, optionally authenticating and setting the connection's name,
or provide a contextual client report.`,
Switch to a different protocol, optionally authenticating and setting the connection's name.
This command returns a contextual client report.`,
Sync: false,
KeyExtractionFunc: func(cmd []string) (internal.KeyExtractionFuncResult, error) {
return internal.KeyExtractionFuncResult{
Expand Down
8 changes: 4 additions & 4 deletions internal/modules/generic/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ LT - Only set the expiry time if the new expiry time is less than the current on
{
Command: "incr",
Module: constants.GenericModule,
Categories: []string{constants.KeyspaceCategory, constants.WriteCategory, constants.FastCategory},
Categories: []string{constants.WriteCategory, constants.FastCategory},
Description: `(INCR key)
Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation.
An error is returned if the key contains a value of the wrong type or contains a string that cannot be represented as integer.
Expand All @@ -866,7 +866,7 @@ This operation is limited to 64 bit signed integers.`,
{
Command: "decr",
Module: constants.GenericModule,
Categories: []string{constants.KeyspaceCategory, constants.WriteCategory, constants.FastCategory},
Categories: []string{constants.WriteCategory, constants.FastCategory},
Description: `(DECR key)
Decrements the number stored at key by one.
If the key does not exist, it is set to 0 before performing the operation.
Expand All @@ -879,7 +879,7 @@ This operation is limited to 64 bit signed integers.`,
{
Command: "incrby",
Module: constants.GenericModule,
Categories: []string{constants.KeyspaceCategory, constants.WriteCategory, constants.FastCategory},
Categories: []string{constants.WriteCategory, constants.FastCategory},
Description: `(INCRBY key increment)
Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation.
An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.`,
Expand All @@ -901,7 +901,7 @@ An error is returned if the key contains a value of the wrong type or contains a
{
Command: "decrby",
Module: constants.GenericModule,
Categories: []string{constants.KeyspaceCategory, constants.WriteCategory, constants.FastCategory},
Categories: []string{constants.WriteCategory, constants.FastCategory},
Description: `(DECRBY key decrement)
The DECRBY command reduces the value stored at the specified key by the specified decrement.
If the key does not exist, it is initialized with a value of 0 before performing the operation.
Expand Down

0 comments on commit eb94269

Please sign in to comment.