BASE.md

EJDB 2.0

NOTE: Issues tracker is disabled. You are welcome to contribute, pull requests accepted.

EJDB2 is an embeddable JSON database engine published under MIT license.

The Story of the IT-depression, birds and EJDB 2.0

• C11 API
• Single file database
• Online backups support
• 500K library size for Android
• iOS / Android / React Native / Flutter integration
• Simple but powerful query language (JQL) as well as support of the following standards:
  • rfc6902 JSON Patch
  • rfc7386 JSON Merge patch
  • rfc6901 JSON Path
• Support of collection joins
• Powered by iowow.io - The persistent key/value storage engine
• HTTP REST/Websockets endpoints powered by IWNET and BearSSL.
• JSON documents are stored in using fast and compact binn binary format

---

• Native language bindings
• Supported platforms
  • macOS
  • iOS
  • Linux
  • Android
  • Windows
• JQL query language
  • Grammar
  • Quick into
  • Data modification
  • Projections
  • Collection joins
  • Sorting
  • Query options
• Indexes and performance
• Network API
  • HTTP API
  • Websockets API
• C API
• License

---

EJDB2 platforms matrix

	Linux	macOS	iOS	Android	Windows
C library	✔️	✔️	✔️	✔️	✔️1
NodeJS	✔️	✔️			❌3
DartVM	✔️	✔️2			❌3
Flutter			✔️	✔️
React Native			❌4	✔️
Swift	✔️	✔️	✔️
Java	✔️	✔️		✔️	✔️2

[1] No HTTP/Websocket support #257
[2] Binaries are not distributed with dart pub. You can build it manually
[3] Can be build, but needed a linkage with windows node/dart libs.
[4] Porting in progress #273

Native language bindings

• NodeJS
• Dart
• Java
• Android support
• Swift | iOS
• React Native
• Flutter

Unofficial EJDB2 language bindings

• Go
  • https://github.com/memmaker/go-ejdb2
• Rust
  • https://crates.io/crates/ejdb2
• .Net
  • https://github.com/kmvi/ejdb2-csharp
• Haskell
  • https://github.com/cescobaz/ejdb2haskell
  • https://hackage.haskell.org/package/ejdb2-binding
• Pharo
  • https://github.com/pharo-nosql/pharo-ejdb
• Lua
  • https://github.com/chriku/ejdb-lua

Status

• EJDB 2.0 core engine is well tested and used in various heavily loaded deployments
• Tested on Linux, macOS and FreeBSD. Has limited Windows support
• Old EJDB 1.x version can be found in separate ejdb_1.x branch. We are not maintaining ejdb 1.x.

Used by

• Wirow video conferencing platform

Are you using EJDB? Let me know!

macOS

EJDB2 code ported and tested on High Sierra / Mojave / Catalina

EJDB2 Swift binding for MacOS, iOS and Linux. Swift binding is outdated at now. Looking for contributors.

brew install ejdb

Building from sources

cmake v3.24 or higher required

git clone --recurse-submodules git@github.com:Softmotions/ejdb.git

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make install

Linux

Building debian packages

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DPACKAGE_DEB=ON
make package

RPM based Linux distributions

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DPACKAGE_RPM=ON
make package

Windows

EJDB2 can be cross-compiled for windows

Note: HTTP/Websocket network API is disabled and not yet supported

Nodejs/Dart bindings not yet ported to Windows.

Cross-compilation Guide for Windows

IWSTART

IWSTART is an automatic CMake initial project generator for C projects based on iowow / iwnet / ejdb2 libs.

https://github.com/Softmotions/iwstart