ethdb/database.go


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

// Copyright 2018 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

// Package ethdb defines the interfaces for an Ethereum data store.
package ethdb

import "io"

// Reader wraps the Has and Get method of a backing data store.
type Reader interface {
    // Has retrieves if a key is present in the key-value data store.
    Has(key []byte) (bool, error)

    // Get retrieves the given key if it's present in the key-value data store.
    Get(key []byte) ([]byte, error)
}

// Writer wraps the Put method of a backing data store.
type Writer interface {
    // Put inserts the given value into the key-value data store.
    Put(key []byte, value []byte) error

    // Delete removes the key from the key-value data store.
    Delete(key []byte) error
}

// Stater wraps the Stat method of a backing data store.
type Stater interface {
    // Stat returns a particular internal stat of the database.
    Stat(property string) (string, error)
}

// Compacter wraps the Compact method of a backing data store.
type Compacter interface {
    // Compact flattens the underlying data store for the given key range. In essence,
    // deleted and overwritten versions are discarded, and the data is rearranged to
    // reduce the cost of operations needed to access them.
    //
    // A nil start is treated as a key before all keys in the data store; a nil limit
    // is treated as a key after all keys in the data store. If both is nil then it
    // will compact entire data store.
    Compact(start []byte, limit []byte) error
}

// KeyValueStore contains all the methods required to allow handling different
// key-value data stores backing the high level database.
type KeyValueStore interface {
    Reader
    Writer
    Batcher
    Iteratee
    Stater
    Compacter
    io.Closer
}

// Database contains all the methods required by the high level database to not
// only access the key-value data store but also the chain freezer.
type Database interface {
    Reader
    Writer
    Batcher
    Iteratee
    Stater
    Compacter
    io.Closer
}