Event Store

EventStoreDB, the event-native database. Designed for Event Sourcing, Event-Driven, and Microservices architectures

Code Quality Rank: L3

Programming language: C#

License: GNU General Public License v3.0 or later

Tags: CQRS     Database     Events     Event     Sourcing     Storage     Persistence    

Latest version: v22.6.0

README

EventStoreDB

The open-source, functional database with Complex Event Processing in JavaScript.

This is the repository for the open source version of EventStoreDB, which includes the clustering implementation for high availability.

Support

Information on support and commercial tools such as LDAP authentication can be found here: Event Store Support.

CI Status

Documentation

Documentation is located in the docs folder. It's orchestrated in the separate documentation repository. It's available online at https://developers.eventstore.com/.

Read more in the [documentation contribution guidelines](./CONTRIBUTING.md#documentation).

Community

We have a community discussion space at Event Store Discuss. If you prefer Slack, there is also an #eventstore channel in the DDD-CQRS-ES Slack community (Sign-up information).

Release Packages

The latest release packages are hosted in the downloads section on the Event Store website: Event Store Downloads

We also host native packages for Linux on Package Cloud and Windows packages can be installed via Chocolatey (4.0.0 onwards only).

Building EventStoreDB

EventStoreDB is written in a mixture of C#, C++ and JavaScript. It can run on Windows, Linux and macOS (using Docker) using the .NET Core runtime. However, the projections library (which uses the V8 javascript engine) contains platform specific code and it must be built for the platform on which you intend to run it.

Windows / Linux

Prerequisites

• .NET Core SDK 6.0

Build EventStoreDB

Once you've installed the prerequisites for your system, you can launch a Release build of EventStore as follows:

dotnet build -c Release src

The build scripts: build.sh and build.ps1 are also available for Linux and Windows respectively to simplify the build process.

To start a single node, you can then run:

dotnet ./src/EventStore.ClusterNode/bin/x64/Release/net6.0/EventStore.ClusterNode.dll --insecure --db ./tmp/data --index ./tmp/index --log ./tmp/log -runprojections all --startstandardprojections --EnableAtomPubOverHttp

Note: The build system has changed after version 5.0.5, therefore the above instructions will not work for older releases.

Running the tests

You can launch the tests as follows:

dotnet test src/EventStore.sln

Build EventStoreDB Docker image

You can also build a Docker image by running the command:

docker build --tag myeventstore . \
--build-arg CONTAINER_RUNTIME={container-runtime}
--build-arg RUNTIME={runtime}

For instance:

docker build --tag myeventstore . \
--build-arg CONTAINER_RUNTIME=bullseye-slim \
--build-arg RUNTIME=linux-x64

Note: Because of the Docker issue, if you're building a Docker image on Windows, you may need to set the DOCKER_BUILDKIT=0 environment variable. For instance, running in PowerShell:

$env:DOCKER_BUILDKIT=0; docker build --tag myeventstore . `
--build-arg CONTAINER_RUNTIME=bullseye-slim `
--build-arg RUNTIME=linux-x64

Currently we support following configurations:

1. Bullseye slim:
   • CONTAINER_RUNTIME=bullseye-slim
   • RUNTIME=linux-x64
2. Focal:
   • CONTAINER_RUNTIME=focal
   • RUNTIME=linux-x64
3. Alpine:
   • CONTAINER_RUNTIME=alpine
   • RUNTIME=alpine-x64

You can verify the built image by running:

docker run --rm myeventstore --insecure --what-if

Building the EventStoreDB Clients

The client libraries are located in their own repositories, refer to their specific instructions.

gRPC clients:

• Go: EventStore-Client-Go
• .Net: EventStore-Client-Dotnet
• Java: EventStoreDB-Client-Java
• Node.js: EventStore-Client-NodeJS
• Rust: EventStoreDB-Client-Rust

TCP clients:

• .Net: EventStoreDB-Client-Dotnet-Legacy
• JVM: EventStore.JVM
• Haskell: EventStoreDB-Client-Haskell

Note: the TCP protocol is being phased out.

Building the EventStoreDB web UI

The web UI repository is a git submodule of the current repository located under src/EventStore.UI.

The web UI is prebuilt and the files are located in [src/EventStore.ClusterNode.Web/clusternode-web](src/EventStore.ClusterNode.Web/clusternode-web). However, if you still want to build the latest web UI, there is a parameter in the build.sh ([<build_ui=yes|no>]) and build.ps1 (-BuildUI) scripts to allow you to do so.

Building the Projections Library

The list of precompiled projections libraries can be found in src/libs/x64. If you still want to build the projections library please follow the links below.

• [Windows](scripts/build-js1/build-js1-win/build-js1-win-instructions.md)
• [Linux](scripts/build-js1/build-js1-linux/README.md)
• [macOS](scripts/build-js1/build-js1-mac/build-js1-mac.sh)

Contributing

Development is done on the master branch. We attempt to do our best to ensure that the history remains clean and to do so, we generally ask contributors to squash their commits into a set or single logical commit.

If you want to switch to a particular release, you can check out the tag for this particular version. For example:
git checkout oss-v6.0.0-preview1

Read more in the [contribution guidelines](./CONTRIBUTING.md).

Proto Changes

If you update the protos, continuous integration will fail. After ensuring the proto change is backwards compatible, please run ./protolock.sh commit at the root of this repository.