Repository files navigation

KurrentDB is a database that's engineered for modern software applications and event-driven architectures. Itsevent-native design simplifies data modeling and preserves data integrity while the integrated streaming engine solvesdistributed messaging challenges and ensures data consistency.

"KurrentDB Client Go" is the client for talking toKurrentDB.

The fastest way to add this client to a project is to rungo get github.com/kurrent-io/KurrentDB-Client-Go@latest withgo, SeeINSTALL.md for detailed installation instructions and troubleshooting.

• API Reference
• Samples

Join our global community of developers.

• Discuss
• Discord (Kurrent)
• Discord (ddd-cqrs-es)

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

• Create an issue
• Documentation
• Contributing guide

The client is built using theGo programming language. To build the client, you need to have Goinstalled on your machine. You can download it from the official Go website.Once you have Go installed, you can build the client by running the following command in the root directory of theproject:

make build

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

Testing requiresDocker andDocker Compose to be installed.

Start all required KurrentDB services using the provideddocker-compose configuration:

make start-kurrentdb

To stop the services, you can run:

make stop-kurrentdb

You can launch the tests as follows:

make test

Alternatively, you can run the tests using thego test command:

gotest ./...

By default, the test suite uses the Docker image:docker.kurrent.io/eventstore/eventstoredb-ee:lts. To run the testswith a different image, set the environment variables listed below.

For example, to use the commercial imagedocker.kurrentio/eventstore-ee/eventstoredb-commercial:23.10.5-commercialb-bookworm-slim, configure your environmentwith:

These variables combine to form the complete image reference used during testing.

• Release notes
• Beginners Guide to Event Sourcing
• Articles
• Webinars
• Contact us