# Data stores reference

Copy as Markdown[View as Markdown](/docs/development/guides/resources/data/reference.md)

***

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

## Paths[​](#paths "Direct link to 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[​](#routes "Direct link to Routes")

| Route                                             | Description                    |
| ------------------------------------------------- | ------------------------------ |
| `/docs/containers/{container-id}/{version}`       | Data store documentation page. |
| `/visualiser/containers/{container-id}/{version}` | Data store resource diagram.   |

## Required fields[​](#required-fields "Direct link to Required fields")

### `id`[​](#id "Direct link to id")

* Type: `string`

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

Example

```
---
id: orders-database
---
```

### `name`[​](#name "Direct link to name")

* Type: `string`

Display name of the data store.

Example

```
---
name: Orders Database
---
```

### `version`[​](#version "Direct link to version")

* Type: `string`

Version of the data store documentation.

Example

```
---
version: 1.0.0
---
```

## Optional fields[​](#optional-fields "Direct link to Optional fields")

### `summary`[​](#summary "Direct link to summary")

* Type: `string`

Short description of the data store.

Example

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

### `container_type`[​](#container_type "Direct link to container_type")

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

Type of data store.

Example

```
---
container_type: database
---
```

### `technology`[​](#technology "Direct link to technology")

* Type: `string`

Technology used by the data store.

Example

```
---
technology: PostgreSQL
---
```

### `authoritative`[​](#authoritative "Direct link to authoritative")

* Type: `boolean`

Marks this data store as an authoritative source of data.

Example

```
---
authoritative: true
---
```

### `access_mode`[​](#access_mode "Direct link to access_mode")

* Type: `read`, `write`, `readWrite`, or `appendOnly`

How consumers interact with the data store.

Example

```
---
access_mode: readWrite
---
```

### `classification`[​](#classification "Direct link to classification")

* Type: `public`, `internal`, `confidential`, or `regulated`

Data classification.

Example

```
---
classification: confidential
---
```

### `residency`[​](#residency "Direct link to residency")

* Type: `string`

Region or residency information.

Example

```
---
residency: eu-west-1
---
```

### `retention`[​](#retention "Direct link to retention")

* Type: `string`

Retention policy or duration.

Example

```
---
retention: 7 years
---
```

### `owners`[​](#owners "Direct link to owners")

* Type: `array`

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

Example

```
---
owners:
  - data-platform
---
```

### `services`[​](#services "Direct link to services")

* Type: `array`

Services associated with the data store.

Example

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

### `badges`[​](#badges "Direct link to badges")

* Type: `array`

Badges rendered on the data store page.

Example

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