> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

SQLPlus Script Runner

View this plugin on the Plugins site

step([$class: 'SQLPlusRunnerBuilder']): SQLPlus Script Runner

  • credentialsId
    • Type: String
  • user
    Inform schema user information (example: SCOTT) or schema user and password (example: SCOTT/TIGER). You can use global variable like ${USER}.
    • Type: String
  • password
    • Type: String
  • instance
    Inform instance information (example: ORCL). You can use global variable like ${INSTANCE}.
    • Type: String
  • scriptType
    • Type: String
  • script
    This is the name of SQL script, expected at src/main/resources folder.
    Example:
    update.sql or sql/update.sql
    • Type: String
  • scriptContent
    This is a custom SQL script.
    Example:
     SELECT sysdate from dual; 
     show user; 

    • Type: String
  • customNLSLang (optional)
    NLS_LANG is an environment variable used to define language, territory and character set properties. Example: AMERICAN_AMERICA.US7ASCII or FRENCH_CANADA.WE8ISO8859P1Source: ORAFAQ
    • Type: String
  • customOracleHome (optional)
    Using custom ORACLE_HOME will override global ORACLE_HOME. Leave this field blank to use global ORACLE_HOME. ORACLE_HOME refers to either a directory where the Oracle software is installed or an environment variable pointing to the directory where the Oracle software is installed. Source: ORAFAQ
    • Type: String
  • customSQLPath (optional)
    SQLPATH contains the name of your directory for your SQL script collection. Example: c:\u01\app\sql_scripts or /oracle/app/sqlSource: DBA Oracle
    • Type: String
  • customSQLPlusHome (optional)
    Using custom SQL*Plus will help find SQL*Plus executable file, this helps if you are working with Jenkins slave machines. Example: C:\Oracle\App\Server\Oracle\bin\sqlplus.exe or /oracle/app/oracle/product/12.1.0/dbhome_1/bin/sqlplusLearn more about distributed builds
    • Type: String
  • customTNSAdmin (optional)
    Using custom TNS_ADMIN refers to a directory where the Oracle SQL*Net configuration files (like sqlnet.ora and tnsnames.ora) are located. Example: C:\Oracle\App\Server\Oracle\network\admin or /oracle/app/oracle/product/12.1.0/dbhome_1/network/adminSource: ORAFAQ
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.