Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work #2981

edlng · 2025-01-20T21:18:00Z

Issue link

This Pull Request is linked to issue (URL):

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one issue.
Commit message has a detailed description of what changed and why.
Tests are added or updated.
CHANGELOG.md and documentation files are updated.
Destination branch is correct - main or release
Create merge commit if merging release branch into main, squash otherwise.

Signed-off-by: Edward Liang <[email protected]>

* GO: add xpending command Signed-off-by: jbrinkman <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* GO Implement Dump and ObjectEncoding command Signed-off-by: EdricCua <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* Implement Echo Command Signed-off-by: EdricCua <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* Go: `XREADGROUP`. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* Shadow protobuf Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

…key-io#2967) Signed-off-by: TJ Zhang <[email protected]> Co-authored-by: TJ Zhang <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* Go: `XAUTOCLAIM`. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

…-io#2956) * Go: update return types & response handlers for scan commands Signed-off-by: TJ Zhang <[email protected]> Signed-off-by: Edward Liang <[email protected]>

…-io#2958) * Implement Object Freq, Idle and RefCount Signed-off-by: EdricCua <[email protected]> Signed-off-by: Edward Liang <[email protected]>

…2888) * Sort,Sort_RO,Sort Store commands Signed-off-by: Niharika Bhavaraju <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* Go: `XGROUP CREATE`. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

…y-io#2975) * go xGroupCreateConsumer and XGroupDelConsumer Signed-off-by: jbrinkman <[email protected]> Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

* Fix return types. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Fix return types Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Signed-off-by: Edward Liang <[email protected]>

go/api/base_client.go

Signed-off-by: Edward Liang <[email protected]>

jbrinkman · 2025-01-22T20:37:02Z

go/api/glide_client.go

-// GlideClient is a client used for connection in Standalone mode.
-type GlideClient interface {
+// IGlideClient is a client used for connection in Standalone mode.
+type IGlideClient interface {


Rename symbol IGlideClient to GlideClientCommands to better align the interface name to what it actually represents - an aggregation of all of the command interfaces.

jbrinkman · 2025-01-22T20:37:30Z

go/api/glide_cluster_client.go

@@ -7,30 +7,57 @@ package api
 import "C"

 // GlideClusterClient interface compliance check.
-var _ GlideClusterClient = (*glideClusterClient)(nil)
+var _ IGlideClusterClient = (*GlideClusterClient)(nil)


Rename symbol IGlideClusterClient to GlideClusterClientCommands to better align the interface name to what it actually represents - an aggregation of all of the command interfaces.

prateek-kumar-improving · 2025-01-22T21:05:39Z

go/api/base_client.go

+//	If key exists, returns the value of key as a Result[string]. Otherwise, return [api.CreateNilStringResult()].
+//
+// For example:
+//  1. key: value


Indentation should be consistent for the entire file for documentation.

On GitHub you can set for the appearance of tabs to be 4 spaces instead (for some reason the default is 8 ) and that "fixes" the appearance issue. All good

Signed-off-by: Edward Liang <[email protected]>

…GlideClient for pkgsite to work (valkey-io#2981) * moved docs from interfaces to base client Signed-off-by: Edward Liang <[email protected]>

…GlideClient for pkgsite to work (valkey-io#2981) * moved docs from interfaces to base client Signed-off-by: Edward Liang <[email protected]> Signed-off-by: EdricCua <[email protected]>

* Implement DBSize Server Management Cluster Signed-off-by: EdricCua <[email protected]> * Fix docs Signed-off-by: EdricCua <[email protected]> * Fix docs Signed-off-by: EdricCua <[email protected]> * ORT- Add resolutions for hybrid-node-tests and bump versions (#2987) * add resolutions for hybrid-node-tests and bump ORT versions Signed-off-by: BoazBD <[email protected]> * format Signed-off-by: BoazBD <[email protected]> --------- Signed-off-by: BoazBD <[email protected]> Signed-off-by: EdricCua <[email protected]> * Go: Implement Server Management Command DBSize (#2991) * Implement DBSize Command Signed-off-by: EdricCua <[email protected]> * GO: Implement Copy Command (#2980) * Implement Copy Command Signed-off-by: EdricCua <[email protected]> * Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work (#2981) * moved docs from interfaces to base client Signed-off-by: Edward Liang <[email protected]> Signed-off-by: EdricCua <[email protected]> * quickfix of changing glideClient to become GlideClient (#3000) Signed-off-by: Edward Liang <[email protected]> Signed-off-by: EdricCua <[email protected]> * Go: Add command XRange and XRevRange (#2989) * Go: Add command XRange and XRevRange Signed-off-by: TJ Zhang <[email protected]> Signed-off-by: EdricCua <[email protected]> * Go: Added config folder for request_routing_config_test.go and errors folder for errors.go (#2996) * Implemented Time Command Signed-off-by: Niharika Bhavaraju <[email protected]> * Fixed code review changes Signed-off-by: Niharika Bhavaraju <[email protected]> * Added Time command (cluster) Signed-off-by: Niharika Bhavaraju <[email protected]> * Fixed code review comments Signed-off-by: Niharika Bhavaraju <[email protected]> * Added route,errors folders Signed-off-by: Niharika Bhavaraju <[email protected]> * Fixed failing tests Signed-off-by: Niharika Bhavaraju <[email protected]> --------- Signed-off-by: Niharika Bhavaraju <[email protected]> Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Implement DBSize Cluster Signed-off-by: EdricCua <[email protected]> * Fix merge conflict Signed-off-by: EdricCua <[email protected]> * Fix review comment Signed-off-by: EdricCua <[email protected]> * Fix docs for RouteOption Signed-off-by: EdricCua <[email protected]> --------- Signed-off-by: EdricCua <[email protected]> Signed-off-by: BoazBD <[email protected]> Signed-off-by: Edward Liang <[email protected]> Signed-off-by: TJ Zhang <[email protected]> Signed-off-by: Niharika Bhavaraju <[email protected]> Co-authored-by: BoazBD <[email protected]> Co-authored-by: Edward Liang <[email protected]> Co-authored-by: tjzhang-BQ <[email protected]> Co-authored-by: Niharika Bhavaraju <[email protected]>

edlng requested a review from a team as a code owner January 20, 2025 21:18

edlng and others added 18 commits January 20, 2025 14:49

moved docs from interfaces to base client

36776df

Signed-off-by: Edward Liang <[email protected]>

GO: xpending command (valkey-io#2957)

8337cad

* GO: add xpending command Signed-off-by: jbrinkman <[email protected]> Signed-off-by: Edward Liang <[email protected]>

GO Implement Dump, Restore and ObjectEncoding Command (valkey-io#2781)

d8ae33d

* GO Implement Dump and ObjectEncoding command Signed-off-by: EdricCua <[email protected]> Signed-off-by: Edward Liang <[email protected]>

GO: Implement Echo Command (valkey-io#2863)

3b7ddc3

* Implement Echo Command Signed-off-by: EdricCua <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: XREADGROUP. (valkey-io#2949)

11acb5d

* Go: `XREADGROUP`. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Java: Shadow protobuf dependency (valkey-io#2931)

a5fbce5

* Shadow protobuf Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: Add commands ZRemRangeByRank/ZRemRangeByScore/ZRemRangeByLex (val…

18aa5f6

…key-io#2967) Signed-off-by: TJ Zhang <[email protected]> Co-authored-by: TJ Zhang <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: XAUTOCLAIM. (valkey-io#2955)

043c51d

* Go: `XAUTOCLAIM`. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: update return types & response handlers for scan commands (valkey…

7349b1a

…-io#2956) * Go: update return types & response handlers for scan commands Signed-off-by: TJ Zhang <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go implement object freq object idle object ref count command (valkey…

dfff4e0

…-io#2958) * Implement Object Freq, Idle and RefCount Signed-off-by: EdricCua <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: Implement Sort, Sort ReadOnly and Sort Store commands (valkey-io#…

2030000

…2888) * Sort,Sort_RO,Sort Store commands Signed-off-by: Niharika Bhavaraju <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: XGROUP CREATE. (valkey-io#2966)

5096018

* Go: `XGROUP CREATE`. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: Add stream commands XGroupCreateConsumer/XGroupDelConsumer (valke…

c37ca67

…y-io#2975) * go xGroupCreateConsumer and XGroupDelConsumer Signed-off-by: jbrinkman <[email protected]> Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: Fix return types, part 6 (valkey-io#2965)

9b22bb3

* Fix return types. Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

Go: Fix return types, parn 5 (valkey-io#2964)

6377cfb

Fix return types Signed-off-by: Yury-Fridlyand <[email protected]> Signed-off-by: Edward Liang <[email protected]>

added exposed types for GlideClient

c01bfa3

Signed-off-by: Edward Liang <[email protected]>

fixed indentation issues

a537763

Signed-off-by: Edward Liang <[email protected]>

performed rebase to pass ci

a5eda6f

Signed-off-by: Edward Liang <[email protected]>

edlng force-pushed the go/pkgsite-fix branch from b9a2e76 to a5eda6f Compare January 20, 2025 23:42

Merge remote-tracking branch 'upstream/main' into go/pkgsite-fix

78715d6

Signed-off-by: Edward Liang <[email protected]>

Yury-Fridlyand reviewed Jan 21, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into go/pkgsite-fix

b404f8f

Signed-off-by: Edward Liang <[email protected]>

Yury-Fridlyand mentioned this pull request Jan 21, 2025

Go: ZRANDMEMBER. #2983

Merged

6 tasks

Addressed some documentation changes in examples

e14cc01

Signed-off-by: Edward Liang <[email protected]>

Yury-Fridlyand added go golang wrapper docs Documentation labels Jan 22, 2025

Yury-Fridlyand approved these changes Jan 22, 2025

View reviewed changes

jbrinkman approved these changes Jan 22, 2025

View reviewed changes

prateek-kumar-improving reviewed Jan 22, 2025

View reviewed changes

edlng added 2 commits January 22, 2025 13:41

Renamed interfaces to be more informative

f77e2e3

Signed-off-by: Edward Liang <[email protected]>

Fix lint error

f27fcf3

Signed-off-by: Edward Liang <[email protected]>

edlng closed this Jan 22, 2025

edlng reopened this Jan 22, 2025

yipin-chen merged commit c8d8718 into valkey-io:main Jan 24, 2025
33 of 34 checks passed

yipin-chen deleted the go/pkgsite-fix branch January 24, 2025 00:04

jbrinkman linked an issue Jan 27, 2025 that may be closed by this pull request

[Task] Golang wrapper command documentation alignment #2828

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work #2981

Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work #2981

edlng commented Jan 20, 2025

jbrinkman Jan 22, 2025

edlng Jan 22, 2025

jbrinkman Jan 22, 2025

edlng Jan 22, 2025

prateek-kumar-improving Jan 22, 2025

edlng Jan 22, 2025

Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work #2981

Moved documentation comments to base_client file and made changes to GlideClient for pkgsite to work #2981

Conversation

edlng commented Jan 20, 2025

Issue link

Checklist

jbrinkman Jan 22, 2025

Choose a reason for hiding this comment

edlng Jan 22, 2025

Choose a reason for hiding this comment

jbrinkman Jan 22, 2025

Choose a reason for hiding this comment

edlng Jan 22, 2025

Choose a reason for hiding this comment

prateek-kumar-improving Jan 22, 2025

Choose a reason for hiding this comment

edlng Jan 22, 2025

Choose a reason for hiding this comment