{"id":780,"date":"2014-10-05T18:18:32","date_gmt":"2014-10-05T22:18:32","guid":{"rendered":"http:\/\/bioinfo.iric.ca\/?p=780"},"modified":"2017-04-29T17:27:37","modified_gmt":"2017-04-29T21:27:37","slug":"gestion-des-versions-du-contenu-dune-bd-avec-sqlalchemy","status":"publish","type":"post","link":"https:\/\/bioinfo.iric.ca\/fr\/gestion-des-versions-du-contenu-dune-bd-avec-sqlalchemy\/","title":{"rendered":"Gestion des versions du contenu d’une BD avec SQLAlchemy"},"content":{"rendered":"

Une des fonctionnalit\u00e9s phare requises d’un SGL est la sauvegarde de l’historique des changements appliqu\u00e9s aux donn\u00e9es stor\u00e9es dans la base de donn\u00e9es sous-jacente. Ceci peut repr\u00e9senter une fonctionnalit\u00e9 non triviale \u00e0 impl\u00e9menter et\/ou d\u00e9ployer et il existe certainement plusieurs visions de la forme que cette impl\u00e9mentation devrait prendre.
\nHeureusement pour tous les fans de SQLAlchemy<\/a>, une solution pr\u00eate \u00e0 l’usage est sugg\u00e9r\u00e9e sur la page des exemples de l’ORM<\/a> (en anglais seulement). Bien que la page d’exemple sugg\u00e8re diff\u00e9rents types d’impl\u00e9mentation, ma pr\u00e9f\u00e9r\u00e9e demeure Versioning with a History Table<\/em>.<\/p>\n

Elle est incroyablement simple \u00e0 mettre en place et son utilisation subs\u00e9quente ne requiert l’ajout d’aucune ligne de code… Fantastique !
\nCette impl\u00e9mentation se pr\u00e9sente sous la forme d’un mixin<\/a> con\u00e7u pour fonctionner avec la technique de d\u00e9finition des objet nomm\u00e9e \u00ab\u00a0declarative\u00a0\u00bb. C’est cette technique qui est employ\u00e9e dans l’exemple ci-bas. Si vous travaillez avec du code un peu plus vieux et faisant usage des mappeurs classiques de SQLAlchemy, un ensemble de fonctions est disponible pour assurer les m\u00eame fonctionnalit\u00e9s.<\/p>\n

\n

Incroyablement simple \u00e0 mettre en place, son utilisation subs\u00e9quente ne requiert l’ajout d’aucune ligne de code.<\/p>\n<\/blockquote>\n

Laissez-moi vous d\u00e9montrer sa mise en place \u00e0 l’aide d’un exemple:<\/p>\n

En gros, il ne faut qu’importer le mixin<\/em> et un wrapper<\/em> pour la session SQL, ajouter le mixin<\/em> \u00e0 notre d\u00e9claration de classe et envelopper votre session dans une versioned_session<\/em>.<\/p>\n<\/div>

<\/div><\/div><\/div>

Cet extrait de code:<\/p>\n

\r\n\r\n\r\n\r\n\r\n\r\n\r\nBase = declarative_base()\r\n\r\nclass MaClasse(Base):\r\n    __tablename__ = 'ma_table'\r\n\r\n    id = Column(Integer, primary_key=True)\r\n    nom = Column(String(50))\r\n\r\n\r\nSession = sessionmaker(bind=engine)\r\n\r\n\r\n\r\n\r\nsess = Session()\r\n# Faites quelque chose avec votre session\r\n<\/code><\/pre>\n<\/div>
<\/div><\/div><\/div>
Devient:<\/p>\n
\r\n# Ajout des d\u00e9clarations d'import n\u00e9cessaires\r\nfrom history_meta import (\r\nVersioned, \r\nversioned_session\r\n)\r\n\r\nBase = declarative_base()\r\n\r\nclass MaClasse(Versioned, Base):\r\n    __tablename__ = 'ma_table'\r\n\r\n    id = Column(Integer, primary_key=True)\r\n    nom = Column(String(50))\r\n\r\n\r\nSession = sessionmaker(bind=engine)\r\n\r\n# enveloppez votre session dans une versioned_session<\/i>\r\nversioned_session(Session)\r\n\r\nsess = Session()\r\n# Faites quelque chose avec votre session\r\n<\/code><\/pre>\n<\/div>
<\/div><\/div><\/div>
Facile, n’est-ce pas ?!
\nL’ajout du mixin dans la d\u00e9claration des objets instancie des tables \u00ab\u00a0soeurs\u00a0\u00bb (avec \u00ab\u00a0_history\u00a0\u00bb d’ajout\u00e9 \u00e0 leur nom) pour chaque objet Versioned<\/em> d\u00e9clar\u00e9. Ces tables contiendront une copie compl\u00e8te des attributs de la table d’origine en plus d’un attribut version<\/em> (essentiellement un entier auto incr\u00e9mental) et, optionnellement, un attribut changed<\/em> de type utc_timestamp.<\/p>\n
Une fois ces petits ajouts effectu\u00e9s, chaque changement ou suppression appliqu\u00e9 sur un objet occasionnera une \u00e9criture de l’objet *avant* sa modification dans la table soeur \u00ab\u00a0_history\u00a0\u00bb accompagn\u00e9 d’une incr\u00e9mentation du champ \u00ab\u00a0version\u00a0\u00bb. Qui plus est: toute la cuisine est automatiquement g\u00e9r\u00e9e par l’ORM, sans l’ajout d’une seule ligne de code suppl\u00e9mentaire.<\/p>\n
Alors comment fait-on pour acc\u00e9der \u00e0 l’historique d’une entr\u00e9e de la BD ? Rien de plus simple ! Les lignes de code suivantes expliquent comment instancier une classe correspondant \u00e0 l’historique de la classe soeur. Celle-ci s’utilise ensuite comme un objet SQLAlchemy classique:<\/p>\n
\r\nHistoriqueDeMaClasse = MaClasse.__history_mapper__.class_\r\netats_precedents = HistoriqueDeMaClasse.filter(HistoriqueDeMaClasse.id == un_id)\\\r\n                  .order_by(HistoriqueDeMaClasse.version).all()\r\n\r\n## Faites quelque chose avec les \u00e9tats pr\u00e9c\u00e9dents de votre objet :)\r\n<\/code><\/pre>\n
Merveilleux, non ?
\nC’est maintenant le temps de vous mettre au boulot et de d\u00e9ployer des objets avec historique dans tous les projets qui pourraient en b\u00e9n\u00e9ficier !<\/p>\n<\/div>
<\/div><\/div><\/div><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[122,88,26],"tags":[155,154,153,38],"class_list":["post-780","post","type-post","status-publish","format-standard","hentry","category-database","category-informatique","category-langage-python","tag-developpement-web","tag-mor","tag-sgl","tag-sqlalchemy"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/posts\/780","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/comments?post=780"}],"version-history":[{"count":20,"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/posts\/780\/revisions"}],"predecessor-version":[{"id":2751,"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/posts\/780\/revisions\/2751"}],"wp:attachment":[{"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/media?parent=780"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/categories?post=780"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bioinfo.iric.ca\/fr\/wp-json\/wp\/v2\/tags?post=780"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}