doc/book/en/devrepo/datamodel/metadata.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 18 Aug 2010 16:53:05 +0200
branchstable
changeset 6120 c000e41316ec
parent 5394 105011657405
permissions -rw-r--r--
[book] some more documentation and cleanups * merged existing facets documentation with the one I've just written and put almost everything within the code * added a note about __depends__ and __recommends__ and about the recommends semantic (extracted from a post on the ml) * added a note about write security checking (extracted from a post on the ml) * fixed some dumb sphinx errors


Metadata
--------

.. index::
   schema: meta-data;
   schema: eid; creation_date; modification_data; cwuri
   schema: created_by; owned_by; is; is_instance;

Each entity type in |cubicweb| has at least the following meta-data attributes and relations:

`eid`
  entity's identifier which is unique in an instance. We usually call this identifier `eid` for historical reason.

`creation_date`
  Date and time of the creation of the entity.

`modification_date`
  Date and time of the latest modification of an entity.

`cwuri`
  Reference URL of the entity, which is not expected to change.

`created_by`
  Relation to the :ref:`users <CWUser>` who has created the entity

`owned_by`
  Relation to :ref:`users <CWUser>` whom the entity belongs; usually the creator but not
  necessary, and it could have multiple owners notably for permission control

`is`
  Relation to the :ref:`entity type <CWEType>` of which type the entity is.

`is_instance`
  Relation to the :ref:`entity types <CWEType>` of which type the
  entity is an instance of.