openstack/nova
Code Issues Proposed changes

doc: update the man page entry for nova-manage db sync

Browse Source 
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
This commit is contained in:
Matt Riedemann
2017-01-31 16:30:47 -05:00
parent a3563ed37e
commit a8aa093925
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/man/nova-manage.rst
View File

@@ -44,9 +44,16 @@ Nova Database
Print the current main database version.
``nova-manage db sync``
``nova-manage db sync [--version <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 <number>] [--verbose]``