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

Code

Description

Default Value

Name

Code

Description

Default Value

DB User Property

DB_USER

The property that will be used to set the username used to log into the database.

FDORA_USER

Or You can use file name like SCHEMASCHEMANAME_FILENAME.sql.

For example, SCHEMA_SQLcltest.sql. In this case this will default to FDORA_DB_SCHEMA_USER.

DB Password Property

DB_PASSWORD

The property that will be used to set the password used to log into the database.

FDORA_PASSWORD

Or You can use file name like SCHEMASCHEMANAME_FILENAME.sql.

For example, SCHEMA_SQLcltest.sql. In this case this will default to FDORA_DB_SCHEMA_PASSWORD.

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 file contains WHENEVER SQLERROR CONTINUE case insensitively, this property will default to true, and ignore failures even if box is unchecked.

Ignore Compilation Warnings

IGNORE_COMPILATION_WARNING

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.

Fix SQL Syntax

FIX_SQL_SYNTAX

If there is need to add / at the end of file, FlexDeploy will add it at deploy time. For example, if there is program block as last statement, we need / and new line after it.

True

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.

${{FDSQLCL_SQL_ROOT_TARGET_FOLDER}}

 

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