Skip to content
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.

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

Tfs olric update module + maxKeylength #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Olric [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Olric%3A+Distributed+and+in-memory+key%2Fvalue+database.+It+can+be+used+both+as+an+embedded+Go+library+and+as+a+language-independent+service.+&url=https://github.com/buraksezer/olric&hashtags=golang,distributed,database)

[![Go Reference](https://pkg.go.dev/badge/github.com/buraksezer/olric.svg)](https://pkg.go.dev/github.com/buraksezer/olric) [![Coverage Status](https://coveralls.io/repos/github/buraksezer/olric/badge.svg?branch=master)](https://coveralls.io/github/buraksezer/olric?branch=master) [![Build Status](https://travis-ci.org/buraksezer/olric.svg?branch=master)](https://travis-ci.org/buraksezer/olric) [![Go Report Card](https://goreportcard.com/badge/github.com/buraksezer/olric)](https://goreportcard.com/report/github.com/buraksezer/olric) [![Discord](https://img.shields.io/discord/721708998021087273.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/ahK7Vjr8We) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Go Reference](https://pkg.go.dev/badge/github.com/buraksezer/olric.svg)](https://pkg.go.dev/github.com/buraksezer/olric) [![Coverage Status](https://coveralls.io/repos/github/ShareChat/olric/badge.svg?branch=master)](https://coveralls.io/github/buraksezer/olric?branch=master) [![Build Status](https://travis-ci.org/buraksezer/olric.svg?branch=master)](https://travis-ci.org/buraksezer/olric) [![Go Report Card](https://goreportcard.com/badge/github.com/buraksezer/olric)](https://goreportcard.com/report/github.com/buraksezer/olric) [![Discord](https://img.shields.io/discord/721708998021087273.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/ahK7Vjr8We) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Olric is a distributed, in-memory key/value store and cache. It's designed from the ground up to be distributed, and it can be
used both as an embedded Go library and as a language-independent service.
Expand All @@ -22,14 +22,14 @@ See [Docker](#docker) and [Samples](#samples) sections to get started!

Join our [Discord server!](https://discord.gg/ahK7Vjr8We)

The current production version is [v0.5.7](https://github.com/buraksezer/olric/tree/release/v0.5.0#olric-)
The current production version is [v0.5.7](https://github.com/ShareChat/olric/tree/release/v0.5.0#olric-)

### About versions

Olric v0.4 and previous versions use *Olric Binary Protocol*, v0.5.x and later use [Redis serialization protocol](https://redis.io/docs/reference/protocol-spec/) for communication and the API was significantly changed.
Olric v0.4.x tree is going to receive bug fixes and security updates forever, but I would recommend considering an upgrade to the new version.

This document only covers `v0.5.x` and later. See v0.4.x documents [here](https://github.com/buraksezer/olric/tree/release/v0.4.0#olric-).
This document only covers `v0.5.x` and later. See v0.4.x documents [here](https://github.com/ShareChat/olric/tree/release/v0.4.0#olric-).

## At a glance

Expand Down Expand Up @@ -163,7 +163,7 @@ See [Architecture](#architecture) section to see details.

We have a few communication channels:

* [Issue Tracker](https://github.com/buraksezer/olric/issues)
* [Issue Tracker](https://github.com/ShareChat/olric/issues)
* [Discord server](https://discord.gg/ahK7Vjr8We)

You should know that the issue tracker is only intended for bug reports and feature requests.
Expand All @@ -175,7 +175,7 @@ Software doesn't maintain itself. If you need support on complex topics or reque
With a correctly configured Golang environment:

```
go install github.com/buraksezer/olric/cmd/[email protected]
go install github.com/ShareChat/olric/cmd/[email protected]
```

Now you can start using Olric:
Expand Down Expand Up @@ -213,7 +213,7 @@ OK
With olricd, you can create an Olric cluster with a few commands. This is how to install olricd:

```bash
go install github.com/buraksezer/olric/cmd/[email protected]
go install github.com/ShareChat/olric/cmd/[email protected]
```

Let's create a cluster with the following:
Expand Down Expand Up @@ -916,13 +916,13 @@ You should feel free to ask any questions about configuration and integration. P
Olric provides a function to generate default configuration to use in embedded-member mode:

```go
import "github.com/buraksezer/olric/config"
import "github.com/ShareChat/olric/config"
...
c := config.New("local")
```

The `New` function takes a parameter called `env`. It denotes the network environment and consumed by [hashicorp/memberlist](https://github.com/hashicorp/memberlist).
Default configuration is good enough for distributed caching scenario. In order to see all configuration parameters, please take a look at [this](https://godoc.org/github.com/buraksezer/olric/config).
Default configuration is good enough for distributed caching scenario. In order to see all configuration parameters, please take a look at [this](https://godoc.org/github.com/ShareChat/olric/config).

See [Sample Code](#sample-code) section for an introduction.

Expand All @@ -934,13 +934,13 @@ You can also import configuration from a YAML file by using the `Load` function:
c, err := config.Load(path/to/olric.yaml)
```

A sample configuration file in YAML format can be found [here](https://github.com/buraksezer/olric/blob/master/cmd/olricd/olricd.yaml). This may be the most appropriate way to manage the Olric configuration.
A sample configuration file in YAML format can be found [here](https://github.com/ShareChat/olric/blob/master/cmd/olricd/olricd.yaml). This may be the most appropriate way to manage the Olric configuration.


### Client-Server Mode

Olric provides **olricd** to implement client-server mode. olricd gets a YAML file for the configuration. The most basic functionality of olricd is that
translating YAML configuration into Olric's configuration struct. A sample `olricd.yaml` file is being provided [here](https://github.com/buraksezer/olric/blob/master/cmd/olricd/olricd.yaml).
translating YAML configuration into Olric's configuration struct. A sample `olricd.yaml` file is being provided [here](https://github.com/ShareChat/olric/blob/master/cmd/olricd/olricd.yaml).

### Network Configuration

Expand Down Expand Up @@ -1191,7 +1191,7 @@ dmaps:
evictionPolicy: "NONE" # NONE/LRU
```

If you prefer embedded-member deployment scenario, please take a look at [config#CacheConfig](https://godoc.org/github.com/buraksezer/olric/config#CacheConfig) and [config#DMapCacheConfig](https://godoc.org/github.com/buraksezer/olric/config#DMapCacheConfig) for the configuration.
If you prefer embedded-member deployment scenario, please take a look at [config#CacheConfig](https://godoc.org/github.com/ShareChat/olric/config#CacheConfig) and [config#DMapCacheConfig](https://godoc.org/github.com/ShareChat/olric/config#DMapCacheConfig) for the configuration.


### Lock Implementation
Expand Down Expand Up @@ -1255,8 +1255,8 @@ import (
"log"
"time"

"github.com/buraksezer/olric"
"github.com/buraksezer/olric/config"
"github.com/ShareChat/olric"
"github.com/ShareChat/olric/config"
)

func main() {
Expand Down Expand Up @@ -1348,8 +1348,8 @@ import (
"log"
"time"

"github.com/buraksezer/olric"
"github.com/buraksezer/olric/config"
"github.com/ShareChat/olric"
"github.com/ShareChat/olric/config"
)

func main() {
Expand Down Expand Up @@ -1440,7 +1440,7 @@ import (
"log"
"time"

"github.com/buraksezer/olric"
"github.com/ShareChat/olric"
)

func main() {
Expand Down Expand Up @@ -1509,8 +1509,8 @@ import (
"log"
"time"

"github.com/buraksezer/olric"
"github.com/buraksezer/olric/config"
"github.com/ShareChat/olric"
"github.com/ShareChat/olric/config"
)

func main() {
Expand Down Expand Up @@ -1619,7 +1619,7 @@ import (
"log"
"time"

"github.com/buraksezer/olric"
"github.com/ShareChat/olric"
)

func main() {
Expand Down
6 changes: 3 additions & 3 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ import (
"context"
"time"

"github.com/buraksezer/olric/internal/dmap"
"github.com/buraksezer/olric/pkg/storage"
"github.com/buraksezer/olric/stats"
"github.com/ShareChat/olric/internal/dmap"
"github.com/ShareChat/olric/pkg/storage"
"github.com/ShareChat/olric/stats"
)

const DefaultScanCount = 10
Expand Down
2 changes: 1 addition & 1 deletion cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
"fmt"
"strconv"

"github.com/buraksezer/olric/internal/protocol"
"github.com/ShareChat/olric/internal/protocol"
"github.com/tidwall/redcon"
)

Expand Down
24 changes: 12 additions & 12 deletions cluster_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,18 @@ import (
"syscall"
"time"

"github.com/buraksezer/olric/config"
"github.com/buraksezer/olric/hasher"
"github.com/buraksezer/olric/internal/bufpool"
"github.com/buraksezer/olric/internal/cluster/partitions"
"github.com/buraksezer/olric/internal/discovery"
"github.com/buraksezer/olric/internal/dmap"
"github.com/buraksezer/olric/internal/kvstore/entry"
"github.com/buraksezer/olric/internal/protocol"
"github.com/buraksezer/olric/internal/resp"
"github.com/buraksezer/olric/internal/server"
"github.com/buraksezer/olric/pkg/storage"
"github.com/buraksezer/olric/stats"
"github.com/ShareChat/olric/config"
"github.com/ShareChat/olric/hasher"
"github.com/ShareChat/olric/internal/bufpool"
"github.com/ShareChat/olric/internal/cluster/partitions"
"github.com/ShareChat/olric/internal/discovery"
"github.com/ShareChat/olric/internal/dmap"
"github.com/ShareChat/olric/internal/kvstore/entry"
"github.com/ShareChat/olric/internal/protocol"
"github.com/ShareChat/olric/internal/resp"
"github.com/ShareChat/olric/internal/server"
"github.com/ShareChat/olric/pkg/storage"
"github.com/ShareChat/olric/stats"
"github.com/redis/go-redis/v9"
)

Expand Down
8 changes: 4 additions & 4 deletions cluster_client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ import (
"testing"
"time"

"github.com/buraksezer/olric/config"
"github.com/buraksezer/olric/hasher"
"github.com/buraksezer/olric/internal/testutil"
"github.com/buraksezer/olric/stats"
"github.com/ShareChat/olric/config"
"github.com/ShareChat/olric/hasher"
"github.com/ShareChat/olric/internal/testutil"
"github.com/ShareChat/olric/stats"
"github.com/stretchr/testify/require"
"golang.org/x/sync/errgroup"
)
Expand Down
4 changes: 2 additions & 2 deletions cluster_iterator.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import (
"sync"
"time"

"github.com/buraksezer/olric/internal/dmap"
"github.com/buraksezer/olric/internal/protocol"
"github.com/ShareChat/olric/internal/dmap"
"github.com/ShareChat/olric/internal/protocol"
)

type currentCursor struct {
Expand Down
2 changes: 1 addition & 1 deletion cluster_iterator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
"fmt"
"testing"

"github.com/buraksezer/olric/internal/testutil"
"github.com/ShareChat/olric/internal/testutil"
"github.com/stretchr/testify/require"
)

Expand Down
2 changes: 1 addition & 1 deletion cluster_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"context"
"testing"

"github.com/buraksezer/olric/internal/protocol"
"github.com/ShareChat/olric/internal/protocol"
"github.com/stretchr/testify/require"
)

Expand Down
8 changes: 4 additions & 4 deletions cmd/olricd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ import (
"os"
"runtime"

"github.com/buraksezer/olric"
"github.com/buraksezer/olric/cmd/olricd/server"
"github.com/buraksezer/olric/config"
"github.com/ShareChat/olric"
"github.com/ShareChat/olric/cmd/olricd/server"
"github.com/ShareChat/olric/config"
"github.com/sean-/seed"
)

Expand All @@ -42,7 +42,7 @@ Options:
current folder. Set OLRICD_CONFIG to overwrite it.

The Go runtime version %s
Report bugs to https://github.com/buraksezer/olric/issues
Report bugs to https://github.com/ShareChat/olric/issues
`
_, err := fmt.Fprintf(os.Stdout, msg, runtime.Version())
if err != nil {
Expand Down
4 changes: 2 additions & 2 deletions cmd/olricd/server/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ import (
"os/signal"
"syscall"

"github.com/buraksezer/olric"
"github.com/buraksezer/olric/config"
"github.com/ShareChat/olric"
"github.com/ShareChat/olric/config"
"golang.org/x/sync/errgroup"
)

Expand Down
2 changes: 1 addition & 1 deletion config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"strconv"
"time"

"github.com/buraksezer/olric/hasher"
"github.com/ShareChat/olric/hasher"
"github.com/hashicorp/memberlist"
)

Expand Down
4 changes: 2 additions & 2 deletions config/engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ package config

import (
"fmt"
"github.com/buraksezer/olric/internal/kvstore"
"github.com/buraksezer/olric/pkg/storage"
"github.com/ShareChat/olric/internal/kvstore"
"github.com/ShareChat/olric/pkg/storage"
)

// Engine contains storage engine configuration and their implementations.
Expand Down
4 changes: 2 additions & 2 deletions config/load.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"reflect"
"time"

"github.com/buraksezer/olric/config/internal/loader"
"github.com/buraksezer/olric/hasher"
"github.com/ShareChat/olric/config/internal/loader"
"github.com/ShareChat/olric/hasher"
"github.com/hashicorp/memberlist"
"github.com/pkg/errors"
)
Expand Down
4 changes: 2 additions & 2 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ services:
cd /go/src/github.com/buraksezer/olric-consul-plugin &&
go build -buildmode=plugin -o /usr/lib/olric-consul-plugin.so &&
cd /go/src/github.com/buraksezer/olric &&
go build -v -o /go/bin/olricd /go/src/github.com/buraksezer/olric/cmd/olricd/main.go &&
/go/bin/olricd -c /go/src/github.com/buraksezer/olric/cmd/olricd/olricd-local.yaml"
go build -v -o /go/bin/olricd /go/src/github.com/ShareChat/olric/cmd/olricd/main.go &&
/go/bin/olricd -c /go/src/github.com/ShareChat/olric/cmd/olricd/olricd-local.yaml"
volumes:
- ${PWD}/olricd-consul.yaml:/etc/olricd.yaml:ro
- ../:/go/src/github.com/buraksezer/olric
Expand Down
10 changes: 5 additions & 5 deletions embedded_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ import (
"sync"
"time"

"github.com/buraksezer/olric/internal/discovery"
"github.com/buraksezer/olric/internal/dmap"
"github.com/buraksezer/olric/internal/protocol"
"github.com/buraksezer/olric/internal/util"
"github.com/buraksezer/olric/stats"
"github.com/ShareChat/olric/internal/discovery"
"github.com/ShareChat/olric/internal/dmap"
"github.com/ShareChat/olric/internal/protocol"
"github.com/ShareChat/olric/internal/util"
"github.com/ShareChat/olric/stats"
)

// EmbeddedLockContext is returned by Lock and LockWithTimeout methods.
Expand Down
2 changes: 1 addition & 1 deletion embedded_client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"testing"
"time"

"github.com/buraksezer/olric/internal/testutil"
"github.com/ShareChat/olric/internal/testutil"
"github.com/stretchr/testify/require"
"golang.org/x/sync/errgroup"
)
Expand Down
4 changes: 2 additions & 2 deletions embedded_iterator.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ package olric
import (
"sync"

"github.com/buraksezer/olric/internal/dmap"
"github.com/buraksezer/olric/internal/protocol"
"github.com/ShareChat/olric/internal/dmap"
"github.com/ShareChat/olric/internal/protocol"
)

// EmbeddedIterator implements distributed query on DMaps.
Expand Down
2 changes: 1 addition & 1 deletion embedded_iterator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
"fmt"
"testing"

"github.com/buraksezer/olric/internal/testutil"
"github.com/ShareChat/olric/internal/testutil"
"github.com/stretchr/testify/require"
)

Expand Down
2 changes: 1 addition & 1 deletion events/cluster_events.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"strconv"
"strings"

"github.com/buraksezer/olric/internal/util"
"github.com/ShareChat/olric/internal/util"
)

const (
Expand Down
4 changes: 2 additions & 2 deletions get_response.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ import (
"errors"
"time"

"github.com/buraksezer/olric/internal/resp"
"github.com/buraksezer/olric/pkg/storage"
"github.com/ShareChat/olric/internal/resp"
"github.com/ShareChat/olric/pkg/storage"
)

var ErrNilResponse = errors.New("storage entry is nil")
Expand Down
6 changes: 3 additions & 3 deletions get_response_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (
"testing"
"time"

"github.com/buraksezer/olric/internal/dmap"
"github.com/buraksezer/olric/internal/resp"
"github.com/buraksezer/olric/internal/testcluster"
"github.com/ShareChat/olric/internal/dmap"
"github.com/ShareChat/olric/internal/resp"
"github.com/ShareChat/olric/internal/testcluster"
"github.com/stretchr/testify/require"
)

Expand Down
Loading