XML files containing one or more data fix sql statements, a sql statement to back up data, and validation statements used to determine whether the data fix should be committed or rolled back.
Object Type Identification
- If a file has .xml extension, then it is considered a data fix file
File Extensions
| Name | Description |
|---|
| .xml | Extensible Markup Language file format used to create common information formats and share both the format and the data using standard ASCII text. |
Object Type
Object Type Attributes
| Name | Code | Description | Required | Default Value | Supported Values |
|---|
| Source | SOURCE | Object source location type | Yes | SCM | SCM |
| Target Location | TARGET_LOCATION | Path to where the file should be deployed to | No |
|
|
| Database URL Property | DB_URL | Property name for database URL | No | FDJDBC_URL |
|
| Database User Property | DB_USER | Property name for database user name | No | FDJDBC_USER |
|
| Database Password Property | DB_PASSWORD | Property name for database password | No | FDJDBC_PASSWORD |
|
XML Schema
| Info |
|---|
Elements without min/max occurrences listed have the default values for cardinality, which are minOccurs="1" and maxOccurs="1" |
...
| Element | Path | XSD Line Number | Description |
|---|
| DataFix | / | 3 | The root element for the data fix |
| Description | /DataFix | 9 | A description for the data fix being run |
| FixSQL | /DataFix | 10 | The SQL which implements the data fix. It can be multiple statements delimited by a semicolon or slash |
| BackupSQL | /DataFix | 11 | SQL to perform necessary backup of data before executing FixSQL. This must be one valid SQL statement, not followed by a semicolon | Tip |
|---|
Include ${{FD_PROJECT_VERSION}} in the title of your backup table to easily identify it after execution |
|
| ConnectStringProperty | /DataFix | 12 | The JDBC connection string for the database. The object attribute will be used if property is not specified in file |
| UserProperty | /DataFix | 13 | User to connect to database with. The object attribute will be used if property is not specified in file |
| PasswordProperty | /DataFix | 14 | Password for the database user. The object attribute will be used if property is not specified in file |
| Validations | /DataFix | 15 | The rule(s) used to validate the data fix before committing changes |
| Validation | /DataFix/Validations | 18 | A single validation rule |
| Description | /DataFix/Validations/Validation | 21 | A description for the validation rule |
| ValidationSQL | /DataFix/Validations/Validation | 22 | Select query which is executed before and after the FixSQL is executed, and result is compared with before and after values. This must be one valid SQL statement, not followed by a semicolon |
| Environment | /DataFix/Validations/Validation | 23 | The expected results defined by an environment |
| EnvironmentCode | /DataFix/Validations/Validation/Environment | 26 | FlexDeploy environment code, or DEFAULT to apply to any deploy environment not explicitly specified |
| Before | /DataFix/Validations/Validation/Environment | 27 | Contains results to check before FixSQL is executed |
| After | /DataFix/Validations/Validation/Environment | 28 | Contains results to check after FixSQL is executed |
| UpdateCount | /DataFix/Validations/Validation/Environment | 29 | Results to compare return of JDBC executeUpdate() of FixSQL. If the FixSQL contains more than one statement, it is the sum of the updated rows |
| Operators | N/A | 42 | Complex type containing list of accepted operators to be used in validations |
Data Fix Source Template
| Code Block |
|---|
|
<?xml version="1.0" encoding="UTF-8"?>
<DataFix xmlns="http://flexagon.com/database/datafix">
<Description></Description>
<FixSQL></FixSQL>
<BackupSQL></BackupSQL>
<ConnectStringProperty></ConnectStringProperty>
<UserProperty></UserProperty>
<PasswordProperty></PasswordProperty>
<Validations>
<!-- Can be one or more -->
<Validation>
<Description></Description>
<ValidationSQL></ValidationSQL>
<!-- Can be one or more -->
<Environment>
<EnvironmentCode></EnvironmentCode>
<Before>
<Equals></Equals>
<NotEquals></NotEquals>
<GreaterThan></GreaterThan>
<GreaterThanEqual></GreaterThanEqual>
<LessThan></LessThan>
<LessThanEqual></LessThanEqual>
</Before>
<After>
<Equals></Equals>
<NotEquals></NotEquals>
<GreaterThan></GreaterThan>
<GreaterThanEqual></GreaterThanEqual>
<LessThan></LessThan>
<LessThanEqual></LessThanEqual>
</After>
<UpdateCount>
<Equals></Equals>
<NotEquals></NotEquals>
<GreaterThan></GreaterThan>
<GreaterThanEqual></GreaterThanEqual>
<LessThan></LessThan>
<LessThanEqual></LessThanEqual>
</UpdateCount>
</Environment>
</Validation>
</Validations>
</DataFix>
|
Data Fix Source Examples
The first example is a simple data fix that updates one row of a table, then verifies only the expected row is updated.
...