Polish (#137)

- Remove obsolete config property
- Allow either DatabaseURL or SystemDBPool to be configured (tests in
`dbos_test.go` already cover this)
- add `--schema `to the CLI readme

Author: maxdml

cmd/dbos/README.md

@@ -37,6 +37,19 @@ export DBOS_SYSTEM_DATABASE_URL=postgres://user:pass@localhost/mydb
 dbos migrate
 ```
 
+### Database Schema Configuration
+
+By default, DBOS creates its system tables in the `dbos` schema. You can specify a custom schema name using the `--schema` global flag.
+
+Example:
+```bash
+# Use a custom schema for all DBOS system tables
+dbos migrate --schema myapp_schema
+
+# All workflow commands will use the specified schema
+dbos workflow list --schema myapp_schema
+```
+
 ### Configuration File
 
 The CLI uses a `dbos-config.yaml` file for configuration. By default, it looks for this file in the current directory. You can specify a different config file using the `--config` flag.
@@ -60,6 +73,7 @@ These options are available for all commands:
 
 - `-D, --db-url <url>` - Your DBOS system database URL
 - `--config <file>` - Config file (default: dbos-config.yaml)
+- `--schema <name>` - Database schema name (default: dbos)
 - `--verbose` - Enable verbose mode (DEBUG level logging)
 
 ## Commands
@@ -87,6 +101,8 @@ Create DBOS system tables in your database. This command runs the migration comm
 ```bash
 dbos migrate
 dbos migrate --app-role myapp_role
+dbos migrate --schema custom_schema
+dbos migrate --schema custom_schema --app-role myapp_role
 ```
 
 The migrate commands are defined in `dbos-config.yaml`:

cmd/dbos/utils.go

@@ -71,14 +71,13 @@ func getDBURL(_ *cobra.Command) (string, error) {
 }
 
 // createDBOSContext creates a new DBOS context with the provided database URL
-func createDBOSContext(userContext context.Context, dbURL string) (dbos.DBOSContext, error) {
+func createDBOSContext(ctx context.Context, dbURL string) (dbos.DBOSContext, error) {
 	appName := "dbos-cli"
 
 	config := dbos.Config{
 		DatabaseURL: dbURL,
 		AppName:     appName,
 		Logger:      initLogger(slog.LevelError),
-		Context:     userContext,
 	}
 
 	// Use the global schema flag if it's set
@@ -87,11 +86,11 @@ func createDBOSContext(userContext context.Context, dbURL string) (dbos.DBOSCont
 		logger.Debug("Using database schema", "schema", schema)
 	}
 
-	ctx, err := dbos.NewDBOSContext(context.Background(), config)
+	dbosCtx, err := dbos.NewDBOSContext(ctx, config)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create DBOS context: %w", err)
 	}
-	return ctx, nil
+	return dbosCtx, nil
 }
 
 // outputJSON outputs data as JSON

dbos/client.go

@@ -14,10 +14,10 @@ import (
 )
 
 type ClientConfig struct {
-	DatabaseURL    string        // Connection URL for the PostgreSQL database
+	DatabaseURL    string        // DatabaseURL is a PostgreSQL connection string. Either this or SystemDBPool is required.
+	SystemDBPool   *pgxpool.Pool // SystemDBPool is a custom System Database Pool. It's optional and takes precedence over DatabaseURL if both are provided.
 	DatabaseSchema string        // Database schema name (defaults to "dbos")
 	Logger         *slog.Logger  // Optional custom logger
-	SystemDBPool   *pgxpool.Pool // Optional existing connection pool for the system database
 }
 
 // Client provides a programmatic way to interact with your DBOS application from external code.

dbos/dbos.go

@@ -30,24 +30,23 @@ const (
 // Config holds configuration parameters for initializing a DBOS context.
 // DatabaseURL and AppName are required.
 type Config struct {
-	DatabaseURL        string          // PostgreSQL connection string (required)
-	AppName            string          // Application name for identification (required)
-	DatabaseSchema     string          // Database schema name (defaults to "dbos")
-	Logger             *slog.Logger    // Custom logger instance (defaults to a new slog logger)
-	AdminServer        bool            // Enable Transact admin HTTP server (disabled by default)
-	AdminServerPort    int             // Port for the admin HTTP server (default: 3001)
-	ConductorURL       string          // DBOS conductor service URL (optional)
-	ConductorAPIKey    string          // DBOS conductor API key (optional)
-	ApplicationVersion string          // Application version (optional, overridden by DBOS__APPVERSION env var)
-	ExecutorID         string          // Executor ID (optional, overridden by DBOS__VMID env var)
-	Context            context.Context // User Context
-	SystemDBPool       *pgxpool.Pool   // Custom System Database Pool
+	AppName            string        // Application name for identification (required)
+	DatabaseURL        string        // DatabaseURL is a PostgreSQL connection string. Either this or SystemDBPool is required.
+	SystemDBPool       *pgxpool.Pool // SystemDBPool is a custom System Database Pool. It's optional and takes precedence over DatabaseURL if both are provided.
+	DatabaseSchema     string        // Database schema name (defaults to "dbos")
+	Logger             *slog.Logger  // Custom logger instance (defaults to a new slog logger)
+	AdminServer        bool          // Enable Transact admin HTTP server (disabled by default)
+	AdminServerPort    int           // Port for the admin HTTP server (default: 3001)
+	ConductorURL       string        // DBOS conductor service URL (optional)
+	ConductorAPIKey    string        // DBOS conductor API key (optional)
+	ApplicationVersion string        // Application version (optional, overridden by DBOS__APPVERSION env var)
+	ExecutorID         string        // Executor ID (optional, overridden by DBOS__VMID env var)
 }
 
 func processConfig(inputConfig *Config) (*Config, error) {
 	// First check required fields
-	if len(inputConfig.DatabaseURL) == 0 {
-		return nil, fmt.Errorf("missing required config field: databaseURL")
+	if len(inputConfig.DatabaseURL) == 0 && inputConfig.SystemDBPool == nil {
+		return nil, fmt.Errorf("either databaseURL or systemDBPool must be provided")
 	}
 	if len(inputConfig.AppName) == 0 {
 		return nil, fmt.Errorf("missing required config field: appName")

dbos/dbos_test.go

@@ -62,7 +62,7 @@ func TestConfig(t *testing.T) {
 		assert.Equal(t, expectedMsg, dbosErr.Message)
 	})
 
-	t.Run("FailsWithoutDatabaseURL", func(t *testing.T) {
+	t.Run("FailsWithoutDatabaseURLOrSystemDBPool", func(t *testing.T) {
 		config := Config{
 			AppName: "test-app",
 		}
@@ -75,7 +75,7 @@ func TestConfig(t *testing.T) {
 
 		assert.Equal(t, InitializationError, dbosErr.Code)
 
-		expectedMsg := "Error initializing DBOS Transact: missing required config field: databaseURL"
+		expectedMsg := "Error initializing DBOS Transact: either databaseURL or systemDBPool must be provided"
 		assert.Equal(t, expectedMsg, dbosErr.Message)
 	})
 
@@ -523,7 +523,6 @@ func TestCustomPool(t *testing.T) {
 		require.NoError(t, err)
 
 		config := Config{
-			DatabaseURL:  databaseURL,
 			AppName:      "test-custom-pool",
 			SystemDBPool: pool,
 		}
@@ -609,7 +608,7 @@ func TestCustomPool(t *testing.T) {
 		return input, nil
 	}
 
-	t.Run("InvalidDatabaseUrl", func(t *testing.T) {
+	t.Run("CustomPoolTakesPrecedence", func(t *testing.T) {
 		invalidDatabaseURL := "postgres://invalid:invalid@localhost:5432/invaliddb"
 		databaseURL := getDatabaseURL()
 		poolConfig, err := pgxpool.ParseConfig(databaseURL)