Skip to main content

Data stores reference

View as Markdown

This page lists the fields, paths, and routes supported by data stores.

Paths​

Data stores use the containers collection.

/containers/{Data Store Name}/index.mdx
/services/{Service Name}/containers/{Data Store Name}/index.mdx
/systems/{System Name}/containers/{Data Store Name}/index.mdx

Versioned data stores use:

/containers/{Data Store Name}/versioned/{version}/index.mdx

Routes​

RouteDescription
/docs/containers/{container-id}/{version}Data store documentation page.
/visualiser/containers/{container-id}/{version}Data store resource diagram.

Required fields​

id​

  • Type: string

Unique id of the data store. EventCatalog uses this for URLs and resource references.

Example
---
id: orders-database
---

name​

  • Type: string

Display name of the data store.

Example
---
name: Orders Database
---

version​

  • Type: string

Version of the data store documentation.

Example
---
version: 1.0.0
---

Optional fields​

summary​

  • Type: string

Short description of the data store.

Example
---
summary: Stores order state and fulfilment status.
---

container_type​

  • Type: database, cache, objectStore, searchIndex, dataWarehouse, dataLake, externalSaaS, or other

Type of data store.

Example
---
container_type: database
---

technology​

  • Type: string

Technology used by the data store.

Example
---
technology: PostgreSQL
---

authoritative​

  • Type: boolean

Marks this data store as an authoritative source of data.

Example
---
authoritative: true
---

access_mode​

  • Type: read, write, readWrite, or appendOnly

How consumers interact with the data store.

Example
---
access_mode: readWrite
---

classification​

  • Type: public, internal, confidential, or regulated

Data classification.

Example
---
classification: confidential
---

residency​

  • Type: string

Region or residency information.

Example
---
residency: eu-west-1
---

retention​

  • Type: string

Retention policy or duration.

Example
---
retention: 7 years
---

owners​

  • Type: array

An array of team or user ids that own the data store.

Example
---
owners:
  - data-platform
---

services​

  • Type: array

Services associated with the data store.

Example
---
services:
  - id: order-service
    version: 1.0.0
---

badges​

  • Type: array

Badges rendered on the data store page.

Example
---
badges:
  - content: Authoritative
    backgroundColor: green
    textColor: green
---