doc something

Author: pcrespov

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

@@ -1,10 +1,15 @@
-""" User's confirmations table
+"""User's confirmations table
 
-    - Keeps a list of tokens to identify an action (registration, invitation, reset, etc) authorized
-    by link to a a user in the framework
-    - These tokens have an expiration date defined by configuration
+- Keeps a list of tokens to identify an action (registration, invitation, reset, etc) authorized
+by link to a a user in the framework
+- These tokens have an expiration date defined by configuration
 
+Migration strategy:
+- The primary key is `code`, which is unique and sufficient for migration.
+- Ensure `user_id` foreign key references are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
 """
+
 import enum
 
 import sqlalchemy as sa

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

@@ -1,9 +1,12 @@
-""" Groups table
+"""Groups table
 
-    - List of groups in the framework
-    - Groups have a ID, name and a list of users that belong to the group
-"""
+- Represents user groups in the system.
 
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references (if any) are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
 
 import sqlalchemy as sa
 from common_library.groups_enums import GroupType

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

@@ -1,5 +1,11 @@
-""" Collection of jinja2 templates for customizable docs (e.g. emails, sites)
+"""Jinja2 templates table
 
+- Collection of jinja2 templates for customizable docs (e.g. emails, sites)
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- No foreign key dependencies exist.
+- No additional changes are required; this table can be migrated as is.
 """
 
 import sqlalchemy as sa

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

@@ -1,8 +1,13 @@
 """Products table
 
+- Represents products in the system.
 - List of products served by the simcore platform
 - Products have a name and an associated host (defined by a regex)
 - Every product has a front-end with exactly the same name
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references (if any) are valid in the target database.
 """
 
 import json
@@ -122,6 +127,7 @@ class ProductLoginSettingsDict(TypedDict, total=False):
 # NOTE: a default entry is created in the table Product
 # see packages/postgres-database/src/simcore_postgres_database/migration/versions/350103a7efbd_modified_products_table.py
 
+
 products = sa.Table(
     "products",
     metadata,

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

@@ -1,3 +1,13 @@
+"""Products to templates table
+
+- Links products to Jinja2 templates.
+
+Migration strategy:
+- Composite primary key (`product_id`, `template_id`) is unique and sufficient for migration.
+- Ensure foreign key references to `products` and `jinja2_templates` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from ._common import (

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

@@ -1,6 +1,13 @@
-""" Projects table
+"""Projects table
 
+- Represents user projects in the system.
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references (if any) are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
 """
+
 import enum
 
 import sqlalchemy as sa

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

@@ -1,3 +1,13 @@
+"""Projects comments table
+
+- Stores comments associated with projects.
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references to `projects` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from ._common import RefActions, column_created_datetime, column_modified_datetime

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

@@ -1,3 +1,13 @@
+"""Projects networks table
+
+- Represents networks associated with projects.
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references to `projects` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 from sqlalchemy.dialects.postgresql import JSONB
 

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

@@ -1,7 +1,13 @@
-""" Groups table
+"""Projects nodes table
 
-    - List of groups in the framework
-    - Groups have a ID, name and a list of users that belong to the group
+- Represents nodes within projects.
+- List of groups in the framework
+- Groups have a ID, name and a list of users that belong to the group
+
+Migration strategy:
+- The primary key is `node_id`, which is unique and sufficient for migration.
+- Ensure foreign key references to `projects` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
 """
 
 import sqlalchemy as sa

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

@@ -1,3 +1,13 @@
+"""Projects tags table
+
+- Links tags to projects.
+
+Migration strategy:
+- Composite primary key (`project_id`, `tag_id`) is unique and sufficient for migration.
+- Ensure foreign key references to `projects` and `tags` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from ._common import RefActions

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

@@ -1,3 +1,13 @@
+"""Projects to folders table
+
+- Links projects to folders.
+
+Migration strategy:
+- Composite primary key (`project_id`, `folder_id`) is unique and sufficient for migration.
+- Ensure foreign key references to `projects` and `folders` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from ._common import RefActions, column_created_datetime, column_modified_datetime

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

@@ -1,3 +1,13 @@
+"""Projects to products table
+
+- Links projects to products.
+
+Migration strategy:
+- Composite primary key (`project_id`, `product_id`) is unique and sufficient for migration.
+- Ensure foreign key references to `projects` and `products` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from ._common import RefActions, column_created_datetime, column_modified_datetime

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

@@ -1,4 +1,15 @@
-""" Stores SOME of the information associated to Research Resource Identifiers (RRIDs) as defined in https://scicrunch.org/resources
+"""Scicrunch resources table
+
+- Stores resources fetched from Scicrunch.
+- Stores SOME of the information associated to Research Resource Identifiers (RRIDs) as defined in https://scicrunch.org/resources
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- No foreign key dependencies exist.
+- No additional changes are required; this table can be migrated as is.
+"""
+
+"""
 """
 
 import sqlalchemy as sa

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

@@ -0,0 +1,39 @@
+"""Service compatibility table
+
+- Defines compatibility between services.
+
+Migration strategy:
+- Composite primary key (`service_key`, `service_version`) is unique and sufficient for migration.
+- Ensure foreign key references (if any) are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
+import sqlalchemy as sa
+from sqlalchemy.dialects.postgresql import JSONB
+
+from .base import metadata
+
+service_compatibility = sa.Table(
+    "service_compatibility",
+    metadata,
+    sa.Column(
+        "service_key",
+        sa.String,
+        nullable=False,
+        doc="Service key identifier",
+    ),
+    sa.Column(
+        "service_version",
+        sa.String,
+        nullable=False,
+        doc="Service version identifier",
+    ),
+    sa.Column(
+        "compatibility",
+        JSONB,
+        nullable=False,
+        server_default=sa.text("'{}'::jsonb"),
+        doc="Compatibility information in JSON format",
+    ),
+    sa.PrimaryKeyConstraint("service_key", "service_version"),
+)

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

@@ -1,23 +1,23 @@
 """
-    Establishes which services can consume a given filetype
+Services consume filetypes table
 
-    The relation is N-N because
-    - a service could handle one or more filetypes and
-    - one filetype could be handled by one or more services
+- Links services to the file types they consume.
+- Establishes which services can consume a given filetype
+- The relation is N-N because
+  - a service could handle one or more filetypes and
+  - one filetype could be handled by one or more services
+
+Migration strategy:
+- Composite primary key (`service_key`, `filetype_id`) is unique and sufficient for migration.
+- Ensure foreign key references to `services` and `filetypes` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
 """
+
 import sqlalchemy as sa
 
 from ._common import RefActions
 from .base import metadata
 
-#
-# TODO: This information SHALL be defined in service metadata upon publication
-#       and the catalog service, using e.g. a background task,
-#       can automatically fill this table with services that elligable (e.g. shared with everybody)
-#       to consume given filetypes. Notice also that service "matching" will also be determined in a near
-#       future by more complex metadata
-#
-
 services_consume_filetypes = sa.Table(
     "services_consume_filetypes",
     metadata,

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

@@ -1,3 +1,13 @@
+"""Tags table
+
+- Represents tags that can be associated with various entities.
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references (if any) are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from .base import metadata

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

@@ -1,3 +1,13 @@
+"""Tags access rights table
+
+- Defines access rights for tags.
+
+Migration strategy:
+- Composite primary key (`tag_id`, `user_id`) is unique and sufficient for migration.
+- Ensure foreign key references to `tags` and `users` are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 
 from ._common import RefActions, column_created_datetime, column_modified_datetime

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

@@ -1,3 +1,13 @@
+"""Users table
+
+- Represents users in the system.
+
+Migration strategy:
+- The primary key is `id`, which is unique and sufficient for migration.
+- Ensure foreign key references (if any) are valid in the target database.
+- No additional changes are required; this table can be migrated as is.
+"""
+
 import sqlalchemy as sa
 from common_library.users_enums import UserRole, UserStatus
 from sqlalchemy.sql import expression
@@ -10,6 +20,7 @@
     "UserStatus",
 )
 
+
 users = sa.Table(
     "users",
     metadata,