Go: Implement Sort, Sort ReadOnly and Sort Store commands #2888
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
niharikabhavaraju
force-pushed
the
niharika-sortcmds
branch
from
10c81db to
072f75b
Compare
Signed-off-by: Niharika Bhavaraju <[email protected]>
Signed-off-by: Niharika Bhavaraju <[email protected]>
niharikabhavaraju
force-pushed
the
niharika-sortcmds
branch
from
072f75b to
ca3c534
Compare
go/api/command_options.go
Outdated
| @@ -279,6 +280,128 @@ func (listDirection ListDirection) toString() (string, error) { | |||
| } | |||
| } | |||
|
|
|||
| const ( | |||
There was a problem hiding this comment.
Please move these changes into a separate file under package options.
| @@ -225,3 +225,254 @@ func (suite *GlideTestSuite) TestConfigSetAndGet_invalidArgs() { | |||
| assert.Equal(suite.T(), map[api.Result[string]]api.Result[string]{}, result2) | |||
| assert.Nil(suite.T(), err) | |||
| } | |||
|
|
|||
| func (suite *GlideTestSuite) TestSortWithOptions_ExternalWeights() { | |||
There was a problem hiding this comment.
Is this functionality specific to standalone or a particular version?
There was a problem hiding this comment.
Some SORT options (searching in multiple keys) available only in standalone mode.
It was planned to support this on server side in cluster mode with condition that all keys are mapped to the same slot. I don't know the status of this feature - could you check please?
| @@ -225,3 +225,254 @@ func (suite *GlideTestSuite) TestConfigSetAndGet_invalidArgs() { | |||
| assert.Equal(suite.T(), map[api.Result[string]]api.Result[string]{}, result2) | |||
| assert.Nil(suite.T(), err) | |||
| } | |||
|
|
|||
| func (suite *GlideTestSuite) TestSortWithOptions_ExternalWeights() { | |||
There was a problem hiding this comment.
Some SORT options (searching in multiple keys) available only in standalone mode.
It was planned to support this on server side in cluster mode with condition that all keys are mapped to the same slot. I don't know the status of this feature - could you check please?
go/api/generic_commands.go
Outdated
| // Sorts the elements in the list, set, or sorted set at key and returns the result. | ||
| // The sort command can be used to sort elements based on different criteria and apply | ||
| // transformations on sorted elements. | ||
| // To store the result into a new key, see {@link #sortStore(string, string)}. |
There was a problem hiding this comment.
Fix link formats (apply throughout)
go/api/command_options.go
Outdated
| var args []string | ||
|
|
||
| if opts.Limit != nil { | ||
| args = append(args, LIMIT_COMMAND_STRING, fmt.Sprintf("%d", opts.Limit.Offset), fmt.Sprintf("%d", opts.Limit.Count)) |
There was a problem hiding this comment.
why not utils.IntToString() as it is done in other places?
Signed-off-by: Niharika Bhavaraju <[email protected]>
go/api/generic_commands.go
Outdated
| @@ -11,7 +13,7 @@ type GenericBaseCommands interface { | |||
| // Del removes the specified keys from the database. A key is ignored if it does not exist. | |||
| // | |||
| // Note: | |||
| // In cluster mode, if keys in `keyValueMap` map to different hash slots, the command | |||
| // In cluster mode, if `key` and `destination` map to different hash slots, the command | |||
There was a problem hiding this comment.
Suggested change
| // In cluster mode, if `key` and `destination` map to different hash slots, the command | |
| // In cluster mode, if `keys` map to different hash slots, the command |
go/api/generic_commands.go
Outdated
| @@ -37,7 +39,7 @@ type GenericBaseCommands interface { | |||
| // Exists returns the number of keys that exist in the database | |||
| // | |||
| // Note: | |||
| // In cluster mode, if keys in `keyValueMap` map to different hash slots, the command | |||
| // In cluster mode, if `key` and `destination` map to different hash slots, the command | |||
There was a problem hiding this comment.
Suggested change
| // In cluster mode, if `key` and `destination` map to different hash slots, the command | |
| // In cluster mode, if `keys` map to different hash slots, the command |
go/api/generic_commands.go
Outdated
| // This command is routed depending on the client's {@link ReadFrom} strategy. | ||
| // | ||
| // Note: | ||
| // In cluster mode, if `key` and `destination` map to different hash slots, the command |
There was a problem hiding this comment.
there is no destination, but key names could be referenced in options
go/api/options/sort_options.go
Outdated
Comment on lines
41
to
70
| // Limit Limits the range of elements | ||
| Limit *Limit | ||
|
|
||
| // OrderBy sets the order to sort by (ASC or DESC) | ||
| OrderBy OrderBy | ||
|
|
||
| // IsAlpha determines whether to sort lexicographically (true) or numerically (false) | ||
| IsAlpha bool | ||
|
|
||
| // ByPattern - a pattern to sort by external keys instead of by the elements stored at the key themselves. The | ||
| // pattern should contain an asterisk (*) as a placeholder for the element values, where the value | ||
| // from the key replaces the asterisk to create the key name. For example, if key | ||
| // contains IDs of objects, byPattern can be used to sort these IDs based on an | ||
| // attribute of the objects, like their weights or timestamps. | ||
| // Supported in cluster mode since Valkey version 8.0 and above. | ||
| ByPattern string | ||
|
|
||
| // A pattern used to retrieve external keys' values, instead of the elements at key. | ||
| // The pattern should contain an asterisk (*) as a placeholder for the element values, where the | ||
| // value from key replaces the asterisk to create the key name. This | ||
| // allows the sorted elements to be transformed based on the related keys values. For example, if | ||
| // key< contains IDs of users, getPatterns can be used to retrieve | ||
| // specific attributes of these users, such as their names or email addresses. E.g., if | ||
| // getPatterns is name_*, the command will return the values of the keys | ||
| // name_<element> for each sorted element. Multiple getPatterns | ||
| // arguments can be provided to retrieve multiple attributes. The special value # can | ||
| // be used to include the actual element from key being sorted. If not provided, only | ||
| // the sorted elements themselves are returned. | ||
| // Supported in cluster mode since Valkey version 8.0 and above. | ||
| GetPatterns []string // List of patterns to retrieve external keys' values |
There was a problem hiding this comment.
Move all docs to the corresponding setters. I afraid doc of private fields won't be visible to a user.
Signed-off-by: Niharika Bhavaraju <[email protected]>
…ey-glide into niharika-sortcmds
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implementing the Sort, Sort ReadOnly and Sort Store commands in GO client.