# HG changeset patch # User Stephanie Marcu # Date 1284541428 -7200 # Node ID 1c4ac1626f3c3d3b4ae371a9a885ca4e46685f94 # Parent c0ee416040faad895405b7a625c4d6af2f86360d [book - #1251197] add a section in migration page for add_cube and add_cubes command diff -r c0ee416040fa -r 1c4ac1626f3c doc/book/en/devrepo/migration.rst --- a/doc/book/en/devrepo/migration.rst Wed Sep 15 11:00:55 2010 +0200 +++ b/doc/book/en/devrepo/migration.rst Wed Sep 15 11:03:48 2010 +0200 @@ -91,6 +91,24 @@ * `session`, repository session object +New cube dependencies +--------------------- + +If your code depends on some new cubes, you have to add them in a migration +script by using: + +* `add_cube(cube, update_database=True)`, add a cube. +* `add_cubes(cubes, update_database=True)`, add a list of cubes. + +The `update_database` parameter is telling if the database schema +should be updated or if only the relevant persistent property should be +inserted (for the case where a new cube has been extracted from an +existing one, so the new cube schema is actually already in there). + +If some of the added cubes are already used by an instance, they'll simply be +silently skipped. + + Schema migration ---------------- The following functions for schema migration are available in `repository`