Skip to main content

Data Image

Symbol for data image

Definition#

A data image (data-image) is a fundamental component that contains the necessary information to Spawn a database. It is analogous to a Docker Image.

A data image definition is composed of at least of a name (name), a source type (sourceType), an engine (engine), and an engine version (version) as seen in the example below.

Example#

In this example, we have an application (myApp) that uses a MySQL database to store customer data.

The data image is defined in a single yaml file.

myApp.yaml

The yaml file contains all the instructions necessary to create a data image.

name: dev
sourceType: backup
engine: mysql
version: 5.7
backup:
folder: ./data
file: backup.sql

You can't connect to a data-image, it's a read-only representation of your database.

Spawn imposes a 500Gi limit on the size of data images.

Supported engines#

Please use the following strings when choosing which engine to use in your data image definition:

  • mssql
  • postgresql
  • mysql
  • mariadb
  • mongodb
  • redis

Supported engine versions#

Please visit our engine support page to view the current versions we support for each engine.

Supported source types#

Please use the following strings when choosing which source type to use in your data image definition:

You can connect to a data container data-container, created from the data image.