Database migration for tool request API.

lib/galaxy/model/migrations/alembic/versions_gxy/7ffd33d5d144_implement_structured_tool_state.py

@@ -0,0 +1,96 @@
+"""implement structured tool state
+
+Revision ID: 7ffd33d5d144
+Revises: eee9229a9765
+Create Date: 2022-11-09 15:53:11.451185
+
+"""
+
+from sqlalchemy import (
+    Column,
+    Integer,
+    String,
+)
+
+from galaxy.model.custom_types import JSONType
+from galaxy.model.database_object_names import build_index_name
+from galaxy.model.migrations.util import (
+    add_column,
+    create_foreign_key,
+    create_index,
+    create_table,
+    drop_column,
+    drop_index,
+    drop_table,
+    transaction,
+)
+
+# revision identifiers, used by Alembic.
+revision = "7ffd33d5d144"
+down_revision = "eee9229a9765"
+branch_labels = None
+depends_on = None
+
+job_table_name = "job"
+tool_source_table_name = "tool_source"
+tool_request_table_name = "tool_request"
+request_column_name = "tool_request_id"
+job_request_index_name = build_index_name(job_table_name, request_column_name)
+
+
+def upgrade():
+    with transaction():
+        create_table(
+            tool_source_table_name,
+            Column("id", Integer, primary_key=True),
+            Column("hash", String(255), index=True),
+            Column("source", JSONType),
+        )
+        create_table(
+            tool_request_table_name,
+            Column("id", Integer, primary_key=True),
+            Column("request", JSONType),
+            Column("state", String(32)),
+            Column("state_message", JSONType),
+            Column("tool_source_id", Integer, index=True),
+            Column("history_id", Integer, index=True),
+        )
+
+        create_foreign_key(
+            "foreign_key_tool_source_id",
+            tool_request_table_name,
+            tool_source_table_name,
+            ["tool_source_id"],
+            ["id"],
+        )
+
+        create_foreign_key(
+            "foreign_key_history_id",
+            tool_request_table_name,
+            "history",
+            ["history_id"],
+            ["id"],
+        )
+
+        add_column(
+            job_table_name,
+            Column(request_column_name, Integer, default=None),
+        )
+
+        create_foreign_key(
+            "foreign_key_tool_request_id",
+            job_table_name,
+            tool_request_table_name,
+            ["tool_request_id"],
+            ["id"],
+        )
+
+        create_index(job_request_index_name, job_table_name, [request_column_name])
+
+
+def downgrade():
+    with transaction():
+        drop_index(job_request_index_name, job_table_name)
+        drop_column(job_table_name, request_column_name)
+        drop_table(tool_request_table_name)
+        drop_table(tool_source_table_name)