dimgigov
e1bae0c7a0
- Add docs/ folder with English (en/) and Bulgarian (bg/) documentation - Create index.md with language switching and links - English docs: installation, quickstart, architecture, baraql, storage, schema, lsm, btree, vector, graph, fts, columnar, transactions, distributed, protocol, udf, api-binary, api-http, api-websocket - Bulgarian docs: installation, quickstart, architecture, baraql, schema, lsm, btree, vector, graph, fts, transactions, distributed - Update README license to BSD 3-Clause - Add LICENSE file with BSD 3-Clause text
1.6 KiB
1.6 KiB
BaraDB - Installation Guide
Requirements
- Nim Compiler >= 2.0.0
- Operating System: Linux, macOS, Windows
Installing Nim
Linux/macOS
curl https://nim-lang.org/choosenim/init.sh -sSf | sh
Or via package manager:
# Ubuntu/Debian
apt-get install nim
# macOS
brew install nim
Windows
Download the installer from nim-lang.org or use winget:
winget install nim
Building BaraDB
Clone the Repository
git clone https://github.com/katehonz/barabaDB.git
cd barabaDB
Build the Project
# Debug build
nim c -o:build/baradadb src/baradadb.nim
# Release build (optimized)
nim c -d:release -o:build/baradadb src/baradadb.nim
Run Tests
nim c --path:src -r tests/test_all.nim
Run Benchmarks
nim c -d:release -r benchmarks/bench_all.nim
Installation Options
Pre-built Binary
Download the latest release from the GitHub Releases page.
Docker
docker pull barabadb/barabadb
docker run -it barabadb/barabadb
Embedded Usage
Add to your .nimble file:
requires "barabadb >= 1.0.0"
Then import in your code:
import barabadb
var db = newLSMTree("./data")
db.put("key1", cast[seq[byte]]("value1"))
db.close()
Verifying Installation
./build/baradadb --version
Expected output:
BaraDB v1.0.0
multimodal database engine