status-im/nim-rocksdb
2
0
Fork 0
mirror of https://github.com/status-im/nim-rocksdb.git synced 2025-02-24 12:58:21 +00:00
Code Issues Projects Releases Wiki Activity
nim-rocksdb/README.md

97 lines
3.5 KiB
Markdown
Raw Normal View History

Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
# Nim-RocksDb
initial commit
2018-01-27 11:34:54 +01:00
readme: fix license, badges
2018-09-04 23:02:57 -06:00
[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-rocksdb/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-rocksdb)
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-rocksdb/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-rocksdb)
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
initial commit
2018-01-27 11:34:54 +01:00
A Nim wrapper for [Facebook's RocksDB](https://github.com/facebook/rocksdb), a persistent key-value store for Flash and RAM Storage.
Add nim-rocksdb usage example
2018-01-27 17:01:14 +01:00
## Current status
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
Nim-RocksDb provides a wrapper for the low-level functions in the librocksdb c
library.
Add nim-rocksdb usage example
2018-01-27 17:01:14 +01:00
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
## Installation
use dynamic linking instead of dlopen on all Linux distros - also document the need for "librocksdb-dev" on Debian
2018-12-25 11:56:20 +01:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
Nim-RocksDb requires Nim and the Nimble package manager. For Windows you will
need Visual Studio 2015 Update 3 or greater with the English language pack.
use dynamic linking instead of dlopen on all Linux distros - also document the need for "librocksdb-dev" on Debian
2018-12-25 11:56:20 +01:00
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
To get started run:
```
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
nimble install rocksdb
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
```
Add nim-rocksdb usage example
2018-01-27 17:01:14 +01:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
This will download and install the RocksDB libraries for your platform and copy
them into the `build/` directory of the project. On Linux and MacOS only static
linking to the RocksDb libraries is supported and on Windows only dynamic linking
is supported.
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
On Windows you may want to copy the dll into another location or set your PATH
to include the `build/` directory so that your application can find the dll on
startup.
Add nim-rocksdb usage example
2018-01-27 17:01:14 +01:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
### Compression libraries
allow statically linking librocksdb (#29)
2022-03-22 10:02:39 +01:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
RocksDb supports using a number of compression libraries. This library builds
and only supports the following compression libraries:
- lz4
- zstd
On Linux and MacOS these libraries are staticly linked into the final binary
along with the RocksDb static library. On Windows they are staticly linked into
the RocksDb dll.
### Static linking
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
On Linux and MacOS your Nim program will need to use the C++ linker profile
because RocksDb is a C++ library. For example:
allow statically linking librocksdb (#29)
2022-03-22 10:02:39 +01:00
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
```
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
when defined(macosx):
switch("clang.linkerexe", "clang++")
when defined(linux):
switch("gcc.linkerexe", "g++")
allow statically linking librocksdb (#29)
2022-03-22 10:02:39 +01:00
```
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
Note that static linking is currently not supported on windows.
allow statically linking librocksdb (#29)
2022-03-22 10:02:39 +01:00
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
## Usage
Build windows DLLs from vendor directory (#45) * Add vcpkg as a submodule. * Set vendor submodules to RocksDb version v9.1.0 * Update readme.
2024-06-12 21:16:06 +08:00
Implement missing getter and setters for option types. (#62) * Update readme. * Add additional opts getters and setters for ReadOptionsRef and WriteOptionsRef. Updated BackupEngineOptionsRef to use newer c library type. * Add majority of option type getter and setters.
2024-07-03 23:46:42 +08:00
See [simple_example](examples/simple_example.nim)
Build windows DLLs from vendor directory (#45) * Add vcpkg as a submodule. * Set vendor submodules to RocksDb version v9.1.0 * Update readme.
2024-06-12 21:16:06 +08:00
initial commit
2018-01-27 11:34:54 +01:00
### Contribution
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
Any contribution intentionally submitted for inclusion in the work by you shall
be dual licensed as above, without any additional terms or conditions.
readme: fix license, badges
2018-09-04 23:02:57 -06:00
Update versioning to follow the upstream RocksDb version (#80)
2025-01-10 13:41:01 +08:00
## Versioning
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
The library generally follows the upstream RocksDb version number, adding one
more number for tracking changes to the Nim wrapper itself.
Update versioning to follow the upstream RocksDb version (#80)
2025-01-10 13:41:01 +08:00
readme: fix license, badges
2018-09-04 23:02:57 -06:00
## License
License update to respect original repo (#16)
2019-01-03 14:04:11 +01:00
### Wrapper License
This repository is licensed and distributed under either of
readme: update license
2018-09-05 12:48:31 -06:00
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
Update README.md
2019-01-02 14:57:34 +01:00
or
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
readme: fix license, badges
2018-09-04 23:02:57 -06:00
Use static linking on Linux and MacOS, dynamic on Windows (#81) - We now only support static linking on Linux and MacOS. Windows is still only using dynamic linking. - Dynamically linking can be enabled on Linux and MacOS using the 'rocksdb_dynamic_linking' flag but this is not documented and the dynamic libraries are not built in nimble install. They can be built using one of the build scripts if needed. - Updated the wrapper generation so that we don't need to use dynlibOverride when using static linking. - Static libs are copied to the same directory as the dll. - Cleaned up the librocksdb.nim file which imports the rocksdb wrapper. - Updated the tasks in the nimble file.
2025-01-21 14:24:04 +08:00
at your option. This file may not be copied, modified, or distributed except
according to those terms.
License update to respect original repo (#16)
2019-01-03 14:04:11 +01:00
### Dependency License
RocksDB is developed and maintained by Facebook Database Engineering Team.
It is built on earlier work on LevelDB by Sanjay Ghemawat (sanjay@google.com)
and Jeff Dean (jeff@google.com)
RocksDB is dual-licensed under both the [GPLv2](https://github.com/facebook/rocksdb/blob/master/COPYING) and Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0). You may select, at your option, one of the above-listed licenses.
Reference in New Issue Copy Permalink