garnet icon indicating copy to clipboard operation
garnet copied to clipboard

API Coverage - Implement SUNIONSTORE

Open TalZaccai opened this issue 1 year ago • 2 comments
trafficstars

Feature request type

sample request

Is your feature request related to a problem? Please describe

Here's your opportunity to implement a couple of RESP commands in Garnet!

SUNIONSTORE

Syntax: SUNIONSTORE destination key [key ...]

Command description: This command is equal to SUNION, but instead of returning the resulting set, it is stored in destination.

If destination already exists, it is overwritten.

Response:

Integer reply: the number of elements in the resulting set.

Describe the solution you'd like

How to approach this task:

  1. Add the new command info to the setCommandsInfoMap in the RespCommandsInfo class (Garnet.server/Resp/RespCommandsInfo.cs)
  2. Add the new command string to the returned HashSet in the RespInfo.GetCommands method (Garnet.server/Resp/RespInfo.cs)
  3. Add the appropriate fast parsing logic for the new command in the RespCommand.FastParseArrayCommand method (use other commands as reference) (Garnet.server/Resp/RespCommand.cs)
  4. Implement the wrapper method to the storage layer in StorageSession (Garnet.server/Storage/Session/ObjectStore/SetOps.cs)
  5. Define a new method in IGarnetAPI and implement it in GarnetApiObjectCommands, calling the method you have implemented in step #4 (Garnet.server/API/IGarnetAPI.cs, Garnet.server/API/GarnetApiObjectCommands.cs)
  6. Add a new method to the RespServerSession class which will call the storage API and return the appropriate response (Garnet.server/Resp/Objects/SetCommands.cs)
  7. Add a new method to SetObjImpl which will perform the required operation on the hash object (Garnet.server/Objects/Set/SetObjectImpl.cs)
  8. Add a new enum value to SetOperation and add the appropriate case to the switch in SetObject.Operate, in which you will call the method defined in step #8 (Garnet.server/Objects/Set/SetObject.cs)
  9. Add an appropriate case to the switch in TransactionManager.SetObjectKeys (Garnet.server/Transaction/TxnKeyManager.cs)
  10. Add tests for the new command in the RespSetTests class (Garnet.test/RespSetTests.cs)

Tip: First add a simple test that calls the new command and use it to debug as you develop, it will make your life much easier!

If you have any questions, the Garnet team is here to help!

Describe alternatives you've considered

No response

Additional context

No response

TalZaccai avatar Apr 18 '24 17:04 TalZaccai

Please assign to me

Zzhiter avatar Apr 19 '24 01:04 Zzhiter

Please assign to me

Looks like @tisilent already linked a PR. Thank you both!

TalZaccai avatar Apr 19 '24 02:04 TalZaccai