4. Commands

Most of the available commands must be run from the main directory where the file manage.py is located.

This script accepts a command followed by mandatory and optional arguments.

Usage: ./manage.py subcommand [options] [args]

The following options are always available:

-v VERBOSITY, --verbosity=VERBOSITY

Verbosity level; 0=minimal output, 1=normal output, 2=all output

--traceback

Print traceback on exception. Useful for debugging purpose.

--settings=SETTINGS

The Python path to a settings module, e.g. “myproject.settings.main”. If this isn’t provided, the DJANGO_SETTINGS_MODULE environment variable will be used.

--pythonpath=PYTHONPATH

A directory to add to the Python path, e.g. “/home/djangoprojects/myproject”.

--version

show Django’s version number

-h, --help

show an help message and exit

4.1. Database related commands

4.1.1. syncdb

The command ./manage.py syncdb creates the database tables for all apps in INSTALLED_APPS whose tables haven’t already been created, except those which use migrations.

Usage: ./manage.py syncdb [options]

--all

Makes syncdb work on all apps, even migrated ones. Be careful! This option should only be set to initialize if no tables were created.

4.1.2. migrate

The command ./manage.py migrate runs migrations for all apps.

Use this commands after an upgrade of OpenPLM to synchronize the database. Always make a backup of your data (database and files) before running this command!

Usage: ./manage.py migrate [options] [appname] [migrationname|zero] [--all] [--list] [--skip] [--merge] [--no-initial-data] [--fake] [--db-dry-run] [--database=dbalias]

--all

Run the specified migration for all apps.

--list

List migrations noting those that have been applied

--skip

Will skip over out-of-order missing migrations

--merge

Will run out-of-order missing migrations as they are - no rollbacks.

--no-initial-data

Skips loading initial data if specified.

--fake

Pretends to do the migrations, but doesn’t actually execute them. Only set this option if your database schema is synchronised with OpenPLM source code.

--db-dry-run

Doesn’t execute the SQL generated by the db methods, and doesn’t store a record that the migration(s) occurred. Useful to test migrations before applying them.

--delete-ghost-migrations

Tells South to delete any ‘ghost’ migrations (ones in the database but not on disk).

--ignore-ghost-migrations

Tells South to ignore any ‘ghost’ migrations (ones in the database but not on disk) and continue to apply new migrations.

See also

More documentation on this command is available here.

4.1.3. dbshell

Runs the command-line client for the database.

Usage: ./manage.py dbshell

4.2. Search index related commands

Note

Do not forget to set change the owner of the index directory to www-data (user who runs celery)

4.2.1. rebuild_index

The command ./manage.py rebuild_index completely rebuilds the search index by removing the old data and then updating.

Usage: ./manage.py rebuild_index [options]

-a AGE, --age=AGE

Number of hours back to consider objects new.

-b BATCHSIZE, --batch-size=BATCHSIZE

Number of items to index at once.

-r, --remove

Remove objects from the index that are no longer present in the database.

-k WORKERS, --workers=WORKERS

Allows for the use multiple workers to parallelize indexing. Requires multiprocessing.

4.2.2. update_index

The command ./manage.py update_index freshens the index for the given app(s).

Usage: ./manage.py update_index [options] <appname appname ...>

-a AGE, --age=AGE

Number of hours back to consider objects new.

-b BATCHSIZE, --batch-size=BATCHSIZE

Number of items to index at once.

-r, --remove

Remove objects from the index that are no longer present in the database.

-k WORKERS, --workers=WORKERS

Allows for the use multiple workers to parallelize indexing. Requires multiprocessing.

See also

More documentation on these commands is available here.

4.3. User related commands

4.3.1. changepassword

The command ./manage.py changepassword changes the password of the given user.

Usage ./manage.py changepassword [options] username

4.3.2. createsuperuser

The command ./manage.py createsuperuser creates a new super user (administrator who can manage data through the admin interface).

Usage ./manage.py createsuperuser [options]

4.3.3. createcompany

The command ./manage.py createcompany creates the company user (special user who owns official and deprecated parts and documents).

Usage ./manage.py createcompany [options]

4.4. Translation related commands

4.4.1. makemessages

The command ./manage.py makemessages creates/updates a message file (extensions : .po) in the conf/locale (in the django tree) or locale (for project and application) directory.

Usage ./manage.py makemessages [options]

-v VERBOSITY, --verbosity=VERBOSITY

Verbosity level; 0=minimal output, 1=normal output, 2=all output

--settings=SETTINGS

The Python path to a settings module, e.g. “myproject.settings.main”. If this isn’t provided, the DJANGO_SETTINGS_MODULE environment variable will be used.

--pythonpath=PYTHONPATH

A directory to add to the Python path, e.g. “/home/djangoprojects/myproject”.

--traceback

Print traceback on exception

-l LOCALE, --locale=LOCALE

Creates or updates the message files only for the given locale (e.g. pt_BR).

-a, --all

Reexamines all source code and templates for new translation strings and updates all message files for all available languages.

-e EXTENSIONS, --extension=EXTENSIONS

The file extension(s) to examine (default: ”.html”, separate multiple extensions with commas, or use -e multiple times)

-i PATTERN, --ignore=PATTERN

Ignore files or directories matching this glob-style pattern. Use multiple times to ignore more.

See also

More documentation on these commands is available here.

Note

When you create/update message files for the main application use ./manage.py makemessages - -ignore=apps/* [options]

If you want to create/update message files for a given application, first change your current directory to the application directory.

4.4.2. compilemessages

The command ./manage.py compilemessages compiles message files (.po) to .mo files .

Usage ./manage.py compilemessages [options]

-v VERBOSITY, --verbosity=VERBOSITY

Verbosity level; 0=minimal output, 1=normal output, 2=all output

--settings=SETTINGS

The Python path to a settings module, e.g. “myproject.settings.main”. If this isn’t provided, the DJANGO_SETTINGS_MODULE environment variable will be used.

--pythonpath=PYTHONPATH

A directory to add to the Python path, e.g. “/home/djangoprojects/myproject”.

--traceback

Print traceback on exception

-l LOCALE, --locale=LOCALE

The locale to process. Default is to process all.

See also

More documentation on these commands is available here.

Note

If you want to compile message files for a given application, first change your current directory to the application directory.