trove-manage 命令行客户端

trove-manage 客户端是数据库管理实用程序 API 及其扩展的命令行界面 (CLI)。

本章节记录了 trove-manage 版本 5.0.1

要获取特定 trove-manage 命令的帮助,请输入

$ trove-manage COMMAND --help

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] [--nodebug]
                    [--nouse-syslog] [--noverbose] [--nowatch-log-file]
                    [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog]
                    [--verbose] [--version] [--watch-log-file]

                    {db_sync,db_upgrade,db_downgrade,datastore_update,
                    datastore_version_update,db_recreate,
                    db_load_datastore_config_parameters,
                    datastore_version_flavor_add,
                    datastore_version_flavor_delete}
                    ...

trove-manage 可选参数

-h, --help

显示此帮助消息并退出

--config-dir DIR

*.conf 文件中提取配置文件的目录路径。此文件集按排序方式排列,以便在单独选项被覆盖时提供可预测的解析顺序。该集合在通过之前的 –config-file 参数指定的文件之后进行解析,因此目录中的覆盖选项优先。

--config-file PATH

要使用的配置文件路径。可以指定多个配置文件,后面的文件的值优先。默认使用的文件是:None

--debug, -d

打印调试输出(将日志级别设置为 DEBUG 而不是默认的 INFO 级别)。

--log-config-append PATH, --log_config PATH

日志配置文件的名称。此文件将附加到任何现有的日志配置文件。有关日志配置文件的详细信息,请参阅 Python 日志模块文档。请注意,当使用日志配置文件时,所有日志配置都设置在配置文件中,并且其他日志配置选项将被忽略(例如,logging_context_format_string)。

--log-date-format DATE_FORMAT

日志记录中 %(asctime)s 的格式字符串。默认值:None。如果设置了 log_config_append,则此选项将被忽略。

--log-dir LOG_DIR, --logdir LOG_DIR

(可选)用于相对 --log-file 路径的基本目录。如果设置了 log_config_append,则此选项将被忽略。

--log-file PATH, --logfile PATH

(可选)将日志输出发送到的日志文件名。如果没有设置默认值,日志将输出到 stderr,如 use_stderr 所定义。如果设置了 log_config_append,则此选项将被忽略。

--nodebug

--debug 的反向选项

--nouse-syslog

--use-syslog 的反向选项

--nouse-syslog-rfc-format

–use-syslog-rfc-format 的反向

--noverbose

--verbose 的反向选项

--syslog-log-facility SYSLOG_LOG_FACILITY

接收日志行的 syslog 设备。如果设置了 log_config_append,则此选项将被忽略。

--use-syslog

使用 syslog 进行日志记录。现有的 syslog 格式已**弃用**,以后将更改为符合 RFC5424。如果设置了 log_config_append,则此选项将被忽略。

--verbose, -v

如果设置为 false,日志级别将设置为 WARNING 而不是默认的 INFO 级别。

--version

显示程序版本号并退出

--watch-log-file

使用设计为监视文件系统的日志记录处理程序。当日志文件被移动或删除时,此处理程序会立即使用指定的路径打开新的日志文件。只有在指定了 log_file 选项并使用 Linux 平台时才有效。如果设置了 log_config_append,则此选项将被忽略。

trove-manage datastore_update

usage: trove-manage datastore_update [-h] datastore_name default_version

添加或更新一个数据存储。如果数据存储已存在,则默认版本将被更新。

位置参数

datastore_name

数据存储的名称。

default_version

要设置为默认值的现有数据存储版本的名称或 ID。添加新的数据存储时,使用空字符串。

可选参数

-h, --help

显示此帮助消息并退出

trove-manage datastore_version_flavor_add

usage: trove-manage datastore_version_flavor_add [-h]
                                                 datastore_name
                                                 datastore_version_name
                                                 flavor_ids

位置参数

datastore_name

数据存储的名称。

datastore_version_name

数据存储版本的名称。

flavor_ids

逗号分隔的 flavor ID 列表。

可选参数

-h, --help

显示此帮助消息并退出

trove-manage datastore_version_flavor_delete

usage: trove-manage datastore_version_flavor_delete [-h]
                                                    datastore_name
                                                    datastore_version_name
                                                    flavor_id

位置参数

datastore_name

数据存储的名称。

datastore_version_name

数据存储版本的名称。

flavor_id

要删除的数据存储和数据存储版本的 flavor。

可选参数

-h, --help

显示此帮助消息并退出

trove-manage datastore_version_update

usage: trove-manage datastore_version_update [-h]
                                             datastore version_name manager
                                             image_id packages active
                                             --image-tags <image_tags>
                                             --registry-ext <registry_ext>
                                             --repl-strategy <repl_strategy>

添加或更新一个数据存储版本。如果数据存储版本已存在,则除了数据存储名称和版本之外的所有值都将被更新。

位置参数

datastore

数据存储的名称。

version_name

数据存储版本的名称。

manager

将管理数据存储版本的管理器的名称。

image_id

用于创建数据存储版本实例的镜像的 ID。

packages

数据存储版本所需的安装在客户机镜像上的软件包。

active

数据存储版本是否处于活动状态。允许的值为 01

可选参数

-h, --help

显示此帮助消息并退出

--image-tags

逗号分隔的镜像标签列表。如果未显式提供镜像 ID,则可以通过镜像标签检索镜像。多个镜像标签用逗号分隔,例如 trove,mysql。使用镜像标签比 ID 更灵活,尤其是在将新的客户机镜像上传到 Glance 时,Trove 可以自动选择最新的镜像来创建实例。

--registry-ext

默认数据存储版本管理器的扩展。允许为 Trove 支持的每个数据存储版本使用自定义管理器。

--repl-strategy

默认复制策略的扩展。允许为 Trove 支持的每个数据存储使用自定义复制策略。

trove-manage db_downgrade

usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version

将数据库降级到指定的版本。

位置参数

版本

目标版本。

可选参数

-h, --help

显示此帮助消息并退出

--repo_path REPO_PATH

SQLAlchemy Migrate 仓库路径。

trove-manage db_load_datastore_config_parameters

usage: trove-manage db_load_datastore_config_parameters [-h]
                                                        datastore
                                                        datastore_version
                                                        config_file_location

将数据存储版本的配置组参数验证规则加载到数据库中。

位置参数

datastore

数据存储的名称。

datastore_version

数据存储版本的名称。

config_file_location

配置组参数验证规则的完整文件路径。

可选参数

-h, --help

显示此帮助消息并退出

trove-manage db_recreate

警告

运行此命令将删除数据库并重新创建它。这意味着数据库中的所有数据都将丢失。运行此命令时请小心。

usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]

删除数据库并重新创建它。

可选参数

-h, --help

显示此帮助消息并退出

--repo_path REPO_PATH

SQLAlchemy Migrate 仓库路径。

trove-manage db_sync

usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]

填充数据库结构

可选参数

-h, --help

显示此帮助消息并退出

--repo_path REPO_PATH

SQLAlchemy Migrate 仓库路径。

trove-manage db_upgrade

usage: trove-manage db_upgrade [-h] [--version VERSION]
                               [--repo_path REPO_PATH]

将数据库升级到指定的版本。

可选参数

-h, --help

显示此帮助消息并退出

--version VERSION

目标版本。默认为最新版本。

--repo_path REPO_PATH

SQLAlchemy Migrate 仓库路径。