packageDeploy (JDBC)

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

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

The SQL Databases supported by the parser are:

  • Oracle 10g+

    • Using statement delimiter of ;

    • PL/SQL blocks starting with DECLARE or BEGIN and finishing with END; /

  • MySql 5.1+

  • PostgreSql 9.0+ 

  • Derby 10.8.2.2+

  • SAP HANA

  • SQL Server 2008+

  • MariaDB 10.0+

  • Vertica 6.5+

  • H2 1.2.137+

  • solidDB 6.5+

  • SQL Azure

  • DB2 9.7+

  • AWS Redshift

  • Hsql 1.8+

  • Sybase ASE12.5+

  • SQLite 3.7.2+

  • DB2 z/OS 9.1+

  • EnterpriseDB 9.4+

  • Phoenix 4.2.2+

  • Greenplum 4.3+

No JDBC drivers are included in the plugin, so the path to one is required (FDJDBC_DRIVER_PATH).

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

JDBC URL

FDJDBC_URL

Yes

The JDBC URL of the database.

JDBC User

FDJDBC_USER

No

The username that will be used to connect with.

JDBC Password

FDJDBC_PASSWORD

No

The password of the username.

JDBC Driver Path

FDJDBC_DRIVER_PATH

Yes

Classpath for locating the JDBC Driver

Ex: /u01/sqlcl/lib/ojdbc8.jar

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Ignore Compile Error Extensions

FDJDBC_IGNORE_COM_ERR_EXT_DEF

No

When populating or evaluating files, set Ignore Failure to true for files with these extensions (tbl). This property sets the default attribute value for populated project files, and does not impact the deployment behavior of existing project files (unless explicitly re-evaluated to pick up the default).

For Oracle database, plugin will print errors from USER_ERRORS or DBA_ERRORS for the object being deployed. It reads errors from USER_ERRORS first and then reads from DBA_ERRORS if nothing found, previously it read from one or the other depending on if schema is coded in SQL statement. 

Ex: tbl

SQL Ignore Failure Extensions

FDJDBC_IGNORE_COM_ERR_EXT_DEF

No

When populating or evaluating files, set Ignore Compilation Warnings to true for files with these extensions (pks, pkb). This property sets the default attribute value for populated project files, and does not impact the deployment behavior of existing project files (unless explicitly re-evaluated to pick up the default).

Ex: pkb,pks

SQL Ignore Drop Failures

FDJDBC_IGNORE_DROP_FAILURE

No

When executing drop SQL statements ignore errors. Useful if SQL files consistently have DROP statements but dropped entity does not always exist. Defaults to false.

Property Replacement Default

FDJDBC_PROPERTY_REPLACEMENT_DEFAULT

No

When populating or evaluating files, default Property Replacement to this. This property sets the default attribute value for populated project files, and does not impact the deployment behavior of existing project files (unless explicitly re-evaluated to pick up the default).

SQL Root Target Folder

FDJDBC_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

FDJDBC_OTHER_ROOT_TARGET_FOLDER

No

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

Retry Count Default

FDJDBC_RETRY_COUNT_DEFAULT

No

When populating or evaluating files, default the Retry Count to the specified value (0-5). This property sets the default attribute value for populated project files, and does not impact the deployment behavior of existing project files (unless explicitly re-evaluated to pick up the default).

SQL Extension Order

FDJDBC_SQL_EXTENSIONS

No

The order of sql extensions that you want to use when populating and sorting files. Files should be sorted as needed at or before build time.

Defaults to "seq,tbl,idx,typ,tps,tpb,sql,pkh,plb,pks,pkb,pls,pck,fnc,trg,spc,bdy,prc"

Project File Includes

FD_PARTIAL_FILE_INCLUDES

No

Controls files included in Project Files during populate. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used (e.g. /java/*##*.java##*person*##/java/.*[tT]est.*\.java).  

Project File Excludes

FD_PARTIAL_FILE_EXCLUDES

No

Controls files excluded from Project Files during populate. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used (e.g. /java/*##*.java##*person*##/java/.*[tT]est.*\.java).

Stop On Deployment Error

FDJDBC_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.

This value defaults to false

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Run Destructive

FDJDBC_INP_RUN_DESTRUCTIVE

No

This option allows destructive statements to be run. See Special Considerations below.

Show DBMS Output

FDJDBC_INP_SHOW_DBMS_OUT

No

No Print DBMS Output in the log. Only supported for Oracle Database.

Show SQL

FDJDBC_INP_PRINT_SQL

No

Print SQL statement in log.

Generate SQL Execution Report

FDJDBC_INP_GENERATE_SQL_EXECUTION_REPORT

No

Check to generate report of successful SQL statement executions.

Artifacts

This operation consumes packages of files created by the packageJdbcBuild 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

See below for information about the project file attributes.

Supported Object Types

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