Event Stores

An event store is a set of databases and file directories to which Syntasa apps write data. Event Stores are used to provide a logical subdivision between your apps on the backend, as well as letting you define your data storage locations. They also differentiate between your development and production data. Event Stores are only populated upon data creation and are insubstantial until they are used. They are required for app creation, so make sure you have at least one before attempting to create an app.

The Event Stores page is available from the main menu ( mceclip3.png ) and selecting the Event Stores submenu or from the sidebar (mceclip0.png) from within the resources page.

Event_Stores.png

All apps require a store, either an event store or ID store, to be specified. It is recommended to have one event store per Synthesizer app but it is not necessary.

Most event stores will have the following three databases and three file storage directories:

  • development (dev) - Within the development environment, the user is able to test new configurations and settings before deploying to production.
  • production (prod) - Within the production environment live data is processed and stored.
  • snapshot (snap) - Snapshots of configurations are stored in case a rollback to an earlier configuration is needed.

Event_Store_Edit.png

Adding a New Event Store

  1. Open the Event Stores page.
  2. Click the plus icon (Plus_Icon.png) to add a new event store. 
  3. An event store creation box will appear.
  4. Provide the new store with a unique name.
  5. Fill out the path and database details for each environment.
  6. It is recommended to name database values after the key and dev/prod/snap respectively, e.g. KEY_prod, or above adobe_summit_prod.
  7. Click 'Create'.
  8. A new event store entry will appear in the list on the screen and available to use.

Event_Store_Create.png

Configurations

  • Name - Distinct name of the event store.
  • Key - Auto-populated from the event store name; suggested leaving as is.
  • Development - Location where app testing data gets written.
    • Path - File location where any resultant files are stored from processing.
    • Database - Name of the database where processed data is stored.
  • Production - Location where production data gets written.
    • Path - File location where any resultant files are stored from processing.
    • Database - Name of the database where processed data is stored.
  • Snapshot - Location where snapshots allowing for rollbacks get written.
    • Path - File location where any resultant files are stored from processing.
    • Database - Name of the database where processed data is stored.

Expected Output

An entry gets created in the Event Store screen with a Name, Created At time, and Updated At time.

The event store reference is available to use with any Synthesizer, Composer or Orchestrator app. After processing an app, data will be available in the defined locations. If you are looking for the event stores in their storage location, they will NOT appear until data is written to them by an app. Creating the event store does not pre-allocate a storage location or create a database. The database name will also define where your data is stored in BigQuery and Athena.