dbos-golang

Category: Development & Coding | Uploader: dbos-inc | Downloads: 0 | Version: v1.0（Latest）

DBOS Go SDK for building reliable, fault-tolerant applications with durable workflows. Use this skill when writing Go code with DBOS, creating workflows and steps, using queues, using the DBOS Client from external applications, or building Go applications that need to be resilient to failures.

Changelog: Source: GitHub https://github.com/dbos-inc/agent-skills

Directory Structure

Current level: tree/main/skills/dbos-golang/

📁 references/
- 📄 _sections.md 1.4 KB
- 📄 advanced-patching.md 2.8 KB
- 📄 advanced-versioning.md 2.0 KB
- 📄 client-enqueue.md 2.0 KB
- 📄 client-setup.md 1.9 KB
- 📄 comm-events.md 2.3 KB
- 📄 comm-messages.md 2.0 KB
- 📄 comm-streaming.md 2.3 KB
- 📄 lifecycle-config.md 2.0 KB
- 📄 pattern-debouncing.md 1.7 KB
- 📄 pattern-idempotency.md 1.9 KB
- 📄 pattern-scheduled.md 2.0 KB
- 📄 pattern-sleep.md 1.4 KB
- 📄 queue-basics.md 1.4 KB
- 📄 queue-concurrency.md 1.4 KB
- 📄 queue-deduplication.md 1.6 KB
- 📄 queue-listening.md 1.3 KB
- 📄 queue-partitioning.md 1.3 KB
- 📄 queue-priority.md 1.2 KB
- 📄 queue-rate-limiting.md 1.2 KB
- 📄 step-basics.md 2.3 KB
- 📄 step-concurrency.md 2.4 KB
- 📄 step-retries.md 2.0 KB
- 📄 test-setup.md 2.3 KB
- 📄 workflow-background.md 1.6 KB
- 📄 workflow-constraints.md 2.1 KB
- 📄 workflow-control.md 1.9 KB
- 📄 workflow-determinism.md 1.5 KB
- 📄 workflow-introspection.md 1.8 KB
- 📄 workflow-timeout.md 1.3 KB
📄 AGENTS.md 2.6 KB
📄 CLAUDE.md 9 B
📄 SKILL.md 3.5 KB

SKILL.md

---
name: dbos-golang
description: DBOS Go SDK for building reliable, fault-tolerant applications with durable workflows. Use this skill when writing Go code with DBOS, creating workflows and steps, using queues, using the DBOS Client from external applications, or building Go applications that need to be resilient to failures.
license: MIT
metadata:
  author: dbos
  version: "1.0.0"
  organization: DBOS
  date: February 2026
  abstract: Comprehensive guide for building fault-tolerant Go applications with DBOS. Covers workflows, steps, queues, communication patterns, and best practices for durable execution.
---

# DBOS Go Best Practices

Guide for building reliable, fault-tolerant Go applications with DBOS durable workflows.

## When to Apply

Reference these guidelines when:
- Adding DBOS to existing Go code
- Creating workflows and steps
- Using queues for concurrency control
- Implementing workflow communication (events, messages, streams)
- Configuring and launching DBOS applications
- Using the DBOS Client from external applications
- Testing DBOS applications

## Rule Categories by Priority

| Priority | Category | Impact | Prefix |
|----------|----------|--------|--------|
| 1 | Lifecycle | CRITICAL | `lifecycle-` |
| 2 | Workflow | CRITICAL | `workflow-` |
| 3 | Step | HIGH | `step-` |
| 4 | Queue | HIGH | `queue-` |
| 5 | Communication | MEDIUM | `comm-` |
| 6 | Pattern | MEDIUM | `pattern-` |
| 7 | Testing | LOW-MEDIUM | `test-` |
| 8 | Client | MEDIUM | `client-` |
| 9 | Advanced | LOW | `advanced-` |

## Critical Rules

### Installation

Install the DBOS Go module:

```bash
go get github.com/dbos-inc/dbos-transact-golang/dbos@latest
```

### DBOS Configuration and Launch

A DBOS application MUST create a context, register workflows, and launch before running any workflows:

```go
package main

import (
	"context"
	"log"
	"os"
	"time"

	"github.com/dbos-inc/dbos-transact-golang/dbos"
)

func main() {
	ctx, err := dbos.NewDBOSContext(context.Background(), dbos.Config{
		AppName:     "my-app",
		DatabaseURL: os.Getenv("DBOS_SYSTEM_DATABASE_URL"),
	})
	if err != nil {
		log.Fatal(err)
	}
	defer dbos.Shutdown(ctx, 30*time.Second)

	dbos.RegisterWorkflow(ctx, myWorkflow)

	if err := dbos.Launch(ctx); err != nil {
		log.Fatal(err)
	}
}
```

### Workflow and Step Structure

Workflows are comprised of steps. Any function performing complex operations or accessing external services must be run as a step using `dbos.RunAsStep`:

```go
func fetchData(ctx context.Context) (string, error) {
	resp, err := http.Get("https://api.example.com/data")
	if err != nil {
		return "", err
	}
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	return string(body), nil
}

func myWorkflow(ctx dbos.DBOSContext, input string) (string, error) {
	result, err := dbos.RunAsStep(ctx, fetchData, dbos.WithStepName("fetchData"))
	if err != nil {
		return "", err
	}
	return result, nil
}
```

### Key Constraints

- Do NOT start or enqueue workflows from within steps
- Do NOT use uncontrolled goroutines to start workflows - use `dbos.RunWorkflow` with queues or `dbos.Go`/`dbos.Select` for concurrent steps
- Workflows MUST be deterministic - non-deterministic operations go in steps
- Do NOT modify global variables from workflows or steps
- All workflows and queues MUST be registered before calling `Launch()`

## How to Use

Read individual rule files for detailed explanations and examples:

```
references/lifecycle-config.md
references/workflow-determinism.md
references/queue-concurrency.md
```

## References

- https://docs.dbos.dev/
- https://github.com/dbos-inc/dbos-transact-golang

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

dbos-golang

Directory Structure

SKILL.md

Report

Notice