Skip to content

Latest commit

 

History

History
131 lines (89 loc) · 3.92 KB

README.md

File metadata and controls

131 lines (89 loc) · 3.92 KB

GO wrapper

The Valkey GLIDE Go Wrapper is currently in public preview. Please refer to this page for available commands.

Valkey GLIDE

Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, however the public preview currently has limited implementation for the commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS and GCP, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity.

Supported Engine Versions

Refer to the Supported Engine Versions table for details.

Getting Started - GO Wrapper

System Requirements

The release of Valkey GLIDE was tested on the following platforms:

Linux:

  • Ubuntu 24.04.1 (x86_64/amd64 and arm64/aarch64)

macOS:

  • macOS 14.7 (Apple silicon/aarch_64)

GO supported versions

Go Version
1.20
1.22

Installation and Setup

To install Valkey GLIDE in your Go project, follow these steps:

  1. Open your terminal in your project directory.
  2. Execute the commands below: 
    $ go get github.com/valkey-io/valkey-glide/go
$ go mod tidy
  3. After installation, you can start up a Valkey server and run one of the examples in Basic Examples.

Basic Examples

Standalone Example:

package main

import (
	"fmt"

	"github.com/valkey-io/valkey-glide/go/api"
)

func main() {
	host := "localhost"
	port := 6379

	config := api.NewGlideClientConfiguration().
		WithAddress(&api.NodeAddress{Host: host, Port: port})

	client, err := api.NewGlideClient(config)
	if err != nil {
        fmt.Println("There was an error: ", err)
        return
	}

	res, err := client.Ping()
	if err != nil {
        fmt.Println("There was an error: ", err)
        return
	}
	fmt.Println(res) // PONG

	client.Close()
}

Cluster Example:

package main

import (
	"fmt"

	"github.com/valkey-io/valkey-glide/go/api"
)

func main() {
	host := "localhost"
	port := 7001

	config := api.NewGlideClusterClientConfiguration().
		WithAddress(&api.NodeAddress{Host: host, Port: port})

	client, err := api.NewGlideClusterClient(config)
	if err != nil {
		fmt.Println("There was an error: ", err)
		return
	}

	res, err := client.Ping()
	if err != nil {
        fmt.Println("There was an error: ", err)
        return
	}
	fmt.Println(res) // PONG

	client.Close()
}

Building & Testing

Development instructions for local building & testing the package are in the DEVELOPER.md file.

Known issues

When building an application on macos, a notice like this may appear:

ld: warning: '...' has malformed LC_DYSYMTAB, expected 123 undefined symbols to start at index 17006, found 174 undefined symbols starting at index 68

It could be safely ignored. It is not an error, it could be suppressed by setting LDFLAGS for go as described there. We're working on fixing this issue, you can track it in #3177.