Coroutine-friendly bindings for FoundationDB providing a unified typed API, transactional helpers with automatic retries, futures, tuple utilities, tenant management and range iterator support.
Kotlin Multiplatform bindings for FoundationDB. The project wraps the official Apple-provided Java and C client libraries so the same typed API surface (transactions, futures, options, tuple utilities, etc.) can be used from JVM code as well as native Apple/Linux binaries.
The repository currently tracks FoundationDB 7.3 and is meant for application developers that want:
| Platform | Targets |
|---|---|
| JVM | linux, macOS (Intel + Apple Silicon) |
| Native | macosArm64, , , |
Windows: upstream FoundationDB no longer provides Windows client binaries, so the mingw target and the related installers were intentionally not implemented. If Apple or another source resumes publishing Windows builds we can revisit this.
The artifacts are published to Maven Central under io.maryk.foundationdb:foundationdb-multiplatform. Add the dependency to
any source set that should talk to FoundationDB:
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("io.maryk.foundationdb:foundationdb-multiplatform:7.3.75")
}
}
}
}
On the JVM the wrapper delegates straight to the official Java bindings. On native targets the project links against the
C client (libfdb_c) that ships with FoundationDB. You must install the FoundationDB client libraries for the host OS
before running your binaries; the provided scripts under foundationdb/scripts install/copy these binaries into
foundationdb/bin (project-local, preferred over system paths).
fun main() {
// Pick the API version once per process and grab a singleton
FDB.selectAPIVersion(ApiVersion.LATEST)
val fdb = FDB.instance()
// Execute a transactional block with automatic retries
fdb.run { txn ->
val key = Tuple.from("hello").pack()
txn.set(key, "world".encodeToByteArray())
}
// Read back the value
value = fdb.read { txn ->
key = Tuple.from().pack()
txn.(key).await()
}
println(value?.decodeToString())
}
Additional examples live in src/commonTest/kotlin/maryk/foundationdb and mirror all major FoundationDB features
(range iterators, tuple decoding helpers, management API, etc.).
./gradlew jvmTest – installs a local FoundationDB server (macOS/Linux), starts it, and runs the JVM tests.Native builds require the FoundationDB client headers. Gradle downloads them automatically (
fdb-headers-${version}.tar.gz) when building Kotlin/Native targets; the generated headers live underbuild/foundationdb/headers.
Bug reports, feature requests, and pull requests are very welcome. Please open an issue describing the desired change.
Apache License 2.0 – see LICENSE for the full text.
macosX64linuxX64linuxArm64./gradlew macosArm64Test, macosX64Test, linuxX64Test, linuxArm64Test – build/link native binaries and run the
platform specific tests. These tasks also install FoundationDB locally if needed.foundationdb/scripts/install-foundationdb.sh – helper that downloads the official Apple release for the current host
and copies fdbserver, fdbcli, and libfdb_c into foundationdb/bin for local development.Surfaced from shared tags and platforms — no rankings paid for.