pkg/SugarDB
1
0
Fork 0
mirror of https://github.com/EchoVault/SugarDB.git synced 2025-10-05 16:06:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added godoc comment for Decr embedded API method.

Browse Source
This commit is contained in:
Kelvin Mwinuka
2024-06-23 22:52:32 +08:00
parent 10f01c1d87
commit 8ad27145f5
2 changed files with 23 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
echovault/api_generic.go
View File

@@ -440,6 +440,14 @@ func (server *EchoVault) Incr(key string) (int, error) {
return internal.ParseIntegerResponse(b) return internal.ParseIntegerResponse(b)
} }
// Decr decrements the value at the given key if it's an integer.
// If the key does not exist, it's created with an initial value of 0 before incrementing.
//
// Parameters:
//
// `key` - string
//
// Returns: The new value as an integer.
func (server *EchoVault) Decr(key string) (int, error) { func (server *EchoVault) Decr(key string) (int, error) {
// Construct the command // Construct the command
cmd := []string{"DECR", key} cmd := []string{"DECR", key}

23
internal/modules/generic/commands.go
View File

@@ -646,19 +646,26 @@ LT - Only set the expiry time if the new expiry time is less than the current on
HandlerFunc: handleExpireAt, HandlerFunc: handleExpireAt,
}, },
{ {
Command: "incr", Command: "incr",
Module: constants.GenericModule, Module: constants.GenericModule,
Categories: []string{constants.KeyspaceCategory, constants.WriteCategory, constants.FastCategory}, Categories: []string{constants.KeyspaceCategory, 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. This operation is limited to 64 bit signed integers.`, 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.
This operation is limited to 64 bit signed integers.`,
Sync: true, Sync: true,
KeyExtractionFunc: incrKeyFunc, KeyExtractionFunc: incrKeyFunc,
HandlerFunc: handleIncr, HandlerFunc: handleIncr,
}, },
{ {
Command: "decr", Command: "decr",
Module: constants.GenericModule, Module: constants.GenericModule,
Categories: []string{constants.KeyspaceCategory, constants.WriteCategory, constants.FastCategory}, Categories: []string{constants.KeyspaceCategory, 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. An error is returned if the key contains a value of the wrong type or contains a string that cannot be represented as integer. This operation is limited to 64 bit signed integers.`, 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.
An error is returned if the key contains a value of the wrong type or contains a string that cannot be represented as integer.
This operation is limited to 64 bit signed integers.`,
Sync: true, Sync: true,
KeyExtractionFunc: decrKeyFunc, KeyExtractionFunc: decrKeyFunc,
HandlerFunc: handleDecr, HandlerFunc: handleDecr,