README
¶
Example datastore implementations
This directory contains simple implementation of the datastore interface
THE CODE IN THIS DIRECTORY IS NOT SAFE TO USE IN ANY APPLICATION!
If you are looking for a more complete persistent implementation of the go-datastore interface, there are several implementations you can choose from:
- https://github.com/ipfs/go-ds-flatfs - Filesystem backed implementation, good for big blobs, though may be missing few features (some iteration settings don't work).
- https://github.com/ipfs/go-ds-leveldb - Datastore implementation backed by LevelDB database. Good for small-size values and many keys.
- https://github.com/ipfs/go-ds-badger - A fast datastore implementation backed by BadgerDB. Good for most kinds of data.
Documentation
¶
Overview ¶
Package fs is a simple Datastore implementation that stores keys as directories and files, mirroring the key. That is, the key "/foo/bar" is stored as file "PATH/foo/bar/.dsobject".
This means key some segments will not work. For example, the following keys will result in unwanted behavior:
- "/foo/./bar"
- "/foo/../bar"
- "/foo\x00bar"
Keys that only differ in case may be confused with each other on case insensitive file systems, for example in OS X.
This package is intended for exploratory use, where the user would examine the file system manually, and should only be used with human-friendly, trusted keys. You have been warned.
Index ¶
- Variables
- func NewDatastore(path string) (ds.Datastore, error)
- type Datastore
- func (d *Datastore) Batch(ctx context.Context) (ds.Batch, error)
- func (d *Datastore) Close() error
- func (d *Datastore) Delete(ctx context.Context, key ds.Key) (err error)
- func (d *Datastore) DiskUsage(ctx context.Context) (uint64, error)
- func (d *Datastore) Get(ctx context.Context, key ds.Key) (value []byte, err error)
- func (d *Datastore) GetSize(ctx context.Context, key ds.Key) (size int, err error)
- func (d *Datastore) Has(ctx context.Context, key ds.Key) (exists bool, err error)
- func (d *Datastore) KeyFilename(key ds.Key) string
- func (d *Datastore) Put(ctx context.Context, key ds.Key, value []byte) (err error)
- func (d *Datastore) Query(ctx context.Context, q query.Query) (query.Results, error)
- func (d *Datastore) Sync(ctx context.Context, prefix ds.Key) error
Constants ¶
This section is empty.
Variables ¶
var ObjectKeySuffix = ".dsobject"
Functions ¶
Types ¶
type Datastore ¶
type Datastore struct {
// contains filtered or unexported fields
}
Datastore uses a uses a file per key to store values.
func (*Datastore) KeyFilename ¶
KeyFilename returns the filename associated with `key`
Source Files