DBOS SDK Integration Skills
Relevant source files
The following files were used as context for generating this wiki page:
Introduction
The DBOS SDK Integration Skills provide a specialized knowledge base for developers building reliable, fault-tolerant applications using DBOS SDKs across multiple programming languages, primarily TypeScript and Go. These skills focus on implementing durable workflows, steps, and queues that are resilient to failures, ensuring that long-running business processes can recover gracefully from system interruptions.
The scope of these integration skills encompasses the entire application lifecycle, from configuration and setup to advanced patterns like idempotency, debouncing, and scheduled execution. By utilizing the provided reference architectures and categorization, developers can effectively manage complex asynchronous communication and stateful workflows within the DBOS ecosystem.
Sources: bundled-skills/dbos-typescript/AGENTS.md:7-11, bundled-skills/dbos-golang/AGENTS.md:7-11
SDK Structure and Organization
The integration skills are organized into a hierarchical structure designed for on-demand retrieval of technical depth. Each language-specific SDK folder contains a main skill file, a navigation guide, and a deep repository of specific reference documents.
Reference Categorization
The documentation is partitioned into nine distinct categories, prioritized by their impact on application reliability and system architecture.
| Priority | Category | Impact | Description |
|---|---|---|---|
| 1 | Lifecycle | CRITICAL | Configuration and server integration (e.g., Express). |
| 2 | Workflow | CRITICAL | Core logic for durable execution and background tasks. |
| 3 | Step | HIGH | Individual transactional operations and retry logic. |
| 4 | Queue | HIGH | Distributed task queuing and concurrency control. |
| 5 | Communication | MEDIUM | Event-driven messaging and streaming data. |
| 6 | Pattern | MEDIUM | Reusable logic like idempotency and scheduled tasks. |
| 7 | Testing | LOW-MEDIUM | Framework-specific setup for automated verification. |
| 8 | Client | MEDIUM | External application connectivity and job enqueuing. |
| 9 | Advanced | LOW | Versioning and complex patching strategies. |
Sources: bundled-skills/dbos-typescript/AGENTS.md:20-33, bundled-skills/dbos-golang/AGENTS.md:20-33
Technical Architecture and Logic
The DBOS integration architecture relies on three primary pillars: Workflows, Steps, and Queues. These components work together to maintain system state and ensure progress even in the event of hardware or software failure.
Workflow and Step Execution Flow
Workflows act as the orchestrators of business logic. Within a workflow, "Steps" represent atomic units of work that can involve database transactions or external API calls.
The diagram shows how DBOS checkpoints state after step execution to allow recovery from the last successful point.
Sources: bundled-skills/dbos-typescript/AGENTS.md:70-76, bundled-skills/dbos-golang/AGENTS.md:65-70
Queue and Concurrency Management
Integration skills emphasize sophisticated queue management to handle high-volume asynchronous tasks. This includes partitioning, priority handling, and rate limiting to prevent system saturation.
The flow represents the logic used in the SDK to ensure that enqueued tasks are processed according to defined constraints like deduplication and priority.
Sources: bundled-skills/dbos-typescript/AGENTS.md:54-61, bundled-skills/dbos-golang/AGENTS.md:49-55
Key Implementation Patterns
The integration skills provide specific patterns to solve common distributed systems problems.
Reliability Patterns
- Idempotency: Ensuring that operations can be repeated without unintended side effects.
- Scheduled Tasks: Executing logic based on cron-like schedules or specific time offsets.
- Sleep: Implementing durable sleep that survives process restarts.
- Retries: Standardized configurations for step-level failure recovery.
Communication and Events
The SDKs support various communication models:
- Events: Notifying other parts of the system about state changes.
- Messages: Direct point-to-point communication between workflows.
- Streaming: Handling large data volumes or real-time updates.
Sources: bundled-skills/dbos-typescript/AGENTS.md:47-52, 63-65, bundled-skills/dbos-golang/AGENTS.md:43-47, 57-59
Language Support Comparisons
While the core concepts are shared, the implementation varies by language to fit native idioms.
| Feature | TypeScript SDK | Go SDK |
|---|---|---|
| Integration | Express.js middleware support | Standard library/HTTP integration |
| Patterns | Class-based decorators/metadata | Functional/Interface implementations |
| Lifecycle | lifecycle-express.md | lifecycle-config.md |
| Step Logic | Transactional & Basic steps | Transactional, Basic, & Concurrent steps |
Sources: bundled-skills/dbos-typescript/AGENTS.md:44, 63, bundled-skills/dbos-golang/AGENTS.md:40, 57-61
Conclusion
DBOS SDK Integration Skills provide a robust framework for building durable applications. By leveraging structured categories and documented patterns for workflows, steps, and queues, developers can transition from simple request-response models to complex, failure-resilient distributed systems. These skills ensure that whether in Go or TypeScript, application state and logic progress remain reliable across any infrastructure interruptions.