dbos 1.7.0a5__py3-none-any.whl → 1.8.0__py3-none-any.whl

dbos/_admin_server.py

@@ -343,6 +343,8 @@ class AdminRequestHandler(BaseHTTPRequestHandler):
             offset=filters.get("offset"),
             sort_desc=filters.get("sort_desc", False),
             workflow_id_prefix=filters.get("workflow_id_prefix"),
+            load_input=filters.get("load_input", False),
+            load_output=filters.get("load_output", False),
         )
         workflows_output = [
             conductor_protocol.WorkflowsOutput.from_workflow_information(i)
@@ -367,6 +369,7 @@ class AdminRequestHandler(BaseHTTPRequestHandler):
             offset=filters.get("offset"),
             queue_name=filters.get("queue_name"),
             sort_desc=filters.get("sort_desc", False),
+            load_input=filters.get("load_input", False),
         )
         workflows_output = [
             conductor_protocol.WorkflowsOutput.from_workflow_information(i)

dbos/_client.py

@@ -13,7 +13,7 @@ else:
 
 from dbos import _serialization
 from dbos._dbos import WorkflowHandle, WorkflowHandleAsync
-from dbos._dbos_config import is_valid_database_url
+from dbos._dbos_config import get_system_database_url, is_valid_database_url
 from dbos._error import DBOSException, DBOSNonExistentWorkflowError
 from dbos._registrations import DEFAULT_MAX_RECOVERY_ATTEMPTS
 from dbos._serialization import WorkflowInputs
@@ -97,17 +97,28 @@ class WorkflowHandleClientAsyncPolling(Generic[R]):
 
 
 class DBOSClient:
-    def __init__(self, database_url: str, *, system_database: Optional[str] = None):
+    def __init__(
+        self,
+        database_url: str,
+        *,
+        system_database_url: Optional[str] = None,
+        system_database: Optional[str] = None,
+    ):
         assert is_valid_database_url(database_url)
         # We only create database connections but do not run migrations
         self._sys_db = SystemDatabase(
-            database_url=database_url,
+            system_database_url=get_system_database_url(
+                {
+                    "system_database_url": system_database_url,
+                    "database_url": database_url,
+                    "database": {"sys_db_name": system_database},
+                }
+            ),
             engine_kwargs={
                 "pool_timeout": 30,
                 "max_overflow": 0,
                 "pool_size": 2,
             },
-            sys_db_name=system_database,
         )
         self._sys_db.check_connection()
         self._app_db = ApplicationDatabase(
@@ -294,6 +305,8 @@ class DBOSClient:
         offset: Optional[int] = None,
         sort_desc: bool = False,
         workflow_id_prefix: Optional[str] = None,
+        load_input: bool = True,
+        load_output: bool = True,
     ) -> List[WorkflowStatus]:
         return list_workflows(
             self._sys_db,
@@ -308,6 +321,8 @@ class DBOSClient:
             offset=offset,
             sort_desc=sort_desc,
             workflow_id_prefix=workflow_id_prefix,
+            load_input=load_input,
+            load_output=load_output,
         )
 
     async def list_workflows_async(
@@ -324,6 +339,8 @@ class DBOSClient:
         offset: Optional[int] = None,
         sort_desc: bool = False,
         workflow_id_prefix: Optional[str] = None,
+        load_input: bool = True,
+        load_output: bool = True,
     ) -> List[WorkflowStatus]:
         return await asyncio.to_thread(
             self.list_workflows,
@@ -338,6 +355,8 @@ class DBOSClient:
             offset=offset,
             sort_desc=sort_desc,
             workflow_id_prefix=workflow_id_prefix,
+            load_input=load_input,
+            load_output=load_output,
         )
 
     def list_queued_workflows(
@@ -351,6 +370,7 @@ class DBOSClient:
         limit: Optional[int] = None,
         offset: Optional[int] = None,
         sort_desc: bool = False,
+        load_input: bool = True,
     ) -> List[WorkflowStatus]:
         return list_queued_workflows(
             self._sys_db,
@@ -362,6 +382,7 @@ class DBOSClient:
             limit=limit,
             offset=offset,
             sort_desc=sort_desc,
+            load_input=load_input,
         )
 
     async def list_queued_workflows_async(
@@ -375,6 +396,7 @@ class DBOSClient:
         limit: Optional[int] = None,
         offset: Optional[int] = None,
         sort_desc: bool = False,
+        load_input: bool = True,
     ) -> List[WorkflowStatus]:
         return await asyncio.to_thread(
             self.list_queued_workflows,
@@ -386,6 +408,7 @@ class DBOSClient:
             limit=limit,
             offset=offset,
             sort_desc=sort_desc,
+            load_input=load_input,
         )
 
     def list_workflow_steps(self, workflow_id: str) -> List[StepInfo]:

dbos/_conductor/conductor.py

@@ -223,6 +223,8 @@ class ConductorWebsocket(threading.Thread):
                             body = list_workflows_message.body
                             infos = []
                             try:
+                                load_input = body.get("load_input", False)
+                                load_output = body.get("load_output", False)
                                 infos = list_workflows(
                                     self.dbos._sys_db,
                                     workflow_ids=body["workflow_uuids"],
@@ -235,6 +237,8 @@ class ConductorWebsocket(threading.Thread):
                                     limit=body["limit"],
                                     offset=body["offset"],
                                     sort_desc=body["sort_desc"],
+                                    load_input=load_input,
+                                    load_output=load_output,
                                 )
                             except Exception as e:
                                 error_message = f"Exception encountered when listing workflows: {traceback.format_exc()}"
@@ -257,6 +261,7 @@ class ConductorWebsocket(threading.Thread):
                             q_body = list_queued_workflows_message.body
                             infos = []
                             try:
+                                q_load_input = q_body.get("load_input", False)
                                 infos = list_queued_workflows(
                                     self.dbos._sys_db,
                                     start_time=q_body["start_time"],
@@ -267,6 +272,7 @@ class ConductorWebsocket(threading.Thread):
                                     offset=q_body["offset"],
                                     queue_name=q_body["queue_name"],
                                     sort_desc=q_body["sort_desc"],
+                                    load_input=q_load_input,
                                 )
                             except Exception as e:
                                 error_message = f"Exception encountered when listing queued workflows: {traceback.format_exc()}"

dbos/_conductor/protocol.py

@@ -110,7 +110,7 @@ class RestartResponse(BaseMessage):
     error_message: Optional[str] = None
 
 
-class ListWorkflowsBody(TypedDict):
+class ListWorkflowsBody(TypedDict, total=False):
     workflow_uuids: List[str]
     workflow_name: Optional[str]
     authenticated_user: Optional[str]
@@ -121,6 +121,8 @@ class ListWorkflowsBody(TypedDict):
     limit: Optional[int]
     offset: Optional[int]
     sort_desc: bool
+    load_input: bool
+    load_output: bool
 
 
 @dataclass
@@ -209,7 +211,7 @@ class ListWorkflowsResponse(BaseMessage):
     error_message: Optional[str] = None
 
 
-class ListQueuedWorkflowsBody(TypedDict):
+class ListQueuedWorkflowsBody(TypedDict, total=False):
     workflow_name: Optional[str]
     start_time: Optional[str]
     end_time: Optional[str]
@@ -218,6 +220,7 @@ class ListQueuedWorkflowsBody(TypedDict):
     limit: Optional[int]
     offset: Optional[int]
     sort_desc: bool
+    load_input: bool
 
 
 @dataclass

dbos/_context.py

@@ -10,7 +10,7 @@ from enum import Enum
 from types import TracebackType
 from typing import List, Literal, Optional, Type, TypedDict
 
-from opentelemetry.trace import Span, Status, StatusCode
+from opentelemetry.trace import Span, Status, StatusCode, use_span
 from sqlalchemy.orm import Session
 
 from dbos._utils import GlobalParams
@@ -68,6 +68,20 @@ class StepStatus:
     max_attempts: Optional[int]
 
 
+@dataclass
+class ContextSpan:
+    """
+    A span that is used to track the context of a workflow or step execution.
+
+    Attributes:
+        span: The OpenTelemetry span object.
+        context_manager: The context manager that is used to manage the span's lifecycle.
+    """
+
+    span: Span
+    context_manager: AbstractContextManager[Span]
+
+
 class DBOSContext:
     def __init__(self) -> None:
         self.executor_id = GlobalParams.executor_id
@@ -86,7 +100,7 @@ class DBOSContext:
         self.curr_step_function_id: int = -1
         self.curr_tx_function_id: int = -1
         self.sql_session: Optional[Session] = None
-        self.spans: list[Span] = []
+        self.context_spans: list[ContextSpan] = []
 
         self.authenticated_user: Optional[str] = None
         self.authenticated_roles: Optional[List[str]] = None
@@ -202,8 +216,8 @@ class DBOSContext:
         self._end_span(exc_value)
 
     def get_current_span(self) -> Optional[Span]:
-        if len(self.spans):
-            return self.spans[-1]
+        if len(self.context_spans) > 0:
+            return self.context_spans[-1].span
         return None
 
     def _start_span(self, attributes: TracedAttributes) -> None:
@@ -218,27 +232,38 @@ class DBOSContext:
         )
         attributes["authenticatedUserAssumedRole"] = self.assumed_role
         span = dbos_tracer.start_span(
-            attributes, parent=self.spans[-1] if len(self.spans) > 0 else None
+            attributes,
+            parent=self.context_spans[-1].span if len(self.context_spans) > 0 else None,
+        )
+        # Activate the current span
+        cm = use_span(
+            span,
+            end_on_exit=False,
+            record_exception=False,
+            set_status_on_exception=False,
         )
-        self.spans.append(span)
+        self.context_spans.append(ContextSpan(span, cm))
+        cm.__enter__()
 
     def _end_span(self, exc_value: Optional[BaseException]) -> None:
+        context_span = self.context_spans.pop()
         if exc_value is None:
-            self.spans[-1].set_status(Status(StatusCode.OK))
+            context_span.span.set_status(Status(StatusCode.OK))
         else:
-            self.spans[-1].set_status(
+            context_span.span.set_status(
                 Status(StatusCode.ERROR, description=str(exc_value))
             )
-        dbos_tracer.end_span(self.spans.pop())
+        dbos_tracer.end_span(context_span.span)
+        context_span.context_manager.__exit__(None, None, None)
 
     def set_authentication(
         self, user: Optional[str], roles: Optional[List[str]]
     ) -> None:
         self.authenticated_user = user
         self.authenticated_roles = roles
-        if user is not None and len(self.spans) > 0:
-            self.spans[-1].set_attribute("authenticatedUser", user)
-            self.spans[-1].set_attribute(
+        if user is not None and len(self.context_spans) > 0:
+            self.context_spans[-1].span.set_attribute("authenticatedUser", user)
+            self.context_spans[-1].span.set_attribute(
                 "authenticatedUserRoles", json.dumps(roles) if roles is not None else ""
             )
 

dbos/_dbos.py

@@ -91,6 +91,7 @@ from ._context import (
 from ._dbos_config import (
     ConfigFile,
     DBOSConfig,
+    get_system_database_url,
     overwrite_config,
     process_config,
     translate_dbos_config_to_config_file,
@@ -424,9 +425,8 @@ class DBOS:
             assert self._config["database_url"] is not None
             assert self._config["database"]["sys_db_engine_kwargs"] is not None
             self._sys_db_field = SystemDatabase(
-                database_url=self._config["database_url"],
+                system_database_url=get_system_database_url(self._config),
                 engine_kwargs=self._config["database"]["sys_db_engine_kwargs"],
-                sys_db_name=self._config["database"]["sys_db_name"],
                 debug_mode=debug_mode,
             )
             assert self._config["database"]["db_engine_kwargs"] is not None
@@ -966,6 +966,12 @@ class DBOS:
             fn, "DBOS.cancelWorkflow"
         )
 
+    @classmethod
+    async def cancel_workflow_async(cls, workflow_id: str) -> None:
+        """Cancel a workflow by ID."""
+        await cls._configure_asyncio_thread_pool()
+        await asyncio.to_thread(cls.cancel_workflow, workflow_id)
+
     @classmethod
     async def _configure_asyncio_thread_pool(cls) -> None:
         """
@@ -987,11 +993,23 @@ class DBOS:
         _get_dbos_instance()._sys_db.call_function_as_step(fn, "DBOS.resumeWorkflow")
         return cls.retrieve_workflow(workflow_id)
 
+    @classmethod
+    async def resume_workflow_async(cls, workflow_id: str) -> WorkflowHandleAsync[Any]:
+        """Resume a workflow by ID."""
+        await cls._configure_asyncio_thread_pool()
+        await asyncio.to_thread(cls.resume_workflow, workflow_id)
+        return await cls.retrieve_workflow_async(workflow_id)
+
     @classmethod
     def restart_workflow(cls, workflow_id: str) -> WorkflowHandle[Any]:
         """Restart a workflow with a new workflow ID"""
         return cls.fork_workflow(workflow_id, 1)
 
+    @classmethod
+    async def restart_workflow_async(cls, workflow_id: str) -> WorkflowHandleAsync[Any]:
+        """Restart a workflow with a new workflow ID"""
+        return await cls.fork_workflow_async(workflow_id, 1)
+
     @classmethod
     def fork_workflow(
         cls,
@@ -1017,6 +1035,23 @@ class DBOS:
         )
         return cls.retrieve_workflow(new_id)
 
+    @classmethod
+    async def fork_workflow_async(
+        cls,
+        workflow_id: str,
+        start_step: int,
+        *,
+        application_version: Optional[str] = None,
+    ) -> WorkflowHandleAsync[Any]:
+        """Restart a workflow with a new workflow ID from a specific step"""
+        await cls._configure_asyncio_thread_pool()
+        new_id = await asyncio.to_thread(
+            lambda: cls.fork_workflow(
+                workflow_id, start_step, application_version=application_version
+            ).get_workflow_id()
+        )
+        return await cls.retrieve_workflow_async(new_id)
+
     @classmethod
     def list_workflows(
         cls,
@@ -1032,6 +1067,8 @@ class DBOS:
         offset: Optional[int] = None,
         sort_desc: bool = False,
         workflow_id_prefix: Optional[str] = None,
+        load_input: bool = True,
+        load_output: bool = True,
     ) -> List[WorkflowStatus]:
         def fn() -> List[WorkflowStatus]:
             return list_workflows(
@@ -1047,12 +1084,50 @@ class DBOS:
                 offset=offset,
                 sort_desc=sort_desc,
                 workflow_id_prefix=workflow_id_prefix,
+                load_input=load_input,
+                load_output=load_output,
             )
 
         return _get_dbos_instance()._sys_db.call_function_as_step(
             fn, "DBOS.listWorkflows"
         )
 
+    @classmethod
+    async def list_workflows_async(
+        cls,
+        *,
+        workflow_ids: Optional[List[str]] = None,
+        status: Optional[Union[str, List[str]]] = None,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        name: Optional[str] = None,
+        app_version: Optional[str] = None,
+        user: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        sort_desc: bool = False,
+        workflow_id_prefix: Optional[str] = None,
+        load_input: bool = True,
+        load_output: bool = True,
+    ) -> List[WorkflowStatus]:
+        await cls._configure_asyncio_thread_pool()
+        return await asyncio.to_thread(
+            cls.list_workflows,
+            workflow_ids=workflow_ids,
+            status=status,
+            start_time=start_time,
+            end_time=end_time,
+            name=name,
+            app_version=app_version,
+            user=user,
+            limit=limit,
+            offset=offset,
+            sort_desc=sort_desc,
+            workflow_id_prefix=workflow_id_prefix,
+            load_input=load_input,
+            load_output=load_output,
+        )
+
     @classmethod
     def list_queued_workflows(
         cls,
@@ -1065,6 +1140,7 @@ class DBOS:
         limit: Optional[int] = None,
         offset: Optional[int] = None,
         sort_desc: bool = False,
+        load_input: bool = True,
     ) -> List[WorkflowStatus]:
         def fn() -> List[WorkflowStatus]:
             return list_queued_workflows(
@@ -1077,12 +1153,41 @@ class DBOS:
                 limit=limit,
                 offset=offset,
                 sort_desc=sort_desc,
+                load_input=load_input,
             )
 
         return _get_dbos_instance()._sys_db.call_function_as_step(
             fn, "DBOS.listQueuedWorkflows"
         )
 
+    @classmethod
+    async def list_queued_workflows_async(
+        cls,
+        *,
+        queue_name: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        name: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        sort_desc: bool = False,
+        load_input: bool = True,
+    ) -> List[WorkflowStatus]:
+        await cls._configure_asyncio_thread_pool()
+        return await asyncio.to_thread(
+            cls.list_queued_workflows,
+            queue_name=queue_name,
+            status=status,
+            start_time=start_time,
+            end_time=end_time,
+            name=name,
+            limit=limit,
+            offset=offset,
+            sort_desc=sort_desc,
+            load_input=load_input,
+        )
+
     @classmethod
     def list_workflow_steps(cls, workflow_id: str) -> List[StepInfo]:
         def fn() -> List[StepInfo]:
@@ -1094,6 +1199,11 @@ class DBOS:
             fn, "DBOS.listWorkflowSteps"
         )
 
+    @classmethod
+    async def list_workflow_steps_async(cls, workflow_id: str) -> List[StepInfo]:
+        await cls._configure_asyncio_thread_pool()
+        return await asyncio.to_thread(cls.list_workflow_steps, workflow_id)
+
     @classproperty
     def logger(cls) -> Logger:
         """Return the DBOS `Logger` for the current context."""
@@ -1266,31 +1376,3 @@ class DBOSConfiguredInstance:
     def __init__(self, config_name: str) -> None:
         self.config_name = config_name
         DBOS.register_instance(self)
-
-
-# Apps that import DBOS probably don't exit.  If they do, let's see if
-#   it looks like startup was abandoned or a call was forgotten...
-def _dbos_exit_hook() -> None:
-    if _dbos_global_registry is None:
-        # Probably used as or for a support module
-        return
-    if _dbos_global_instance is None:
-        print("DBOS exiting; functions were registered but DBOS() was not called")
-        dbos_logger.warning(
-            "DBOS exiting; functions were registered but DBOS() was not called"
-        )
-        return
-    if not _dbos_global_instance._launched:
-        if _dbos_global_instance.fastapi is not None:
-            # FastAPI lifespan middleware will call launch/destroy, so we can ignore this.
-            # This is likely to happen during fastapi dev runs, where the reloader loads the module multiple times.
-            return
-        print("DBOS exiting; DBOS exists but launch() was not called")
-        dbos_logger.warning("DBOS exiting; DBOS exists but launch() was not called")
-        return
-    # If we get here, we're exiting normally
-    _dbos_global_instance.destroy()
-
-
-# Register the exit hook
-atexit.register(_dbos_exit_hook)

dbos/_dbos_config.py

@@ -23,7 +23,8 @@ class DBOSConfig(TypedDict, total=False):
     Attributes:
         name (str): Application name
         database_url (str): Database connection string
-        sys_db_name (str): System database name
+        system_database_url (str): Connection string for the system database (if different from the application database)
+        sys_db_name (str): System database name (deprecated)
         sys_db_pool_size (int): System database pool size
         db_engine_kwargs (Dict[str, Any]): SQLAlchemy engine kwargs (See https://docs.sqlalchemy.org/en/20/core/engines.html#sqlalchemy.create_engine)
         log_level (str): Log level
@@ -36,6 +37,7 @@ class DBOSConfig(TypedDict, total=False):
 
     name: str
     database_url: Optional[str]
+    system_database_url: Optional[str]
     sys_db_name: Optional[str]
     sys_db_pool_size: Optional[int]
     db_engine_kwargs: Optional[Dict[str, Any]]
@@ -111,6 +113,7 @@ class ConfigFile(TypedDict, total=False):
     runtimeConfig: RuntimeConfig
     database: DatabaseConfig
     database_url: Optional[str]
+    system_database_url: Optional[str]
     telemetry: Optional[TelemetryConfig]
     env: Dict[str, str]
 
@@ -136,6 +139,8 @@ def translate_dbos_config_to_config_file(config: DBOSConfig) -> ConfigFile:
 
     if "database_url" in config:
         translated_config["database_url"] = config.get("database_url")
+    if "system_database_url" in config:
+        translated_config["system_database_url"] = config.get("system_database_url")
 
     # Runtime config
     translated_config["runtimeConfig"] = {"run_admin_server": True}
@@ -488,6 +493,8 @@ def overwrite_config(provided_config: ConfigFile) -> ConfigFile:
             "DBOS_DATABASE_URL environment variable is not set. This is required to connect to the database."
         )
     provided_config["database_url"] = db_url
+    if "system_database_url" in provided_config:
+        del provided_config["system_database_url"]
 
     # Telemetry config
     if "telemetry" not in provided_config or provided_config["telemetry"] is None:
@@ -537,3 +544,19 @@ def overwrite_config(provided_config: ConfigFile) -> ConfigFile:
         del provided_config["env"]
 
     return provided_config
+
+
+def get_system_database_url(config: ConfigFile) -> str:
+    if "system_database_url" in config and config["system_database_url"] is not None:
+        return config["system_database_url"]
+    else:
+        assert config["database_url"] is not None
+        app_db_url = make_url(config["database_url"])
+        if config["database"].get("sys_db_name") is not None:
+            sys_db_name = config["database"]["sys_db_name"]
+        else:
+            assert app_db_url.database is not None
+            sys_db_name = app_db_url.database + SystemSchema.sysdb_suffix
+        return app_db_url.set(database=sys_db_name).render_as_string(
+            hide_password=False
+        )

dbos/_error.py

@@ -55,7 +55,7 @@ class DBOSErrorCode(Enum):
     InitializationError = 3
     WorkflowFunctionNotFound = 4
     NonExistentWorkflowError = 5
-    DeadLetterQueueError = 6
+    MaxRecoveryAttemptsExceeded = 6
     MaxStepRetriesExceeded = 7
     NotAuthorized = 8
     ConflictingWorkflowError = 9
@@ -121,13 +121,13 @@ class DBOSNonExistentWorkflowError(DBOSException):
         )
 
 
-class DBOSDeadLetterQueueError(DBOSException):
-    """Exception raised when a workflow database record does not exist for a given ID."""
+class MaxRecoveryAttemptsExceededError(DBOSException):
+    """Exception raised when a workflow exceeds its max recovery attempts."""
 
     def __init__(self, wf_id: str, max_retries: int):
         super().__init__(
-            f"Workflow {wf_id} has been moved to the dead-letter queue after exceeding the maximum of ${max_retries} retries",
-            dbos_error_code=DBOSErrorCode.DeadLetterQueueError.value,
+            f"Workflow {wf_id} has exceeded its maximum of {max_retries} execution or recovery attempts. Further attempts to execute or recover it will fail. See documentation for details: https://docs.dbos.dev/python/reference/decorators",
+            dbos_error_code=DBOSErrorCode.MaxRecoveryAttemptsExceeded.value,
         )
 
 

dbos/_sys_db.py

@@ -37,12 +37,12 @@ from ._context import get_local_dbos_context
 from ._error import (
     DBOSAwaitedWorkflowCancelledError,
     DBOSConflictingWorkflowError,
-    DBOSDeadLetterQueueError,
     DBOSNonExistentWorkflowError,
     DBOSQueueDeduplicatedError,
     DBOSUnexpectedStepError,
     DBOSWorkflowCancelledError,
     DBOSWorkflowConflictIDError,
+    MaxRecoveryAttemptsExceededError,
 )
 from ._logger import dbos_logger
 from ._schemas.system_database import SystemSchema
@@ -57,20 +57,25 @@ class WorkflowStatusString(Enum):
     PENDING = "PENDING"
     SUCCESS = "SUCCESS"
     ERROR = "ERROR"
-    RETRIES_EXCEEDED = "RETRIES_EXCEEDED"
+    MAX_RECOVERY_ATTEMPTS_EXCEEDED = "MAX_RECOVERY_ATTEMPTS_EXCEEDED"
     CANCELLED = "CANCELLED"
     ENQUEUED = "ENQUEUED"
 
 
 WorkflowStatuses = Literal[
-    "PENDING", "SUCCESS", "ERROR", "RETRIES_EXCEEDED", "CANCELLED", "ENQUEUED"
+    "PENDING",
+    "SUCCESS",
+    "ERROR",
+    "MAX_RECOVERY_ATTEMPTS_EXCEEDED",
+    "CANCELLED",
+    "ENQUEUED",
 ]
 
 
 class WorkflowStatus:
     # The workflow ID
     workflow_id: str
-    # The workflow status. Must be one of ENQUEUED, PENDING, SUCCESS, ERROR, CANCELLED, or RETRIES_EXCEEDED
+    # The workflow status. Must be one of ENQUEUED, PENDING, SUCCESS, ERROR, CANCELLED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED
     status: str
     # The name of the workflow function
     name: str
@@ -331,22 +336,15 @@ class SystemDatabase:
     def __init__(
         self,
         *,
-        database_url: str,
+        system_database_url: str,
         engine_kwargs: Dict[str, Any],
-        sys_db_name: Optional[str] = None,
         debug_mode: bool = False,
     ):
         # Set driver
-        system_db_url = sa.make_url(database_url).set(drivername="postgresql+psycopg")
-        # Resolve system database name
-        sysdb_name = sys_db_name
-        if not sysdb_name:
-            assert system_db_url.database is not None
-            sysdb_name = system_db_url.database + SystemSchema.sysdb_suffix
-        system_db_url = system_db_url.set(database=sysdb_name)
+        url = sa.make_url(system_database_url).set(drivername="postgresql+psycopg")
 
         self.engine = sa.create_engine(
-            system_db_url,
+            url,
             **engine_kwargs,
         )
         self._engine_kwargs = engine_kwargs
@@ -437,7 +435,14 @@ class SystemDatabase:
 
         # Values to update when a row already exists for this workflow
         update_values: dict[str, Any] = {
-            "recovery_attempts": SystemSchema.workflow_status.c.recovery_attempts + 1,
+            "recovery_attempts": sa.case(
+                (
+                    SystemSchema.workflow_status.c.status
+                    != WorkflowStatusString.ENQUEUED.value,
+                    SystemSchema.workflow_status.c.recovery_attempts + 1,
+                ),
+                else_=SystemSchema.workflow_status.c.recovery_attempts,
+            ),
             "updated_at": func.extract("epoch", func.now()) * 1000,
         }
         # Don't update an existing executor ID when enqueueing a workflow.
@@ -515,7 +520,7 @@ class SystemDatabase:
                 raise DBOSConflictingWorkflowError(status["workflow_uuid"], err_msg)
 
             # Every time we start executing a workflow (and thus attempt to insert its status), we increment `recovery_attempts` by 1.
-            # When this number becomes equal to `maxRetries + 1`, we mark the workflow as `RETRIES_EXCEEDED`.
+            # When this number becomes equal to `maxRetries + 1`, we mark the workflow as `MAX_RECOVERY_ATTEMPTS_EXCEEDED`.
             if (
                 (wf_status != "SUCCESS" and wf_status != "ERROR")
                 and max_recovery_attempts is not None
@@ -532,7 +537,7 @@ class SystemDatabase:
                         == WorkflowStatusString.PENDING.value
                     )
                     .values(
-                        status=WorkflowStatusString.RETRIES_EXCEEDED.value,
+                        status=WorkflowStatusString.MAX_RECOVERY_ATTEMPTS_EXCEEDED.value,
                         deduplication_id=None,
                         started_at_epoch_ms=None,
                         queue_name=None,
@@ -541,7 +546,7 @@ class SystemDatabase:
                 conn.execute(dlq_cmd)
                 # Need to commit here because we're throwing an exception
                 conn.commit()
-                raise DBOSDeadLetterQueueError(
+                raise MaxRecoveryAttemptsExceededError(
                     status["workflow_uuid"], max_recovery_attempts
                 )
 
@@ -788,11 +793,17 @@ class SystemDatabase:
                     pass  # CB: I guess we're assuming the WF will show up eventually.
             time.sleep(1)
 
-    def get_workflows(self, input: GetWorkflowsInput) -> List[WorkflowStatus]:
+    def get_workflows(
+        self,
+        input: GetWorkflowsInput,
+        *,
+        load_input: bool = True,
+        load_output: bool = True,
+    ) -> List[WorkflowStatus]:
         """
         Retrieve a list of workflows result and inputs based on the input criteria. The result is a list of external-facing workflow status objects.
         """
-        query = sa.select(
+        load_columns = [
             SystemSchema.workflow_status.c.workflow_uuid,
             SystemSchema.workflow_status.c.status,
             SystemSchema.workflow_status.c.name,
@@ -808,12 +819,16 @@ class SystemDatabase:
             SystemSchema.workflow_status.c.updated_at,
             SystemSchema.workflow_status.c.application_version,
             SystemSchema.workflow_status.c.application_id,
-            SystemSchema.workflow_status.c.inputs,
-            SystemSchema.workflow_status.c.output,
-            SystemSchema.workflow_status.c.error,
             SystemSchema.workflow_status.c.workflow_deadline_epoch_ms,
             SystemSchema.workflow_status.c.workflow_timeout_ms,
-        )
+        ]
+        if load_input:
+            load_columns.append(SystemSchema.workflow_status.c.inputs)
+        if load_output:
+            load_columns.append(SystemSchema.workflow_status.c.output)
+            load_columns.append(SystemSchema.workflow_status.c.error)
+
+        query = sa.select(*load_columns)
         if input.sort_desc:
             query = query.order_by(SystemSchema.workflow_status.c.created_at.desc())
         else:
@@ -880,29 +895,35 @@ class SystemDatabase:
             info.updated_at = row[12]
             info.app_version = row[13]
             info.app_id = row[14]
+            info.workflow_deadline_epoch_ms = row[15]
+            info.workflow_timeout_ms = row[16]
 
+            raw_input = row[17] if load_input else None
+            raw_output = row[18] if load_output else None
+            raw_error = row[19] if load_output else None
             inputs, output, exception = _serialization.safe_deserialize(
                 info.workflow_id,
-                serialized_input=row[15],
-                serialized_output=row[16],
-                serialized_exception=row[17],
+                serialized_input=raw_input,
+                serialized_output=raw_output,
+                serialized_exception=raw_error,
             )
             info.input = inputs
             info.output = output
             info.error = exception
-            info.workflow_deadline_epoch_ms = row[18]
-            info.workflow_timeout_ms = row[19]
 
             infos.append(info)
         return infos
 
     def get_queued_workflows(
-        self, input: GetQueuedWorkflowsInput
+        self,
+        input: GetQueuedWorkflowsInput,
+        *,
+        load_input: bool = True,
     ) -> List[WorkflowStatus]:
         """
         Retrieve a list of queued workflows result and inputs based on the input criteria. The result is a list of external-facing workflow status objects.
         """
-        query = sa.select(
+        load_columns = [
             SystemSchema.workflow_status.c.workflow_uuid,
             SystemSchema.workflow_status.c.status,
             SystemSchema.workflow_status.c.name,
@@ -918,12 +939,13 @@ class SystemDatabase:
             SystemSchema.workflow_status.c.updated_at,
             SystemSchema.workflow_status.c.application_version,
             SystemSchema.workflow_status.c.application_id,
-            SystemSchema.workflow_status.c.inputs,
-            SystemSchema.workflow_status.c.output,
-            SystemSchema.workflow_status.c.error,
             SystemSchema.workflow_status.c.workflow_deadline_epoch_ms,
             SystemSchema.workflow_status.c.workflow_timeout_ms,
-        ).where(
+        ]
+        if load_input:
+            load_columns.append(SystemSchema.workflow_status.c.inputs)
+
+        query = sa.select(*load_columns).where(
             sa.and_(
                 SystemSchema.workflow_status.c.queue_name.isnot(None),
                 SystemSchema.workflow_status.c.status.in_(["ENQUEUED", "PENDING"]),
@@ -984,18 +1006,21 @@ class SystemDatabase:
             info.updated_at = row[12]
             info.app_version = row[13]
             info.app_id = row[14]
+            info.workflow_deadline_epoch_ms = row[15]
+            info.workflow_timeout_ms = row[16]
+
+            raw_input = row[17] if load_input else None
 
+            # Error and Output are not loaded because they should always be None for queued workflows.
             inputs, output, exception = _serialization.safe_deserialize(
                 info.workflow_id,
-                serialized_input=row[15],
-                serialized_output=row[16],
-                serialized_exception=row[17],
+                serialized_input=raw_input,
+                serialized_output=None,
+                serialized_exception=None,
             )
             info.input = inputs
             info.output = output
             info.error = exception
-            info.workflow_deadline_epoch_ms = row[18]
-            info.workflow_timeout_ms = row[19]
 
             infos.append(info)
 

dbos/_workflow_commands.py

@@ -33,6 +33,8 @@ def list_workflows(
     offset: Optional[int] = None,
     sort_desc: bool = False,
     workflow_id_prefix: Optional[str] = None,
+    load_input: bool = True,
+    load_output: bool = True,
 ) -> List[WorkflowStatus]:
     input = GetWorkflowsInput()
     input.workflow_ids = workflow_ids
@@ -47,7 +49,9 @@ def list_workflows(
     input.sort_desc = sort_desc
     input.workflow_id_prefix = workflow_id_prefix
 
-    infos: List[WorkflowStatus] = sys_db.get_workflows(input)
+    infos: List[WorkflowStatus] = sys_db.get_workflows(
+        input, load_input=load_input, load_output=load_output
+    )
 
     return infos
 
@@ -63,6 +67,7 @@ def list_queued_workflows(
     limit: Optional[int] = None,
     offset: Optional[int] = None,
     sort_desc: bool = False,
+    load_input: bool = True,
 ) -> List[WorkflowStatus]:
     input: GetQueuedWorkflowsInput = {
         "queue_name": queue_name,
@@ -75,7 +80,9 @@ def list_queued_workflows(
         "sort_desc": sort_desc,
     }
 
-    infos: List[WorkflowStatus] = sys_db.get_queued_workflows(input)
+    infos: List[WorkflowStatus] = sys_db.get_queued_workflows(
+        input, load_input=load_input
+    )
     return infos
 
 

dbos/cli/cli.py

@@ -21,6 +21,7 @@ from .._client import DBOSClient
 from .._dbos_config import (
     _app_name_to_db_name,
     _is_valid_app_name,
+    get_system_database_url,
     is_valid_database_url,
     load_config,
 )
@@ -294,13 +295,12 @@ def migrate(
     sys_db = None
     try:
         sys_db = SystemDatabase(
-            database_url=connection_string,
+            system_database_url=get_system_database_url(config),
             engine_kwargs={
                 "pool_timeout": 30,
                 "max_overflow": 0,
                 "pool_size": 2,
             },
-            sys_db_name=sys_db_name,
         )
         app_db = ApplicationDatabase(
             database_url=connection_string,
@@ -450,7 +450,7 @@ def list(
         typer.Option(
             "--status",
             "-S",
-            help="Retrieve workflows with this status (PENDING, SUCCESS, ERROR, RETRIES_EXCEEDED, ENQUEUED, or CANCELLED)",
+            help="Retrieve workflows with this status (PENDING, SUCCESS, ERROR, ENQUEUED, CANCELLED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED)",
         ),
     ] = None,
     appversion: Annotated[
@@ -657,7 +657,7 @@ def list_queue(
         typer.Option(
             "--status",
             "-S",
-            help="Retrieve functions with this status (PENDING, SUCCESS, ERROR, RETRIES_EXCEEDED, ENQUEUED, or CANCELLED)",
+            help="Retrieve functions with this status (PENDING, SUCCESS, ERROR, ENQUEUED, CANCELLED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED)",
         ),
     ] = None,
     queue_name: Annotated[

{dbos-1.7.0a5.dist-info → dbos-1.8.0.dist-info}/METADATA

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

{dbos-1.7.0a5.dist-info → dbos-1.8.0.dist-info}/RECORD

@@ -1,23 +1,23 @@
-dbos-1.7.0a5.dist-info/METADATA,sha256=MpwGnaijkOfUai8Dqdrk2NS_wemMnKYf9N1YItrPMpo,13267
-dbos-1.7.0a5.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
-dbos-1.7.0a5.dist-info/entry_points.txt,sha256=_QOQ3tVfEjtjBlr1jS4sHqHya9lI2aIEIWkz8dqYp14,58
-dbos-1.7.0a5.dist-info/licenses/LICENSE,sha256=VGZit_a5-kdw9WT6fY5jxAWVwGQzgLFyPWrcVVUhVNU,1067
+dbos-1.8.0.dist-info/METADATA,sha256=DRFRURSy4U5kkdo7hqLRdpzPwVuRqoXCEt2Qou2EWqI,13265
+dbos-1.8.0.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
+dbos-1.8.0.dist-info/entry_points.txt,sha256=_QOQ3tVfEjtjBlr1jS4sHqHya9lI2aIEIWkz8dqYp14,58
+dbos-1.8.0.dist-info/licenses/LICENSE,sha256=VGZit_a5-kdw9WT6fY5jxAWVwGQzgLFyPWrcVVUhVNU,1067
 dbos/__init__.py,sha256=NssPCubaBxdiKarOWa-wViz1hdJSkmBGcpLX_gQ4NeA,891
 dbos/__main__.py,sha256=G7Exn-MhGrVJVDbgNlpzhfh8WMX_72t3_oJaFT9Lmt8,653
-dbos/_admin_server.py,sha256=S2hFr3m5R3WkbOp3Yz9lWt5iLBfWPnvhYwYLokVax0A,16094
+dbos/_admin_server.py,sha256=e8ELhcDWqR3_PNobnNgUvLGh5lzZq0yFSF6dvtzoQRI,16267
 dbos/_app_db.py,sha256=htblDPfqrpb_uZoFcvaud7cgQ-PDyn6Bn-cBidxdCTA,10603
 dbos/_classproperty.py,sha256=f0X-_BySzn3yFDRKB2JpCbLYQ9tLwt1XftfshvY7CBs,626
-dbos/_client.py,sha256=DeiJHo5fTedWsipr7qlQQIcDmVAPjzzX94X01121oQM,14780
-dbos/_conductor/conductor.py,sha256=y_T-8kEHwKWt6W8LtcFMctB_6EvYFWsuGLxiFuuKKBU,23702
-dbos/_conductor/protocol.py,sha256=DOTprPSd7oHDcvwWSyZpnlPds_JfILtcKzHZa-qBsF4,7330
-dbos/_context.py,sha256=zhje6jObpBcRALYfHyyIEumHtk_enl_PxLl01j4oDME,24897
+dbos/_client.py,sha256=6ReC_VF1JhscxtMjmjwJH_X7HV0L9Zoj_OiYhs4el40,15517
+dbos/_conductor/conductor.py,sha256=3E_hL3c9g9yWqKZkvI6KA0-ZzPMPRo06TOzT1esMiek,24114
+dbos/_conductor/protocol.py,sha256=q3rgLxINFtWFigdOONc-4gX4vn66UmMlJQD6Kj8LnL4,7420
+dbos/_context.py,sha256=0vFtLAk3WF5BQYIYNFImDRBppKO2CTKOSy51zQC-Cu8,25723
 dbos/_core.py,sha256=kRY2PXVryfpwjbOCmgzPA_-qNsFmRMLi-CxYCnyp1V8,49495
 dbos/_croniter.py,sha256=XHAyUyibs_59sJQfSNWkP7rqQY6_XrlfuuCxk4jYqek,47559
-dbos/_dbos.py,sha256=BprKIGPT-QDeoxtKM6kjRUK9dyF8sPCFfHIyIt0u7CE,48142
-dbos/_dbos_config.py,sha256=JUG4V1rrP0p1AYESgih4ea80qOH_13UsgoIIm8X84pw,20562
+dbos/_dbos.py,sha256=ByU8F1ueT2WTjT9SW518FfRL300kpK_6y8n7WWSwtOQ,50869
+dbos/_dbos_config.py,sha256=TWIbGCWl_8o3l0Y2IzrL1q9mTYl_vVeZDjYJMDXCPVU,21676
 dbos/_debug.py,sha256=99j2SChWmCPAlZoDmjsJGe77tpU2LEa8E2TtLAnnh7o,1831
 dbos/_docker_pg_helper.py,sha256=tLJXWqZ4S-ExcaPnxg_i6cVxL6ZxrYlZjaGsklY-s2I,6115
-dbos/_error.py,sha256=nS7KuXJHhuNXZRErxdEUGT38Hb0VPyxNwSyADiVpHcE,8581
+dbos/_error.py,sha256=2_2ve3qN0BLhFWMmd3aD9At54tIMCeh8TqHtVcEEVQo,8705
 dbos/_event_loop.py,sha256=cvaFN9-II3MsHEOq8QoICc_8qSKrjikMlLfuhC3Y8Dk,2923
 dbos/_fastapi.py,sha256=T7YlVY77ASqyTqq0aAPclZ9YzlXdGTT0lEYSwSgt1EE,3151
 dbos/_flask.py,sha256=Npnakt-a3W5OykONFRkDRnumaDhTQmA0NPdUCGRYKXE,1652
@@ -49,7 +49,7 @@ dbos/_schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbos/_schemas/application_database.py,sha256=SypAS9l9EsaBHFn9FR8jmnqt01M74d9AF1AMa4m2hhI,1040
 dbos/_schemas/system_database.py,sha256=rbFKggONdvvbb45InvGz0TM6a7c-Ux9dcaL-h_7Z7pU,4438
 dbos/_serialization.py,sha256=bWuwhXSQcGmiazvhJHA5gwhrRWxtmFmcCFQSDJnqqkU,3666
-dbos/_sys_db.py,sha256=PaWa5Y8ublSMqPQXCHvYqln01cGf2LtPdXaLEHJq500,80653
+dbos/_sys_db.py,sha256=0GAWwxxelTxukYHQIwLr9JOlwy0vENkxbyGcfnv8_Ko,81321
 dbos/_templates/dbos-db-starter/README.md,sha256=GhxhBj42wjTt1fWEtwNriHbJuKb66Vzu89G4pxNHw2g,930
 dbos/_templates/dbos-db-starter/__package/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbos/_templates/dbos-db-starter/__package/main.py.dbos,sha256=aQnBPSSQpkB8ERfhf7gB7P9tsU6OPKhZscfeh0yiaD8,2702
@@ -62,11 +62,11 @@ dbos/_templates/dbos-db-starter/migrations/versions/2024_07_31_180642_init.py,sh
 dbos/_templates/dbos-db-starter/start_postgres_docker.py,sha256=lQVLlYO5YkhGPEgPqwGc7Y8uDKse9HsWv5fynJEFJHM,1681
 dbos/_tracer.py,sha256=RnlcaOJEx_58hr2J9L9g6E7gjAHAeEtEGugJZmCwNfQ,2963
 dbos/_utils.py,sha256=uywq1QrjMwy17btjxW4bES49povlQwYwYbvKwMT6C2U,1575
-dbos/_workflow_commands.py,sha256=4QCs7ziQ9T457tqfaNFwiXd6mDisr-ZK__skz1Uteyg,4648
+dbos/_workflow_commands.py,sha256=EmmAaQfRWeOZm_WPTznuU-O3he3jiSzzT9VpYrhxugE,4835
 dbos/cli/_github_init.py,sha256=Y_bDF9gfO2jB1id4FV5h1oIxEJRWyqVjhb7bNEa5nQ0,3224
 dbos/cli/_template_init.py,sha256=7JBcpMqP1r2mfCnvWatu33z8ctEGHJarlZYKgB83cXE,2972
-dbos/cli/cli.py,sha256=IcfaX4rrSrk6f24S2jrlR33snYMyNyEIx_lNQtuVr2E,22081
+dbos/cli/cli.py,sha256=TwiaWr5zZrXOyhgv7OgkWzVA3y8znCj2L6i0sb91--0,22122
 dbos/dbos-config.schema.json,sha256=CjaspeYmOkx6Ip_pcxtmfXJTn_YGdSx_0pcPBF7KZmo,6060
 dbos/py.typed,sha256=QfzXT1Ktfk3Rj84akygc7_42z0lRpCq0Ilh8OXI6Zas,44
 version/__init__.py,sha256=L4sNxecRuqdtSFdpUGX3TtBi9KL3k7YsZVIvv-fv9-A,1678
-dbos-1.7.0a5.dist-info/RECORD,,
+dbos-1.8.0.dist-info/RECORD,,

{dbos-1.7.0a5.dist-info → dbos-1.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.4)
+Generator: pdm-backend (2.4.5)
 Root-Is-Purelib: true
 Tag: py3-none-any