To use the Foundation DBUtils application, you can run the executable from the command line. When running the Foundation DBUtils application from the command line, use one of the following commands.
|
Command |
Description |
|---|---|
|
create |
The create command creates a new OnBase database. For example:
The database creation process can be configured through the application of command line switches. For information on the command line switches that impact the database creation process, see Applying Command Line Switches for Database Creation. |
|
upgrade |
The upgrade command upgrades an existing OnBase database. Note:
If you are upgrading your database from a schema version prior to 3.5-441, you must use OnBase Configuration to upgrade your database to schema version 3.5-441. See the System Administration module reference guide for more information. When using this command, you must include one of the following arguments:
Include the service argument to use an automatic service to verify the upgrade. Include the interactive argument to display a challenge code. Use the challenge code to acquire a corresponding response code, and enter the response code to verify the upgrade. The response code is available from your first line of support. For example:
The database upgrade process can be configured through the application of command line switches. For information on the command line switches that impact the database upgrade process, see Applying Command Line Switches for Database Upgrades. |
|
reupgrade |
The reupgrade command conducts a subset of upgrade processes previously run on an existing OnBase database. These processes ensure that proper default values are set and appropriate migration scripts are rerun. For example:
The database reupgrade process can be configured through the application of command line switches. For information on the command line switches that impact the database reupgrade process, see Applying Command Line Switches for Database Upgrades. |
|
compare |
The compare command compares the schema of an attached database against the defined schema associated with your version of Foundation DBUtils. This allows you to review the changes that Foundation DBUtils will enact prior to upgrading your database. It also allows you to determine if there are any tables or indexes that differ from the schema associated with your version of Foundation DBUtils. |
|
protect |
The protect command encrypts the ProtectedSection of a specified JSON configuration file. CAUTION:
The protect command conducts encryption that cannot be manually unencrypted. The encrypted values can only be read by Foundation DBUtils when the application is run by the user that performed the initial encryption. For example:
Where <JSONConfigurationFile> is the full path to either the default JSON configuration file or a custom JSON configuration file. Note:
The default JSON configuration file is usually located in the same directory as the Foundation DBUtils application. For more information on using JSON configuration files with the Foundation DBUtils application, see Modifying the JSON Configuration File. |