usage: octavia-db-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-journal]
[--nouse-json] [--nouse-syslog] [--nowatch-log-file]
[--shell_completion SHELL_COMPLETION]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal] [--use-json]
[--use-syslog] [--watch-log-file]
{current,history,branches,check_migration,upgrade,upgrade_persistence,downgrade,stamp,revision}
...
options:
-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. This option must be set from the command-line.
--config-file PATH Path to a config file to use. Multiple config files can be specified, with
values in later files taking precedence. Defaults to None. This option
must be set from the command-line.
--debug, -d If set to true, the logging level will be set to DEBUG instead of the
default INFO level.
--log-config-append PATH, --log-config 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. Note
that when logging configuration files are used then all logging
configuration is set in the configuration file and other logging
configuration options are ignored (for example, log-date-format).
--log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log records. Default: None .
This option is ignored if log_config_append is set.
--log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative log_file paths. This
option is ignored if log_config_append is set.
--log-file PATH, --logfile PATH
(Optional) Name of log file to send logging output to. If no default is
set, logging will go to stderr as defined by use_stderr. This option is
ignored if log_config_append is set.
--nodebug The inverse of --debug
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--shell_completion SHELL_COMPLETION
Display a shell completion script Allowed values: bash, zsh
--syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is ignored if
log_config_append is set.
--use-journal Enable journald for logging. If running in a systemd environment you may
wish to enable journal support. Doing so will use the journal native
protocol which includes structured metadata in addition to log
messages.This option is ignored if log_config_append is set.
--use-json Use JSON formatting for logging. This option is ignored if
log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is DEPRECATED and will be
changed later to honor RFC5424. This option is ignored if
log_config_append is set.
--watch-log-file Uses logging handler designed to watch file system. When log file is moved
or removed this handler will open a new log file with specified path
instantaneously. It makes sense only if log_file option is specified and
Linux platform is used. This option is ignored if log_config_append is
set.
Command:
{current,history,branches,check_migration,upgrade,upgrade_persistence,downgrade,stamp,revision}
Available commands
current Display the current revision for a database. :param config: a
:class:`.Config` instance. :param verbose: output in verbose mode.
history List changeset scripts in chronological order. :param config: a
:class:`.Config` instance. :param rev_range: string revision range. :param
verbose: output in verbose mode. :param indicate_current: indicate current
revision.
branches Show current branch points. :param config: a :class:`.Config` instance.
:param verbose: output in verbose mode.
check_migration Show current branch points. :param config: a :class:`.Config` instance.
:param verbose: output in verbose mode. and validate head file
upgrade Upgrade to a later version. :param config: a :class:`.Config` instance.
:param revision: string revision target or range for --sql mode. May be
``"heads"`` to target the most recent revision(s). :param sql: if True,
use ``--sql`` mode. :param tag: an arbitrary "tag" that can be intercepted
by custom ``env.py`` scripts via the
:meth:`.EnvironmentContext.get_tag_argument` method.
upgrade_persistence
Run migrations for persistence backend
downgrade (No longer supported)
stamp 'stamp' the revision table with the given revision; don't run any
migrations. :param config: a :class:`.Config` instance. :param revision:
target revision or list of revisions. May be a list to indicate stamping
of multiple branch heads; may be ``"base"`` to remove all revisions from
the table or ``"heads"`` to stamp the most recent revision(s). .. note::
this parameter is called "revisions" in the command line interface. :param
sql: use ``--sql`` mode :param tag: an arbitrary "tag" that can be
intercepted by custom ``env.py`` scripts via the
:class:`.EnvironmentContext.get_tag_argument` method. :param purge: delete
all entries in the version table before stamping.
revision Create a new revision file. :param config: a :class:`.Config` object.
:param message: string message to apply to the revision; this is the
``-m`` option to ``alembic revision``. :param autogenerate: whether or not
to autogenerate the script from the database; this is the
``--autogenerate`` option to ``alembic revision``. :param sql: whether to
dump the script out as a SQL string; when specified, the script is dumped
to stdout. This is the ``--sql`` option to ``alembic revision``. :param
head: head revision to build the new revision upon as a parent; this is
the ``--head`` option to ``alembic revision``. :param splice: whether or
not the new revision should be made into a new head of its own; is
required when the given ``head`` is not itself a head. This is the
``--splice`` option to ``alembic revision``. :param branch_label: string
label to apply to the branch; this is the ``--branch-label`` option to
``alembic revision``. :param version_path: string symbol identifying a
specific version path from the configuration; this is the ``--version-
path`` option to ``alembic revision``. :param rev_id: optional revision
identifier to use instead of having one generated; this is the ``--rev-
id`` option to ``alembic revision``. :param depends_on: optional list of
"depends on" identifiers; this is the ``--depends-on`` option to ``alembic
revision``. :param process_revision_directives: this is a callable that
takes the same form as the callable described at
:paramref:`.EnvironmentContext.configure.process_revision_directives`;
will be applied to the structure generated by the revision process where
it can be altered programmatically. Note that unlike all the other
parameters, this option is only available via programmatic use of
:func:`.command.revision`.
Options (16)
| Option | Description | Source |
|---|
-h, --help | show this help message and exit | help |
--config-dir DIR | Path to a config directory to pull `*.conf` files from. | help |
--config-file PATH | Path to a config file to use. | help |
--debug, -d | If set to true, the logging level will be set to DEBUG instead of the default INFO level. | help |
--log-date-format DATE_FORMAT | Defines the format string for %(asctime)s in log records. | help |
--nodebug | The inverse of --debug | help |
--nouse-journal | The inverse of --use-journal | help |
--nouse-json | The inverse of --use-json | help |
--nouse-syslog | The inverse of --use-syslog | help |
--nowatch-log-file | The inverse of --watch-log-file | help |
--shell_completion SHELL_COMPLETION | Display a shell completion script Allowed values: bash, zsh | help |
--syslog-log-facility SYSLOG_LOG_FACILITY | Syslog facility to receive log lines. | help |
--use-journal | Enable journald for logging. | help |
--use-json | Use JSON formatting for logging. | help |
--use-syslog | Use syslog for logging. | help |
--watch-log-file | Uses logging handler designed to watch file system. | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.