From a8aa093925c6bea0dae40f59139afc67b26f7aac Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 31 Jan 2017 16:30:47 -0500 Subject: [PATCH] doc: update the man page entry for nova-manage db sync The docs for this command were woefully out of date. This change clarifies the wording since we're really upgrading the schema in the database, not "synchronizing" it even though that's the name of the command - the migration scripts run the 'upgrade' method only. Also, it was saying this was how you created the main database, which is totally wrong since this command doesn't create the database. The deployer creates the database, this command migrates the schema on that database. Then I also added the arguments along with a description of each and noted that this will by default upgrade the cell0 schema. Change-Id: I3d40cb32c325bc3f665e727b921082efba043192 --- doc/source/man/nova-manage.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/source/man/nova-manage.rst b/doc/source/man/nova-manage.rst index 630d4652461d..4170b3004390 100644 --- a/doc/source/man/nova-manage.rst +++ b/doc/source/man/nova-manage.rst @@ -44,9 +44,16 @@ Nova Database Print the current main database version. -``nova-manage db sync`` +``nova-manage db sync [--version ] [--local_cell]`` - Sync the main database up to the most recent version. This is the standard way to create the db as well. + Upgrade the main database schema up to the most recent version or + ``--version`` if specified. By default, this command will also attempt to + upgrade the schema for the cell0 database if it is mapped (see the + ``map_cell0`` or ``simple_cell_setup`` commands for more details on mapping + the cell0 database). If ``--local_cell`` is specified, then only the main + database in the current cell is upgraded. The local database connection is + determined by ``[database]/connection`` in the configuration file passed to + nova-manage. ``nova-manage db archive_deleted_rows [--max_rows ] [--verbose]``