Source code for watcher.cmd.dbmanage

# -*- encoding: utf-8 -*-
#
# Copyright 2013 Hewlett-Packard Development Company, L.P.
# 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.

"""
Run storage database migration.
"""

import sys

from oslo_config import cfg

from watcher.common import service
from watcher import conf
from watcher.db import migration
from watcher.db import purge

CONF = conf.CONF


[docs]class DBCommand(object):

[docs]    @staticmethod
    def upgrade():
        migration.upgrade(CONF.command.revision)

[docs]    @staticmethod
    def downgrade():
        migration.downgrade(CONF.command.revision)

[docs]    @staticmethod
    def revision():
        migration.revision(CONF.command.message, CONF.command.autogenerate)

[docs]    @staticmethod
    def stamp():
        migration.stamp(CONF.command.revision)

[docs]    @staticmethod
    def version():
        print(migration.version())

[docs]    @staticmethod
    def create_schema():
        migration.create_schema()

[docs]    @staticmethod
    def purge():
        purge.purge(CONF.command.age_in_days, CONF.command.max_number,
                    CONF.command.goal, CONF.command.exclude_orphans,
                    CONF.command.dry_run)


def add_command_parsers(subparsers):
    parser = subparsers.add_parser(
        'upgrade',
        help="Upgrade the database schema to the latest version. "
             "Optionally, use --revision to specify an alembic revision "
             "string to upgrade to.")
    parser.set_defaults(func=DBCommand.upgrade)
    parser.add_argument('--revision', nargs='?')

    parser = subparsers.add_parser(
        'downgrade',
        help="Downgrade the database schema to the oldest revision. "
             "While optional, one should generally use --revision to "
             "specify the alembic revision string to downgrade to.")
    parser.set_defaults(func=DBCommand.downgrade)
    parser.add_argument('--revision', nargs='?')

    parser = subparsers.add_parser('stamp')
    parser.add_argument('revision', nargs='?')
    parser.set_defaults(func=DBCommand.stamp)

    parser = subparsers.add_parser(
        'revision',
        help="Create a new alembic revision. "
             "Use --message to set the message string.")
    parser.add_argument('-m', '--message')
    parser.add_argument('--autogenerate', action='store_true')
    parser.set_defaults(func=DBCommand.revision)

    parser = subparsers.add_parser(
        'version',
        help="Print the current version information and exit.")
    parser.set_defaults(func=DBCommand.version)

    parser = subparsers.add_parser(
        'create_schema',
        help="Create the database schema.")
    parser.set_defaults(func=DBCommand.create_schema)

    parser = subparsers.add_parser(
        'purge',
        help="Purge the database.")
    parser.add_argument('-d', '--age-in-days',
                        help="Number of days since deletion (from today) "
                             "to exclude from the purge. If None, everything "
                             "will be purged.",
                        type=int, default=None, nargs='?')
    parser.add_argument('-n', '--max-number',
                        help="Max number of objects expected to be deleted. "
                             "Prevents the deletion if exceeded. No limit if "
                             "set to None.",
                        type=int, default=None, nargs='?')
    parser.add_argument('-t', '--goal',
                        help="UUID or name of the goal to purge.",
                        type=str, default=None, nargs='?')
    parser.add_argument('-e', '--exclude-orphans', action='store_true',
                        help="Flag to indicate whether or not you want to "
                             "exclude orphans from deletion (default: False).",
                        default=False)
    parser.add_argument('--dry-run', action='store_true',
                        help="Flag to indicate whether or not you want to "
                             "perform a dry run (no deletion).",
                        default=False)

    parser.set_defaults(func=DBCommand.purge)


command_opt = cfg.SubCommandOpt('command',
                                title='Command',
                                help='Available commands',
                                handler=add_command_parsers)


def register_sub_command_opts():
    cfg.CONF.register_cli_opt(command_opt)


def main():
    register_sub_command_opts()
    # this is hack to work with previous usage of watcher-dbsync
    # pls change it to watcher-dbsync upgrade
    valid_commands = set([
        'upgrade', 'downgrade', 'revision',
        'version', 'stamp', 'create_schema',
        'purge',
    ])
    if not set(sys.argv).intersection(valid_commands):
        sys.argv.append('upgrade')

    service.prepare_service(sys.argv, CONF)
    CONF.command.func()