Command Line Switches for Foundation DBUtils - Upgrade Guidelines - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Upgrade Guidelines

Platform
OnBase
Product
Upgrade Guidelines
Release
Foundation 23.1
License
Standard
Essential
Premier

When running the Foundation DBUtils application, you can apply command line switches. Command line switches can be applied to specify database connection information, specify an alternative JSON configuration file, or view help information.

Note:

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

The following command line switches can be applied when using the upgrade command:

Switch

Description

--datasourcename

A unique name, defined by the user, to identify the connection string used to connect to the database.

Note:

This identifying name may be different from the name of the actual database.

--connectionstring

The connection string used to connect to the database.

--provider

The data provider type used for the database. Only SQL Server and Oracle data providers can be used to connect to the OnBase database. Use one of the following:

  • For a SQL Server database:

    "System.Data.SqlClient"

  • For an Oracle database:

    "Oracle.ManagedDataAccess.Client"

--configoverride

Specifies the full path to a custom JSON configuration file.

--help

Displays help information.

For example, the following upgrade command updates a database, and the command line switches provide the connection information for the database. In this example, 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