{"id":13724857,"url":"https://github.com/Level/rocksdb","last_synced_at":"2025-05-07T19:31:00.741Z","repository":{"id":21471576,"uuid":"92492008","full_name":"Level/rocksdb","owner":"Level","description":"Discontinued. Pure C++ Node.js RocksDB binding. An abstract-leveldown compliant store.","archived":true,"fork":false,"pushed_at":"2024-12-01T21:00:52.000Z","size":16365,"stargazers_count":229,"open_issues_count":12,"forks_count":54,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-29T07:21:00.541Z","etag":null,"topics":["abstract-leveldown","level","leveldb","nodejs","prebuilt-binaries","rocksdb"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Level.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"open_collective":"level"}},"created_at":"2017-05-26T08:56:45.000Z","updated_at":"2025-02-20T23:36:34.000Z","dependencies_parsed_at":"2024-11-06T08:28:52.443Z","dependency_job_id":"a5205b85-af15-4aa2-a135-a37a69b14a76","html_url":"https://github.com/Level/rocksdb","commit_stats":{"total_commits":918,"total_committers":48,"mean_commits":19.125,"dds":0.5751633986928104,"last_synced_commit":"29c9d9ff51ee52120e90e8a6dff12dd722ad62ef"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Level%2Frocksdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Level%2Frocksdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Level%2Frocksdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Level%2Frocksdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Level","download_url":"https://codeload.github.com/Level/rocksdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252215813,"owners_count":21713038,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["abstract-leveldown","level","leveldb","nodejs","prebuilt-binaries","rocksdb"],"created_at":"2024-08-03T01:02:04.593Z","updated_at":"2025-05-07T19:30:55.725Z","avatar_url":"https://github.com/Level.png","language":"C++","funding_links":["https://opencollective.com/level"],"categories":["C++","JavaScript"],"sub_categories":[],"readme":"# rocksdb\n\n\u003e A low-level Node.js RocksDB binding. An [`abstract-leveldown`](https://github.com/Level/abstract-leveldown) compliant store.\n\n[![level badge][level-badge]](https://github.com/Level/awesome)\n[![npm](https://img.shields.io/npm/v/rocksdb.svg)](https://www.npmjs.com/package/rocksdb)\n[![Node version](https://img.shields.io/node/v/rocksdb.svg)](https://www.npmjs.com/package/rocksdb)\n[![Test](https://img.shields.io/github/workflow/status/Level/rocksdb/Test?label=test)](https://github.com/Level/rocksdb/actions/workflows/test.yml)\n[![Coverage](https://img.shields.io/codecov/c/github/Level/rocksdb?label=\\\u0026logo=codecov\\\u0026logoColor=fff)](https://codecov.io/gh/Level/rocksdb)\n[![Standard](https://img.shields.io/badge/standard-informational?logo=javascript\\\u0026logoColor=fff)](https://standardjs.com)\n[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)\n[![Donate](https://img.shields.io/badge/donate-orange?logo=open-collective\\\u0026logoColor=fff)](https://opencollective.com/level)\n\n## Table of Contents\n\n\u003cdetails\u003e\u003csummary\u003eClick to expand\u003c/summary\u003e\n\n- [Introduction](#introduction)\n- [Supported Platforms](#supported-platforms)\n- [API](#api)\n- [Contributing](#contributing)\n  - [Git Submodules](#git-submodules)\n  - [Publishing](#publishing)\n- [Donate](#donate)\n- [License](#license)\n\n\u003c/details\u003e\n\n## Introduction\n\nThis module closely follows [`leveldown`](https://github.com/Level/leveldown) and implements the same API. The difference is that `leveldown` is a binding for [LevelDB](https://github.com/google/leveldb) while `rocksdb` is a binding for [RocksDB, Facebook's fork of LevelDB](https://github.com/facebook/rocksdb).\n\nIt 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.\n\n**If you are upgrading:** please see [UPGRADING.md](UPGRADING.md).\n\n## Supported Platforms\n\nWe aim to support _at least_ Active LTS and Current Node.js releases, Electron 5.0.0, as well as any future Node.js and Electron releases thanks to [N-API](https://nodejs.org/api/n-api.html). The minimum node version for `rocksdb` is `10.12.0`.\n\nThe `rocksdb` npm package ships with prebuilt binaries for popular 64-bit platforms and is known to work on:\n\n- **Linux** (including ARM platforms such as Raspberry Pi and Kindle)\n- **Mac OS**\n- **Solaris** (SmartOS \u0026 Nodejitsu)\n- **FreeBSD**\n- **Windows**\n\nWhen installing `rocksdb`, [`node-gyp-build`](https://github.com/prebuild/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](https://github.com/nodejs/node-gyp#installation).\n\nIf 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`.\n\n## API\n\nPlease refer to [`leveldown`](https://github.com/Level/leveldown#api) for API documentation. The `db.open(options, callback)` method of `rocksdb` has a few additional options:\n\n- `readOnly` (boolean, default `false`): open database in read-only mode.\n- `infoLogLevel` (string, default `null`): verbosity of info log. One of `'debug'`, `'info'`, `'warn'`, `'error'`, `'fatal'`, `'header'` or `null` (disable).\n\n## Contributing\n\n[`Level/rocksdb`](https://github.com/Level/rocksdb) is an **OPEN Open Source Project**. This means that:\n\n\u003e 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.\n\nSee the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.\n\n### Git Submodules\n\nThis project uses Git Submodules. This means that you should clone it recursively if you're planning on working on it:\n\n```bash\n$ git clone --recurse-submodules https://github.com/Level/rocksdb.git\n```\n\nAlternatively, you can initialize submodules after cloning:\n\n```bash\n$ git submodule update --init --recursive\n```\n\n### Publishing\n\n1. Increment the version: `npm version ..`\n2. Push to GitHub: `git push --follow-tags`\n3. Wait for CI to complete\n4. Download prebuilds into `./prebuilds`: `npm run download-prebuilds`\n5. Optionally verify loading a prebuild: `npm run test-prebuild`\n6. Optionally verify which files npm will include: `canadian-pub`\n7. Finally: `npm publish`\n\n## Donate\n\nSupport us with a monthly donation on [Open Collective](https://opencollective.com/level) and help us continue our work.\n\n## License\n\n[MIT](LICENSE)\n\n_`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](http://opensource.org/licenses/BSD-3-Clause). A large portion of `rocksdb` Windows support comes from the [Windows LevelDB port](http://code.google.com/r/kkowalczyk-leveldb/) (archived) by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) ([`@kjk`](https://twitter.com/kjk)). If you're using `rocksdb` on Windows, you should give him your thanks!_\n\n[level-badge]: https://leveljs.org/img/badge.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLevel%2Frocksdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLevel%2Frocksdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLevel%2Frocksdb/lists"}