Spaces:
Sleeping
Sleeping
File size: 14,920 Bytes
c96b98a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | import time
from typing import Optional, List
try:
from sqlalchemy import create_engine, Engine, MetaData, Table, Column, String, BigInteger, inspect, Index
from sqlalchemy.dialects import postgresql
from sqlalchemy.orm import sessionmaker, scoped_session
from sqlalchemy.sql.expression import select, text
except ImportError:
raise ImportError("`sqlalchemy` not installed. Please install it with `pip install sqlalchemy`")
from phi.workflow import WorkflowSession
from phi.storage.workflow.base import WorkflowStorage
from phi.utils.log import logger
class PgWorkflowStorage(WorkflowStorage):
def __init__(
self,
table_name: str,
schema: Optional[str] = "ai",
db_url: Optional[str] = None,
db_engine: Optional[Engine] = None,
schema_version: int = 1,
auto_upgrade_schema: bool = False,
):
"""
This class provides workflow storage using a PostgreSQL database.
The following order is used to determine the database connection:
1. Use the db_engine if provided
2. Use the db_url
3. Raise an error if neither is provided
Args:
table_name (str): The name of the table to store Workflow sessions.
schema (Optional[str]): The schema to use for the table. Defaults to "ai".
db_url (Optional[str]): The database URL to connect to.
db_engine (Optional[Engine]): The SQLAlchemy database engine to use.
schema_version (int): Version of the schema. Defaults to 1.
auto_upgrade_schema (bool): Whether to automatically upgrade the schema.
Raises:
ValueError: If neither db_url nor db_engine is provided.
"""
_engine: Optional[Engine] = db_engine
if _engine is None and db_url is not None:
_engine = create_engine(db_url)
if _engine is None:
raise ValueError("Must provide either db_url or db_engine")
# Database attributes
self.table_name: str = table_name
self.schema: Optional[str] = schema
self.db_url: Optional[str] = db_url
self.db_engine: Engine = _engine
self.metadata: MetaData = MetaData(schema=self.schema)
self.inspector = inspect(self.db_engine)
# Table schema version
self.schema_version: int = schema_version
# Automatically upgrade schema if True
self.auto_upgrade_schema: bool = auto_upgrade_schema
# Database session
self.Session: scoped_session = scoped_session(sessionmaker(bind=self.db_engine))
# Database table for storage
self.table: Table = self.get_table()
logger.debug(f"Created PgWorkflowStorage: '{self.schema}.{self.table_name}'")
def get_table_v1(self) -> Table:
"""
Define the table schema for version 1.
Returns:
Table: SQLAlchemy Table object representing the schema.
"""
table = Table(
self.table_name,
self.metadata,
# Session UUID: Primary Key
Column("session_id", String, primary_key=True),
# ID of the workflow that this session is associated with
Column("workflow_id", String),
# ID of the user interacting with this workflow
Column("user_id", String),
# Workflow Memory
Column("memory", postgresql.JSONB),
# Workflow Metadata
Column("workflow_data", postgresql.JSONB),
# User Metadata
Column("user_data", postgresql.JSONB),
# Session Metadata
Column("session_data", postgresql.JSONB),
# The Unix timestamp of when this session was created.
Column("created_at", BigInteger, default=lambda: int(time.time())),
# The Unix timestamp of when this session was last updated.
Column("updated_at", BigInteger, onupdate=lambda: int(time.time())),
extend_existing=True,
)
# Add indexes
Index(f"idx_{self.table_name}_session_id", table.c.session_id)
Index(f"idx_{self.table_name}_workflow_id", table.c.workflow_id)
Index(f"idx_{self.table_name}_user_id", table.c.user_id)
return table
def get_table(self) -> Table:
"""
Get the table schema based on the schema version.
Returns:
Table: SQLAlchemy Table object for the current schema version.
Raises:
ValueError: If an unsupported schema version is specified.
"""
if self.schema_version == 1:
return self.get_table_v1()
else:
raise ValueError(f"Unsupported schema version: {self.schema_version}")
def table_exists(self) -> bool:
"""
Check if the table exists in the database.
Returns:
bool: True if the table exists, False otherwise.
"""
logger.debug(f"Checking if table exists: {self.table.name}")
try:
return self.inspector.has_table(self.table.name, schema=self.schema)
except Exception as e:
logger.error(f"Error checking if table exists: {e}")
return False
def create(self) -> None:
"""
Create the table if it doesn't exist.
"""
if not self.table_exists():
try:
with self.Session() as sess, sess.begin():
if self.schema is not None:
logger.debug(f"Creating schema: {self.schema}")
sess.execute(text(f"CREATE SCHEMA IF NOT EXISTS {self.schema};"))
logger.debug(f"Creating table: {self.table_name}")
self.table.create(self.db_engine, checkfirst=True)
except Exception as e:
logger.error(f"Could not create table: '{self.table.fullname}': {e}")
def read(self, session_id: str, user_id: Optional[str] = None) -> Optional[WorkflowSession]:
"""
Read a WorkflowSession from the database.
Args:
session_id (str): The ID of the session to read.
user_id (Optional[str]): The ID of the user associated with the session.
Returns:
Optional[WorkflowSession]: The WorkflowSession object if found, None otherwise.
"""
try:
with self.Session() as sess:
stmt = select(self.table).where(self.table.c.session_id == session_id)
if user_id:
stmt = stmt.where(self.table.c.user_id == user_id)
result = sess.execute(stmt).fetchone()
return WorkflowSession.model_validate(result) if result is not None else None
except Exception as e:
logger.debug(f"Exception reading from table: {e}")
logger.debug(f"Table does not exist: {self.table.name}")
logger.debug("Creating table for future transactions")
self.create()
return None
def get_all_session_ids(self, user_id: Optional[str] = None, workflow_id: Optional[str] = None) -> List[str]:
"""
Get all session IDs, optionally filtered by user_id and/or workflow_id.
Args:
user_id (Optional[str]): The ID of the user to filter by.
workflow_id (Optional[str]): The ID of the workflow to filter by.
Returns:
List[str]: List of session IDs matching the criteria.
"""
try:
with self.Session() as sess, sess.begin():
# get all session_ids
stmt = select(self.table.c.session_id)
if user_id is not None or user_id != "":
stmt = stmt.where(self.table.c.user_id == user_id)
if workflow_id is not None:
stmt = stmt.where(self.table.c.workflow_id == workflow_id)
# order by created_at desc
stmt = stmt.order_by(self.table.c.created_at.desc())
# execute query
rows = sess.execute(stmt).fetchall()
return [row[0] for row in rows] if rows is not None else []
except Exception as e:
logger.debug(f"Exception reading from table: {e}")
logger.debug(f"Table does not exist: {self.table.name}")
logger.debug("Creating table for future transactions")
self.create()
return []
def get_all_sessions(
self, user_id: Optional[str] = None, workflow_id: Optional[str] = None
) -> List[WorkflowSession]:
"""
Get all sessions, optionally filtered by user_id and/or workflow_id.
Args:
user_id (Optional[str]): The ID of the user to filter by.
workflow_id (Optional[str]): The ID of the workflow to filter by.
Returns:
List[WorkflowSession]: List of AgentSession objects matching the criteria.
"""
try:
with self.Session() as sess, sess.begin():
# get all sessions
stmt = select(self.table)
if user_id is not None and user_id != "":
stmt = stmt.where(self.table.c.user_id == user_id)
if workflow_id is not None:
stmt = stmt.where(self.table.c.workflow_id == workflow_id)
# order by created_at desc
stmt = stmt.order_by(self.table.c.created_at.desc())
# execute query
rows = sess.execute(stmt).fetchall()
return [WorkflowSession.model_validate(row) for row in rows] if rows is not None else []
except Exception as e:
logger.debug(f"Exception reading from table: {e}")
logger.debug(f"Table does not exist: {self.table.name}")
logger.debug("Creating table for future transactions")
self.create()
return []
def upsert(self, session: WorkflowSession, create_and_retry: bool = True) -> Optional[WorkflowSession]:
"""
Insert or update a WorkflowSession in the database.
Args:
session (WorkflowSession): The WorkflowSession object to upsert.
create_and_retry (bool): Retry upsert if table does not exist.
Returns:
Optional[WorkflowSession]: The upserted WorkflowSession object.
"""
try:
with self.Session() as sess, sess.begin():
# Create an insert statement
stmt = postgresql.insert(self.table).values(
session_id=session.session_id,
workflow_id=session.workflow_id,
user_id=session.user_id,
memory=session.memory,
workflow_data=session.workflow_data,
user_data=session.user_data,
session_data=session.session_data,
)
# Define the upsert if the session_id already exists
# See: https://docs.sqlalchemy.org/en/20/dialects/postgresql.html#postgresql-insert-on-conflict
stmt = stmt.on_conflict_do_update(
index_elements=["session_id"],
set_=dict(
workflow_id=session.workflow_id,
user_id=session.user_id,
memory=session.memory,
workflow_data=session.workflow_data,
user_data=session.user_data,
session_data=session.session_data,
updated_at=int(time.time()),
), # The updated value for each column
)
sess.execute(stmt)
except Exception as e:
logger.debug(f"Exception upserting into table: {e}")
if create_and_retry and not self.table_exists():
logger.debug(f"Table does not exist: {self.table.name}")
logger.debug("Creating table and retrying upsert")
self.create()
return self.upsert(session, create_and_retry=False)
return None
return self.read(session_id=session.session_id)
def delete_session(self, session_id: Optional[str] = None):
"""
Delete a workflow session from the database.
Args:
session_id (Optional[str]): The ID of the session to delete.
Raises:
ValueError: If session_id is not provided.
"""
if session_id is None:
logger.warning("No session_id provided for deletion.")
return
try:
with self.Session() as sess, sess.begin():
# Delete the session with the given session_id
delete_stmt = self.table.delete().where(self.table.c.session_id == session_id)
result = sess.execute(delete_stmt)
if result.rowcount == 0:
logger.debug(f"No session found with session_id: {session_id}")
else:
logger.debug(f"Successfully deleted session with session_id: {session_id}")
except Exception as e:
logger.error(f"Error deleting session: {e}")
def drop(self) -> None:
"""
Drop the table from the database if it exists.
"""
if self.table_exists():
logger.debug(f"Deleting table: {self.table_name}")
self.table.drop(self.db_engine)
def upgrade_schema(self) -> None:
"""
Upgrade the schema of the workflow storage table.
This method is currently a placeholder and does not perform any actions.
"""
pass
def __deepcopy__(self, memo):
"""
Create a deep copy of the PgWorkflowStorage instance, handling unpickleable attributes.
Args:
memo (dict): A dictionary of objects already copied during the current copying pass.
Returns:
PostgresWorkflowStorage: A deep-copied instance of PostgresWorkflowStorage.
"""
from copy import deepcopy
# Create a new instance without calling __init__
cls = self.__class__
copied_obj = cls.__new__(cls)
memo[id(self)] = copied_obj
# Deep copy attributes
for k, v in self.__dict__.items():
if k in {"metadata", "table", "inspector"}:
continue
# Reuse db_engine and Session without copying
elif k in {"db_engine", "Session"}:
setattr(copied_obj, k, v)
else:
setattr(copied_obj, k, deepcopy(v, memo))
# Recreate metadata and table for the copied instance
copied_obj.metadata = MetaData(schema=copied_obj.schema)
copied_obj.inspector = inspect(copied_obj.db_engine)
copied_obj.table = copied_obj.get_table()
return copied_obj
|