Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aerospike/aerospike-client-Go
Aerospike Client Go
https://github.com/aerospike/aerospike-client-Go
Last synced: about 2 months ago
JSON representation
Aerospike Client Go
- Host: GitHub
- URL: https://github.com/aerospike/aerospike-client-Go
- Owner: aerospike
- License: apache-2.0
- Created: 2014-07-26T02:56:21.000Z (about 10 years ago)
- Default Branch: v7
- Last Pushed: 2024-07-22T17:34:25.000Z (2 months ago)
- Last Synced: 2024-07-22T21:12:12.250Z (2 months ago)
- Language: Go
- Size: 4.17 MB
- Stars: 430
- Watchers: 72
- Forks: 199
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: security_test.go
Awesome Lists containing this project
README
# Aerospike Go Client v7
[](https://goreportcard.com/report/github.com/aerospike/aerospike-client-go/v7)
[](https://pkg.go.dev/github.com/aerospike/aerospike-client-go/v7)
[](github.com/aerospike/aerospike-client-go/actions)
An Aerospike library for Go.
This library is compatible with Go 1.20+ and supports the following operating systems: Linux, Mac OS X (Windows builds are possible, but untested).
Up-to-date documentation is available in the [](https://pkg.go.dev/github.com/aerospike/aerospike-client-go/v7).
You can refer to the test files for idiomatic use cases.
Please refer to [`CHANGELOG.md`](CHANGELOG.md) for release notes, or if you encounter breaking changes.
- [Aerospike Go Client v7](#aerospike-go-client-v7)
- [Usage](#usage)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Some Hints:](#some-hints)
- [Performance Tweaking](#performance-tweaking)
- [Tests](#tests)
- [Examples](#examples)
- [Tools](#tools)
- [Benchmarks](#benchmarks)
- [API Documentation](#api-documentation)
- [Google App Engine](#google-app-engine)
- [Reflection, and Object API](#reflection-and-object-api)
- [Proxy Client / DBAAS](#proxy-client--dbaas)
- [License](#license)
## Usage
The following is a very simple example of CRUD operations in an Aerospike database.
```go
package main
import (
"fmt"
aero "github.com/aerospike/aerospike-client-go/v7"
)
// This is only for this example.
// Please handle errors properly.
func panicOnError(err error) {
if err != nil {
panic(err)
}
}
func main() {
// define a client to connect to
client, err := aero.NewClient("127.0.0.1", 3000)
panicOnError(err)
key, err := aero.NewKey("test", "aerospike", "key")
panicOnError(err)
// define some bins with data
bins := aero.BinMap{
"bin1": 42,
"bin2": "An elephant is a mouse with an operating system",
"bin3": []interface{}{"Go", 2009},
}
// write the bins
err = client.Put(nil, key, bins)
panicOnError(err)
// read it back!
rec, err := client.Get(nil, key)
panicOnError(err)
// delete the key, and check if key exists
existed, err := client.Delete(nil, key)
panicOnError(err)
fmt.Printf("Record existed before delete? %v\n", existed)
}
```
More examples illustrating the use of the API are located in the
[`examples`](examples) directory.
Details about the API are available in the [`docs`](docs) directory.
[Go](http://golang.org) version v1.20+ is required.
To install the latest stable version of Go, visit
[http://golang.org/dl/](http://golang.org/dl/)
Aerospike Go client implements the wire protocol, and does not depend on the C client.
It is goroutine friendly, and works asynchronously.
Supported operating systems:
- Major Linux distributions (Ubuntu, Debian, Red Hat)
- Mac OS X
- Windows (untested)
1. Install Go 1.21+ and setup your environment as [Documented](http://golang.org/doc/code.html#GOPATH) here.
2. Get the client in your ```GOPATH``` : ```go get github.com/aerospike/aerospike-client-go/v7```
- To update the client library: ```go get -u github.com/aerospike/aerospike-client-go/v7```
Using [gopkg.in](https://gopkg.in/) is also supported: `go get -u gopkg.in/aerospike/aerospike-client-go.v7`
### Some Hints:
- To run a go program directly: ```go run ```
- to build: ```go build -o ```
- example: ```go build -tags as_proxy -o benchmark tools/benchmark/benchmark.go```
We are bending all efforts to improve the client's performance. In our reference benchmarks, Go client performs almost as good as the C client.
To read about performance variables, please refer to [`docs/performance.md`](docs/performance.md)
This library is packaged with a number of tests. Tests require Ginkgo and Gomega library.
Before running the tests, you need to update the dependencies:
$ go get .
To run all the test cases with race detection:
$ ginkgo -r -race
A variety of example applications are provided in the [`examples`](examples) directory.
A variety of clones of original tools are provided in the [`tools`](tools) directory.
They show how to use more advanced features of the library to re-implement the same functionality in a more concise way.
Benchmark utility is provided in the [`tools/benchmark`](tools/benchmark) directory.
See the [`tools/benchmark/README.md`](tools/benchmark/README.md) for details.
A simple API documentation is available in the [`docs`](docs/README.md) directory. The latest up-to-date docs can be found in [](https://pkg.go.dev/github.com/aerospike/aerospike-client-go/v7).
To build the library for App Engine, build it with the build tag `app_engine`. Aggregation functionality is not available in this build.
To make the library both flexible and fast, we had to integrate the reflection API (methods with `[Get/Put/...]Object` names) tightly in the library. In case you wanted to avoid mixing those API in your app inadvertently, you can use the build tag `as_performance` to remove those APIs from the build.
To compile the client for the proxy server in our database-as-a-service (dbaas) environment, pass `-tags as_proxy` to the compiler on build.
The Aerospike Go Client is made available under the terms of the Apache License, Version 2, as stated in the file `LICENSE`.
Individual files may be made available under their own specific license,
all compatible with Apache License, Version 2. Please see individual files for details.