1
- # Pebble [ ![ Build Status] ( https://github.com/cockroachdb/pebble/actions/workflows/ci.yaml/badge.svg?branch=master )] ( https://github.com/cockroachdb/pebble/actions/workflows/ci.yaml ) [ ![ GoDoc] ( https://godoc.org/github.com/cockroachdb/pebble?status.svg )] ( https://godoc.org/github.com/cockroachdb/pebble ) <sup ><sub ><sub >[ Coverage] ( https://storage.googleapis.com/crl-codecover-public/pebble/index.html ) </sub ></sub ></sup >
1
+ # Pebble [ ![ Build Status] ( https://github.com/cockroachdb/pebble/v2/ actions/workflows/ci.yaml/badge.svg?branch=master )] ( https://github.com/cockroachdb/pebble/v2/ actions/workflows/ci.yaml ) [ ![ GoDoc] ( https://godoc.org/github.com/cockroachdb/pebble/v2 ?status.svg )] ( https://godoc.org/github.com/cockroachdb/pebble/v2 ) <sup ><sub ><sub >[ Coverage] ( https://storage.googleapis.com/crl-codecover-public/pebble/index.html ) </sub ></sub ></sup >
2
2
3
3
#### [ Nightly benchmarks] ( https://cockroachdb.github.io/pebble/ )
4
4
@@ -118,7 +118,7 @@ incompatibilities.
118
118
* SSTable format version 3 and 4. Pebble does not support version 3
119
119
and version 4 format sstables. The sstable format version is
120
120
controlled by the ` BlockBasedTableOptions::format_version ` option.
121
- See [ #97 ] ( https://github.com/cockroachdb/pebble/issues/97 ) .
121
+ See [ #97 ] ( https://github.com/cockroachdb/pebble/v2/ issues/97 ) .
122
122
123
123
## Format major versions
124
124
@@ -134,11 +134,11 @@ to a compatible format major version before running newer Pebble versions. Newer
134
134
Pebble versions will refuse to open databases in no longer supported formats.
135
135
136
136
To opt into new formats, a user may set ` FormatMajorVersion ` on the
137
- [ ` Options ` ] ( https://pkg.go.dev/github.com/cockroachdb/pebble#Options )
137
+ [ ` Options ` ] ( https://pkg.go.dev/github.com/cockroachdb/pebble/v2 #Options )
138
138
supplied to
139
- [ ` Open ` ] ( https://pkg.go.dev/github.com/cockroachdb/pebble#Open ) , or
139
+ [ ` Open ` ] ( https://pkg.go.dev/github.com/cockroachdb/pebble/v2 #Open ) , or
140
140
upgrade the format major version at runtime using
141
- [ ` DB.RatchetFormatMajorVersion ` ] ( https://pkg.go.dev/github.com/cockroachdb/pebble#DB.RatchetFormatMajorVersion ) .
141
+ [ ` DB.RatchetFormatMajorVersion ` ] ( https://pkg.go.dev/github.com/cockroachdb/pebble/v2 #DB.RatchetFormatMajorVersion ) .
142
142
Format major version upgrades are permanent; There is no option to
143
143
return to an earlier format.
144
144
@@ -180,7 +180,7 @@ property collectors, the `pebble` tool can also be used, at the latest version
180
180
that supports the format. For example:
181
181
```
182
182
# WARNING: only use if no custom comparer/merger/property collector are necessary.
183
- go run github.com/cockroachdb/pebble/cmd/[email protected] db upgrade <db-dir>
183
+ go run github.com/cockroachdb/pebble/v2/ cmd/[email protected] db upgrade <db-dir>
184
184
```
185
185
186
186
For reference, the table below lists the range of supported Pebble format major
@@ -224,7 +224,7 @@ import (
224
224
" fmt"
225
225
" log"
226
226
227
- " github.com/cockroachdb/pebble"
227
+ " github.com/cockroachdb/pebble/v2 "
228
228
)
229
229
230
230
func main () {
0 commit comments