Skip to content

Commit

Permalink
Merge pull request valkey-io#2218 from janhavigupta007/go/multi_strin…
Browse files Browse the repository at this point in the history 
…g_commands

Go: Implementing string commands
  • Loading branch information
@janhavigupta007
janhavigupta007 authored Sep 11, 2024
2 parents 923ecc4 + fea9a5b commit 284247b
Show file tree
Hide file tree
Showing 6 changed files with 567 additions and 10 deletions.
75 changes: 74 additions & 1 deletion go/api/base_client.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import "C"

import (
"errors"
"strconv"
"unsafe"

"github.com/valkey-io/valkey-glide/go/glide/protobuf"
Expand Down Expand Up @@ -158,6 +159,38 @@ func (client *baseClient) Get(key string) (string, error) {
return handleStringOrNullResponse(result), nil
}

func (client *baseClient) MSet(keyValueMap map[string]string) (string, error) {
flat := []string{}
for key, value := range keyValueMap {
flat = append(flat, key, value)
}
result, err := client.executeCommand(C.MSet, flat)
if err != nil {
return "", err
}
return handleStringResponse(result), nil
}

func (client *baseClient) MSetNX(keyValueMap map[string]string) (bool, error) {
flat := []string{}
for key, value := range keyValueMap {
flat = append(flat, key, value)
}
result, err := client.executeCommand(C.MSetNX, flat)
if err != nil {
return false, err
}
return handleBooleanResponse(result), nil
}

func (client *baseClient) MGet(keys []string) ([]string, error) {
result, err := client.executeCommand(C.MGet, keys)
if err != nil {
return nil, err
}
return handleStringArrayResponse(result), nil
}

func (client *baseClient) Incr(key string) (int64, error) {
result, err := client.executeCommand(C.Incr, []string{key})
if err != nil {
Expand Down Expand Up @@ -201,6 +234,46 @@ func (client *baseClient) DecrBy(key string, amount int64) (int64, error) {
return handleLongResponse(result), nil
}

func (client *baseClient) Strlen(key string) (int64, error) {
result, err := client.executeCommand(C.Strlen, []string{key})
if err != nil {
return 0, err
}
return handleLongResponse(result), nil
}

func (client *baseClient) SetRange(key string, offset int, value string) (int64, error) {
result, err := client.executeCommand(C.SetRange, []string{key, strconv.Itoa(offset), value})
if err != nil {
return 0, err
}
return handleLongResponse(result), nil
}

func (client *baseClient) GetRange(key string, start int, end int) (string, error) {
result, err := client.executeCommand(C.GetRange, []string{key, strconv.Itoa(start), strconv.Itoa(end)})
if err != nil {
return "", err
}
return handleStringResponse(result), nil
}

func (client *baseClient) Append(key string, value string) (int64, error) {
result, err := client.executeCommand(C.Append, []string{key, value})
if err != nil {
return 0, err
}
return handleLongResponse(result), nil
}

func (client *baseClient) LCS(key1 string, key2 string) (string, error) {
result, err := client.executeCommand(C.LCS, []string{key1, key2})
if err != nil {
return "", err
}
return handleStringResponse(result), nil
}

func (client *baseClient) GetDel(key string) (string, error) {
if key == "" {
return "", errors.New("key is required")
Expand All @@ -211,5 +284,5 @@ func (client *baseClient) GetDel(key string) (string, error) {
return "", err
}

return handleStringOrNullResponseWithFree(result), nil
return handleStringOrNullResponse(result), nil
}
206 changes: 204 additions & 2 deletions go/api/commands.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ type StringCommands interface {
//
// For example:
// result, err := client.Set("key", "value")
// result : "OK"
//
// [valkey.io]: https://valkey.io/commands/set/
Set(key string, value string) (string, error)
Expand All @@ -43,13 +44,15 @@ type StringCommands interface {
// If SetOptions.returnOldValue is set, return the old value as a String.
//
// For example:
// key: initialValue
// result, err := client.SetWithOptions("key", "value", &api.SetOptions{
// ConditionalSet: api.OnlyIfExists,
// Expiry: &api.Expiry{
// Type: api.Seconds,
// Count: uint64(5),
// },
// })
// result: "OK"
//
// [valkey.io]: https://valkey.io/commands/set/
SetWithOptions(key string, value string, options *SetOptions) (string, error)
Expand All @@ -65,11 +68,81 @@ type StringCommands interface {
// If key exists, returns the value of key as a String. Otherwise, return ("").
//
// For example:
// result, err := client.Get("key")
// 1. key: value
// result, err := client.Get("key")
// result: "value"
// 2. result, err := client.Get("nonExistentKey")
// result: ""
//
// [valkey.io]: https://valkey.io/commands/get/
Get(key string) (string, error)

// Sets multiple keys to multiple values in a single operation.
//
// Note:
// When in cluster mode, the command may route to multiple nodes when keys in keyValueMap map to different hash slots.
//
// See [valkey.io] for details.
//
// Parameters:
// keyValueMap - A key-value map consisting of keys and their respective values to set.
//
// Return value:
// "OK" on success.
//
// For example:
// result, err := client.MSet(map[string]string{"key1": "value1", "key2": "value2"})
// result: "OK"
//
// [valkey.io]: https://valkey.io/commands/mset/
MSet(keyValueMap map[string]string) (string, error)

// Retrieves the values of multiple keys.
//
// Note:
// When in cluster mode, the command may route to multiple nodes when keys map to different hash slots.
//
// See [valkey.io] for details.
//
// Parameters:
// keys - A list of keys to retrieve values for.
//
// Return value:
// An array of values corresponding to the provided keys.
// If a key is not found, its corresponding value in the list will be an empty string("").
//
// For example:
// key1: value1, key2: value2
// result, err := client.MGet([]string{"key1", "key2", "key3"})
// result : {"value1", "value2", ""}
//
// [valkey.io]: https://valkey.io/commands/mget/
MGet(keys []string) ([]string, error)

// Sets multiple keys to values if the key does not exist. The operation is atomic, and if one or more keys already exist,
// the entire operation fails.
//
// Note:
// When in cluster mode, all keys in keyValueMap must map to the same hash slot.
//
// See [valkey.io] for details.
//
// Parameters:
// keyValueMap - A key-value map consisting of keys and their respective values to set.
//
// Return value:
// true, if all keys were set. false, if no key was set.
//
// For example:
// 1. result, err := client.MSetNX(map[string]string{"key1": "value1", "key2": "value2"})
// result: true
// 2. key3: initialValue
// result, err := client.MSetNX(map[string]string{"key3": "value3", "key4": "value4"})
// result: false
//
// [valkey.io]: https://valkey.io/commands/msetnx/
MSetNX(keyValueMap map[string]string) (bool, error)

// Increments the number stored at key by one. If key does not exist, it is set to 0 before performing the operation.
//
// See [valkey.io] for details.
Expand All @@ -81,7 +154,9 @@ type StringCommands interface {
// The value of key after the increment.
//
// For example:
// key: 1
// result, err := client.Incr("key");
// result: 2
//
// [valkey.io]: https://valkey.io/commands/incr/
Incr(key string) (int64, error)
Expand All @@ -98,7 +173,9 @@ type StringCommands interface {
// The value of key after the increment.
//
// For example:
// key: 1
// result, err := client.IncrBy("key", 2);
// result: 3
//
// [valkey.io]: https://valkey.io/commands/incrby/
IncrBy(key string, amount int64) (int64, error)
Expand All @@ -117,7 +194,9 @@ type StringCommands interface {
// The value of key after the increment.
//
// For example:
// key: 1
// result, err := client.IncrBy("key", 0.5);
// result: 1.5
//
// [valkey.io]: https://valkey.io/commands/incrbyfloat/
IncrByFloat(key string, amount float64) (float64, error)
Expand All @@ -133,7 +212,9 @@ type StringCommands interface {
// The value of key after the decrement.
//
// For example:
// key: 1
// result, err := client.Decr("key");
// result: 0
//
// [valkey.io]: https://valkey.io/commands/decr/
Decr(key string) (int64, error)
Expand All @@ -150,11 +231,132 @@ type StringCommands interface {
// The value of key after the decrement.
//
// For example:
// result, err := client.Decr("key");
// key: 1
// result, err := client.DecrBy("key", 2);
// result: -1
//
// [valkey.io]: https://valkey.io/commands/decrby/
DecrBy(key string, amount int64) (int64, error)

// Returns the length of the string value stored at key.
//
// See [valkey.io] for details.
//
// Parameters:
// key - The key to check its length.
//
// Return value:
// The length of the string value stored at key.
// If key does not exist, it is treated as an empty string, and the command returns 0.
//
// For example:
// key: value
// result, err := client.Strlen("key");
// result: 5
//
// [valkey.io]: https://valkey.io/commands/strlen/
Strlen(key string) (int64, error)

// Overwrites part of the string stored at key, starting at the specified byte's offset, for the entire length of value.
// If the offset is larger than the current length of the string at key, the string is padded with zero bytes to make
// offset fit.
// Creates the key if it doesn't exist.
//
// See [valkey.io] for details.
//
// Parameters:
// key - The key of the string to update.
// offset - The position in the string where value should be written.
// value - The string written with offset.
//
// Return value:
// The length of the string stored at key after it was modified.
//
// For example:
// 1. result, err := client.SetRange("key", 6, "GLIDE");
// result: 11 (New key created with length of 11 bytes)
// value, err := client.Get("key")
// value: "\x00\x00\x00\x00\x00\x00GLIDE"
// 2. "key": "愛" (value char takes 3 bytes)
// result, err = client.SetRange("key", 1, "a")
// "key": �a� // (becomes an invalid UTF-8 string)
//
// [valkey.io]: https://valkey.io/commands/setrange/
SetRange(key string, offset int, value string) (int64, error)

// Returns the substring of the string value stored at key, determined by the byte's offsets start and end (both are
// inclusive).
// Negative offsets can be used in order to provide an offset starting from the end of the string. So -1 means the last
// character, -2 the penultimate and so forth.
//
// See [valkey.io] for details.
//
// Parameters:
// key - The key of the string.
// start - The starting offset.
// end - The ending offset.
//
// Return value:
// A substring extracted from the value stored at key.
// An ("") empty string is returned if the offset is out of bounds.
//
// For example:
// 1. mykey: "This is a string"
// result, err := client.GetRange("mykey", 0, 3);
// result: "This"
// result, err := client.GetRange("mykey", -3, -1);
// result: "ing" (extracted last 3 characters of a string)
// 2. "key": "愛" (value char takes 3 bytes)
// result, err = client.GetRange("key", 0, 1)
// result: � // (returns an invalid UTF-8 string)
//
// [valkey.io]: https://valkey.io/commands/getrange/
GetRange(key string, start int, end int) (string, error)

// Appends a value to a key. If key does not exist it is created and set as an empty string, so APPEND will be similar to
// SET in this special case.
//
// See [valkey.io] for details.
//
// Parameters:
// key - The key of the string.
// value - The value to append.
//
// Return value:
// The length of the string after appending the value.
//
// For example:
// result, err := client.Append("key", "value");
// result: 5
//
// [valkey.io]: https://valkey.io/commands/append/
Append(key string, value string) (int64, error)

// Returns the longest common subsequence between strings stored at key1 and key2.
//
// Since:
// Valkey 7.0 and above.
//
// Note:
// When in cluster mode, key1 and key2 must map to the same hash slot.
//
// See [valkey.io] for details.
//
// Parameters:
// key1 - The key that stores the first string.
// key2 - The key that stores the second string.
//
// Return value:
// A String containing the longest common subsequence between the 2 strings.
// An empty String is returned if the keys do not exist or have no common subsequences.
//
// For example:
// testKey1: foo, testKey2: fao
// result, err := client.LCS("testKey1", "testKey2");
// result: "fo"
//
// [valkey.io]: https://valkey.io/commands/lcs/
LCS(key1 string, key2 string) (string, error)
// GetDel gets the value associated with the given key and deletes the key.
//
// Parameters:
Expand Down
Loading

0 comments on commit 284247b

Please sign in to comment.