Metadata Types

A Metadata Type defines which fields should be searchable in your product or dataset metadata.

Three metadata types are added by default called eo, telemetry and eo3.

You would create a new metadata type if you want custom fields to be searchable for your products, or if you want to structure your metadata documents differently.

You can see the default metadata type in the repository at datacube/index/default-metadata-types.yaml.

To add or alter metadata types, you can use commands like: datacube metadata add <path-to-file> and to update: datacube metadata update <path-to-file>. Using --allow-unsafe will allow you to update metadata types where the changes may have unexpected consequences.

---
name: barebone
description: A minimalist metadata type file
dataset:
  id: [id] # No longer configurable in newer ODCs.
  sources: [lineage, source_datasets] # No longer configurable in newer ODCs.
  creation_dt: [properties, 'odc:processing_datetime']
  label: [label]
  search_fields:
    platform:
      description: Platform code
      offset: [properties, 'eo:platform']
      indexed: false

Note

Metadata type yaml file must contain name, description and dataset keys.

Dataset key must contain id, sources, creation_dt, label and search_fields keys.