aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/syndtr/goleveldb/leveldb/doc.go
blob: be768e5739f733f4c5a0b0f4f53b1de32a0597b0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// Copyright (c) 2012, Suryandaru Triandana <syndtr@gmail.com>
// All rights reserved.
//
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Package leveldb provides implementation of LevelDB key/value database.
//
// Create or open a database:
//
//  // The returned DB instance is safe for concurrent use. Which mean that all
//  // DB's methods may be called concurrently from multiple goroutine.
//  db, err := leveldb.OpenFile("path/to/db", nil)
//  ...
//  defer db.Close()
//  ...
//
// Read or modify the database content:
//
//  // Remember that the contents of the returned slice should not be modified.
//  data, err := db.Get([]byte("key"), nil)
//  ...
//  err = db.Put([]byte("key"), []byte("value"), nil)
//  ...
//  err = db.Delete([]byte("key"), nil)
//  ...
//
// Iterate over database content:
//
//  iter := db.NewIterator(nil, nil)
//  for iter.Next() {
//      // Remember that the contents of the returned slice should not be modified, and
//      // only valid until the next call to Next.
//      key := iter.Key()
//      value := iter.Value()
//      ...
//  }
//  iter.Release()
//  err = iter.Error()
//  ...
//
// Iterate over subset of database content with a particular prefix:
//  iter := db.NewIterator(util.BytesPrefix([]byte("foo-")), nil)
//  for iter.Next() {
//      // Use key/value.
//      ...
//  }
//  iter.Release()
//  err = iter.Error()
//  ...
//
// Seek-then-Iterate:
//
//  iter := db.NewIterator(nil, nil)
//  for ok := iter.Seek(key); ok; ok = iter.Next() {
//      // Use key/value.
//      ...
//  }
//  iter.Release()
//  err = iter.Error()
//  ...
//
// Iterate over subset of database content:
//
//  iter := db.NewIterator(&util.Range{Start: []byte("foo"), Limit: []byte("xoo")}, nil)
//  for iter.Next() {
//      // Use key/value.
//      ...
//  }
//  iter.Release()
//  err = iter.Error()
//  ...
//
// Batch writes:
//
//  batch := new(leveldb.Batch)
//  batch.Put([]byte("foo"), []byte("value"))
//  batch.Put([]byte("bar"), []byte("another value"))
//  batch.Delete([]byte("baz"))
//  err = db.Write(batch, nil)
//  ...
//
// Use bloom filter:
//
//  o := &opt.Options{
//      Filter: filter.NewBloomFilter(10),
//  }
//  db, err := leveldb.OpenFile("path/to/db", o)
//  ...
//  defer db.Close()
//  ...
package leveldb