Skip to content
forked from Level/rocksdb

Pure C++ Node.js RocksDB binding. An abstract-leveldown compliant store.

License

Notifications You must be signed in to change notification settings

farcasterxyz/rocksdb

 
 

Repository files navigation

rocksdb

This fork's sole purpose is to add prebuilds for Linux ARM to reduce install time on ARM-based systems.

Add to your project using:

yarn add @farcaster/rocksdb
import AbstractRocksDB from '@farcaster/rocksdb';

Git Submodules

This project uses Git Submodules. This means that you should clone it recursively if you're planning on working on it:

$ git clone --recurse-submodules https://github.com/Level/rocksdb.git

Alternatively, you can initialize submodules after cloning:

$ git submodule update --progress --init --recursive

Publishing

  1. Increment the version: npm version ..
  2. Push to GitHub: git push --follow-tags
  3. Wait for CI to complete
  4. Download prebuilds into ./prebuilds: npm run download-prebuilds
  5. Optionally verify loading a prebuild: npm run test-prebuild
  6. Optionally verify which files npm will include: canadian-pub
  7. Finally: npm publish

License

MIT

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!

About

Pure C++ Node.js RocksDB binding. An abstract-leveldown compliant store.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 49.7%
  • JavaScript 48.1%
  • Python 2.2%