applies everywhere

Author: pcrespov

packages/postgres-database/src/simcore_postgres_database/models/_common.py

@@ -5,13 +5,15 @@
 from ..constants import DECIMAL_PLACES
 
 
-class ReferentialAction:
-    # SEE https://docs.sqlalchemy.org/en/20/orm/cascades.html
-    CASCADE = "CASCADE"
-    SET_NULL = "SET NULL"
-    SET_DEFAULT = "SET DEFAULT"
-    RESTRICT = "RESTRICT"
-    NO_ACTION = "NO ACTION"
+class RefActions:
+    """Referential actions for `ON UPDATE`, `ON DELETE`"""
+
+    # SEE https://docs.sqlalchemy.org/en/20/core/constraints.html#on-update-on-delete
+    CASCADE: Final[str] = "CASCADE"
+    SET_NULL: Final[str] = "SET NULL"
+    SET_DEFAULT: Final[str] = "SET DEFAULT"
+    RESTRICT: Final[str] = "RESTRICT"
+    NO_ACTION: Final[str] = "NO ACTION"
 
 
 def column_created_datetime(*, timezone: bool = True) -> sa.Column:
@@ -43,8 +45,8 @@ def column_created_by_user(
         sa.Integer,
         sa.ForeignKey(
             users_table.c.id,
-            onupdate=ReferentialAction.CASCADE,
-            ondelete=ReferentialAction.SET_NULL,
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.SET_NULL,
         ),
         nullable=not required,
         doc="Who created this row at `created`",
@@ -59,8 +61,8 @@ def column_modified_by_user(
         sa.Integer,
         sa.ForeignKey(
             users_table.c.id,
-            onupdate=ReferentialAction.CASCADE,
-            ondelete=ReferentialAction.SET_NULL,
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.SET_NULL,
         ),
         nullable=not required,
         doc="Who modified this row at `modified`",
@@ -83,8 +85,8 @@ def column_trashed_by_user(resource_name: str, users_table: sa.Table) -> sa.Colu
         sa.BigInteger,
         sa.ForeignKey(
             users_table.c.id,
-            onupdate=ReferentialAction.CASCADE,
-            ondelete=ReferentialAction.SET_NULL,
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.SET_NULL,
             name=f"fk_{resource_name}_trashed_by_user_id",
         ),
         nullable=True,

packages/postgres-database/src/simcore_postgres_database/models/api_keys.py

@@ -13,6 +13,7 @@
 import sqlalchemy as sa
 from sqlalchemy.sql import func
 
+from ._common import RefActions
 from .base import metadata
 from .users import users
 
@@ -35,7 +36,7 @@
     sa.Column(
         "user_id",
         sa.BigInteger(),
-        sa.ForeignKey(users.c.id, ondelete="CASCADE"),
+        sa.ForeignKey(users.c.id, ondelete=RefActions.CASCADE),
         nullable=False,
         doc="Identified user",
     ),
@@ -44,8 +45,8 @@
         sa.String,
         sa.ForeignKey(
             "products.name",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
             name="fk_api_keys_product_name",
         ),
         nullable=False,

packages/postgres-database/src/simcore_postgres_database/models/classifiers.py

@@ -11,6 +11,7 @@
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
 
+from ._common import RefActions
 from .base import metadata
 
 group_classifiers = sa.Table(
@@ -32,8 +33,8 @@
         sa.ForeignKey(
             "groups.gid",
             name="fk_group_classifiers_gid_to_groups_gid",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         unique=True,  # Every Group can ONLY have one set of classifiers
     ),

packages/postgres-database/src/simcore_postgres_database/models/cluster_to_groups.py

@@ -1,6 +1,7 @@
 import sqlalchemy as sa
 from sqlalchemy.sql import expression, func
 
+from ._common import RefActions
 from .base import metadata
 from .clusters import clusters
 from .groups import groups
@@ -14,8 +15,8 @@
         sa.ForeignKey(
             clusters.c.id,
             name="fk_cluster_to_groups_id_clusters",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         doc="Cluster unique ID",
     ),
@@ -25,8 +26,8 @@
         sa.ForeignKey(
             groups.c.gid,
             name="fk_cluster_to_groups_gid_groups",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         doc="Group unique IDentifier",
     ),

packages/postgres-database/src/simcore_postgres_database/models/clusters.py

@@ -4,6 +4,7 @@
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
 
+from ._common import RefActions
 from .base import metadata
 
 
@@ -36,8 +37,8 @@ class ClusterType(Enum):
         sa.ForeignKey(
             "groups.gid",
             name="fk_clusters_gid_groups",
-            onupdate="CASCADE",
-            ondelete="RESTRICT",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.RESTRICT,
         ),
         nullable=False,
         doc="Identifier of the group that owns this cluster",

packages/postgres-database/src/simcore_postgres_database/models/comp_runs.py

@@ -5,6 +5,7 @@
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
 
+from ._common import RefActions
 from .base import metadata
 from .comp_pipeline import StateType
 
@@ -26,8 +27,8 @@
         sa.ForeignKey(
             "projects.uuid",
             name="fk_comp_runs_project_uuid_projects",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         nullable=False,
         doc="The project uuid with which the run entry is associated",
@@ -38,8 +39,8 @@
         sa.ForeignKey(
             "users.id",
             name="fk_comp_runs_user_id_users",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         nullable=False,
         doc="The user id with which the run entry is associated",
@@ -50,8 +51,8 @@
         sa.ForeignKey(
             "clusters.id",
             name="fk_comp_runs_cluster_id_clusters",
-            onupdate="CASCADE",
-            ondelete="SET NULL",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.SET_NULL,
         ),
         nullable=True,
         doc="The cluster id on which the run entry is associated, if NULL or 0 uses the default",

packages/postgres-database/src/simcore_postgres_database/models/confirmations.py

@@ -9,6 +9,7 @@
 
 import sqlalchemy as sa
 
+from ._common import RefActions
 from .base import metadata
 from .users import users
 
@@ -57,6 +58,9 @@ class ConfirmationAction(enum.Enum):
     # constraints ----------------
     sa.PrimaryKeyConstraint("code", name="confirmation_code"),
     sa.ForeignKeyConstraint(
-        ["user_id"], [users.c.id], name="user_confirmation_fkey", ondelete="CASCADE"
+        ["user_id"],
+        [users.c.id],
+        name="user_confirmation_fkey",
+        ondelete=RefActions.CASCADE,
     ),
 )

packages/postgres-database/src/simcore_postgres_database/models/folders_v2.py

@@ -1,7 +1,7 @@
 import sqlalchemy as sa
 from sqlalchemy.sql import expression
 
-from ._common import column_created_datetime, column_modified_datetime
+from ._common import RefActions, column_created_datetime, column_modified_datetime
 from .base import metadata
 from .workspaces import workspaces
 
@@ -35,8 +35,8 @@
         sa.String,
         sa.ForeignKey(
             "products.name",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
             name="fk_new_folders_to_products_name",
         ),
         nullable=False,
@@ -46,8 +46,8 @@
         sa.BigInteger,
         sa.ForeignKey(
             "users.id",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
             name="fk_folders_to_user_id",
         ),
         nullable=True,
@@ -57,8 +57,8 @@
         sa.BigInteger,
         sa.ForeignKey(
             workspaces.c.workspace_id,
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
             name="fk_folders_to_workspace_id",
         ),
         nullable=True,
@@ -69,7 +69,7 @@
         sa.ForeignKey(
             "groups.gid",
             name="fk_new_folders_to_groups_gid",
-            ondelete="SET NULL",
+            ondelete=RefActions.SET_NULL,
         ),
         nullable=True,
     ),

packages/postgres-database/src/simcore_postgres_database/models/groups.py

@@ -10,6 +10,7 @@
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
 
+from ._common import RefActions
 from .base import metadata
 
 
@@ -86,8 +87,8 @@ class GroupType(enum.Enum):
         sa.ForeignKey(
             "users.id",
             name="fk_user_to_groups_id_users",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         doc="User unique IDentifier",
     ),
@@ -97,8 +98,8 @@ class GroupType(enum.Enum):
         sa.ForeignKey(
             "groups.gid",
             name="fk_user_to_groups_gid_groups",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
         ),
         doc="Group unique IDentifier",
     ),

packages/postgres-database/src/simcore_postgres_database/models/groups_extra_properties.py

@@ -1,21 +1,19 @@
 import sqlalchemy as sa
 
-from ._common import column_created_datetime, column_modified_datetime
+from ._common import RefActions, column_created_datetime, column_modified_datetime
 from .base import metadata
 
-#
-# groups_extra_properties: Maps internet access permissions to groups
-#
 groups_extra_properties = sa.Table(
     "groups_extra_properties",
+    # groups_extra_properties: Maps internet access permissions to groups
     metadata,
     sa.Column(
         "group_id",
         sa.BigInteger,
         sa.ForeignKey(
             "groups.gid",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
             name="fk_groups_extra_properties_to_group_group_id",
         ),
         nullable=False,
@@ -26,8 +24,8 @@
         sa.VARCHAR,
         sa.ForeignKey(
             "products.name",
-            onupdate="CASCADE",
-            ondelete="CASCADE",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
             name="fk_groups_extra_properties_to_products_name",
         ),
         nullable=False,