@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-many",
          "sql": "${P.id} = ${<primary producer name>.fk_id}"
        }
      ]
    }
  ],
  "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" },
    {
      "format": "JSON",
      "exportDestination": "<export destination>"
    },
    {
      "format": "CSV",
      "exportDestination": "<export destination>",
      "trigger": {
        "type": "CRON",
        "value": "0 0 * * *"
      }
    }
  ],
  "metadata": {
    "<metadata tag key>": "<metadata tag value>",
    "owner_email": "<owner email>"
  },
  "project": "<project name>",
  "schema": "<schema name>",
  "_version": 1
}