Prior to running Foundation DBUtils with the create command, you can configure the database creation process by applying command line switches. The available command line switches are described below.
|
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. |
|
--hsipassword |
Sets the password for the hsi user. For more information, see --hsipassword. |
|
--viewerpassword |
Sets the password for the viewer user. For more information, see --viewerpassword. |
|
--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. |
|
--nouser |
Prevents the Foundation DBUtils application from creating users during the database creation process. For more information, see --nouser. |
|
--help |
Displays help information for the preceding command. For more information, see --help. |
|
--dbspace# |
Specifies the initial size, growth increment, and full path to the corresponding tablespace. For more information, see --dbspace# "[initial size], [growth increment], [tablespace path]". |
|
--tablespaceoption |
Specifies the process used to create tablespaces. The options include:
For more information, see --tablespaceoption "[option]". |
|
--check |
Forces the Foundation DBUtils application to create Check Document Types during the database creation process. For more information, see --check. |
|
--testsystem |
Forces the Foundation DBUtils application to only execute the portions of the database creation process required for Test System Creation. For more information, see --testsystem. |
|
--transferdb |
Forces the Foundation DBUtils application to only execute the portions of the database creation process required for the creation of a transfer database. For more information, see --transferdb. |
|
--unicode |
Forces the Foundation DBUtils application to create a database with Unicode character columns. For more information, see --unicode. |
|
--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 create command is followed by command line switches that specify a name for the connection string used to connect to the database, connection string parameters, database provider information, and passwords for the hsi and viewer database users:
foundationdbutils.exe create --datasourcename "DataSourceName" --connectionstring "Data Source=Serv001\instance;database=TestDB; User Id=username;Password=password" --provider "System.Data.SqlClient" --hsipassword "password1" --viewerpassword "password2"
Any options specified by applying command line switches override the corresponding option specifications in any default or custom JSON configuration files.