Skip to content

Commit

Permalink
fixup! Add to FAQ: how do I upgrade to abstract-level?
Browse files Browse the repository at this point in the history
  • Loading branch information
vweevers committed Dec 11, 2021
1 parent 2026545 commit 445a85a
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,41 +62,41 @@ Enter [`abstract-level`](https://github.com/Level/abstract-level). This module m

### How do I upgrade to `abstract-level`?

_This section is a work in progress that will explain how to replace old modules (that are based on `levelup` and `abstract-leveldown`) with new `abstract-level` based modules. At the time of writing, no `abstract-level` implementation has been published yet._
_This section is a work in progress that will explain how to replace old modules (that are based on [`levelup`](https://github.com/Level/levelup) and [`abstract-leveldown`](https://github.com/Level/abstract-leveldown)) with new [`abstract-level`](https://github.com/Level/abstract-level) based modules. At the time of writing, no `abstract-level` implementation has been published yet._

We've put together several upgrade guides for different modules. For example, if you're currently using `level@7` and no other modules (ignoring transitive dependencies of `level`) then it will suffice to read the upgrade guide of `level@8` (_not yet available_).
We've put together several upgrade guides for different modules. For example, if you're currently using `level@7` and no other modules (ignoring transitive dependencies) then it will suffice to read the upgrade guide of `level@8` (_not yet available_).

Naming-wise, databases generally use an npm package name in the form of `*-level` while utilities and plugins are called `level-*`. This replaces the [down versus up](https://github.com/Level/abstract-level/issues/6) naming scheme. Similarly, while it was previously helpful to distinguish between "database" and its "underlying store", now you will mostly just encounter the term "database" in documentation.
Naming-wise, databases generally use an npm package name in the form of `*-level` while utilities and plugins are called `level-*`. This replaces the [down versus up](https://github.com/Level/abstract-level/issues/6) naming scheme. Similarly, while it was previously helpful to distinguish between "database" and its "underlying store", now you will mostly just encounter the term "database" in our documentation.

**If you are upgrading:**

<!-- - From `level@7` to `level@8`: see `level@8` (_not yet available_) -->

<!-- - From `leveldown` to `leveldb-level`: see `leveldb-level@1` (_not yet available_) -->
<!-- - From [`leveldown`](https://github.com/Level/leveldown) to `leveldb-level`: see `leveldb-level@1` (_not yet available_) -->

<!-- - From `memdown` to `memory-level`: see `memory-level@1` (_not yet available_) -->
<!-- - From [`memdown`](https://github.com/Level/memdown) to `memory-level`: see `memory-level@1` (_not yet available_) -->

<!-- - From `level-mem` to `memory-level`: see `memory-level@1` (_not yet available_) -->
<!-- - From [`level-mem`](https://github.com/Level/mem) to `memory-level`: see `memory-level@1` (_not yet available_) -->

<!-- - From `level-js` to `indexeddb-level`: see `indexeddb-level@1` (_not yet available_) -->
<!-- - From [`level-js`](https://github.com/Level/level-js) to `indexeddb-level`: see `indexeddb-level@1` (_not yet available_) -->

<!-- - From `rocksdb` to `rocks-level`: see `rocks-level` (_not yet available_) -->
<!-- - From [`rocksdb`](https://github.com/Level/rocksdb) to `rocks-level`: see `rocks-level` (_not yet available_) -->

<!-- - From `level-rocksdb` to `rocks-level`: see `rocks-level` (_not yet available_) -->
<!-- - From [`level-rocksdb`](https://github.com/Level/level-rocksdb) to `rocks-level`: see `rocks-level` (_not yet available_) -->

<!-- - From `subleveldown` to `prefix-level`: see `prefix-level@1` (_not yet available_) -->
<!-- - From [`subleveldown`](https://github.com/Level/subleveldown) to `prefix-level`: see `prefix-level@1` (_not yet available_) -->

<!-- - From `multileveldown` to TBD: see TBD (_not yet available_) -->
<!-- - From [`multileveldown`](https://github.com/Level/multileveldown) to TBD: see TBD (_not yet available_) -->

<!-- - From `level-party` to `rave-level`: see `rave-level@1` (_not yet available_) -->
<!-- - From [`level-party`](https://github.com/Level/party) to `rave-level`: see `rave-level@1` (_not yet available_) -->

- From [`abstract-leveldown`](https://github.com/Level/abstract-leveldown) to `abstract-level`: see [`abstract-level@1`](https://github.com/Level/abstract-level/blob/main/UPGRADING.md#100)
- From [`levelup`](https://github.com/Level/levelup): if the module that you're wrapping with `levelup` is listed here, then that, else see [`abstract-level@1`](https://github.com/Level/abstract-level/blob/main/UPGRADING.md#100)
- From an [`abstract-leveldown`](https://github.com/Level/abstract-leveldown) implementation that upgraded to `abstract-level` but has no upgrade guide itself: see [`abstract-level@1`](https://github.com/Level/abstract-level/blob/main/UPGRADING.md#100). That guide may talk about internals that don't directly apply to you.

<!-- If you use a combination of the above, you must upgrade all to their `abstract-level` equivalent. E.g. the old `level@7` cannot be combined with `prefix-level@1` and the old `encoding-down` can't be combined with anything. -->

The following modules are or will be deprecated: `leveldown`, `memdown`, `level-mem`, `rocksdb`, `rocksdb-level`, `subleveldown`, `level-party`, `multileveldown`. The same goes for `levelup`, `deferred-leveldown`, `encoding-down` and [`level-packager`](https://github.com/Level/packager), which in addition have no replacements as their functionality was merged into `abstract-level`.
The following modules are or will be deprecated: [`leveldown`](https://github.com/Level/leveldown), [`memdown`](https://github.com/Level/memdown), [`level-mem`](https://github.com/Level/mem), [`level-js`](https://github.com/Level/level-js), [`rocksdb`](https://github.com/Level/rocksdb), [`level-rocksdb`](https://github.com/Level/level-rocksdb), [`subleveldown`](https://github.com/Level/subleveldown), [`multileveldown`](https://github.com/Level/multileveldown), [`level-party`](https://github.com/Level/party). The same goes for [`levelup`](https://github.com/Level/levelup), [`deferred-leveldown`](https://github.com/Level/deferred-leveldown), [`encoding-down`](https://github.com/Level/encoding-down) and [`level-packager`](https://github.com/Level/packager), which in addition have no replacements as their functionality was merged into `abstract-level`.

Lastly, there are new and replaced utilities. Most folks don't need direct access to these modules except for the first:

Expand Down

0 comments on commit 445a85a

Please sign in to comment.