Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbos-inc/dbos-transact-ts
The TypeScript framework for backends that scale
https://github.com/dbos-inc/dbos-transact-ts
dbos postgresql typescript
Last synced: 2 days ago
JSON representation
The TypeScript framework for backends that scale
- Host: GitHub
- URL: https://github.com/dbos-inc/dbos-transact-ts
- Owner: dbos-inc
- License: mit
- Created: 2023-07-12T16:43:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T18:08:29.000Z (3 months ago)
- Last Synced: 2024-10-29T18:31:00.127Z (3 months ago)
- Topics: dbos, postgresql, typescript
- Language: TypeScript
- Homepage: https://docs.dbos.dev
- Size: 2.25 MB
- Stars: 361
- Watchers: 2
- Forks: 27
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-repositories - dbos-inc/dbos-transact-ts - The TypeScript framework for backends that scale (TypeScript)
README
# DBOS Transact: A Lightweight Durable Execution Library Built on Postgres
#### [Documentation](https://docs.dbos.dev/) • [Examples](https://docs.dbos.dev/examples) • [Github](https://github.com/dbos-inc) • [Discord](https://discord.com/invite/jsmC6pXGgX)
---
DBOS Transact is a TypeScript library for **ultra-lightweight durable execution**.
For example:
```javascript
class Example {
@DBOS.step()
static async step_one() {
...
}
@DBOS.step()
static async step_two() {
...
}
@DBOS.workflow()
static async workflow() {
await Example.step_one()
await Example.step_two()
}
}
```
Durable execution means persisting the execution state of your program while it runs, so if it is ever interrupted or crashes, it automatically resumes from where it left off.
Durable execution helps solve many common problems:
- Orchestrating long-running or business-critical workflows so they seamlessly recover from any failure.
- Running reliable background jobs with no timeouts.
- Processing incoming events (e.g. from Kafka) exactly once.
- Running a fault-tolerant distributed task queue.
- Running a reliable cron scheduler.
- Operating an AI agent, or anything that connects to an unreliable or non-deterministic API.
What’s unique about DBOS's implementation of durable execution is that it’s implemented in a **lightweight library** that’s **totally backed by Postgres**.
To use DBOS, just `npm install` it and annotate your program with DBOS decorators.
Under the hood, those decorators store your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database.
If your program crashes or is interrupted, they automatically recover its workflows from their stored state.
So all you need to use DBOS is Postgres—there are no other dependencies you have to manage, no separate workflow server.
One big advantage of this approach is that you can add DBOS to **any** TypeScript application—**it’s just a library**.
For example, you can use DBOS to add reliable background jobs or cron scheduling or queues to your Next.js app with no external dependencies except Postgres.
## Getting Started
Initialize a starter app with:
```shell
npx @dbos-inc/create -t dbos-node-starter
```
Or, if you want to use the integration with Next.js:
```shell
npx @dbos-inc/create -t dbos-nextjs-starter
```
Then build and run your app with:
```shell
npm install
npm run build
npm run start
```
Visit your app in your browser at [`localhost:3000`](http://localhost:3000) to see durable execution in action!
To learn how to build more complex workflows, check out the [programming guide](https://docs.dbos.dev/typescript/programming-guide) or [docs](https://docs.dbos.dev/).
## Documentation
[https://docs.dbos.dev](https://docs.dbos.dev)
## Community
If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
If you see a bug or have a feature request, don't hesitate to open an issue here on GitHub.
If you're interested in contributing, check out our [contributions guide](./CONTRIBUTING.md).