Database Service Management command-line client The trove-manage client is the command-line interface (CLI) for the Database Management Utility and its extensions. This chapter documents trove-manage version 2014.2. For help on a specific trove-manage command, enter: $ trove-manage COMMAND
trove-manage usage usage: trove-manage [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--log-format FORMAT] [--nodebug] [--nouse-syslog] [--nouse-syslog-rfc-format] [--noverbose] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--use-syslog-rfc-format] [--verbose] [--version] {db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate} ...
trove-manage optional arguments -h, --help show this help message and exit --config-dir DIR Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence over-ridden options in the directory take precedence. --config-file PATH Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. The default files used are: None. --debug, -d Print debugging output (set logging level to DEBUG instead of default WARNING level). --log-config-append PATH, --log_config PATH The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. --log-date-format DATE_FORMAT Format string for %(asctime)s in log records. Default: None . --log-dir LOG_DIR, --logdir LOG_DIR (Optional) The base directory used for relative --log- file paths. --log-file PATH, --logfile PATH (Optional) Name of log file to output to. If no default is set, logging will go to stdout. --log-format FORMAT DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. --nodebug The inverse of --debug --nouse-syslog The inverse of --use-syslog --nouse-syslog-rfc-format The inverse of --use-syslog-rfc-format --noverbose The inverse of --verbose --syslog-log-facility SYSLOG_LOG_FACILITY Syslog facility to receive log lines. --use-syslog Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. --use-syslog-rfc-format (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J. --verbose, -v Print more verbose output (set logging level to INFO instead of default WARNING level). --version show program's version number and exit
trove-manage datastore_update command usage: trove-manage datastore_update [-h] datastore_name default_version Add or update a datastore. If the datastore already exists, the default version will be updated. Positional arguments datastore_name Name of the datastore. default_version Name or ID of an existing datastore version to set as the default. When adding a new datastore, use an empty string. Optional arguments -h, --help show this help message and exit
trove-manage datastore_version_update command usage: trove-manage datastore_version_update [-h] datastore version_name manager image_id packages active Add or update a datastore version. If the datastore version already exists, all values except the datastore name and version will be updated. Positional arguments datastore Name of the datastore. version_name Name of the datastore version. manager Name of the manager that will administer the datastore version. image_id ID of the image used to create an instance of the datastore version. packages Packages required by the datastore version that are installed on the guest image. active Whether the datastore version is active or not. Accepted values are 0 and 1. Optional arguments -h, --help show this help message and exit
trove-manage db_downgrade command usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version Downgrade the database to the specified version. Positional arguments version Target version. Optional arguments -h, --help show this help message and exit --repo_path REPO_PATH SQLAlchemy Migrate repository path.
trove-manage db_recreate command usage: trove-manage db_recreate [-h] repo_path Drop the database and recreate it. Positional arguments repo_path SQLAlchemy Migrate repository path. Optional arguments -h, --help show this help message and exit
trove-manage db_sync command usage: trove-manage db_sync [-h] [--repo_path REPO_PATH] Populate the database structure Optional arguments -h, --help show this help message and exit --repo_path REPO_PATH SQLAlchemy Migrate repository path.
trove-manage db_upgrade command usage: trove-manage db_upgrade [-h] [--version VERSION] [--repo_path REPO_PATH] Upgrade the database to the specified version. Optional arguments -h, --help show this help message and exit --version VERSION Target version. Defaults to the latest version. --repo_path REPO_PATH SQLAlchemy Migrate repository path.