custom sys db schema support (#208)

fixes #116

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: chuck-dbos <134347445+chuck-dbos@users.noreply.github.com>

Author: 3 people

transact-cli/README.md

@@ -42,6 +42,21 @@ export PGPASSWORD=password
 java -jar dbos.jar 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` option.
+
+Example:
+```bash
+# Use a custom schema for all DBOS system tables
+java -jar dbos.jar migrate --schema myapp_schema
+
+# All workflow commands will use the specified schema
+java -jar dbos.jar workflow list --schema myapp_schema
+```
+
+## Commands
+
 ### `dbos migrate`
 Create DBOS system tables in your database. This command runs the migration commands specified in the `database.migrate` section of your config file.
 

transact-cli/src/main/java/dev/dbos/transact/cli/DatabaseOptions.java

@@ -25,6 +25,11 @@ public class DatabaseOptions {
       interactive = true)
   private String password;
 
+  @Option(
+      names = {"--schema"},
+      description = "Database schema name [default: dbos")
+  private String schema;
+
   public String url() {
     return this.url;
   }
@@ -37,7 +42,11 @@ public String password() {
     return this.password;
   }
 
+  public String schema() {
+    return this.schema;
+  }
+
   public DBOSClient createClient() {
-    return new DBOSClient(url(), user(), password());
+    return new DBOSClient(url(), user(), password(), schema());
   }
 }

transact-cli/src/main/java/dev/dbos/transact/cli/MigrateCommand.java

@@ -38,13 +38,13 @@ public Integer call() throws Exception {
     out.format("  System Database: %s\n", dbOptions.url());
     out.format("  System Database User: %s\n", dbOptions.user());
 
-    MigrationManager.runMigrations(dbOptions.url(), dbOptions.user(), dbOptions.password());
-    grantDBOSSchemaPermissions(out);
+    MigrationManager.runMigrations(
+        dbOptions.url(), dbOptions.user(), dbOptions.password(), dbOptions.schema());
+    grantDBOSSchemaPermissions(out, dbOptions.schema());
     return 0;
   }
 
-  void grantDBOSSchemaPermissions(PrintWriter out) throws SQLException {
-    final var schema = "dbos";
+  void grantDBOSSchemaPermissions(PrintWriter out, String schema) throws SQLException {
 
     if (appRole == null || appRole.isEmpty()) {
       return;

transact-cli/src/test/java/dev/dbos/transact/cli/MigrateCommandTest.java

@@ -4,6 +4,7 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import dev.dbos.transact.Constants;
 import dev.dbos.transact.migrations.MigrationManager;
 
 import java.io.PrintWriter;
@@ -13,24 +14,20 @@
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.MethodOrderer;
-import org.junit.jupiter.api.Order;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.TestMethodOrder;
 import org.junit.jupiter.api.Timeout;
 import picocli.CommandLine;
 
 @Timeout(value = 2, unit = TimeUnit.MINUTES)
-@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
 public class MigrateCommandTest {
 
   static String db_url = "jdbc:postgresql://localhost:5432/migrate_cmd_test";
   static String db_user = Objects.requireNonNullElse(System.getenv("PGUSER"), "postgres");
   static String db_password = Objects.requireNonNullElse(System.getenv("PGPASSWORD"), "dbos");
 
-  @BeforeAll
-  static void setup() throws Exception {
+  @BeforeEach
+  public void setup() throws Exception {
     var pair = MigrationManager.extractDbAndPostgresUrl(db_url);
     var dropDbSql = String.format("DROP DATABASE IF EXISTS %s WITH (FORCE)", pair.database());
     try (var conn = DriverManager.getConnection(pair.url(), db_user, db_password);
@@ -40,10 +37,9 @@ static void setup() throws Exception {
   }
 
   @Test
-  @Order(1)
   public void migrate() throws Exception {
 
-    assertFalse(checkConnection(db_url, db_user, db_password));
+    assertFalse(checkConnection());
 
     var cmd = new CommandLine(new DBOSCommand());
     var sw = new StringWriter();
@@ -52,14 +48,16 @@ public void migrate() throws Exception {
     var exitCode = cmd.execute("migrate", "-D=" + db_url, "-U=" + db_user);
     assertEquals(0, exitCode);
 
-    assertTrue(checkConnection(db_url, db_user, db_password));
+    assertTrue(checkConnection());
+    assertTrue(checkTable(Constants.DB_SCHEMA, "workflow_status"));
   }
 
   @Test
-  @Order(2)
-  public void migrate_again() throws Exception {
+  public void migrate_twice() throws Exception {
 
-    assertTrue(checkConnection(db_url, db_user, db_password));
+    migrate();
+
+    assertTrue(checkConnection());
 
     var app = new DBOSCommand();
     var cmd = new CommandLine(app);
@@ -70,16 +68,52 @@ public void migrate_again() throws Exception {
     var exitCode = cmd.execute("migrate", "-D=" + db_url, "-U=" + db_user);
     assertEquals(0, exitCode);
 
-    assertTrue(checkConnection(db_url, db_user, db_password));
+    assertTrue(checkConnection());
+    assertTrue(checkTable(Constants.DB_SCHEMA, "workflow_status"));
+  }
+
+  @Test
+  public void migrate_custom_schema() throws Exception {
+
+    assertFalse(checkConnection());
+
+    var schema = "C\"$+0m'";
+
+    var cmd = new CommandLine(new DBOSCommand());
+    var sw = new StringWriter();
+    cmd.setOut(new PrintWriter(sw));
+
+    var exitCode = cmd.execute("migrate", "-D=" + db_url, "-U=" + db_user, "--schema=" + schema);
+    assertEquals(0, exitCode);
+
+    assertTrue(checkConnection());
+    assertTrue(checkTable(schema, "workflow_status"));
   }
 
-  static boolean checkConnection(String url, String user, String password) {
-    try (var conn = DriverManager.getConnection(url, user, password);
+  static boolean checkConnection() {
+    try (var conn = DriverManager.getConnection(db_url, db_user, db_password);
         var stmt = conn.createStatement()) {
       stmt.execute("SELECT 1");
       return true;
     } catch (SQLException e) {
       return false;
     }
   }
+
+  static boolean checkTable(String schema, String table) throws SQLException {
+    var sql =
+        "SELECT EXISTS(SELECT 1 FROM information_schema.tables WHERE table_schema = ? AND table_name = ?)";
+    try (var conn = DriverManager.getConnection(db_url, db_user, db_password);
+        var stmt = conn.prepareStatement(sql)) {
+      stmt.setString(1, schema);
+      stmt.setString(2, table);
+      try (var rs = stmt.executeQuery()) {
+        if (rs.next()) {
+          return rs.getBoolean("exists");
+        } else {
+          return false;
+        }
+      }
+    }
+  }
 }

transact/src/main/java/dev/dbos/transact/DBOSClient.java

@@ -59,8 +59,20 @@ public WorkflowStatus getStatus() {
    * @param password System database credential / password
    */
   public DBOSClient(String url, String user, String password) {
+    this(url, user, password, null);
+  }
+
+  /**
+   * Construct a DBOSClient, by providing system database access credentials
+   *
+   * @param url System database JDBC URL
+   * @param user System database user
+   * @param password System database credential / password
+   * @param schema Database schema for DBOS tables
+   */
+  public DBOSClient(String url, String user, String password, String schema) {
     var dataSource = SystemDatabase.createDataSource(url, user, password, 0, 0);
-    systemDatabase = new SystemDatabase(dataSource);
+    systemDatabase = new SystemDatabase(dataSource, schema);
   }
 
   /**
@@ -69,7 +81,17 @@ public DBOSClient(String url, String user, String password) {
    * @param dataSource System database data source
    */
   public DBOSClient(HikariDataSource dataSource) {
-    systemDatabase = new SystemDatabase(dataSource);
+    this(dataSource, null);
+  }
+
+  /**
+   * Construct a DBOSClient, by providing a configured data source
+   *
+   * @param dataSource System database data source
+   * @param schema Database schema for DBOS tables
+   */
+  public DBOSClient(HikariDataSource dataSource, String schema) {
+    systemDatabase = new SystemDatabase(dataSource, schema);
   }
 
   @Override