90060722a9
This patch introduces a new directory layout in doc/source in conformance with the OpenStack manuals project migration spec [1], moves the existing content in manila/doc/source into the new directories, and adjusts index files accordingly. This is the first step in the migration process as outlined in the spec. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Partial-Bug: #1706181 Needed-By: I7924d94b82e7c8d9716bad7a219fc38c57970773 Depends-On: Ifc80fc56648cef74c85464321d1850e8c68449a0 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: Ieea33262101a1d2459492c1c8aaac5fe042279f6
67 lines
1.9 KiB
ReStructuredText
67 lines
1.9 KiB
ReStructuredText
..
|
|
Copyright 2010-2011 United States Government as represented by the
|
|
Administrator of the National Aeronautics and Space Administration.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
The Database Layer
|
|
==================
|
|
|
|
The :mod:`manila.db.api` Module
|
|
-------------------------------
|
|
|
|
.. automodule:: manila.db.api
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|
|
The Sqlalchemy Driver
|
|
---------------------
|
|
|
|
The :mod:`manila.db.sqlalchemy.api` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. automodule:: manila.db.sqlalchemy.api
|
|
:noindex:
|
|
|
|
The :mod:`manila.db.sqlalchemy.models` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. automodule:: manila.db.sqlalchemy.models
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
|
|
|
|
Tests
|
|
-----
|
|
|
|
Tests are lacking for the db api layer and for the sqlalchemy driver.
|
|
Failures in the drivers would be detected in other test cases, though.
|
|
|
|
DB migration revisions
|
|
----------------------
|
|
|
|
If a DB schema needs to be updated, a new DB migration file needs to be added
|
|
in ``manila/db/migrations/alembic/versions``. To create such a file it's
|
|
possible to use ``manila-manage db revision`` or the corresponding tox command::
|
|
|
|
tox -e dbrevision "change_foo_table"
|
|
|
|
In addition every migration script must be tested. See examples in
|
|
``manila/tests/db/migrations/alembic/migrations_data_checks.py``.
|