adds priority column

Author: pcrespov

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

@@ -2,35 +2,42 @@
 
 from .base import metadata
 
-#
-# tags: a way to mark any entity (e.g. a project, ...)
-#       this can be used to perform operations as filter, select, compare, etc
-#
 tags = sa.Table(
+    #
+    # A way to mark any entity (e.g. a project, ...)
+    # this can be used to perform operations as filter, select, compare, etc
+    #
     "tags",
     metadata,
     sa.Column(
         "id",
         sa.BigInteger(),
         nullable=False,
         primary_key=True,
+        doc="Unique identifier for each tag.",
     ),
-    sa.Column(
-        "name",
-        sa.String(),
-        nullable=False,
-        doc="display name",
-    ),
+    sa.Column("name", sa.String(), nullable=False, doc="The display name of the tag."),
     sa.Column(
         "description",
         sa.String(),
         nullable=True,
-        doc="description displayed",
+        doc="A brief description displayed for the tag.",
     ),
     sa.Column(
         "color",
         sa.String(),
         nullable=False,
-        doc="Hex color (see https://www.color-hex.com/)",
+        doc="Hexadecimal color code representing the tag (e.g., #FF5733).",
+    ),
+    sa.Column(
+        "priority",
+        sa.Integer(),
+        nullable=True,
+        doc=(
+            "Explicit ordering priority when displaying tags. "
+            "Tags with a lower value are displayed first. "
+            "If NULL, tags are considered to have the lowest priority and "
+            "are displayed after non-NULL values, ordered by their ID (reflecting creation order)."
+        ),
     ),
 )

packages/postgres-database/src/simcore_postgres_database/utils_tags.py

@@ -88,14 +88,17 @@ async def create(
         read: bool = True,
         write: bool = True,
         delete: bool = True,
+        priority: int | None = None,
     ) -> TagDict:
         """Creates tag and defaults to full access rights to `user_id`"""
-        values = {
+        values: dict[str, str | int] = {
             "name": name,
             "color": color,
         }
         if description:
             values["description"] = description
+        if priority is not None:
+            values["priority"] = priority
 
         async with transaction_context(self.engine, connection) as conn:
             # insert new tag
@@ -184,7 +187,7 @@ async def update(
             updates = {
                 name: value
                 for name, value in fields.items()
-                if name in {"name", "color", "description"}
+                if name in {"name", "color", "description", "priority"}
             }
 
             if not updates:

packages/postgres-database/src/simcore_postgres_database/utils_tags_sql.py

@@ -89,6 +89,7 @@ def list_tags_stmt(*, user_id: int):
             )
         )
         .group_by(tags.c.id)  # makes it tag.id uniqueness
+        .order_by(tags.c.priority.nulls_last())
         .order_by(tags.c.id)
     )