This is RenderMan 21 Documentation you are viewing. The Rmanwiki home page will redirect you to the current documentation.

Page tree


This command line tool is used by the engine to automatically start and stop the back-end PostgreSQL relational database server. It can also be used by site admins to perform various database maintenance tasks.


Usage:tractor-dbctl [options]



start the postgresql server and automaticallybuild/upgrade schema as configured in db.config (used by engine)


stop the postgresql server as configured in db.config(used by engine)

--startstart the postgresql server
--stopstop the postgresql server; this could be used to shut down postgresql if the engine wasn't able to do this automatically, or if the postgresql server was started manually; don't run this if the engine is running.
--statuscheck the status of the postgresql server
--initinitialize the postgresql data directory; server must not be running
--buildbuild the tractor database; server must be running
--destroyremove the postgres database directory; server must not be running; this will remove all current and historical job and blade information.
--upgradeupdate the database schema
--check-upgradecheck whether upgrades are required
--no-auto-upgradeprevent automatic upgrading of the database schema
--purge-jobsremove all jobs
--vacuumrebuild tables of non-deleted jobs to save space
--reset-job-counterreset the job id counter so that job ids (jids) start at 1; can only be used with --purge-jobs
--show-paramsdisplay configuration parameters stored in the database
--update-paramspush certain configuration parameters as defined in the config files to the database
--logs-usagereport disk space used by postgresql log files
--purge-logsremove postgresql log files
--backup=filenamewrite backup to specified file; the server must not be running.
--restore=filenamerestore database from specified backup file; the server must not be running
--config-dir=pathpath to tractor config directory
--quiet, --qsuppress all output, except for errors
--verbose, -vadjust the level of verbosity
--debug, -dprint debug messages
--help, -hthis message