~ubuntu-branches/debian/jessie/lava-server/jessie

« back to all changes in this revision

Viewing changes to man/lava-server.rst

  • Committer: Package Import Robot
  • Author(s): Neil Williams
  • Date: 2014-06-29 19:29:34 UTC
  • Revision ID: package-import@ubuntu.com-20140629192934-ue8hrzzpye9isevt
Tags: upstream-2014.05.30.09
ImportĀ upstreamĀ versionĀ 2014.05.30.09

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Description
 
2
============
 
3
 
 
4
Summary
 
5
#######
 
6
 
 
7
``lava-server`` is a command-line management interface to a LAVA instance,
 
8
and the Django database management tools for that instance.
 
9
 
 
10
Usage
 
11
#####
 
12
 
 
13
lava-server manage subcommand [options] [args]
 
14
 
 
15
Common Options
 
16
##############
 
17
 
 
18
Most of these options are imported from ``django`` or ``south`` and more
 
19
information can be found in the documentation of those projects.
 
20
 
 
21
These options are supported for all subcommands.
 
22
 
 
23
  -v VERBOSITY, --verbosity=VERBOSITY
 
24
                        Verbosity level; 0=minimal output, 1=normal output,
 
25
                        2=verbose output, 3=very verbose output
 
26
  --settings=SETTINGS   The Python path to a settings module, e.g.
 
27
                        "myproject.settings.main". If this isn't provided, the
 
28
                        DJANGO_SETTINGS_MODULE environment variable will be
 
29
                        used.
 
30
  --pythonpath=PYTHONPATH
 
31
                        A directory to add to the Python path, e.g.
 
32
                        "/home/djangoprojects/myproject".
 
33
  --traceback           Print traceback on exception
 
34
  --version             show program's version number and exit
 
35
  -h, --help            show this help message and exit
 
36
 
 
37
Subcommands
 
38
###########
 
39
 
 
40
Type ``lava-server manage help <subcommand>`` for help on a specific subcommand.
 
41
 
 
42
Available subcommands
 
43
#####################
 
44
 
 
45
auth
 
46
    changepassword
 
47
      Change a user's password for django.contrib.auth.
 
48
 
 
49
      Usage:
 
50
        lava-server manage changepassword [options]
 
51
      Options:
 
52
        --database=DATABASE   Specifies the database to use. Default is "default".
 
53
 
 
54
    createsuperuser
 
55
      Used to create a superuser.
 
56
 
 
57
      Usage:
 
58
        lava-server manage createsuperuser [options]
 
59
      Options:
 
60
        --username=USERNAME   Specifies the username for the superuser.
 
61
        --email=EMAIL         Specifies the email address for the superuser.
 
62
        --noinput             Tells Django to NOT prompt the user for input of any
 
63
                              kind. You must use ``--username`` and ``--email`` with
 
64
                              ``--noinput`` and superusers created with ``--noinput`` will
 
65
                              not be able to log in until they are given a valid
 
66
                              password.
 
67
        --database=DATABASE   Specifies the database to use. Default is **default**.
 
68
 
 
69
django
 
70
    cleanup
 
71
      Can be run as a cronjob or directly to clean out old data from the
 
72
      database (only expired sessions at the moment).
 
73
 
 
74
      Usage:
 
75
        lava-server manage cleanup [options]
 
76
 
 
77
    compilemessages
 
78
      Compiles .po files to .mo files for use with builtin gettext support.
 
79
 
 
80
      Usage:
 
81
        lava-server manage compilemessages [options]
 
82
      Options:
 
83
        -l LOCALE, --locale=LOCALE
 
84
                        The locale to process. Default is to process all.
 
85
    createcachetable
 
86
      Creates the table needed to use the SQL cache backend.
 
87
 
 
88
      Usage:
 
89
        lava-server manage createcachetable [options] <tablename>
 
90
      Options:
 
91
       --database=DATABASE   Nominates a database onto which the cache table will
 
92
                        be installed. Defaults to the "default" database.
 
93
 
 
94
    dbshell
 
95
      Runs the command-line client for specified database, or the default database if none is provided.
 
96
 
 
97
      Usage:
 
98
        lava-server manage dbshell [options]
 
99
      Options:
 
100
        --database=DATABASE   Nominates a database onto which to open a shell.
 
101
                        Defaults to the "default" database.
 
102
 
 
103
    diffsettings
 
104
      Displays differences between the current settings.py and the
 
105
      Django default settings. Settings that do not appear in the
 
106
      defaults are followed by "###".
 
107
 
 
108
      Usage:
 
109
        lava-server manage diffsettings [options]
 
110
 
 
111
    dumpdata
 
112
      Output the contents of the database as a fixture of the given
 
113
      format (using each model's default manager unless ``--all`` is specified).
 
114
 
 
115
      Usage:
 
116
        lava-server manage dumpdata [options] [appname appname.ModelName ...]
 
117
 
 
118
      Options:
 
119
        --format=FORMAT       Specifies the output serialization format for
 
120
                              fixtures.
 
121
        --indent=INDENT       Specifies the indent level to use when pretty-printing
 
122
                              output
 
123
        --database=DATABASE   Nominates a specific database to dump fixtures from.
 
124
                              Defaults to the "default" database.
 
125
        -e EXCLUDE, --exclude=EXCLUDE
 
126
                              An appname or appname.ModelName to exclude (use
 
127
                              multiple --exclude to exclude multiple apps/models).
 
128
        -n, --natural         Use natural keys if they are available.
 
129
        -a, --all             Use Django's base manager to dump all models stored in
 
130
                              the database, including those that would otherwise be
 
131
                              filtered or modified by a custom manager.
 
132
 
 
133
    flush
 
134
      Returns the database to the state it was in immediately after
 
135
      syncdb was executed. This means that all data will be removed from
 
136
      the database, any post-synchronization handlers will be re-executed
 
137
      and the initial_data fixture will be re-installed.
 
138
 
 
139
      Usage:
 
140
        lava-server manage flush [options]
 
141
      Options:
 
142
        --noinput             Tells Django to NOT prompt the user for input of any
 
143
                              kind.
 
144
        --database=DATABASE   Nominates a database to flush. Defaults to the
 
145
                              "default" database.
 
146
 
 
147
    inspectdb
 
148
      Introspects the database tables in the given database and outputs
 
149
      a Django model module.
 
150
 
 
151
      Usage:
 
152
        lava-server manage inspectdb [options]
 
153
      Options:
 
154
        --database=DATABASE   Nominates a database to introspect.  Defaults to using
 
155
                              the "default" database.
 
156
 
 
157
    loaddata
 
158
      Installs the named fixture(s) in the database.
 
159
 
 
160
      Usage:
 
161
        lava-server manage loaddata [options] fixture [fixture ...]
 
162
 
 
163
      Options:
 
164
        --database=DATABASE   Nominates a specific database to load fixtures into.
 
165
                        Defaults to the "default" database.
 
166
 
 
167
 
 
168
    makemessages
 
169
      Runs over the entire source tree of the current directory and
 
170
      pulls out all strings marked for translation. It creates (or
 
171
      updates) a message file in the conf/locale (in the django tree)
 
172
      or locale (for projects and applications) directory.
 
173
 
 
174
      Usage:
 
175
        lava-server manage makemessages [options]
 
176
 
 
177
      Options:
 
178
          -l LOCALE, --locale=LOCALE
 
179
                                Creates or updates the message files for the given
 
180
                                locale (e.g. pt_BR).
 
181
          -d DOMAIN, --domain=DOMAIN
 
182
                                The domain of the message files (default: "django").
 
183
          -a, --all             Updates the message files for all existing locales.
 
184
          -e EXTENSIONS, --extension=EXTENSIONS
 
185
                                The file extension(s) to examine (default: "html,txt",
 
186
                                or "js" if the domain is "djangojs"). Separate
 
187
                                multiple extensions with commas, or use -e multiple
 
188
                                times.
 
189
          -s, --symlinks        Follows symlinks to directories when examining source
 
190
                                code and templates for translation strings.
 
191
          -i PATTERN, --ignore=PATTERN
 
192
                                Ignore files or directories matching this glob-style
 
193
                                pattern. Use multiple times to ignore more.
 
194
          --no-default-ignore   Don't ignore the common glob-style patterns ``'CVS'``,
 
195
                                ``'.*'`` and ``'*~'``.
 
196
          --no-wrap             Don't break long message lines into several lines
 
197
          --no-location         Don't write '#: filename:line' lines
 
198
          --no-obsolete         Remove obsolete message strings
 
199
 
 
200
    reset
 
201
      Executes ``sqlreset`` for the given app(s) in the current database.
 
202
 
 
203
      Usage:
 
204
        lava-server manage reset [options] [appname ...]
 
205
      Options:
 
206
        --noinput             Tells Django to NOT prompt the user for input of any
 
207
                              kind.
 
208
        --database=DATABASE   Nominates a database to reset. Defaults to the
 
209
                              "default" database.
 
210
 
 
211
    runfcgi
 
212
      Run this project as a fastcgi (or some other protocol supported
 
213
      by flup) application. To do this, the flup package from
 
214
      http://www.saddi.com/software/flup/ is required.
 
215
 
 
216
      Usage:
 
217
       lava-server manage runfcgi [options] [fcgi settings]
 
218
 
 
219
      Options:
 
220
        See the django documentation for information on this option.
 
221
 
 
222
    shell
 
223
      Runs a Python interactive interpreter. Tries to use IPython, if it's available.
 
224
 
 
225
      Usage:
 
226
        lava-server manage shell [options]
 
227
 
 
228
      Options:
 
229
        --plain               Tells Django to use plain Python, not IPython.
 
230
 
 
231
 
 
232
    sql
 
233
      Prints the CREATE TABLE SQL statements for the given app name(s).
 
234
 
 
235
      Usage:
 
236
        lava-server manage sql [options] <appname appname ...>
 
237
 
 
238
      Options:
 
239
        --database=DATABASE   Nominates a database to print the SQL for.
 
240
                              Defaults to the "default" database.
 
241
 
 
242
 
 
243
    sqlall
 
244
      Prints the CREATE TABLE, custom SQL and CREATE INDEX SQL statements
 
245
      for the given model module name(s).
 
246
 
 
247
      Usage:
 
248
        lava-server manage sqlall [options] <appname appname ...>
 
249
 
 
250
      Options:
 
251
        --database=DATABASE   Nominates a database to print the SQL for.
 
252
                              Defaults to the "default" database.
 
253
 
 
254
    sqlclear
 
255
      Prints the DROP TABLE SQL statements for the given app name(s).
 
256
 
 
257
      Usage:
 
258
        lava-server manage sqlclear [options] <appname appname ...>
 
259
 
 
260
      Options:
 
261
        --database=DATABASE   Nominates a database to print the SQL for.
 
262
                              Defaults to the "default" database.
 
263
 
 
264
 
 
265
    sqlcustom
 
266
      Prints the custom table modifying SQL statements for the given app name(s).
 
267
 
 
268
      Usage:
 
269
        lava-server manage sqlcustom [options] <appname appname ...>
 
270
 
 
271
      Options:
 
272
        --database=DATABASE   Nominates a database to print the SQL for.
 
273
                              Defaults to the "default" database.
 
274
 
 
275
    sqlflush
 
276
      Returns a list of the SQL statements required to return all tables
 
277
      in the database to the state they were in just after they were installed.
 
278
 
 
279
      Usage:
 
280
        lava-server manage sqlflush [options]
 
281
 
 
282
      Options:
 
283
        --database=DATABASE   Nominates a database to print the SQL for.
 
284
                              Defaults to the "default" database.
 
285
 
 
286
    sqlindexes
 
287
      Prints the CREATE INDEX SQL statements for the given model module name(s).
 
288
 
 
289
      Usage:
 
290
        lava-server manage sqlindexes [options] <appname appname ...>
 
291
 
 
292
      Options:
 
293
        --database=DATABASE   Nominates a database to print the SQL for.
 
294
                              Defaults to the "default" database.
 
295
 
 
296
    sqlinitialdata
 
297
      RENAMED: see ``sqlcustom``
 
298
 
 
299
    sqlreset
 
300
      Prints the DROP TABLE SQL, then the CREATE TABLE SQL, for the given app name(s).
 
301
 
 
302
      Usage:
 
303
        lava-server manage sqlreset [options] <appname appname ...>
 
304
 
 
305
      Options:
 
306
        --database=DATABASE   Nominates a database to print the SQL for.
 
307
                              Defaults to the "default" database.
 
308
 
 
309
    sqlsequencereset
 
310
      Prints the SQL statements for resetting sequences for the given app name(s).
 
311
 
 
312
      Usage:
 
313
        lava-server manage sqlsequencereset [options] <appname appname ...>
 
314
 
 
315
      Options:
 
316
        --database=DATABASE   Nominates a database to print the SQL for.
 
317
                              Defaults to the "default" database.
 
318
    startapp
 
319
      Creates a Django app directory structure for the given app name
 
320
      in the current directory or optionally in the given directory.
 
321
 
 
322
      Usage:
 
323
        lava-server manage startapp [options] [name] [optional destination directory]
 
324
 
 
325
      Options:
 
326
       --template=TEMPLATE   The dotted import path to load the template from.
 
327
       -e EXTENSIONS, --extension=EXTENSIONS
 
328
                        The file extension(s) to render (default: "py").
 
329
                        Separate multiple extensions with commas, or use -e
 
330
                        multiple times.
 
331
       -n FILES, --name=FILES
 
332
                        The file name(s) to render. Separate multiple
 
333
                        extensions with commas, or use -n multiple times.
 
334
    startproject
 
335
      Creates a Django project directory structure for the given project
 
336
      name in the current directory or optionally in the given directory.
 
337
 
 
338
      Usage:
 
339
        lava-server manage startproject [options] [name] [optional destination directory]
 
340
 
 
341
      Options:
 
342
       --template=TEMPLATE   The dotted import path to load the template from.
 
343
       -e EXTENSIONS, --extension=EXTENSIONS
 
344
                        The file extension(s) to render (default: "py").
 
345
                        Separate multiple extensions with commas, or use -e
 
346
                        multiple times.
 
347
       -n FILES, --name=FILES
 
348
                        The file name(s) to render. Separate multiple
 
349
                        extensions with commas, or use -n multiple times.
 
350
 
 
351
    validate
 
352
      Validates all installed models.
 
353
 
 
354
      Usage:
 
355
        lava-server manage validate [options]
 
356
 
 
357
django_openid_auth
 
358
    openid_cleanup
 
359
      Clean up stale OpenID associations and nonces
 
360
 
 
361
      Usage:
 
362
        lava-server manage openid_cleanup [options]
 
363
 
 
364
lava_scheduler_app
 
365
    scheduler
 
366
      Run the LAVA test job scheduler
 
367
 
 
368
      Usage:
 
369
        lava-server manage scheduler [options]
 
370
      Options:
 
371
         --use-fake            Use fake dispatcher (for testing)
 
372
         --dispatcher=DISPATCHER
 
373
                             Dispatcher command to invoke
 
374
 
 
375
    schedulermonitor
 
376
     Run the LAVA test job scheduler
 
377
 
 
378
     Usage:
 
379
       lava-server manage schedulermonitor [options]
 
380
 
 
381
     Options:
 
382
       -l LOGLEVEL, --loglevel=LOGLEVEL
 
383
                        Log level, default is taken from settings.
 
384
       -f LOGFILE, --logfile=LOGFILE
 
385
                        Path to log file, default is taken from settings.
 
386
 
 
387
    testjobmigrate
 
388
      Fill out results_bundle on old testjobs.
 
389
 
 
390
      Usage:
 
391
        lava-server manage testjobmigrate [options]
 
392
 
 
393
south
 
394
    convert_to_south
 
395
      Quickly converts the named application to use South if it is currently using syncdb.
 
396
 
 
397
      Usage:
 
398
        lava-server manage convert_to_south [options]
 
399
      Options:
 
400
        --delete-ghost-migrations
 
401
                        Tells South to delete any 'ghost' migrations (ones in
 
402
                        the database but not on disk).
 
403
        --ignore-ghost-migrations
 
404
                        Tells South to ignore any 'ghost' migrations (ones in
 
405
                        the database but not on disk) and continue to apply
 
406
                        new migrations.
 
407
 
 
408
    datamigration
 
409
      Creates a new template data migration for the given app
 
410
 
 
411
      Usage:
 
412
        lava-server manage datamigration [options]
 
413
 
 
414
      Options:
 
415
        --freeze=FREEZE_LIST  Freeze the specified app(s). Provide an app name with
 
416
                              each; use the option multiple times for multiple apps
 
417
        --stdout              Print the migration to stdout instead of writing it to
 
418
                              a file.
 
419
 
 
420
    graphmigrations
 
421
      Outputs a GraphViz dot file of all migration dependencies to stdout.
 
422
 
 
423
      Usage:
 
424
        lava-server manage graphmigrations [options]
 
425
 
 
426
    migrate
 
427
      Runs migrations for all apps.
 
428
 
 
429
      Usage:
 
430
        lava-server manage migrate [options] [appname]
 
431
        [migrationname|zero] [--all] [--list] [--skip] [--merge]
 
432
        [--no-initial-data] [--fake] [--db-dry-run] [--database=dbalias]
 
433
 
 
434
      Options:
 
435
          --all                 Run the specified migration for all apps.
 
436
          --list                List migrations noting those that have been applied
 
437
          --changes             List changes for migrations
 
438
          --skip                Will skip over out-of-order missing migrations
 
439
          --merge               Will run out-of-order missing migrations as they are -
 
440
                                no rollbacks.
 
441
          --no-initial-data     Skips loading initial data if specified.
 
442
          --fake                Pretends to do the migrations, but doesn't actually
 
443
                                execute them.
 
444
          --db-dry-run          Doesn't execute the SQL generated by the db methods,
 
445
                                and doesn't store a record that the migration(s)
 
446
                                occurred. Useful to test migrations before applying
 
447
                                them.
 
448
          --delete-ghost-migrations
 
449
                                Tells South to delete any 'ghost' migrations (ones in
 
450
                                the database but not on disk).
 
451
          --ignore-ghost-migrations
 
452
                                Tells South to ignore any 'ghost' migrations (ones in
 
453
                                the database but not on disk) and continue to apply
 
454
                                new migrations.
 
455
          --noinput             Tells Django to NOT prompt the user for input of any
 
456
                                kind.
 
457
          --database=DATABASE   Nominates a database to synchronize. Defaults to the
 
458
                                "default" database.
 
459
 
 
460
    migrationcheck
 
461
      Runs migrations for each app in turn, detecting missing depends_on values.
 
462
 
 
463
      Usage:
 
464
        lava-server manage migrationcheck [options]
 
465
 
 
466
    schemamigration
 
467
      Creates a new template schema migration for the given app
 
468
 
 
469
      Usage:
 
470
        lava-server manage schemamigration [options]
 
471
      Options:
 
472
          --freeze=FREEZE_LIST  Freeze the specified app(s). Provide an app name with
 
473
                                each; use the option multiple times for multiple apps
 
474
          --stdout              Print the migration to stdout instead of writing it to
 
475
                                a file.
 
476
          --add-model=ADDED_MODEL_LIST
 
477
                                Generate a Create Table migration for the specified
 
478
                                model.  Add multiple models to this migration with
 
479
                                subsequent --model parameters.
 
480
          --add-field=ADDED_FIELD_LIST
 
481
                                Generate an Add Column migration for the specified
 
482
                                modelname.fieldname - you can use this multiple times
 
483
                                to add more than one column.
 
484
          --add-index=ADDED_INDEX_LIST
 
485
                                Generate an Add Index migration for the specified
 
486
                                modelname.fieldname - you can use this multiple times
 
487
                                to add more than one column.
 
488
          --initial             Generate the initial schema for the app.
 
489
          --auto                Attempt to automatically detect differences from the
 
490
                                last migration.
 
491
          --empty               Make a blank migration.
 
492
 
 
493
    startmigration
 
494
      Deprecated command
 
495
 
 
496
    syncdb
 
497
      Create the database tables for all apps in INSTALLED_APPS whose
 
498
      tables have not already been created, except those which use
 
499
      migrations.
 
500
 
 
501
      Usage:
 
502
        lava-server manage syncdb [options]
 
503
      Options:
 
504
          --noinput             Tells Django to NOT prompt the user for input of any
 
505
                                kind.
 
506
          --database=DATABASE   Nominates a database to synchronize. Defaults to the
 
507
                                "default" database.
 
508
          --migrate             Tells South to also perform migrations after the sync.
 
509
                                Default for during testing, and other internal calls.
 
510
          --all                 Makes syncdb work on all apps, even migrated ones. Be
 
511
                                careful!
 
512
 
 
513
    test
 
514
      Runs the test suite for the specified applications, or the entire site if no apps are specified.
 
515
 
 
516
      Usage:
 
517
        lava-server manage test [options] [appname ...]
 
518
      Options:
 
519
          --noinput             Tells Django to NOT prompt the user for input of any
 
520
                                kind.
 
521
          --failfast            Tells Django to stop running the test suite after
 
522
                                first failed test.
 
523
          --testrunner=TESTRUNNER
 
524
                                Tells Django to use specified test runner class
 
525
                                instead of the one specified by the TEST_RUNNER
 
526
                                setting.
 
527
          --liveserver=LIVESERVER
 
528
                                Overrides the default address where the live server
 
529
                                (used with LiveServerTestCase) is expected to run
 
530
                                from. The default value is localhost:8081.
 
531
 
 
532
    testserver
 
533
      Runs a development server with data from the given fixture(s).
 
534
 
 
535
      Usage:
 
536
        lava-server manage testserver [options] [fixture ...]
 
537
      Options:
 
538
          --noinput             Tells Django to NOT prompt the user for input of any
 
539
                                kind.
 
540
          --addrport=ADDRPORT   port number or ipaddr:port to run the server on
 
541
          -6, --ipv6            Tells Django to use a IPv6 address.
 
542
 
 
543
staticfiles
 
544
    collectstatic
 
545
      Collect static files in a single location.
 
546
 
 
547
      Usage:
 
548
        lava-server manage collectstatic [options]
 
549
      Options:
 
550
        --noinput             Do NOT prompt the user for input of any kind.
 
551
        --no-post-process     Do NOT post process collected files.
 
552
        -i PATTERN, --ignore=PATTERN
 
553
                        Ignore files or directories matching this glob-style
 
554
                        pattern. Use multiple times to ignore more.
 
555
        -n, --dry-run         Do everything except modify the filesystem.
 
556
        -c, --clear           Clear the existing files using the storage before
 
557
                        trying to copy or link the original file.
 
558
        -l, --link            Create a symbolic link to each file instead of
 
559
                        copying.
 
560
        --no-default-ignore   Don't ignore the common private glob-style patterns
 
561
                        ``'CVS'``, ``'.*'`` and ``'*~'``.
 
562
 
 
563
    findstatic
 
564
      Finds the absolute paths for the given static file(s).
 
565
 
 
566
      Usage:  lava-server manage findstatic [options] [file ...]
 
567
 
 
568
      Options:
 
569
      --first               Only return the first match for each static file.
 
570
 
 
571
    runserver
 
572
      Starts a lightweight Web server for development and also serves static files.
 
573
 
 
574
      Usage:
 
575
        lava-server manage runserver [options] [optional port number, or ipaddr:port]
 
576
      Options:
 
577
        -6, --ipv6            Tells Django to use a IPv6 address.
 
578
        --nothreading         Tells Django to NOT use threading.
 
579
        --noreload            Tells Django to NOT use the auto-reloader.
 
580
        --nostatic            Tells Django to NOT automatically serve static files
 
581
                        at STATIC_URL.
 
582
        --insecure            Allows serving static files even if DEBUG is False.