Paulius-Maruska / nds

A Go (golang) Google App Engine datastore package with strongly consistent caching.

Home Page:http://godoc.org/github.com/qedus/nds

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nds

Build Status Coverage Status GoDoc

Package github.com/qedus/nds is a datastore API for the Google App Engine (GAE) Go Runtime Environment that uses memcache to cache all datastore requests. This package guarantees strong cache consistency, meaning you will never get data from a stale cache.

Exposed parts of this API are the same as the official one distributed by Google (appengine/datastore). However, underneath github.com/qedus/nds uses a caching stategy similar to the GAE Python NDB API. In fact the caching strategy used here even fixes one or two of the Python NDB caching consistency bugs.

You can find the API documentation at http://godoc.org/github.com/qedus/nds.

One other benefit is that the standard datastore.GetMulti function only allows you to retrieve a maximum of 1000 entities at a time. The GetMulti in this package allows you to get as many as you need (within timeout limits) by concurrently calling the datastore until your entity request is fulfilled.

How To Use

You can use this package in exactly the same way you would use appengine/datastore. However, it is important that you use nds.Get*, nds.Put*, nds.Delete* and nds.RunInTransaction entirely within your code. Do not mix use of those functions with the appengine/datastore equivalents as you will be liable to get stale datastore entities from github.com/qedus/nds.

Ultimately all you need to do is find/replace the following in your codebase:

  • datastore.Get -> nds.Get
  • datastore.Put -> nds.Put
  • datastore.Delete -> nds.Delete
  • datastore.RunInTransaction -> nds.RunInTransaction

About

A Go (golang) Google App Engine datastore package with strongly consistent caching.

http://godoc.org/github.com/qedus/nds

License:Apache License 2.0


Languages

Language:Go 100.0%