You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -7,9 +15,7 @@ in pure Go. It is the underlying database for [Dgraph](https://dgraph.io), a
7
15
fast, distributed graph database. It's meant to be a performant alternative to
8
16
non-Go-based key-value stores like RocksDB.
9
17
10
-
**Use [Discuss Issues](https://discuss.dgraph.io/c/issues/badger/37) for reporting issues about this repository.**
11
-
12
-
## Project Status [March 24, 2020]
18
+
## Project Status
13
19
14
20
Badger is stable and is being used to serve data sets worth hundreds of
15
21
terabytes. Badger supports concurrent ACID transactions with serializable
@@ -27,7 +33,9 @@ with v1.0 is v1.6.0.
27
33
Badger v2.0 was released in Nov 2019 with a new storage format which won't
28
34
be compatible with all of the v1.x. Badger v2.0 supports compression, encryption and uses a cache to speed up lookup.
29
35
30
-
The [Changelog] is kept fairly up-to-date.
36
+
Badger v3.0 was released in January 2021. This release improves compaction performance.
37
+
38
+
Please consult the [Changelog] for more detailed information on releases.
31
39
32
40
For more details on our version naming schema please read [Choosing a version](#choosing-a-version).
33
41
@@ -51,7 +59,7 @@ For more details on our version naming schema please read [Choosing a version](#
51
59
## Getting Started
52
60
53
61
### Installing
54
-
To start using Badger, install Go 1.12 or above. Badger v2 needs go modules. Run the following command to retrieve the library.
62
+
To start using Badger, install Go 1.12 or above. Badger v3 needs go modules. From your project, run the following command
55
63
56
64
```sh
57
65
$ go get github.com/dgraph-io/badger/v3
@@ -60,13 +68,14 @@ This will retrieve the library.
60
68
61
69
#### Installing Badger Command Line Tool
62
70
63
-
Download and extract the latest Badger DB release from https://github.com/dgraph-io/badger/releases and then run the following commands.
71
+
Badger provides a CLI tool which can perform certain operations like offline backup/restore. To install the Badger CLI,
72
+
retrieve the repository and checkout the desired version. Then run
64
73
65
74
```sh
66
-
$ cd badger-<version>/badger
67
-
$ go install
75
+
$ cd badger
76
+
$ go install.
68
77
```
69
-
This will install the badger command line utility into your $GOBIN path.
78
+
This will install the badger command line utility into your $GOBIN path.
70
79
71
80
#### Choosing a version
72
81
@@ -86,9 +95,12 @@ Following these rules:
86
95
version is the same, therefore the data format on disk is compatible.
87
96
- v1.6.0 and v2.0.0 are data incompatible as their major version implies, so files created with
88
97
v1.6.0 will need to be converted into the new format before they can be used by v2.0.0.
98
+
- v2.x.x and v3.x.x are data incompatible as their major version implies, so files created with
99
+
v2.x.x will need to be converted into the new format before they can be used by v3.0.0.
100
+
89
101
90
102
For a longer explanation on the reasons behind using a new versioning naming schema, you can read
91
-
[VERSIONING.md](VERSIONING.md).
103
+
[VERSIONING](VERSIONING.md).
92
104
93
105
## Badger Documentation
94
106
@@ -99,9 +111,9 @@ Badger Documentation is available at https://dgraph.io/docs/badger
99
111
### Blog Posts
100
112
1.[Introducing Badger: A fast key-value store written natively in
101
113
Go](https://open.dgraph.io/post/badger/)
102
-
2.[Make Badger crash resilient with ALICE](https://blog.dgraph.io/post/alice/)
103
-
3.[Badger vs LMDB vs BoltDB: Benchmarking key-value databases in Go](https://blog.dgraph.io/post/badger-lmdb-boltdb/)
104
-
4.[Concurrent ACID Transactions in Badger](https://blog.dgraph.io/post/badger-txn/)
114
+
2.[Make Badger crash resilient with ALICE](https://open.dgraph.io/post/alice/)
115
+
3.[Badger vs LMDB vs BoltDB: Benchmarking key-value databases in Go](https://open.dgraph.io/post/badger-lmdb-boltdb/)
116
+
4.[Concurrent ACID Transactions in Badger](https://open.dgraph.io/post/badger-txn/)
105
117
106
118
## Design
107
119
Badger was written with these design goals in mind:
@@ -167,6 +179,7 @@ Below is a list of known projects that use Badger:
167
179
*[Immudb](https://github.com/codenotary/immudb) - Lightweight, high-speed immutable database for systems and applications.
168
180
*[Usenet Express](https://usenetexpress.com/) - Serving over 300TB of data with Badger.
169
181
*[gorush](https://github.com/appleboy/gorush) - A push notification server written in Go.
182
+
*[0-stor](https://github.com/zero-os/0-stor) - Single device object store.
170
183
*[Dispatch Protocol](https://github.com/dispatchlabs/disgo) - Blockchain protocol for distributed application data analytics.
171
184
*[GarageMQ](https://github.com/valinurovam/garagemq) - AMQP server written in Go.
172
185
*[RedixDB](https://alash3al.github.io/redix/) - A real-time persistent key-value store with the same redis protocol.
@@ -189,15 +202,23 @@ Below is a list of known projects that use Badger:
189
202
*[Terminotes](https://gitlab.com/asad-awadia/terminotes) - Self hosted notes storage and search server - storage powered by BadgerDB
190
203
*[Pyroscope](https://github.com/pyroscope-io/pyroscope) - Open source confinuous profiling platform built with BadgerDB
191
204
*[Veri](https://github.com/bgokden/veri) - A distributed feature store optimized for Search and Recommendation tasks.
205
+
*[bIter](https://github.com/MikkelHJuul/bIter) - A library and Iterator interface for working with the `badger.Iterator`, simplifying from-to, and prefix mechanics.
206
+
*[ld](https://github.com/MikkelHJuul/ld) - (Lean Database) A very simple gRPC-only key-value database, exposing BadgerDB with key-range scanning semantics.
207
+
*[Souin](https://github.com/darkweak/Souin) - A RFC compliant HTTP cache with lot of other features based on Badger for the storage. Compatible with all existing reverse-proxies.
208
+
*[Xuperchain](https://github.com/xuperchain/xupercore) - A highly flexible blockchain architecture with great transaction performance.
209
+
*[m2](https://github.com/qichengzx/m2) - A simple http key/value store based on the raft protocol.
210
+
*[chaindb](https://github.com/ChainSafe/chaindb) - A blockchain storage layer used by [Gossamer](https://chainsafe.github.io/gossamer/), a Go client for the [Polkadot Network](https://polkadot.network/).
211
+
*[vxdb](https://github.com/vitalvas/vxdb) - Simple schema-less Key-Value NoSQL database with simplest API interface.
212
+
*[Opacity](https://github.com/opacity/storage-node) - Backend implementation for the Opacity storage project
213
+
*[Vephar](https://github.com/vaccovecrana/vephar) - A minimal key/value store using hashicorp-raft for cluster coordination and Badger for data storage.
192
214
193
215
If you are using Badger in a project please send a pull request to add it to the list.
194
216
195
217
## Contributing
196
218
197
-
If you're interested in contributing to Badger see [CONTRIBUTING.md](./CONTRIBUTING.md).
219
+
If you're interested in contributing to Badger see [CONTRIBUTING](./CONTRIBUTING.md).
198
220
199
221
## Contact
200
222
- Please use [discuss.dgraph.io](https://discuss.dgraph.io) for questions, feature requests and discussions.
201
-
- Please use [Github issue tracker](https://github.com/dgraph-io/badger/issues) for filing bugs or feature requests.
202
-
- Follow us on Twitter [@dgraphlabs](https://twitter.com/dgraphlabs).
203
-
223
+
- Please use [discuss.dgraph.io](https://discuss.dgraph.io) for filing bugs or feature requests.
224
+
- Follow us on Twitter [@dgraphlabs](https://twitter.com/dgraphlabs).
0 commit comments