eds-server

README

Overview

This repository contains the reference implementation of the Enterprise Data Streaming server. You can find more detailed information at the Shopmonkey Developer Portal.

Download Release Binary

You can download release binary for different operation systems from the Release section.

Requirements

You will need Golang version 1.19 or later to use this package.

Basic Usage

You first need to migrate your database to load the schema into a database. The database must exist before running this command:

go run . migrate --url 'postgresql://root@localhost:26257/test?sslmode=disable'

Replace the --url flag with your provider connection setting

Once you have a database, you can start the server:

go run . start --url 'postgresql://root@localhost:26257/test?sslmode=disable'

You will also need to provide a server credentials file provided by Shopmonkey and your company id. These should be passed in as command line arguments as well:

--creds server.creds --company-id 1234

Providers

The following are the supported providers:

• PostgreSQL DB
• Cockroach DB - use the postgres connection string
• SQL Server DB
• File - use file://<PATH> to stream files to a directory provided by PATH

Advanced Usage

Logging

You can turn on verbose logging with --verbose flag. You can silence log output with the --silence flag.

Dump Messages

When running the server, you can dump incoming change change events to a file by passing in the --dump-dir flag pointing to a folder to place the files. If the folder doesn't exist, it will be created.

NATS Logging

You can turn on advanced trace logging for communication between the NATS server by using the flag --trace-nats.

License

All files in this repository are licensed under the MIT license. See the LICENSE file for details.