Git Product home page Git Product logo

mc's Introduction

mc.go: A Go client for Memcached

godoc Build Status

This is a (pure) Go client for Memcached. It supports the binary Memcached protocol, SASL authentication and Compression. It's thread-safe. It allows connections to entire Memcached clusters and supports connection pools, timeouts, and failover.

Install

Module-aware mode:

$ go get github.com/memcachier/mc/v3

Legacy GOPATH mode:

$ go get github.com/memcachier/mc

Use

import "github.com/memcachier/mc/v3"
// Legacy GOPATH mode:
// import "github.com/memcachier/mc"

func main() {
  // Error handling omitted for demo

  // Only PLAIN SASL auth supported right now
  c := mc.NewMC("localhost:11211", "username", "password")
  defer c.Quit()

  exp := 3600 // 2 hours
  cas, err = c.Set("foo", "bar", flags, exp, cas)
  if err != nil {
  	...
  }

  val, flags, cas, err = c.Get("foo")
  if err != nil {
  	...
  }

  err = c.Del("foo")
  if err != nil {
  	...
  }
}

Using zlib Compression

import (
  "github.com/memcachier/mc/v3"
  "compress/zlib"
)
// Legacy GOPATH mode:
// import "github.com/memcachier/mc"

func main() {
  // Error handling omitted for demo

  // Only PLAIN SASL auth supported right now
  config := mc.DefaultConfig()

  // You have to set the functions to compress and descompress
  // At this example we are using zlib.

  config.Compression.Decompress = func(value string) (string, error) {
  	var compressedValue bytes.Buffer
  	zw, err := zlib.NewWriterLevel(&compressedValue, -1)
  	if err != nil {
  		return value, err
  	}
  	if _, err = zw.Write([]byte(value)); err != nil {
  		return value, err
  	}
  	zw.Close()
  	return compressedValue.String(), nil
  }

  config.Compression.Compress = func(value string) (string, error) {
  	if value == "" {
  		return value, nil
  	}
  	zr, err := zlib.NewReader(strings.NewReader(value))
  	if err != nil {
  		return value, nil // Does not return error, the value could be not compressed
  	}
  	defer zr.Close()
  	var unCompressedValue bytes.Buffer
  	_, err = io.Copy(&unCompressedValue, zr)
  	if err != nil {
  		return value, nil
  	}
  	return unCompressedValue.String(), nil
  }

  c := mc.NewMCwithConfig("localhost:11211", "username", "password", config)
  defer c.Quit()

  exp := 3600 // 2 hours
  cas, err = c.Set("foo", "bar", flags, exp, cas)
  if err != nil {
  	...
  }

  val, flags, cas, err = c.Get("foo")
  if err != nil {
  	...
  }

  err = c.Del("foo")
  if err != nil {
  	...
  }
}

Using gzip Compression

import (
  "github.com/memcachier/mc/v3"
  "compress/gzip"
)
// Legacy GOPATH mode:
// import "github.com/memcachier/mc"

func main() {
  // Error handling omitted for demo

  // Only PLAIN SASL auth supported right now
  config := mc.DefaultConfig()

  // You have to set the functions to compress and descompress
  // At this example we are using gzip.

  config.Compression.Decompress = func(value string) (string, error) {
  	var compressedValue bytes.Buffer
  	zw, err := gzip.NewWriterLevel(&compressedValue, -1)
  	if err != nil {
  		return value, err
  	}
  	if _, err = zw.Write([]byte(value)); err != nil {
  		return value, err
  	}
  	zw.Close()
  	return compressedValue.String(), nil
  }

  config.Compression.Compress = func(value string) (string, error) {
  	if value == "" {
  		return value, nil
  	}
  	zr, err := gzip.NewReader(strings.NewReader(value))
  	if err != nil {
  		return value, nil // Does not return error, the value could be not compressed
  	}
  	defer zr.Close()
  	var unCompressedValue bytes.Buffer
  	_, err = io.Copy(&unCompressedValue, zr)
  	if err != nil {
  		return value, nil
  	}
  	return unCompressedValue.String(), nil
  }

  c := mc.NewMCwithConfig("localhost:11211", "username", "password", config)
  defer c.Quit()

  exp := 3600 // 2 hours
  cas, err = c.Set("foo", "bar", flags, exp, cas)
  if err != nil {
  	...
  }

  val, flags, cas, err = c.Get("foo")
  if err != nil {
  	...
  }

  err = c.Del("foo")
  if err != nil {
  	...
  }
}

Missing Feature

There is nearly coverage of the Memcached protocol. The biggest missing protocol feature is support for multi_get and other batched operations.

There is also no support for asynchronous IO.

Performance

Right now we use a single per-connection mutex and don't support pipe-lining any operations. There is however support for connection pools which should make up for it.

Get involved!

We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.

Please report bugs via the github issue tracker.

Master git repository:

  • git clone git://github.com/memcachier/mc.git

Licensing

This library is MIT-licensed.

Authors

This library is written and maintained by MemCachier. It was originally written by Blake Mizerany.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.