Skip to content

Oracle SQLPlus - Process Steps

Run SQLPlus script

Run SQLPlus script

NameTypeDescriptionRequired
Connection IDStringThe connection ID to be used (example: localhost:1521/ORCL). If you use the SYS account to run SQL scripts, add the suffix AS SYSDBA.Yes
Fail on Database MessagesBooleanCheck this box to fail on ORA- Database Messages. This option will be ignored if the Skip SQL Errors option is selected.No
Oracle HomeStringOptional field to specify the ORACLE_HOME environment variable value. This field is required to authenticate through Oracle Wallet.No
PasswordPasswordThe password of the user for the scripts to be run as. Leave this property blank, and specify Oracle Home, if you wish to use Oracle Wallet authentication.No
Password ScriptStringIf you want to use a script to provide password, specify the path to script here, leaving Password field blankNo
SQL FilesStringA new-line or comma separated list of sql files to be executed. Order is preserved. Supports * and ? as wildcards.It is preferred to provide the full path of the sql file. Example: C:/Folder Name/*.sqlYes
SQL Files ArgsStringA new-line or comma separated list of sql files Args to be executed, Use space to separate args belonging to same file. Order is preserved. List the files having parameters first. Put the args in double quotes if it has space in it.No
SQLPlus ExecutableStringThe full path to the sqlplus executable to be run or the command to run if it is on the path.Yes
Skip SQL ErrorsEnumeration: true, false, $Ignore any PLS, SP2, and ORA errors encountered during script execution. Select True to skip error, or false to fail on errors. You may also select the parameterized value ${p?:skipSqlErrors}, which will look for the skipSqlErrors property in UCD. If the property isnt defined, the value will be false.No
User nameStringThe user name for the scripts to be run as. Leave this property blank, and specify Oracle Home, if you wish to use Oracle Wallet authentication.No

SQLPlus through Control File

Run SQLPlus scripts using control files for orchestration.

NameTypeDescriptionRequired
ConnectionId x User to PasswordStringA newline separated list of connection IDs, User Names and Passwords. The expected format for a line is username@connectionId=Password. To use Oracle Wallet authentication, use the format @connectionId. A combination of the two formats is allowed.Yes
Control File ExcludesStringA newline separated list of control file excludes for finding control files. Use * for matching any file or folder, and ** for recursively matching folders.No
Control File IncludesStringA newline separated list of control file includes for finding control files. Use * for matching any file or folder, and ** for recursively matching folders. Each line of a control file should be formatted thusly scriptName\tconnectionId\tuser\tABORT_FLAG. \t means whitespace tab.For an example of what a control file should look like, see control.example.txt and the readme.txt in the root of the plugin.No
ModeEnumeration: check, deployWhether to do a deployment or just check that the control files match the valid syntax and all sql files are found. Both modes will do an initial check.No
Oracle HomeStringOptional field to specify the ORACLE_HOME environment variable value. This field is required to authenticate through Oracle Wallet.No
SQLPlus ExecutableStringThe full path to the sqlplus executable scripts to be run or the command to run if it is on the path.Yes