Skip to content

Doc 543: delete duplicate info from readme #1024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
+9 −118
Draft

Doc 543: delete duplicate info from readme #1024

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5476a82
DOC-543: delete duplicate info, add links to docs
amandalindsay Jul 21, 2025
fb8af93
DOC-543: scrub and polish
amandalindsay Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 9 additions & 118 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,133 +4,24 @@

Hazelcast is an open-source distributed in-memory data store and computation platform that provides a wide variety of distributed data structures and concurrency primitives.

Hazelcast Go client is a way to communicate with Hazelcast 4 and 5 clusters and access the cluster data.

## Sample Code

```go
package main

import (
"context"
"fmt"
"log"

"github.com/hazelcast/hazelcast-go-client"
)

func main() {
ctx := context.TODO()
// create the client and connect to the cluster on localhost
client, err := hazelcast.StartNewClient(ctx)
if err != nil {
log.Fatal(err)
}
// get a map
people, err := client.GetMap(ctx, "people")
if err != nil {
log.Fatal(err)
}
personName := "Jane Doe"
// set a value in the map
if err = people.Set(ctx, personName, 30); err != nil {
log.Fatal(err)
}
// get a value from the map
age, err := people.Get(ctx, personName)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s is %d years old.\n", personName, age)
// stop the client to release resources
client.Shutdown(ctx)
}
```

## Features

* Distributed, partitioned and queryable in-memory key-value store implementation, called Map.
* Additional data structures and simple messaging constructs such as Replicated Map, MultiMap, Queue, List, PNCounter, Set, Topic and others.
* Support for serverless and traditional web service architectures with Unisocket and Smart operation modes.
* Go context support for all distributed data structures.
* SQL support (only on Hazelcast 5.x).
* External smart client discovery.
* Hazelcast Management Center integration.
* Ability to listen to client lifecycle, cluster state, and distributed data structure events.
* And [more](https://hazelcast.com/clients/go/#client-features)...

## Install

Requirements:

* Hazelcast Go client is compatible only with Hazelcast 4.x and 5.x.
* We support two most recent releases of Go, currently 1.20 and up.

In your Go module enabled project, add a dependency to `github.com/hazelcast/hazelcast-go-client`:
```shell
# Depend on the latest release
$ go get github.com/hazelcast/hazelcast-go-client@latest
```

## Quick Start

Hazelcast Go client requires a working Hazelcast cluster.

Check out our [Get Started](https://hazelcast.com/get-started/) page for options.

### Starting the Default Client

Start the client with the default Hazelcast host and port using `hazelcast.StartNewClient`, when Hazelcast is running on local with the default options:

```go
ctx := context.TODO()
client, err := hazelcast.StartNewClient(ctx)
// handle client start error
```

### Starting the Client with Given Options

Note that `Config` structs are not thread-safe. Complete creation of the configuration in a single goroutine.

```go
// create the default configuration
config := hazelcast.Config{}
// optionally set member addresses manually
config.Cluster.Network.SetAddresses("member1.example.com:5701", "member2.example.com:5701")
// create and start the client with the configuration provider
client, err := hazelcast.StartNewClientWithConfig(ctx, config)
// handle client start error
```
The Hazelcast Go client allows you to communicate with Hazelcast 4 and 5 clusters and access the cluster data.

## Documentation

Hazelcast Go Client documentation is hosted at [pkg.go.dev](https://pkg.go.dev/github.com/hazelcast/hazelcast-go-client).

You can view the documentation locally by using godoc:
```
$ godoc -http=localhost:5500
```

godoc is not installed by default with the base Go distribution. Install it using:
```
$ go get -u golang.org/x/tools/...`
```

## Support

Join us at [Go Client channel](https://hazelcastcommunity.slack.com/channels/go-client) or [Hazelcast at Google Groups](https://groups.google.com/g/hazelcast).
For a list of the features available, and for information about how to install and get started with the client, see the [Go client documentation](https://docs.hazelcast.com/hazelcast/latest/clients/go).

## Running the tests
## Test the client

This section describes how to test the Hazelcast Go client.
Currently, we support only Linux, MacOS and WSL (Windows Subsystem for Linux) for testing the client.

You need to have the following installed in order to run integration tests:
To run integration tests, you must have the following installed:
* Java 8
* Maven 3 or better
* Maven 3 or later
* Bash
* Make

Before running the tests, starts Hazelcast Remote Controller, which enables the test suite to create clusters:
Before running the tests, start the Hazelcast remote controller to enable the test suite to create clusters:
```shell
# Start RC with Hazelcast Community features
$ ./rc.sh start
Expand All @@ -139,15 +30,15 @@ $ ./rc.sh start
$ HAZELCAST_ENTERPRISE_KEY=ENTERPRISE-KEY-HERE ./rc.sh start
```

You can run the tests using one of the following approaches:
Run the tests using one of the following methods:
* Run `make test-all` to run integration tests.
* Run `make test-all-race` to run integration tests with race detection.
* Run `make test-cover` to generate the coverage report and `make view-cover` to view the test coverage summary and generate an HTML report.

Testing the client with SSL support requires running the remote controller with Hazelcast Enterprise features.
To enable SSL connections, add `ENABLE_SSL=1` to environment variables, or prepend it to the make commands above.

In order to turn on verbose logging, add `ENABLE_TRACE=1` to environment variables, or prepend it to the make commands above.
To turn on verbose logging, add `ENABLE_TRACE=1` to environment variables, or prepend it to the make commands above.

## License

Expand Down
Loading