Skip to content

Command Line Parameters

LHCGreg edited this page Sep 7, 2013 · 1 revision

Options that take a value can be specified either as --option=value or -option value.

Usage: pgdbsc  [OPTIONS]
Available commands are "checkout" and "update".

Parameters:
  -?, -h, --help             Show this message and exit.
  -v, --version              Show version information and exit.
      --targetDb=VALUE       Target database name to create or update.
                               Defaults to the master database name detected
                               from script names.
      --targetDbServer=VALUE Server of the target database. Defaults to
                               localhost.
      --port, --targetDbPort=VALUE
                             Port number of the target database to connect t-
                               o. Defaults to the normal port. Not relevant for

                               MS SQL Server.
  -u, --username=VALUE       Username to use to log in to the target databas-
                               e. If not specified, log in with integrated
                               security.
  -p, --password=VALUE       Password to use to log in to the target databas-
                               e. If not specified and username is not
                               specified, log in with integrated security. If
                               not specified and username is specified, you
                               will be prompted for your password.
      --dir, --scriptDirectory=VALUE
                             Directory with sql scripts to run. If not
                               specified, defaults to the current directory.
  -r=VALUE                   Revision number to check out or update up to. If
                               not specified, goes up to the highest available
                               revision.
      --dbCreateTemplate=VALUE
                             File with a template to use when creating the
                               database in a checkout. $DatabaseName$ will be
                               replaced with the database name. If not
                               specified, a simple "CREATE DATABASE
                               $DatabaseName$" will be used. This is a good
                               place to set database options or grant
                               permissions.
      --sourceDbServer=VALUE Database server to import data from. Data will
                               be imported when the target database's revision
                               matches the source database's revision. The
                               source database must have been created using
                               dbsc.
      --sourceDb=VALUE       Database to import data from. If not specified,
                               defaults to the master database name.
      --sourcePort, --sourceDbPort=VALUE
                             Port number of the source database to connect t-
                               o. Defaults to the normal port. Not relevant for

                               MS SQL Server.
      --sourceUsername=VALUE Username to use to log in to the source databas-
                               e. If not specified, uses integrated security.
      --sourcePassword=VALUE Password to use to log in to the source databas-
                               e. If not specified and username is not
                               specified, uses integrated security. If not
                               specified and username is specified, you will be

                               prompted for your password.
      --importTableList=VALUE
                             File with a list of tables to import from the
                               source database, one per line. If not specified,

                               all tables will be imported.