doc/book/en/B2020-hooks.en.txt
author Nicolas Chauvat <nicolas.chauvat@logilab.fr>
Mon, 29 Dec 2008 23:59:55 +0100
changeset 311 65c6738df991
parent 293 a21688a55d21
permissions -rw-r--r--
[doc] no underline for links

.. -*- coding: utf-8 -*-

.. _hooks:

Hooks
=====

XXX FILLME

*Hooks* are executed before or after updating an entity or a relation in the
repository.

Their prototypes are as follows: 
    
    * after_add_entity     (session, entity)
    * after_update_entity  (session, entity)
    * after_delete_entity  (session, eid)
    * before_add_entity    (session, entity)
    * before_update_entity (session, entity)
    * before_delete_entity (session, eid)

    * after_add_relation     (session, fromeid, rtype, toeid)
    * after_delete_relation  (session, fromeid, rtype, toeid)
    * before_add_relation    (session, fromeid, rtype, toeid)
    * before_delete_relation (session, fromeid, rtype, toeid)
    
    * server_startup
    * server_shutdown
    
    * session_open
    * session_close