forked from mediocregopher/radix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Trying to patch it to remove dependencty on go modules
- Loading branch information
1 parent
d50a4fc
commit cb76e0e
Showing
26 changed files
with
45 additions
and
1,499 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,123 +1,5 @@ | ||
# Radix | ||
|
||
[![Build Status](https://travis-ci.org/mediocregopher/radix.svg)](https://travis-ci.org/mediocregopher/radix) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/mediocregopher/radix/v3)](https://goreportcard.com/report/github.com/mediocregopher/radix/v3) | ||
[![GoDoc](https://godoc.org/github.com/mediocregopher/radix?status.svg)][godoc] | ||
forked and patched from github.com/mediocregopher/radix to overcome issues with golang modules | ||
|
||
Radix is a full-featured [Redis][redis] client for Go. See the [GoDoc][godoc] | ||
for documentation and general usage examples. | ||
|
||
This is the third revision of this project, the previous one has been deprecated | ||
but can be found [here](https://github.com/mediocregopher/radix.v2). | ||
|
||
**This project's name was recently changed from `radix.v3` to `radix`, to | ||
account for go's new [module][module] system. As long as you are using the | ||
latest update of your major go version (1.9.7+, 1.10.3+, 1.11+) the module-aware | ||
go get should work correctly with the new import path.** | ||
|
||
**I'm sorry to anyone for whom this change broke their build, I tried very hard | ||
to not have to do it, but ultimately it was the only way that made sense for the | ||
future. Hopefully the only thing needed to fix the breakage is to change the | ||
import paths and re-run 'go get'.** | ||
|
||
## Installation and Usage | ||
|
||
[Module][module]-aware mode: | ||
|
||
go get github.com/mediocregopher/radix/v3 | ||
// import github.com/mediocregopher/radix/v3 | ||
|
||
Legacy GOPATH mode: | ||
|
||
go get github.com/mediocregopher/radix | ||
// import github.com/mediocregopher/radix | ||
|
||
## Testing | ||
|
||
# requires a redis server running on 127.0.0.1:6379 | ||
go test github.com/mediocregopher/radix/v3 | ||
|
||
## Features | ||
|
||
* Standard print-like API which supports all current and future redis commands. | ||
|
||
* Support for using an io.Reader as a command argument and writing responses to | ||
an io.Writer, as well as marshaling/unmarshaling command arguments from | ||
structs. | ||
|
||
* Connection pooling, which takes advantage of implicit pipelining to reduce | ||
system calls. | ||
|
||
* Helpers for [EVAL][eval], [SCAN][scan], and manual [pipelining][pipelining]. | ||
|
||
* Support for [pubsub][pubsub], as well as persistent pubsub wherein if a | ||
connection is lost a new one transparently replaces it. | ||
|
||
* Full support for [sentinel][sentinel] and [cluster][cluster]. | ||
|
||
* Nearly all important types are interfaces, allowing for custom implementations | ||
of nearly anything. | ||
|
||
## Benchmarks | ||
|
||
Thanks to a huge amount of work put in by @nussjustin, and inspiration from the | ||
[redispipe][redispipe] project and @funny-falcon, radix/v3 is significantly | ||
faster than most redis drivers, including redigo, for normal parallel workloads, | ||
and is pretty comparable for serial workloads. | ||
|
||
Benchmarks can be run from the bench folder. The following results were obtained | ||
by running the benchmarks with `-cpu` set to 32 and 64, on a 32 core machine, | ||
with the redis server on a separate machine. See [this thread][bench_thread] | ||
for more details. | ||
|
||
Some of radix's results are not included below because they use a non-default | ||
configuration. | ||
|
||
[bench_thread]: https://github.com/mediocregopher/radix/issues/67#issuecomment-465060960 | ||
|
||
|
||
``` | ||
# go get rsc.io/benchstat | ||
# cd bench | ||
# go test -v -run=XXX -bench=ParallelGetSet -cpu 32 -cpu 64 -benchmem . >/tmp/radix.stat | ||
# benchstat radix.stat | ||
name time/op | ||
ParallelGetSet/radix/default-32 2.15µs ± 0% <--- The good stuff | ||
ParallelGetSet/radix/default-64 2.05µs ± 0% <--- The better stuff | ||
ParallelGetSet/redigo-32 27.9µs ± 0% | ||
ParallelGetSet/redigo-64 28.5µs ± 0% | ||
ParallelGetSet/redispipe-32 2.02µs ± 0% | ||
ParallelGetSet/redispipe-64 1.71µs ± 0% | ||
name alloc/op | ||
ParallelGetSet/radix/default-32 72.0B ± 0% | ||
ParallelGetSet/radix/default-64 84.0B ± 0% | ||
ParallelGetSet/redigo-32 119B ± 0% | ||
ParallelGetSet/redigo-64 120B ± 0% | ||
ParallelGetSet/redispipe-32 168B ± 0% | ||
ParallelGetSet/redispipe-64 172B ± 0% | ||
name allocs/op | ||
ParallelGetSet/radix/default-32 4.00 ± 0% | ||
ParallelGetSet/radix/default-64 4.00 ± 0% | ||
ParallelGetSet/redigo-32 6.00 ± 0% | ||
ParallelGetSet/redigo-64 6.00 ± 0% | ||
ParallelGetSet/redispipe-32 8.00 ± 0% | ||
ParallelGetSet/redispipe-64 8.00 ± 0% | ||
``` | ||
|
||
## Copyright and licensing | ||
|
||
Unless otherwise noted, the source files are distributed under the *MIT License* | ||
found in the LICENSE.txt file. | ||
|
||
[redis]: http://redis.io | ||
[godoc]: https://godoc.org/github.com/mediocregopher/radix | ||
[eval]: https://redis.io/commands/eval | ||
[scan]: https://redis.io/commands/scan | ||
[pipelining]: https://redis.io/topics/pipelining | ||
[pubsub]: https://redis.io/topics/pubsub | ||
[sentinel]: http://redis.io/topics/sentinel | ||
[cluster]: http://redis.io/topics/cluster-spec | ||
[module]: https://github.com/golang/go/wiki/Modules | ||
[redispipe]: https://github.com/joomcode/redispipe |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.