packageDeploy(SQLcl)

Executes a group of SQL files and copies "Other" files to specified destinations from a package created by the packageBuild(SQLcl) operation. See the appendix for information about the project file attributes.

Please note that the statements in the SQL files must be delimited properly.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Oracle Database User

FDORA_USER

Yes

The username that will be used to connect to the target Oracle Database.

Oracle Database Password

FDORA_PASSWORD

Yes

The password for Oracle Database User.

Oracle Database URL

FDORA_URL

Yes

JDBC URL for Oracle database. For example:

  • jdbc:oracle:thin:@HOSTNAME:PORT:SID or

  • jdbc:oracle:thin:@//HOSTNAME:PORT/SERVICENAME

Oracle SQLcl Home

FD_SQLCL_HOME

Yes

Folder where SQLcl is installed.

( Ex: /u01/install/sqlcl)

Make sure that the endpoint Java Home is a high enough version for your SQLcl version.

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

SQL Extension Order

FDSQLCL_SQL_EXTENSIONS

No

List SQL file extensions in desired order. Will be used for discover and sort. Files with these extensions will discover as type DB Object.

SQL Retry Count Default

FDSQLCL_RETRY_COUNT_DEFAULT

No

When discovering or evaluating files, default the Retry Count to this.

Stop On Deployment Error

FDSQLCL_STOP_ON_DEPLOYMENT_ERROR

No

Stop deploying package files if any error occurs. If unchecked all files will be deployed even if one or more files fails. This is for package operations only.

SQL Ignore Compile Warning Extensions

FDSQLCL_IGNORE_COM_ERR_EXT_DEF

No

When discovering or evaluating files, set the Ignore SQL Compilation Warning attribute to true for files with these extensions.

SQL Property Replacement Default

FDSQLCL_PROPERTY_REPLACEMENT_DEFAULT

No

When discovering or evaluating files, default Property Replacement to this.

SQL Root Target Folder

FDSQLCL_SQL_ROOT_TARGET_FOLDER

No

The path to store the delivered Sql files. Sql files will be run from here. Leave blank to run them from the FD_TEMP_DIR.

Other Root Target Folder

FDSQLCL_OTHER_ROOT_TARGET_FOLDER

No

The path to store the delivered Other files. Leave blank to store them in the FD_TEMP_DIR.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

User Profile (login.sql)

FDSQLCL_INP_LOGIN_SQL_FILE

No

User Profile (login.sql) is intended to allow users to specifically customize their session.

(see the Special considerations section for examples)

Generate SQL Spool File

FDSQLCL_INP_GENERATE_SPOOL_FILE

No

Check to generate report (Spool file) of SQL statement executions.

Show DBMS Output

FDSQLCL_INP_SHOW_DBMS_OUT

No

Check to print DBMS output in the log.

Artifacts

This operation consumes packages of files created by the packageBuild(SQLcl) operation.

Endpoint Selection

This operation delegates the selection to the workflow developer to determine.

Endpoint Execution

This operation will randomly execute on one of the endpoints identified during selection.

Special Considerations

login.sql

The script provided in the input FDSQLCL_INP_LOGIN_SQL_FILE will be created as the login.sql file in the current working directory and will be deleted after execution. The login.sql script in SQLcl is automatically executed whenever you start SQLcl. It can be used to set up your SQLcl environment, including formatting options, environment variables, and other session settings.

Below is an example script that can be customized based on requirements.

-- Set the SQLcl environment settings SET ECHO OFF SET FEEDBACK ON SET HEADING ON SET LINESIZE 200 SET PAGESIZE 9999 SET SERVEROUTPUT ON SET TERMOUT ON SET TIMING ON SET VERIFY OFF -- Set default schema ALTER SESSION SET CURRENT_SCHEMA=YOUR_SCHEMA_NAME; -- Define common substitution variables DEFINE my_variable = 'default_value' -- Custom SQL*Plus prompt SET SQLPROMPT "SQL> " -- Display a welcome message PROMPT Welcome to SQL*Plus

Please see below for information about the project file attributes

Supported Object Types

The SQLcl plugin partial deploy support allows for deploying File and Folder type objects. These links explain the three types and their attributes.

Object Types

  1. DB Objects

  2. Other Objects

 

The following macros are not currently supported in the footer:
  • style