JDBC Object Types - 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

Attribute Code

Name

Description

Default Value

Attribute Code

Name

Description

Default Value

FDJDBC_USER_PROPERTY

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 Target, or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations.

FDJDBC_PASSWORD_PROPERTY

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 Target or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations.

FDJDBC_URL_PROPERTY

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 Target 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

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

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.

If this is checked any SQL execution failure will be ignored and following Statements in file will continue to be executed. File will be marked as Success on execution results.

If this is not checked then any SQL execution failure will mark file as Failed and following Statements in file will not be attempted.

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_WARNING

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

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

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 FD_TEMP_DIR. If the default is used, but the SQL Root Target Folder project property is left blank, then the file will be copied into FD_TEMP_DIR.

${{FDJDBC_SQL_ROOT_TARGET_FOLDER}}

RUN_AS_USER

Run As User

If set, a SQL statement will be executed before the file to switch schema (user). Property replacement will be performed on the value. This is a convenient attribute when many files must switch schema before execution. For example you can use ${{MYSCHEMA}}, where MYSCHEMA is Project or Target property.

This attribute is only supported for Oracle, PostgreSQL, and SQL Server databases.

I.E. If Run As User is set to “TestUser”, then the following would be executed before the file depending on database type:

// Oracle ALTER SESSION SET current_schema=TestUser // PostgreSQL SET SEARCH_PATH TO TestUser // SQL Server EXECUTE AS USER=TestUser

N/A

 

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