--help - 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

Add the --help switch to display help information. When the --help switch is applied, the command preceding the switch is not executed. Instead, the command preceding the switch determines what kind of help information is displayed.

Command

Description of Help Information

No Command

Adding the --help switch without a command displays general help information. For example:

  • foundationdbutils.exe --help

create

Adding the --help switch with the create command displays help information relevant to the database creation process. For example:

  • foundationdbutils.exe create --help

upgrade

Adding the --help switch with the upgrade command displays help information relevant to the database creation process. For example:

  • foundationdbutils.exe upgrade --help

protect

Adding the --help switch with the protect command displays help information relevant to the process used to encrypt the ProtectedSection of a JSON configuration file. For example:

  • foundationdbutils.exe protect --help