metabase-representation-format

Metabase Representation Format

Metabase represents user-created content as a tree of YAML files. Each file is one entity (a collection, card, dashboard, etc.). The format is portable across Metabase instances: numeric database IDs are replaced with human-readable names and entity IDs.

The format is defined by a spec that the @metabase/representations npm package ships (see Reading the spec). The same package ships a CLI (npx @metabase/representations validate-schema) that validates a tree of YAML files against the format.

Entities

The format defines 14 entity types.