@@ -24,18 +24,8 @@ Jaeger Tracing, UsenetExpress, and many more.
24
24
25
25
The list of projects using Badger can be found [ here] ( #projects-using-badger ) .
26
26
27
- Badger v1.0 was released in Nov 2017, and the latest version that is data-compatible with v1.0 is
28
- v1.6.0.
29
-
30
- Badger v2.0 was released in Nov 2019 with a new storage format which won't be compatible with all of
31
- the v1.x. Badger v2.0 supports compression, encryption and uses a cache to speed up lookup.
32
-
33
- Badger v3.0 was released in January 2021. This release improves compaction performance.
34
-
35
27
Please consult the [ Changelog] for more detailed information on releases.
36
28
37
- For more details on our version naming schema please read [ Choosing a version] ( #choosing-a-version ) .
38
-
39
29
[ Changelog ] : https://github.com/hypermodeinc/badger/blob/main/CHANGELOG.md
40
30
41
31
## Table of Contents
@@ -82,30 +72,6 @@ go install .
82
72
83
73
This will install the badger command line utility into your $GOBIN path.
84
74
85
- #### Choosing a version
86
-
87
- BadgerDB is a pretty special package from the point of view that the most important change we can
88
- make to it is not on its API but rather on how data is stored on disk.
89
-
90
- This is why we follow a version naming schema that differs from Semantic Versioning.
91
-
92
- - New major versions are released when the data format on disk changes in an incompatible way.
93
- - New minor versions are released whenever the API changes but data compatibility is maintained.
94
- Note that the changes on the API could be backward-incompatible - unlike Semantic Versioning.
95
- - New patch versions are released when there's no changes to the data format nor the API.
96
-
97
- Following these rules:
98
-
99
- - v1.5.0 and v1.6.0 can be used on top of the same files without any concerns, as their major
100
- version is the same, therefore the data format on disk is compatible.
101
- - v1.6.0 and v2.0.0 are data incompatible as their major version implies, so files created with
102
- v1.6.0 will need to be converted into the new format before they can be used by v2.0.0.
103
- - v2.x.x and v3.x.x are data incompatible as their major version implies, so files created with
104
- v2.x.x will need to be converted into the new format before they can be used by v3.0.0.
105
-
106
- For a longer explanation on the reasons behind using a new versioning naming schema, you can read
107
- [ VERSIONING] ( VERSIONING.md ) .
108
-
109
75
## Badger Documentation
110
76
111
77
Badger Documentation is available at https://docs.hypermode.com/badger
0 commit comments