5.0.0

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [5.0.0] - 2021-09-12
+
+_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._
+
+### Changed
+
+- **Breaking:** bump `rocksdb` from 4.x to [5.x](https://github.com/Level/rocksdb/releases/tag/v5.0.0) ([`a02f4b5`](https://github.com/Level/level-rocksdb/commit/a02f4b5)) (Vincent Weevers)
+- **Breaking:** bump `level-packager` from 5.x to [6.x](https://github.com/Level/packager/releases/tag/v6.0.0) ([#73](https://github.com/Level/level-rocksdb/issues/73)) ([`a0b5ea6`](https://github.com/Level/level-rocksdb/commit/a0b5ea6)) (Vincent Weevers)
+
+### Removed
+
+- **Breaking:** drop Node.js 8 ([Level/community#98](https://github.com/Level/community/issues/98)) ([`ec94d45`](https://github.com/Level/level-rocksdb/commit/ec94d45)) (Vincent Weevers)
+- Remove legacy range options from README ([Level/community#86](https://github.com/Level/community/issues/86)) ([`6d08202`](https://github.com/Level/level-rocksdb/commit/6d08202)) (Vincent Weevers).
+
 ## [4.0.0] - 2019-06-08
 
 _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._
@@ -95,6 +109,8 @@ _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._
 
 _Technically not the first release. Earlier versions were published in 2013._
 
+[5.0.0]: https://github.com/Level/level-rocksdb/releases/tag/v5.0.0
+
 [4.0.0]: https://github.com/Level/level-rocksdb/releases/tag/v4.0.0
 
 [3.0.1]: https://github.com/Level/level-rocksdb/releases/tag/v3.0.1

UPGRADING.md

@@ -2,6 +2,26 @@
 
 This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](CHANGELOG.md).
 
+## 5.0.0
+
+Legacy range options have been removed ([Level/community#86](https://github.com/Level/community/issues/86)). If you previously did:
+
+```js
+db.createReadStream({ start: 'a', end: 'z' })
+```
+
+An error would now be thrown and you must instead do:
+
+```js
+db.createReadStream({ gte: 'a', lte: 'z' })
+```
+
+The same applies to `db.iterator()`, `db.createKeyStream()` and `db.createValueStream()`.
+
+A db created or opened with this release cannot be opened by earlier versions, because RocksDB has been upgraded to 6.17.3 (via `rocksdb` [5.0.0](https://github.com/Level/rocksdb/releases/tag/v5.0.0)) which effectively changes the default [`format_version`](https://rocksdb.org/blog/2019/03/08/format-version-4.html) from 2 to 4.
+
+This release also drops support of Node.js 8 ([Level/community#98](https://github.com/Level/community/issues/98)).
+
 ## 4.0.0
 
 Upgraded to [`[email protected]`](https://github.com/Level/rocksdb/blob/master/UPGRADING.md#v4) and (through `level-packager@5`) [`levelup@4`](https://github.com/Level/levelup/blob/master/UPGRADING.md#v4) and [`encoding-down@6`](https://github.com/Level/encoding-down/blob/master/UPGRADING.md#v6). Please follow these links for more information. A quick summary: support of node < 8.6.0 has been dropped, node 12 is now supported, range options (e.g. `gt`) are now serialized the same as keys, `{ gt: undefined }` is not the same as `{}`, nullish values are now rejected and streams are backed by [`readable-stream@3`](https://github.com/nodejs/readable-stream#version-3xx).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "level-rocksdb",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Fast & simple storage - a Node.js-style RocksDB wrapper (a convenience package bundling LevelUP & RocksDB)",
   "license": "MIT",
   "main": "level-rocksdb.js",