https://github.com/foundationdb-rs/foundationdb-rs
FoundationDB Rust client api
https://github.com/foundationdb-rs/foundationdb-rs
client foundationdb rust
Last synced: about 1 month ago
JSON representation
FoundationDB Rust client api
- Host: GitHub
- URL: https://github.com/foundationdb-rs/foundationdb-rs
- Owner: foundationdb-rs
- License: apache-2.0
- Created: 2021-12-08T15:28:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-12T09:01:25.000Z (about 1 month ago)
- Last Synced: 2025-03-12T10:19:47.123Z (about 1 month ago)
- Topics: client, foundationdb, rust
- Language: Rust
- Homepage: https://crates.io/crates/foundationdb
- Size: 20.4 MB
- Stars: 142
- Watchers: 6
- Forks: 27
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-foundationdb - Rust - rs's community) (Bindings)
README
[](https://discord.gg/zkgtbtFfWY)
[](https://github.com/foundationdb-rs/foundationdb-rs/actions)
[](https://deps.rs/repo/github/foundationdb-rs/foundationdb-rs)
[](https://codecov.io/gh/foundationdb-rs/foundationdb-rs)
# FoundationDB Rust Client
The repo consists of multiple crates:
| Library | Status | Description |
|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [**foundationdb**](foundationdb/README.md) | [](https://crates.io/crates/foundationdb) [](https://docs.rs/foundationdb) | High level FoundationDB client API |
| [**foundationdb-sys**](foundationdb-sys/README.md) | [](https://crates.io/crates/foundationdb-sys) [](https://docs.rs/foundationdb-sys) | C API bindings for FoundationDB |
| **foundationdb-gen** | n/a | Code generator for common options and types of FoundationDB |
The current version requires rustc 1.82+ to work.
The previous version (0.3) is still maintained and is available within the 0.3 branch.
You can access the `main` branch documentation [here](https://foundationdb-rs.github.io/foundationdb-rs/foundationdb/index.html).
## Supported platforms
Supported platforms are listed on the [foundationdb's README](foundationdb/README.md).
## Develop with Nix
A flake.nix is provided to develop the bindings. We recommend add a cluster-file on the `configuration.nix` file:
```nix
{
environment.etc."foundationdb/fdb.cluster" = {
mode = "0555";
text = ''
docker:[email protected]:4500
'';
};
}
```
A FoundationDB cluster can be run using these commands:
```shell
docker run -p 4500:4500 --name fdb -it --rm -d foundationdb/foundationdb:7.1.19
docker exec fdb fdbcli --exec "configure new single memory"
```
## Correctness
Special care has been set up to be sure that the crate is correct, like official bindings. Every hour, we are running thousands of seeds on the [BindingTester](https://github.com/apple/foundationdb/blob/master/bindings/bindingtester/spec/bindingApiTester.md).
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.