A low-level Node.js RocksDB binding. An
abstract-leveldowncompliant store.
This module closely follows leveldown and implements the same API. The difference is that leveldown is a binding for LevelDB while rocksdb is a binding for RocksDB, Facebook's fork of LevelDB.
It is strongly recommended that you use levelup in preference to rocksdb unless you have measurable performance reasons to do so. levelup is optimized for usability and safety. Although we are working to improve the safety of the rocksdb interface it is still easy to crash your Node process if you don't do things in just the right way.
If you are upgrading: please see UPGRADING.md.
We aim to support at least Active LTS and Current Node.js releases, Electron 4.0.0, as well as any future Node.js and Electron releases thanks to N-API. Because N-API has an experimental status in node 6 and early 8.x releases, the minimum node version for rocksdb is 8.6.0.
The rocksdb npm package ships with prebuilt binaries for popular 64-bit platforms and is known to work on:
When installing rocksdb, node-gyp-build will check if a compatible binary exists and fallback to a compile step if it doesn't. In that case you'll need a valid node-gyp installation.
If you don't want to use the prebuilt binary for the platform you are installing on, specify the --build-from-source flag when you install. If you are working on rocksdb itself and want to re-compile the C++ code it's enough to do npm install.
Please refer to leveldown for API documentation. The db.open(options, callback) method of rocksdb has a few additional options:
readOnly (boolean, default false): open database in read-only mode.infoLogLevel (string, default null): verbosity of info log. One of 'debug', 'info', 'warn', 'error', 'fatal', 'header' or null (disable).Level/rocksdb is an OPEN Open Source Project. This means that:
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
See the Contribution Guide for more details.
npm version ..git push --follow-tags./prebuilds: npm run download-prebuildsnpm run test-prebuildcanadian-pubnpm publishTo sustain Level and its activities, become a backer or sponsor on Open Collective. Your logo or avatar will be displayed on our 28+ GitHub repositories and npm packages. 💖
MIT © 2012-present Rod Vagg and Contributors.
rocksdb builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors to the LevelDB fork by Facebook. LevelDB and Snappy are both issued under the New BSD License. A large portion of rocksdb Windows support comes from the Windows LevelDB port (archived) by Krzysztof Kowalczyk (@kjk). If you're using rocksdb on Windows, you should give him your thanks!
[4.0.1] - 2019-09-07
fast-future in favor of native cache limit (#133) (@vweevers)napi-macros from ~1.8.1 to ~2.0.0 (#132) (@vweevers)hallmark devDependency from ^0.1.0 to ^2.0.0 (#127, #138) (@vweevers)standard devDependency from ^12.0.0 to ^14.0.0 (#126, #137) (@vweevers)rimraf devDependency from ^2.6.1 to ^3.0.0 (#135) (@vweevers)electron devDependency from ^5.0.1 to ^6.0.0 (#130) (@vweevers)delayed devDependency from ^1.0.1 to ^2.0.0 (#124) (@vweevers)readfiletree devDependency from ~0.0.1 to ^1.0.0 (#122) (@vweevers)du devDependency from ~0.1.0 to ^1.0.0 (#123) (@vweevers)mkfiletree devDependency from ^1.0.1 to ^2.0.0 (#121) (@vweevers)node-gyp devDependency from ^4.0.0 to ^5.0.0 (#119) (@vweevers)FAQs
A low-level Node.js RocksDB binding
The npm package rocksdb receives a total of 0 weekly downloads. As such, rocksdb popularity was classified as not popular.
We found that rocksdb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.