Feature/adding mset replacement functionality 20210615

datameta/alembic/versions/20210615_37ecf07b7838.py

@@ -0,0 +1,47 @@
+"""added msetreplacements table, moved update-related fields from mset
+
+Revision ID: 37ecf07b7838
+Revises: 7fdc829db18d
+Create Date: 2021-06-15 09:09:20.305816
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = '37ecf07b7838'
+down_revision = '7fdc829db18d'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('msetreplacements',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('uuid', postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column('user_id', sa.Integer(), nullable=False),
+        sa.Column('datetime', sa.DateTime(), nullable=False),
+        sa.Column('reason', sa.String(length=140), nullable=False),
+        sa.Column('metadataset_id', sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(['metadataset_id'], ['metadatasets.id'], name=op.f('fk_msetreplacements_metadataset_id_metadatasets')),
+        sa.ForeignKeyConstraint(['user_id'], ['users.id'], name=op.f('fk_msetreplacements_user_id_users')),
+        sa.PrimaryKeyConstraint('id', name=op.f('pk_msetreplacements')),
+        sa.UniqueConstraint('uuid', name=op.f('uq_msetreplacements_uuid'))
+    )
+    op.drop_constraint('fk_metadatasets_replaced_by_id_metadatasets', 'metadatasets', type_='foreignkey')
+    op.drop_column('metadatasets', 'deprecated_label')
+    op.drop_column('metadatasets', 'is_deprecated')
+    op.drop_column('metadatasets', 'replaced_by_id')
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('metadatasets', sa.Column('replaced_by_id', sa.INTEGER(), autoincrement=False, nullable=True))
+    op.add_column('metadatasets', sa.Column('is_deprecated', sa.BOOLEAN(), autoincrement=False, nullable=True))
+    op.add_column('metadatasets', sa.Column('deprecated_label', sa.VARCHAR(), autoincrement=False, nullable=True))
+    op.create_foreign_key('fk_metadatasets_replaced_by_id_metadatasets', 'metadatasets', 'metadatasets', ['replaced_by_id'], ['id'])
+    op.drop_table('msetreplacements')
+    # ### end Alembic commands ###

datameta/models/db.py

@@ -90,6 +90,7 @@ class User(Base):
     apikeys              = relationship('ApiKey', back_populates='user')
     services             = relationship('Service', secondary=user_service_table, back_populates='users')
     service_executions   = relationship('ServiceExecution', back_populates='user')
+    mset_replacements    = relationship('MsetReplacementEvent', back_populates='user')
 
 
 class ApiKey(Base):
@@ -214,17 +215,32 @@ class MetaDataSet(Base):
     uuid             = Column(UUID(as_uuid=True), unique=True, default=uuid.uuid4, nullable=False)
     user_id          = Column(Integer, ForeignKey('users.id'), nullable=False)
     submission_id    = Column(Integer, ForeignKey('submissions.id'), nullable=True)
-    is_deprecated    = Column(Boolean, default=False)
-    deprecated_label = Column(String, nullable=True)
-    replaced_by_id   = Column(Integer, ForeignKey('metadatasets.id'), nullable=True)
+
     # Relationships
     user                 = relationship('User', back_populates='metadatasets')
     submission           = relationship('Submission', back_populates='metadatasets')
     metadatumrecords     = relationship('MetaDatumRecord', back_populates='metadataset')
-    replaces             = relationship('MetaDataSet', backref=backref('replaced_by', remote_side=[id]))
     service_executions   = relationship('ServiceExecution', back_populates = 'metadataset')
 
 
+class MsetReplacementEvent(Base):
+    """ Stores information about an mset replacement event """
+    __tablename__ = 'msetreplacements'
+    id               = Column(Integer, primary_key=True)
+    uuid             = Column(UUID(as_uuid=True), unique=True, default=uuid.uuid4, nullable=False)
+    user_id          = Column(Integer, ForeignKey('users.id'), nullable=False)
+    datetime         = Column(DateTime, nullable=False)
+    # former 'is_deprecated' label from MetaDataSet
+    reason           = Column(String(140), nullable=False)
+    # the id of the new mset
+    metadataset_id   = Column(Integer, ForeignKey('metadatasets.id'), nullable=False)
+
+    # Relationships
+    user                 = relationship('User', back_populates='mset_replacements')
+    # replaced msets can then backref to the even and the replacing mset can be obtained via event.metadataset_id
+    replaced_msets       = relationship('MetaDataSet', backref=backref('replaced_through', remote_side=[metadataset_id]))
+
+
 class ApplicationSetting(Base):
     __tablename__ = 'appsettings'
     id           = Column(Integer, primary_key=True)