Merge pull request #305 from chaoss/feat/instance-db

Introduce a new operational forge_instance table

Author: MoralCode

collectoss/application/db/models/augur_operations.py

@@ -1,5 +1,5 @@
 # encoding: utf-8
-from sqlalchemy import BigInteger, SmallInteger, Column, Index, Integer, String, Table, text, UniqueConstraint, Boolean, ForeignKey, update, CheckConstraint, Sequence
+from sqlalchemy import BigInteger, SmallInteger, Column, Index, Integer, String, Table, text, UniqueConstraint, Boolean, ForeignKey, update, CheckConstraint, Sequence, DateTime, func
 from sqlalchemy.dialects.postgresql import TIMESTAMP
 from sqlalchemy.orm.exc import NoResultFound, MultipleResultsFound
 from sqlalchemy.exc import IntegrityError
@@ -1072,6 +1072,20 @@ def get_by_id(session, client_id):
             session.rollback()
             raise e
 
+class ForgeInstance(Base):
+    __tablename__ = "forge_instance"
+    __table_args__ = { "schema": "augur_operations" }
+
+    id = Column(Integer, primary_key=True, nullable=False, comment="Internal unique identifier for this forge instance")
+    # platform_type stores an integer that CollectOSS maps/will map to it's internal platform identifier Enum 
+    # (as used in ContributorUUID) for identifying the API endpoints and tasks to use for collection
+    platform_type = Column(Integer, nullable=False, comment="Type specifier identifying the relevant platform API interface to CollectOSS")
+    name = Column(String, nullable=False, comment="User-specified name for this forge instance")
+    # https://stackoverflow.com/a/54800233
+    date_added = Column(DateTime(timezone=True), nullable=False, default=func.now())
+    domain_name = Column(String, nullable=False, comment="The base domain name (without the scheme) where this instance is hosted")
+    enabled = Column(Boolean, default=True, nullable=False, comment="denotes whether collection should run for this instance")
+
 
 class Subscription(Base):
     __tablename__ = "subscriptions"

collectoss/application/schema/alembic/versions/42_introduce_empty_instances_table.py

@@ -0,0 +1,37 @@
+"""introduce empty instances table
+
+Revision ID: 42
+Revises: 41
+Create Date: 2026-05-07 15:51:17.510641
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '42'
+down_revision = '41'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('forge_instance',
+    sa.Column('id', sa.Integer(), nullable=False, comment='Internal unique identifier for this forge instance'),
+    sa.Column('platform_type', sa.Integer(), nullable=False, comment='Type specifier identifying the relevant platform API interface to CollectOSS'),
+    sa.Column('name', sa.String(), nullable=False, comment='User-specified name for this forge instance'),
+    sa.Column('date_added', sa.DateTime(timezone=True), nullable=False),
+    sa.Column('domain_name', sa.String(), nullable=False, comment='The base domain name (without the scheme) where this instance is hosted'),
+    sa.Column('enabled', sa.Boolean(), nullable=False, comment='denotes whether collection should run for this instance'),
+    sa.PrimaryKeyConstraint('id'),
+    schema='augur_operations'
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('forge_instance', schema='augur_operations')
+    # ### end Alembic commands ###