Merge pull request #193 from VForWaTer/details_adjustments

Details adjustments

metacatalog/__version__.py

@@ -1 +1 @@
-__version__ = '0.6.1'
+__version__ = '0.6.2'

metacatalog/db/revisions/__init__.py

@@ -11,6 +11,7 @@
     rev9,
     rev10,
     rev11,
+    rev12,
 )
 
 revisions = {
@@ -26,4 +27,5 @@
     9: rev9,
     10: rev10,
     11: rev11,
+    12: rev12,
 }

metacatalog/db/revisions/rev12.py

@@ -0,0 +1,48 @@
+"""
+Metacatalog database revision
+-----------------------------
+date: 2022-12-16T17:43:29.087342
+
+revision #12
+
+Details adjustments:
+- Details.key has now a limit of 60 letters (instead of 20)
+- new column Details.title
+
+"""
+from sqlalchemy.orm import Session
+from metacatalog import api, models
+
+UPGRADE_SQL = """
+-- details.key 60 letters limit
+ALTER TABLE details ALTER COLUMN key TYPE varchar(60);
+COMMIT;
+-- create column details.title
+ALTER TABLE details ADD COLUMN title VARCHAR;
+COMMIT;
+"""
+
+DOWNGRADE_SQL = """
+-- details.key 20 letters limit, shorten key if longer than 20 letters
+UPDATE details SET key=LEFT(key, 20);
+ALTER TABLE details ALTER COLUMN key TYPE varchar(20);
+COMMIT;
+-- delete column details.title
+ALTER TABLE details DROP COLUMN title;
+COMMIT;
+"""
+
+# define the upgrade function
+def upgrade(session: Session):
+    print('run update')
+    # details key letter limit 60 and new column title
+    with session.bind.connect() as con:
+        con.execute(UPGRADE_SQL)
+
+
+# define the downgrade function
+def downgrade(session: Session):
+    print('run downgrade')
+    # details key letter limit 20 and drop column title
+    with session.bind.connect() as con:
+        con.execute(DOWNGRADE_SQL)

metacatalog/models/details.py

@@ -39,9 +39,19 @@ class Detail(Base):
     key : str
         The key of the key vaule par. Maximum 20 letters,
         ideally no whitespaces.
+        .. versionchanged:: 0.6.2
+        Maximum letters changed from 20 to 60.
+        Ideally, the key should come from a thesaurus available in the 
+        database. In this case, also link the detail to the thesaurus
+        via :attr:`thesaurus_id`.
     stem : str
         Stemmed key using a `nltk.PorterStemmer`. The stemmed
         key can be used to search for related keys
+    title : str
+        .. versionadded:: 0.6.2
+        Optional longer and more descriptive title than :attr:`key`, 
+        use this field e.g. if you used a thesaurus for attr:`key`, but 
+        a longer or more precise title provides additional information.
     value : str, list
         .. versionchanged:: 0.3.0
         The actual value of this detail. This can be a string
@@ -72,8 +82,9 @@ class Detail(Base):
     # columns
     id = Column(Integer, primary_key=True, autoincrement=True)
     entry_id = Column(Integer, ForeignKey('entries.id'))
-    key = Column(String(20), nullable=False)
+    key = Column(String(60), nullable=False)
     stem = Column(String(20), nullable=False)
+    title = Column(String, nullable=True)
     raw_value = Column(MutableDict.as_mutable(JSONB), nullable=False)
     description = Column(String, nullable=True)
     thesaurus_id = Column(Integer, ForeignKey('thesaurus.id'))