BackupDB
- Last Updated: March 25, 2026
- 1 minute read
- OpenEdge DevOps Framework
- Version 2.4
- Documentation
Use this task to create a backup of an OpenEdge database.
Properties
| Property | Required? | Description | Example | Default value |
|---|---|---|---|---|
source |
Yes |
Path to the database where the Can be relative or absolute. May or may not include the
|
source="path" |
None |
target |
Yes |
Path of the backup file for the database. Can be absolute or relative. |
target="path" |
None |
overwrite |
No | Whether to replace if the backup file exists | overwrite=true |
false |
online |
No |
Indicates the database must be online or not when doing a backup. If not set, the Leave this out if you want the task to auto detect if this option should be used. |
online=true |
Auto |
incremental |
No | Performs an incremental backup. | incremental=true |
false |
Sample code snippet
The following code snippet is an example using
BackupDB:
task createDBBackup(type: BackupDB){
source = "db/sports2020/sports2020.db"
target = "${buildDir}/dist/sports2020.bck"
overwrite = true
}