README.md 1.9 KB
Newer Older
tavit ohanian's avatar
tavit ohanian committed
1 2
# go-datastore

Richard Littauer's avatar
Richard Littauer committed
3 4 5 6
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
7
[![GoDoc](https://godoc.org/github.com/ipfs/go-datastore?status.svg)](https://godoc.org/github.com/ipfs/go-datastore)
Richard Littauer's avatar
Richard Littauer committed
8 9

> key-value datastore interfaces
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
10

Steven Allen's avatar
Steven Allen committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24
## Lead Maintainer

[Steven Allen](https://github.com/Stebalien)

## Table of Contents

- [Background](#background)
- [Documentation](#documentation)
- [Contribute](#contribute)
- [License](#license)

## Background

Datastore is a generic layer of abstraction for data store and database access. It is a simple API with the aim to enable application development in a datastore-agnostic way, allowing datastores to be swapped seamlessly without changing application code. Thus, one can leverage different datastores with different strengths without committing the application to one datastore throughout its lifetime.
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
25 26 27

In addition, grouped datastores significantly simplify interesting data access patterns (such as caching and sharding).

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
28 29
Based on [datastore.py](https://github.com/datastore/datastore).

Richard Littauer's avatar
Richard Littauer committed
30
## Documentation
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
31

32
https://godoc.org/github.com/ipfs/go-datastore
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
33

Richard Littauer's avatar
Richard Littauer committed
34 35
## Contribute

36
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/go-datastore/issues)!
Richard Littauer's avatar
Richard Littauer committed
37 38 39 40 41 42 43 44

This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

### Want to hack on IPFS?

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)

## License
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
45 46

MIT