doc/book/en/development/datamodel/baseschema.rst
author Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
Fri, 24 Jul 2009 09:31:04 +0200
changeset 2464 926696e38502
parent 2175 16d3c37c5d28
child 2477 7baebaf44fc2
permissions -rw-r--r--
usage of '**' is deprecated in RelationType declaration, use '*' instead


Pre-defined schemas in the library
----------------------------------

The library defines a set of entity schemas that are required by the system
or commonly used in *CubicWeb* applications.


Entity types used to store the schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* `CWEType`, entity type
* `CWRType`, relation type
* `CWRelation`, relation definition
* `CWAttribute`, attribute relation definition
* `CWConstraint`,  `CWConstraintType`, `RQLExpression`

Entity types used to manage users and permissions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* `CWUser`, system users
* `CWGroup`, users groups
* `CWPermission`, used to configure the security of the application

Entity types used to manage workflows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* `State`, workflow state
* `Transition`, workflow transition
* `TrInfo`, record of a transition trafic for an entity

Other entity types
~~~~~~~~~~~~~~~~~~
* `CWCache`
* `CWProperty`, used to configure the application

* `EmailAddress`, email address, used by the system to send notifications
  to the users and also used by others optionnals schemas

* `Bookmark`, an entity type used to allow a user to customize his links within
  the application