partialJdbcDeploy
- Karl Henselin
- Chandresh Patel
- Erick Jones
@Since 4.5.1
Executes a group of sql files and copies "Other" files to specified destinations from a package created by the partialJdbcBuild 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).
Environment/Instance Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| JDBC URL |
| Yes | The JDBC URL of the database. |
| JDBC User |
| No | The username that will be used to connect with. |
| JDBC Password |
| No | The password of the username. |
| JDBC Driver Path |
| Yes | Classpath for locating the JDBC Driver (e.g. for Weblogic - |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
| Ignore Failure Default | FDJDBC_IGNORE_FAILURE_DEFAULT | No | When populating or evaluating files, set the Ignore SQL Compilation Errors attribute to true for files with these extensions (e.g. .tbl,.idx). 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). |
| FDJDBC_IGNORE_COM_ERR_EXT_DEF | No | When populating or evaluating files, set Ignore Failure 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). | |
| 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). |
Inputs
| 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. @Since 4.6.0.4 |
| Show SQL | FDJDBC_INP_PRINT_SQL | No | Print SQL statement in log. @Since 4.6.0.4 |
Outputs
Output Name | Required | Description |
|---|---|---|
Artifacts
This operation consumes packages of files created by the partialJdbcBuild operation.
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
Endpoint Execution
This operation will randomly execute on one of the endpoint identified during selection.
Special Considerations
See below for information about the project file attributes.
Supported Object Types
The JDBC plugin partial deploy support allows for deploying File and Folder type objects. This page explains the two types and their attributes. This functionality became available in the 4.5.1 release.
DB Objects
DB (Database) type objects model sql files that are stored in SCM. They are used to copy sql files from an SCM to a filesystem on an endpoint where they are executed by JDBC. DB type objects can be sourced only from an SCM. They cannot be created manually. No attributes are required.
Subfolders to the final target location of the sql files are created by the plugin as long as the endpoint user has sufficient privileges.
Attributes
Name | Description | Default Value |
|---|---|---|
| User Property | The property that will be used to set the username used to log into the database. | FDJDBC_USER - Set this value on the environment/instance, or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations. |
| Password Property | The property that will be used to set the password used to log into the database. | FDJDBC_PASSWORD- Set this value on the environment/instance, or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations. |
| JDBC URL Property | The property that will be used to set the JDBC URL used to log into the database. | FDJDBC_URL- Set this value on the environment/instance, or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations. |
| Retry Count | How many times should the file be retried before marking it as a failure. It may be useful to set it to a larger value if deploying many files together if the selected order may not be correct. | Retry Count Default is the project property that fills in the default value at evaluate or populate time. |
| Ignore Failure | If checked, the file and the execution will be marked successful even if it fails to be processed in any way. The failure will be logged, but there will be no other indication. | Ignore Failure Extensions is the project property that takes a list of extensions. Any files that end with those extensions will have their ignore failures checkbox checked at populate or evaluate time. |
| Ignore Compilation Warnings | If checked, the file and the execution will be marked successful even if it encounters a compilation warning. The warning will be logged, but there will be no other indication. | Ignore Compile Error Extensions is the project property that takes a list of extensions. Any files that end with those extensions will have their ignore compilation warnings checkbox checked at populate or evaluate time. |
| Property Replacement | If checked, property replacement will be run on the file, unless it appears to be a binary file, and then it will be skipped for property replacement. | Property Replacement Default is the project property to control the default. |
| Target Location | This is the location where the file will be placed. Property replacement will be performed on the value. If blank, the file will be copied into | ${{FDJDBC_SQL_ROOT_TARGET_FOLDER}} |
Other Objects
Other objects type objects model non-sql files that are stored in SCM. They are used to copy files that are stored with sql files from an SCM to a filesystem on an endpoint.Optionally they can have property replacement performed on the,. They cannot be created manually. No attributes are required.
Attributes
Name | Description | Default Value |
|---|---|---|
| Target Location | This is the location where the file will be placed. Property replacement will be performed on the value. If blank, the folder will be created in | ${{FDJDBC_OTHER_ROOT_TARGET_FOLDER}} |
| Property Replacement | If checked, property replacement will be run on the file, unless it appears to be a binary file, and then it will be skipped for property replacement. | Property Replacement Default is the project property to control the default. |
- style