1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
.. This file is manually generated, unlike many of the other chapters.
================================
trove-manage command-line client
================================
The :command:`trove-manage` client is the command-line interface (CLI)
for the Database Management Utility API and its extensions.
This chapter documents :command:`trove-manage` version ``5.0.1``.
For help on a specific :command:`trove-manage` command, enter:
.. code-block:: console
$ trove-manage COMMAND --help
.. _trove-manage_command_usage:
trove-manage usage
~~~~~~~~~~~~~~~~~~
.. code-block:: console
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_command_options:
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 ``INFO`` 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. 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,
``logging_context_format_string``).
``--log-date-format DATE_FORMAT``
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-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.
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.
``--verbose, -v``
If set to false, the logging level will be set to ``WARNING``
instead of the default ``INFO`` level.
``--version``
show program's version number and exit
``--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.
trove-manage datastore_update
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
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_flavor_add
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
usage: trove-manage datastore_version_flavor_add [-h]
datastore_name
datastore_version_name
flavor_ids
**positional arguments:**
``datastore_name``
Name of the datastore.
``datastore_version_name``
Name of the datastore version.
``flavor_ids``
Comma separated list of flavor ids.
**optional arguments:**
``-h, --help``
show this help message and exit
trove-manage datastore_version_flavor_delete
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
usage: trove-manage datastore_version_flavor_delete [-h]
datastore_name
datastore_version_name
flavor_id
**positional arguments:**
``datastore_name``
Name of the datastore.
``datastore_version_name``
Name of the datastore version.
``flavor_id``
The flavor to be deleted for a given datastore and datastore version.
**optional arguments:**
``-h, --help``
show this help message and exit
trove-manage datastore_version_update
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
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
~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
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_load_datastore_config_parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
usage: trove-manage db_load_datastore_config_parameters [-h]
datastore
datastore_version
config_file_location
Loads configuration group parameter validation rules for a datastore version
into the database.
**positional arguments:**
``datastore``
Name of the datastore.
``datastore_version``
Name of the datastore version.
``config_file_location``
Fully qualified file path to the configuration group
parameter validation rules.
**optional arguments:**
``-h, --help``
show this help message and exit
trove-manage db_recreate
~~~~~~~~~~~~~~~~~~~~~~~~
.. caution::
Running this command will drop the database and recreate it. It means all
data in the database will be lost. Becareful when running this command.
.. code-block:: console
usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]
Drop the database and recreate it.
**optional arguments:**
``-h, --help``
show this help message and exit
``--repo_path REPO_PATH``
SQLAlchemy Migrate repository path.
trove-manage db_sync
~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
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
~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
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.
|
