DBOS Transact Enterprise
DBOS Transact Enterprise is the commercial extension to the open-source (MIT license) DBOS Transact library. DBOS Transact Enterprise is licensed under the DBOS Conductor Software License. All commercial DBOS plans include access to DBOS Transact Enterprise.
Features
DBOS Transact Enterprise provides:
- Conductor access: DBOS Transact Enterprise comes with full access to DBOS Conductor, the control plane for your durable workflows.
- Sharding: Horizontally scale DBOS to handle over 1M workflows or steps per second with a sharded Postgres system database.
- Workflow Retention: Set a retention policy (configurable through the DBOS Console) for how long to retain workflow data.
- Auto-upgrade: Automatically move workflows from older application versions to the latest version.
- Suspending workflows: Suspend workflows during long sleeps or waits for messages, so they use no resources until they wake.
- External storage: Keep large objects in a separate store such as Amazon S3 and checkpoint only small references to them.
Installing DBOS Transact Enterprise
DBOS Transact Enterprise is distributed as a package alongside DBOS Transact:
- Python
- TypeScript
- Go
- Java
Install the dbos-enterprise package as an extra of dbos:
pip install "dbos[enterprise]"
Install the @dbos-inc/dbos-enterprise package, at the same minor version as @dbos-inc/dbos-sdk:
npm install @dbos-inc/dbos-enterprise
Add the go.dbos.dev/dbos-enterprise-go module, at the same minor version as github.com/dbos-inc/dbos-transact-golang, and import it once, anywhere in your program:
go get go.dbos.dev/dbos-enterprise-go
import _ "go.dbos.dev/dbos-enterprise-go"
Add the dev.dbos:transact-enterprise artifact, at exactly the same version as dev.dbos:transact.
DBOS loads it automatically; no code change is needed.
In Java, DBOS Transact Enterprise provides the connection to Conductor.
- Gradle
- Maven
dependencies {
implementation("dev.dbos:transact:1.3.0")
implementation("dev.dbos:transact-enterprise:1.3.0")
}
<dependencies>
<dependency>
<groupId>dev.dbos</groupId>
<artifactId>transact</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>dev.dbos</groupId>
<artifactId>transact-enterprise</artifactId>
<version>1.3.0</version>
</dependency>
</dependencies>
DBOS Transact Enterprise Keys
In production, applications using DBOS Transact Enterprise should connect to Conductor. Their Conductor key also serves as their DBOS Transact Enterprise key, so you don't need to configure anything else.
During development, you can use DBOS Transact Enterprise features without connecting to Conductor by setting a DBOS Transact Enterprise key in your DBOS configuration:
- Python
- TypeScript
- Go
- Java
config: DBOSConfig = {
"name": "my-app-name",
"system_database_url": os.environ.get("DBOS_SYSTEM_DATABASE_URL"),
"transact_enterprise_key": os.environ.get("DBOS_TRANSACT_ENTERPRISE_KEY"),
}
DBOS(config=config)
DBOS.setConfig({
name: "my-app-name",
systemDatabaseUrl: process.env.DBOS_SYSTEM_DATABASE_URL,
transactEnterpriseKey: process.env.DBOS_TRANSACT_ENTERPRISE_KEY,
});
await DBOS.launch();
dbosContext, err := dbos.NewContext(context.Background(), dbos.Config{
AppName: "my-app-name",
DatabaseURL: os.Getenv("DBOS_SYSTEM_DATABASE_URL"),
TransactEnterpriseKey: os.Getenv("DBOS_TRANSACT_ENTERPRISE_KEY"),
})
Java needs no DBOS Transact Enterprise key. In Java, DBOS Transact Enterprise provides the connection to Conductor, so it needs only your Conductor key.
Use a DBOS Transact Enterprise key without Conductor only for development. In production, connect applications using DBOS Transact Enterprise to Conductor.
If you self-host Conductor, DBOS checks entitlements with the Conductor at your configured Conductor URL instead.