@forzalabs/remora/documentation/default_resources/consumer.json

A powerful CLI tool for seamless data translation.

{
  "$schema": "https://raw.githubusercontent.com/ForzaLabs/remora-public/refs/heads/main/json_schemas/consumer-schema.json",
  "name": "<consumer name>",
  "description": "<consumer description>",
  "producers": [
    {
      "name": "<primary producer name>"
    },
    {
      "name": "<secondary producer name>",
      "joins": [
        {
          "otherName": "<primary producer name>",
          "relationship": "<one-to-one | one-to-many | many-to-one>",
          "sql": "<join condition>"
        }
      ]
    }
  ],
  "fields": [
    { "key": "<producer field name>", "from": "<producer name>" },
    { "key": "<original field name>", "from": "<producer name>", "alias": "<new field name>" },
    { "key": "<secondary producer field name>", "from": "<secondary producer name>" },
    { "key": "<another field name>", "from": "<producer name>" }
  ],
  "filters": [
    {
      "sql": "<filter condition>"
    }
  ],
  "outputs": [
    { "format": "<api | sql>" },
    {
      "format": "<json | csv | parquet>",
      "exportDestination": "<export destination>"
    },
    {
      "format": "<csv | json>",
      "exportDestination": "<export destination>",
      "trigger": {
        "type": "<cron | api>",
        "value": "<cron expression or endpoint path>"
      }
    }
  ],
  "metadata": {
    "<metadata tag key>": "<metadata tag value>",
    "owner_email": "<owner email>"
  },
  "project": "<project name>",
  "schema": "<schema name>",
  "_version": 1
}