DBOS Lifecycle

The DBOS class is a singleton—it must be configured and launched exactly once in a program's lifetime, before running any DBOS workflows. Here, we document its lifecycle. Other methods and variables are documented here.

DBOS.setConfig

DBOS.setConfig(
    config: DBOSConfig
)

Configure DBOS. Configuration is documented here.

Parameters:

• config: Configuration parameters for DBOS. See the configuration docs.

DBOS.launch

DBOS.launch(
    options?: DBOSLaunchOptions
): Promise<void>

interface DBOSLaunchOptions {
  conductorKey?: string;
}

Launch DBOS, initializing database connections and starting queues and scheduled workflows. Should be called after all workflows and steps are registered. You should not call a DBOS function until after DBOS is launched.

For example, here is one way to launch DBOS in an app:

async function main() {
  // Configure DBOS
  DBOS.setConfig({
    "name": "dbos-node-toolbox",
    "systemDatabaseUrl": process.env.DBOS_SYSTEM_DATABASE_URL,
  });
  // Launch DBOS
  await DBOS.launch();
}

main().catch(console.log);

Parameters:

• conductor_key: An API key for DBOS Conductor. If provided, application is connected to Conductor. API keys can be created from the DBOS console.

DBOS.shutdown

DBOS.shutdown(
): Promise<void>

Shut down DBOS, terminating all active workflows and closing database disconnections. After this completes, DBOS can be re-configured and re-launched. Useful for testing.

DBOS.logRegisteredEndpoints

DBOS.logRegisteredEndpoints(): void

Logs all DBOS functions that are bound to endpoints, including scheduled workflows, kafka consumers, and any other library event receivers. This can be a useful diagnostic to call at DBOS launch.