{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-outbox-pattern",
  "id": "outbox-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": "Outbox Pattern",
  "ref": "architecture:outbox-pattern",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-local-transaction",
          "json": "https://banes-lab.com/json/records/lexicon/local-transaction",
          "label": "Local Transaction",
          "markdown": "https://banes-lab.com/records/lexicon/local-transaction.md",
          "ref": "lexicon:local-transaction"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-message-relay",
          "json": "https://banes-lab.com/json/records/lexicon/message-relay",
          "label": "Message Relay",
          "markdown": "https://banes-lab.com/records/lexicon/message-relay.md",
          "ref": "lexicon:message-relay"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-event-reliability",
          "json": "https://banes-lab.com/json/records/lexicon/event-reliability",
          "label": "Event Reliability",
          "markdown": "https://banes-lab.com/records/lexicon/event-reliability.md",
          "ref": "lexicon:event-reliability"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-atomic-state-change-message-publish",
          "json": "https://banes-lab.com/json/records/lexicon/atomic-state-change-message-publish",
          "label": "Atomic State Change + Message Publish",
          "markdown": "https://banes-lab.com/records/lexicon/atomic-state-change-message-publish.md",
          "ref": "lexicon:atomic-state-change-message-publish"
        }
      ],
      "relation": "enables"
    },
    {
      "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"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-relay-complexity",
          "json": "https://banes-lab.com/json/records/lexicon/relay-complexity",
          "label": "Relay Complexity",
          "markdown": "https://banes-lab.com/records/lexicon/relay-complexity.md",
          "ref": "lexicon:relay-complexity"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-outbox-pattern-relay-complexity",
          "json": "https://banes-lab.com/json/records/tension/outbox-pattern-relay-complexity",
          "label": "Outbox Pattern / Relay Complexity",
          "markdown": "https://banes-lab.com/records/tension/outbox-pattern-relay-complexity.md",
          "ref": "tension:outbox-pattern-relay-complexity"
        }
      ],
      "relation": "tensions"
    },
    {
      "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"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-message-relay",
          "json": "https://banes-lab.com/json/records/lexicon/message-relay",
          "label": "Message Relay",
          "markdown": "https://banes-lab.com/records/lexicon/message-relay.md",
          "ref": "lexicon:message-relay"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-recommended",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-recommended",
          "label": "recommended",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-recommended.md",
          "ref": "vocabulary:severity-recommended"
        }
      ],
      "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-distributed-monolith",
          "json": "https://banes-lab.com/json/records/architecture/distributed-monolith",
          "label": "Distributed Monolith",
          "markdown": "https://banes-lab.com/records/architecture/distributed-monolith.md",
          "ref": "architecture:distributed-monolith"
        },
        {
          "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": "refactors"
    },
    {
      "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-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/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/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 writes an outgoing message in the same local transaction as the state change, and a relay publishes it afterwards.",
  "siblings": {
    "next": {
      "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"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-saga-pattern",
      "json": "https://banes-lab.com/json/records/architecture/saga-pattern",
      "label": "Saga Pattern",
      "markdown": "https://banes-lab.com/records/architecture/saga-pattern.md",
      "ref": "architecture:saga-pattern"
    }
  },
  "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": [
    "Transactional Outbox"
  ],
  "exemplar": {
    "after": "await database.transaction(async tx => {\n  await tx.foos.save(foo);\n  await tx.outbox.insert({ id: eventId(), type: \"FooSaved\", fooId: foo.id });\n});\nawait outboxRelay.publishPending();",
    "before": "await fooStore.save(foo);\nawait eventBus.publish({ type: \"FooSaved\", fooId: foo.id });",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "persistence",
    "messaging"
  ],
  "severity": "recommended"
}