Documentation
¶
Overview ¶
Package leveldb contains an implementation of the `gokv.Store` interface for LevelDB.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultOptions = Options{ Path: "leveldb", Codec: encoding.JSON, }
DefaultOptions is an Options object with default values. Path: "leveldb", WriteSync: false, Codec: encoding.JSON
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// Path of the DB files.
// Optional ("leveldb" by default).
Path string
// Flag to enable immediate file synchronization on writes.
// If enabled, writes take longer, but no writes are lost when the system crashes.
// If disabled, writes go to a cache first and are persisted via snapshots automatically.
// Set() and Delete() are both writes.
// Optional (false by default).
WriteSync bool
// Encoding format.
// Optional (encoding.JSON by default).
Codec encoding.Codec
}
Options are the options for the LevelDB store.
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store is a gokv.Store implementation for LevelDB.
func NewStore ¶
NewStore creates a new LevelDB store.
You must call the Close() method on the store when you're done working with it.
func (Store) Close ¶
Close closes the store. It must be called to releases any outstanding snapshots, abort any in-flight compactions and discard open transactions.
func (Store) Delete ¶
Delete deletes the stored value for the given key. Deleting a non-existing key-value pair does NOT lead to an error. The key must not be "".
func (Store) Get ¶
Get retrieves the stored value for the given key. You need to pass a pointer to the value, so in case of a struct the automatic unmarshalling can populate the fields of the object that v points to with the values of the retrieved object's values. If no value is found it returns (false, nil). The key must not be "" and the pointer must not be nil.
Source Files