{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-saga-pattern",
  "id": "saga-pattern",
  "kind": "pattern",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-execution-core",
    "json": "https://banes-lab.com/json/records/layer/execution-core",
    "label": "Execution Core",
    "markdown": "https://banes-lab.com/records/layer/execution-core.md",
    "ref": "layer:execution-core"
  },
  "name": "Saga Pattern",
  "ref": "architecture:saga-pattern",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-compensating-transaction",
          "json": "https://banes-lab.com/json/records/architecture/compensating-transaction",
          "label": "Compensating Transaction",
          "markdown": "https://banes-lab.com/records/architecture/compensating-transaction.md",
          "ref": "architecture:compensating-transaction"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-idempotency",
          "json": "https://banes-lab.com/json/records/architecture/idempotency",
          "label": "Idempotency",
          "markdown": "https://banes-lab.com/records/architecture/idempotency.md",
          "ref": "architecture:idempotency"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-eventual-consistency",
          "json": "https://banes-lab.com/json/records/architecture/eventual-consistency",
          "label": "Eventual Consistency",
          "markdown": "https://banes-lab.com/records/architecture/eventual-consistency.md",
          "ref": "architecture:eventual-consistency"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-long-running-transactions",
          "json": "https://banes-lab.com/json/records/lexicon/long-running-transactions",
          "label": "Long-Running Transactions",
          "markdown": "https://banes-lab.com/records/lexicon/long-running-transactions.md",
          "ref": "lexicon:long-running-transactions"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-global-acid-transaction",
          "json": "https://banes-lab.com/json/records/lexicon/global-acid-transaction",
          "label": "Global ACID Transaction",
          "markdown": "https://banes-lab.com/records/lexicon/global-acid-transaction.md",
          "ref": "lexicon:global-acid-transaction"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-workflow-complexity",
          "json": "https://banes-lab.com/json/records/lexicon/workflow-complexity",
          "label": "Workflow Complexity",
          "markdown": "https://banes-lab.com/records/lexicon/workflow-complexity.md",
          "ref": "lexicon:workflow-complexity"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-saga-pattern-workflow-complexity",
          "json": "https://banes-lab.com/json/records/tension/saga-pattern-workflow-complexity",
          "label": "Saga Pattern / Workflow Complexity",
          "markdown": "https://banes-lab.com/records/tension/saga-pattern-workflow-complexity.md",
          "ref": "tension:saga-pattern-workflow-complexity"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-global-acid-transaction",
          "json": "https://banes-lab.com/json/records/lexicon/global-acid-transaction",
          "label": "Global ACID Transaction",
          "markdown": "https://banes-lab.com/records/lexicon/global-acid-transaction.md",
          "ref": "lexicon:global-acid-transaction"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-hidden-distributed-transaction",
          "json": "https://banes-lab.com/json/records/lexicon/hidden-distributed-transaction",
          "label": "Hidden Distributed Transaction",
          "markdown": "https://banes-lab.com/records/lexicon/hidden-distributed-transaction.md",
          "ref": "lexicon:hidden-distributed-transaction"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-compensating-transaction",
          "json": "https://banes-lab.com/json/records/architecture/compensating-transaction",
          "label": "Compensating Transaction",
          "markdown": "https://banes-lab.com/records/architecture/compensating-transaction.md",
          "ref": "architecture:compensating-transaction"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-contextual",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-contextual",
          "label": "contextual",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-contextual.md",
          "ref": "vocabulary:severity-contextual"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-event-messaging-asynchronous-architecture",
          "json": "https://banes-lab.com/json/records/architecture-category/event-messaging-asynchronous-architecture",
          "label": "Event / Messaging / Asynchronous Architecture",
          "markdown": "https://banes-lab.com/records/architecture-category/event-messaging-asynchronous-architecture.md",
          "ref": "architecture-category:event-messaging-asynchronous-architecture"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-dual-write",
          "json": "https://banes-lab.com/json/records/architecture/dual-write",
          "label": "Dual Write",
          "markdown": "https://banes-lab.com/records/architecture/dual-write.md",
          "ref": "architecture:dual-write"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-atomicity",
          "json": "https://banes-lab.com/json/records/architecture/atomicity",
          "label": "Atomicity",
          "markdown": "https://banes-lab.com/records/architecture/atomicity.md",
          "ref": "architecture:atomicity"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-transaction-boundary",
          "json": "https://banes-lab.com/json/records/architecture/transaction-boundary",
          "label": "Transaction Boundary",
          "markdown": "https://banes-lab.com/records/architecture/transaction-boundary.md",
          "ref": "architecture:transaction-boundary"
        }
      ],
      "relation": "refactors"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-orchestration",
          "json": "https://banes-lab.com/json/records/architecture/orchestration",
          "label": "Orchestration",
          "markdown": "https://banes-lab.com/records/architecture/orchestration.md",
          "ref": "architecture:orchestration"
        }
      ],
      "relation": "reinforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-event-driven-architecture",
          "json": "https://banes-lab.com/json/records/architecture/event-driven-architecture",
          "label": "Event-Driven Architecture",
          "markdown": "https://banes-lab.com/records/architecture/event-driven-architecture.md",
          "ref": "architecture:event-driven-architecture"
        }
      ],
      "relation": "enabled-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-anti-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-anti-patterns",
          "label": "Anti-patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-anti-patterns.md",
          "ref": "chapter:/ontology#architecture-category-anti-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-control-coordination-centralization",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-control-coordination-centralization",
          "label": "Control / Coordination / Centralization",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-control-coordination-centralization.md",
          "ref": "chapter:/ontology#architecture-category-control-coordination-centralization"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-event-messaging-asynchronous-architecture",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-event-messaging-asynchronous-architecture",
          "label": "Event / Messaging / Asynchronous Architecture",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-event-messaging-asynchronous-architecture.md",
          "ref": "chapter:/ontology#architecture-category-event-messaging-asynchronous-architecture"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-transactions-state-concurrency",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-transactions-state-concurrency",
          "label": "Transactions / State / Concurrency",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-transactions-state-concurrency.md",
          "ref": "chapter:/ontology#architecture-category-transactions-state-concurrency"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-event-messaging-async",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-event-messaging-async",
          "label": "Event Messaging Async",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-event-messaging-async.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-event-messaging-async"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-transactions-state-concurrency",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-transactions-state-concurrency",
          "label": "Transactions / State / Concurrency",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-transactions-state-concurrency.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-transactions-state-concurrency"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-vocabulary-severity",
          "json": "https://banes-lab.com/json/ontology/schema/the-vocabulary-severity",
          "label": "Severity levels",
          "markdown": "https://banes-lab.com/ontology/schema/the-vocabulary-severity.md",
          "ref": "chapter:/ontology/schema#the-vocabulary-severity"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-resolutions",
          "json": "https://banes-lab.com/json/ontology/schema/the-resolutions",
          "label": "The resolutions",
          "markdown": "https://banes-lab.com/ontology/schema/the-resolutions.md",
          "ref": "chapter:/ontology/schema#the-resolutions"
        }
      ],
      "relation": "linked-from"
    }
  ],
  "summary": "A design pattern that runs a cross-service transaction as a sequence of local steps, each paired with a compensating step.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-outbox-pattern",
      "json": "https://banes-lab.com/json/records/architecture/outbox-pattern",
      "label": "Outbox Pattern",
      "markdown": "https://banes-lab.com/records/architecture/outbox-pattern.md",
      "ref": "architecture:outbox-pattern"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-eventual-consistency",
      "json": "https://banes-lab.com/json/records/architecture/eventual-consistency",
      "label": "Eventual Consistency",
      "markdown": "https://banes-lab.com/records/architecture/eventual-consistency.md",
      "ref": "architecture:eventual-consistency"
    }
  },
  "up": {
    "href": null,
    "json": "https://banes-lab.com/json/api/records/architecture",
    "label": "Architecture principles",
    "markdown": "https://banes-lab.com/api/records/architecture.md",
    "ref": "api:records/architecture"
  },
  "aliases": [
    "Saga"
  ],
  "exemplar": {
    "after": "await saga([\n  { action: () => fooService.create(foo), compensate: id => fooService.cancel(id) },\n  { action: () => barService.create(bar), compensate: id => barService.cancel(id) },\n  { action: () => bazService.create(baz), compensate: id => bazService.cancel(id) },\n]).run();",
    "before": "const tx = coordinator.begin();\nawait fooService.prepare(tx, foo);\nawait barService.prepare(tx, bar);\nawait bazService.prepare(tx, baz);\nawait coordinator.commit(tx);",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "service workflow",
    "distributed system"
  ],
  "severity": "contextual"
}