dbos 1.12.0a2__py3-none-any.whl → 1.13.0__py3-none-any.whl

dbos/cli/cli.py

@@ -5,7 +5,7 @@ import subprocess
 import time
 import typing
 from os import path
-from typing import Any, Optional
+from typing import Any, Optional, Tuple
 
 import jsonpickle  # type: ignore
 import sqlalchemy as sa
@@ -14,65 +14,69 @@ from rich import print as richprint
 from rich.prompt import IntPrompt
 from typing_extensions import Annotated, List
 
+from dbos._context import SetWorkflowID
 from dbos._debug import debug_workflow, parse_start_command
 from dbos.cli.migration import grant_dbos_schema_permissions, migrate_dbos_databases
 
-from .._app_db import ApplicationDatabase
 from .._client import DBOSClient
 from .._dbos_config import (
+    ConfigFile,
     _app_name_to_db_name,
     _is_valid_app_name,
+    get_application_database_url,
     get_system_database_url,
-    is_valid_database_url,
     load_config,
 )
 from .._docker_pg_helper import start_docker_pg, stop_docker_pg
-from .._schemas.system_database import SystemSchema
-from .._sys_db import SystemDatabase, reset_system_database
+from .._sys_db import SystemDatabase
 from .._utils import GlobalParams
 from ..cli._github_init import create_template_from_github
 from ._template_init import copy_template, get_project_name, get_templates_directory
 
 
-def _get_db_url(db_url: Optional[str]) -> str:
+def _get_db_url(
+    *, system_database_url: Optional[str], application_database_url: Optional[str]
+) -> Tuple[str, str]:
     """
     Get the database URL to use for the DBOS application.
     Order of precedence:
-    - If the `db_url` argument is provided, use it.
-    - If the `dbos-config.yaml` file is present, use the `database_url` from it.
-    - If the `DBOS_DATABASE_URL` environment variable is set, use it.
+    - In DBOS Cloud, use the environment variables provided.
+    - Use database URL arguments if provided.
+    - If the `dbos-config.yaml` file is present, use the database URLs from it.
 
-    Otherwise fallback to the same default Postgres URL than the DBOS library.
+    Otherwise fallback to the same SQLite Postgres URL than the DBOS library.
     Note that for the latter to be possible, a configuration file must have been found, with an application name set.
     """
-    database_url = db_url
-    _app_db_name = None
-    if database_url is None:
+    if os.environ.get("DBOS__CLOUD") == "true":
+        system_database_url = os.environ.get("DBOS_SYSTEM_DATABASE_URL")
+        application_database_url = os.environ.get("DBOS_DATABASE_URL")
+        assert system_database_url and application_database_url
+        return system_database_url, application_database_url
+    if system_database_url or application_database_url:
+        cfg: ConfigFile = {
+            "system_database_url": system_database_url,
+            "database_url": application_database_url,
+        }
+        return get_system_database_url(cfg), get_application_database_url(cfg)
+    else:
         # Load from config file if present
         try:
-            config = load_config(run_process_config=False, silent=True)
-            database_url = config.get("database_url")
-            _app_db_name = _app_name_to_db_name(config["name"])
+            config = load_config(silent=True)
+            if config.get("database_url") or config.get("system_database_url"):
+                return get_system_database_url(config), get_application_database_url(
+                    config
+                )
+            else:
+                _app_db_name = _app_name_to_db_name(config["name"])
+                # Fallback on the same defaults than the DBOS library
+                default_url = f"sqlite:///{_app_db_name}.sqlite"
+                return default_url, default_url
         except (FileNotFoundError, OSError):
-            # Config file doesn't exist, continue with other fallbacks
-            pass
-    if database_url is None:
-        database_url = os.getenv("DBOS_DATABASE_URL")
-    if database_url is None and _app_db_name is not None:
-        # Fallback on the same defaults than the DBOS library
-        _password = os.environ.get("PGPASSWORD", "dbos")
-        database_url = f"postgres://postgres:{_password}@localhost:5432/{_app_db_name}?connect_timeout=10&sslmode=prefer"
-    if database_url is None:
-        raise ValueError(
-            "Missing database URL: please set it using the --db-url flag, the DBOS_DATABASE_URL environment variable, or in your dbos-config.yaml file."
-        )
-    assert is_valid_database_url(database_url)
-    return database_url
-
-
-def start_client(db_url: Optional[str] = None) -> DBOSClient:
-    database_url = _get_db_url(db_url)
-    return DBOSClient(database_url=database_url)
+            typer.echo(
+                f"Error: Missing database URL: please set it using CLI flags or your dbos-config.yaml file.",
+                err=True,
+            )
+            raise typer.Exit(code=1)
 
 
 app = typer.Typer()
@@ -114,7 +118,7 @@ def _on_windows() -> bool:
     help="Start your DBOS application using the start commands in 'dbos-config.yaml'"
 )
 def start() -> None:
-    config = load_config(run_process_config=False, silent=True)
+    config = load_config(silent=True)
     start_commands = config["runtimeConfig"]["start"]
     typer.echo("Executing start commands from 'dbos-config.yaml'")
     for command in start_commands:
@@ -263,7 +267,7 @@ def _resolve_project_name_and_template(
 
 @app.command(help="Create DBOS system tables.")
 def migrate(
-    app_database_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -288,28 +292,25 @@ def migrate(
         ),
     ] = None,
 ) -> None:
-    app_database_url = _get_db_url(app_database_url)
-    system_database_url = get_system_database_url(
-        {
-            "system_database_url": system_database_url,
-            "database_url": app_database_url,
-            "database": {},
-        }
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
     )
 
     typer.echo(f"Starting DBOS migrations")
-    typer.echo(f"Application database: {sa.make_url(app_database_url)}")
+    typer.echo(f"Application database: {sa.make_url(application_database_url)}")
     typer.echo(f"System database: {sa.make_url(system_database_url)}")
 
     # First, run DBOS migrations on the system database and the application database
     migrate_dbos_databases(
-        app_database_url=app_database_url, system_database_url=system_database_url
+        app_database_url=application_database_url,
+        system_database_url=system_database_url,
     )
 
     # Next, assign permissions on the DBOS schema to the application role, if any
     if application_role:
         grant_dbos_schema_permissions(
-            database_url=app_database_url, role_name=application_role
+            database_url=application_database_url, role_name=application_role
         )
         grant_dbos_schema_permissions(
             database_url=system_database_url, role_name=application_role
@@ -317,7 +318,7 @@ def migrate(
 
     # Next, run any custom migration commands specified in the configuration
     if os.path.exists("dbos-config.yaml"):
-        config = load_config(run_process_config=False, silent=True)
+        config = load_config(silent=True)
         if "database" not in config:
             config["database"] = {}
         migrate_commands = (
@@ -345,20 +346,20 @@ def migrate(
 @app.command(help="Reset the DBOS system database")
 def reset(
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
-    sys_db_name: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
-            "--sys-db-name",
-            "-s",
-            help="Specify the name of the system database to reset",
+            "--db-url",
+            "-D",
+            help="Your DBOS application database URL",
         ),
     ] = None,
-    db_url: Annotated[
+    system_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
-            "--db-url",
-            "-D",
-            help="Your DBOS application database URL",
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
         ),
     ] = None,
 ) -> None:
@@ -370,22 +371,12 @@ def reset(
             typer.echo("Operation cancelled.")
             raise typer.Exit()
     try:
-        # Make a SA url out of the user-provided URL and verify a database name is present
-        database_url = _get_db_url(db_url)
-        pg_db_url = sa.make_url(database_url)
-        assert (
-            pg_db_url.database is not None
-        ), f"Database name is required in URL: {pg_db_url.render_as_string(hide_password=True)}"
-        # Resolve system database name
-        sysdb_name = (
-            sys_db_name
-            if sys_db_name
-            else (pg_db_url.database + SystemSchema.sysdb_suffix)
-        )
-        reset_system_database(
-            postgres_db_url=pg_db_url.set(database="postgres"), sysdb_name=sysdb_name
+        system_database_url, application_database_url = _get_db_url(
+            system_database_url=system_database_url,
+            application_database_url=application_database_url,
         )
-    except sa.exc.SQLAlchemyError as e:
+        SystemDatabase.reset_system_database(system_database_url)
+    except Exception as e:
         typer.echo(f"Error resetting system database: {str(e)}")
         return
 
@@ -408,7 +399,7 @@ def debug(
 
 @workflow.command(help="List workflows for your application")
 def list(
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -416,6 +407,14 @@ def list(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
     limit: Annotated[
         int,
         typer.Option("--limit", "-l", help="Limit the results returned"),
@@ -428,7 +427,7 @@ def list(
         typing.Optional[str],
         typer.Option(
             "--start-time",
-            "-s",
+            "-t",
             help="Retrieve workflows starting after this timestamp (ISO 8601 format)",
         ),
     ] = None,
@@ -481,7 +480,15 @@ def list(
         ),
     ] = None,
 ) -> None:
-    workflows = start_client(db_url=db_url).list_workflows(
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
+    )
+    workflows = client.list_workflows(
         limit=limit,
         offset=offset,
         sort_desc=sort_desc,
@@ -498,7 +505,7 @@ def list(
 @workflow.command(help="Retrieve the status of a workflow")
 def get(
     workflow_id: Annotated[str, typer.Argument()],
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -506,19 +513,31 @@ def get(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
 ) -> None:
-    status = (
-        start_client(db_url=db_url)
-        .retrieve_workflow(workflow_id=workflow_id)
-        .get_status()
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
     )
+    status = client.retrieve_workflow(workflow_id=workflow_id).get_status()
     print(jsonpickle.encode(status, unpicklable=False))
 
 
 @workflow.command(help="List the steps of a workflow")
 def steps(
     workflow_id: Annotated[str, typer.Argument()],
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -526,10 +545,26 @@ def steps(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
 ) -> None:
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
+    )
     print(
         jsonpickle.encode(
-            start_client(db_url=db_url).list_workflow_steps(workflow_id=workflow_id),
+            client.list_workflow_steps(workflow_id=workflow_id),
             unpicklable=False,
         )
     )
@@ -540,7 +575,7 @@ def steps(
 )
 def cancel(
     workflow_id: Annotated[str, typer.Argument()],
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -548,14 +583,30 @@ def cancel(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
 ) -> None:
-    start_client(db_url=db_url).cancel_workflow(workflow_id=workflow_id)
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
+    )
+    client.cancel_workflow(workflow_id=workflow_id)
 
 
 @workflow.command(help="Resume a workflow that has been cancelled")
 def resume(
     workflow_id: Annotated[str, typer.Argument()],
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -563,14 +614,32 @@ def resume(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
 ) -> None:
-    start_client(db_url=db_url).resume_workflow(workflow_id=workflow_id)
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
+    )
+    client.resume_workflow(workflow_id=workflow_id)
 
 
-@workflow.command(help="Restart a workflow from the beginning with a new id")
+@workflow.command(
+    help="[DEPRECATED - Use fork instead] Restart a workflow from the beginning with a new id"
+)
 def restart(
     workflow_id: Annotated[str, typer.Argument()],
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -578,12 +647,24 @@ def restart(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
 ) -> None:
-    status = (
-        start_client(db_url=db_url)
-        .fork_workflow(workflow_id=workflow_id, start_step=1)
-        .get_status()
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
     )
+    status = client.fork_workflow(workflow_id=workflow_id, start_step=1).get_status()
     print(jsonpickle.encode(status, unpicklable=False))
 
 
@@ -596,11 +677,27 @@ def fork(
         int,
         typer.Option(
             "--step",
-            "-s",
+            "-S",
             help="Restart from this step",
         ),
     ] = 1,
-    db_url: Annotated[
+    forked_workflow_id: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--forked-workflow-id",
+            "-f",
+            help="Custom ID for the forked workflow",
+        ),
+    ] = None,
+    application_version: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--application-version",
+            "-v",
+            help="Custom application version for the forked workflow",
+        ),
+    ] = None,
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -608,18 +705,43 @@ def fork(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
 ) -> None:
-    status = (
-        start_client(db_url=db_url)
-        .fork_workflow(workflow_id=workflow_id, start_step=step)
-        .get_status()
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
     )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
+    )
+
+    if forked_workflow_id is not None:
+        with SetWorkflowID(forked_workflow_id):
+            status = client.fork_workflow(
+                workflow_id=workflow_id,
+                start_step=step,
+                application_version=application_version,
+            ).get_status()
+    else:
+        status = client.fork_workflow(
+            workflow_id=workflow_id,
+            start_step=step,
+            application_version=application_version,
+        ).get_status()
     print(jsonpickle.encode(status, unpicklable=False))
 
 
 @queue.command(name="list", help="List enqueued functions for your application")
 def list_queue(
-    db_url: Annotated[
+    application_database_url: Annotated[
         typing.Optional[str],
         typer.Option(
             "--db-url",
@@ -627,6 +749,14 @@ def list_queue(
             help="Your DBOS application database URL",
         ),
     ] = None,
+    system_database_url: Annotated[
+        typing.Optional[str],
+        typer.Option(
+            "--sys-db-url",
+            "-s",
+            help="Your DBOS system database URL",
+        ),
+    ] = None,
     limit: Annotated[
         typing.Optional[int],
         typer.Option("--limit", "-l", help="Limit the results returned"),
@@ -635,7 +765,7 @@ def list_queue(
         typing.Optional[str],
         typer.Option(
             "--start-time",
-            "-s",
+            "-t",
             help="Retrieve functions starting after this timestamp (ISO 8601 format)",
         ),
     ] = None,
@@ -688,7 +818,15 @@ def list_queue(
         ),
     ] = None,
 ) -> None:
-    workflows = start_client(db_url=db_url).list_queued_workflows(
+    system_database_url, application_database_url = _get_db_url(
+        system_database_url=system_database_url,
+        application_database_url=application_database_url,
+    )
+    client = DBOSClient(
+        application_database_url=application_database_url,
+        system_database_url=system_database_url,
+    )
+    workflows = client.list_queued_workflows(
         limit=limit,
         offset=offset,
         sort_desc=sort_desc,

dbos/cli/migration.py

@@ -9,7 +9,7 @@ def migrate_dbos_databases(app_database_url: str, system_database_url: str) -> N
     app_db = None
     sys_db = None
     try:
-        sys_db = SystemDatabase(
+        sys_db = SystemDatabase.create(
             system_database_url=system_database_url,
             engine_kwargs={
                 "pool_timeout": 30,
@@ -17,7 +17,7 @@ def migrate_dbos_databases(app_database_url: str, system_database_url: str) -> N
                 "pool_size": 2,
             },
         )
-        app_db = ApplicationDatabase(
+        app_db = ApplicationDatabase.create(
             database_url=app_database_url,
             engine_kwargs={
                 "pool_timeout": 30,

dbos/dbos-config.schema.json

@@ -19,6 +19,10 @@
         "type": ["string", "null"],
         "description": "The URL of the application database"
       },
+      "system_database_url": {
+        "type": ["string", "null"],
+        "description": "The URL of the system database"
+      },
       "database": {
         "type": "object",
         "additionalProperties": false,

{dbos-1.12.0a2.dist-info → dbos-1.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 1.12.0a2
+Version: 1.13.0
 Summary: Ultra-lightweight durable execution in Python
 Author-Email: "DBOS, Inc." <contact@dbos.dev>
 License: MIT