Applying Command Line Switches for Database Upgrades - Database Reference Guide - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external

Database Reference Guide

Platform
OnBase
Product
Database Reference Guide
Release
Foundation 23.1
License

Prior to running Foundation DBUtils with the upgrade or reupgrade commands, you can configure the database upgrade process by applying command line switches.The following command line switches can be applied when using the upgrade or reupgrade commands:

Switch

Description

--datasourcename

Specifies a unique name for the connection string used to connect to the database. For more information, see --datasourcename.

--connectionstring

Specifies the connection string used to connect to the database. For more information, see --connectionstring.

--provider

Specifies the data provider type used for the database. For more information, see --provider.

--configoverride

Specifies the full path to a custom JSON configuration file. For more information, see --configoverride.

Note:

For more information on using custom JSON configuration files with the Foundation DBUtils application, see Modifying the JSON Configuration File.

--help

Displays help information for the preceding command. For more information, see --help.

--verbose

CAUTION:

This command line switch should never be applied in a production environment. The resulting logs contain detailed messages and may include sensitive data.

Add the --verbose switch to set the logging level to trace.

For example, the following upgrade command upgrades an OnBase database. In this example, connection information is provided using command line switches, and an interactive challenge code is used to validate the upgrade:

foundationdbutils.exe upgrade --datasourcename "DataSourceName" --connectionstring "Data Source=Serv001\instance;database=TestDB; User Id=username;Password=password" --provider "System.Data.SqlClient" interactive

Note:

Any options specified by applying command line switches override the corresponding option specifications in any default or custom JSON configuration files.