sirix

(★ 1,214)

SirixDB is an an embeddable, bitemporal, append-only database system and event store, storing immutable lightweight snapshots. It keeps the full history of each resource. Every commit stores a space-efficient snapshot through structural sharing. It is log-structured and never overwrites data. SirixDB uses a novel page-level versioning approach.

Showing a partial file list — download the zip above to see everything.

  • .all-contributorsrc
  • .gitattributes
  • .gitignore
  • AGENTS.md
  • build.gradle
  • CHANGELOG.md
  • Circuit Technology Logo.png
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • Dockerfile.native
  • ISSUE_TEMPLATE.md
  • LICENSE
  • README.md
  • REDUCE_DEPENDENCIES_PLAN.md
  • ROADMAP.md
  • SECURITY.md
  • SirixDB.xml
  • SVGlogo.svg

🚀 Installation Guide

1. Get the code
git clone https://github.com/sirixdb/sirix

Downloads the entire project code from GitHub to your computer.

cd sirix

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose -f docker-compose.demo.yml up

Runs the command against the services defined in the compose file.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd bundles/sirix-gui

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

A BUILD SUCCESS message means it worked. The output is created under target/.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew :sirix-kotlin-cli:nativeCompile # produces: sirix-cli

Builds the project using Gradle.

./gradlew :sirix-query:nativeCompile # produces: sirix-shell

Builds the project using Gradle.

./gradlew :sirix-kotlin-cli:run --args="-l /tmp/mydb create"

Builds the project using Gradle.

./gradlew :sirix-mcp:installDist # creates build/install/sirix-mcp/bin/sirix-mcp

Builds the project using Gradle.

// Gradle (Kotlin DSL)

Builds the project using Gradle.

A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation