Backup Database Task Element
X-Ref:
- Ast Backup Database Task Node
- Ast Task Base Node
- Ast Task Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| BackupAction | BackupDatabaseTaskBackupAction | Full | This value specifies what type of backup will be performed. This is a required property |
| ConnectionName | AstAdoNetConnectionNode | This value specifies the server connection to use for the backup procedure. This is a required reference to an existing definiton. | |
| DatabaseSelectionMode | MaintenancePlanDatabaseSelectionMode | All | This value specifies whether tables, views, or both can be selected for inclusion in the task. This is a required property |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| BackupCompressionOption | BackupDatabaseTaskBackupCompressionOption | DefaultServerSetting | This value specifies whether the backup will be compressed. Options include using the default server setting, compressing regardless of the default setitng, or not compressing regardless of the default setting. |
| BackupDeviceType | BackupDatabaseTaskDevice | Disk | This value specifies what type of physical device is used to store the backed up data. |
| BackupTailLog | Boolean | False | This value specifies whether the tail of the log is backed up. |
| CopyOnlyBackup | Boolean | False | TODO |
| DelayValidation | Boolean | false | This value specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. DelayValidation is most often used when the ETL process references tables and other server assets that were created in an earlier stage of the data processing run. |
| Disabled | Boolean | false | This value specifies whether the item is disabled. The default value is False. |
| DisableEventHandlers | Boolean | false | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| ExecutionValueVariableName | AstVariableBaseNode | Specifies a variable to hold the execution results of this component. This references an existing definiton. | |
| ExpireDate | DateTime | 1/1/0001 12:00:00 AM | This value specifies the date and time when the backup data is considered obsolete. |
| FailPackageOnFailure | Boolean | false | This value determines whether the container will fail when a container component fails. If this container corresponds to a package, then the only valid value is False. |
| FailParentOnFailure | Boolean | false | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| ForcedExecutionValue | String | "0" | If the ForceExecutionValue property is set to True, then the container will return the value stored in this property as its execution value. Otherwise, this value will be ignored. The default value for ForecedExecutionValue is 0. |
| ForcedExecutionValueDataType | TypeCode | Int32 | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| ForceExecutionResult | ForceExecutionResult | None | This value indicates whether a specified execution result value will result if the container runs. The default value is None, which means that the container does not force a specified outcome. |
| ForceExecutionValue | Boolean | false | Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain the value specified in the ForcedExecutionValue property. |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. |
| IgnoreDatabasesInNotOnlineState | Boolean | False | This value specifies whether the backup process should skip databases that are offline. |
| IgnoreReplicaType | Boolean | False | TODO |
| IsolationLevel | IsolationLevel | Serializable | Sets the Isolation Level which controls how Transactions behave for this container. |
| Language | Language | Inherited | This specifies the default language to be used by this task and its descendants. |
| LoggingMode | LoggingMode | Inherit | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. |
| MaxErrorCount | Int32 | 1 | This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1. |
| RetainDays | Int32 | -1 | This value specifies how many days must pass before a backup set may be overwritten. |
| ServerVersion | Int32 | 10 | This value specifies the server version for the backup. |
| TransactionMode | ContainerTransactionMode | Join | This value specifies the transaction context in which this task will execute. |
| VerifyIntegrity | Boolean | False | This value specifies whether the backup/restore application should verify that the backup set is complete and all volumes readable. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <AutomaticBackupDestination /> | AstAutomaticDatabaseBackupDestinationNode | The AstAutomaticDatabaseBackupDestinationNode type corresponds directly to an automatic backup destination for the SQL Server Integration Services Database Backup task. |
| <ManualBackupDestination /> | AstManualDatabaseBackupDestinationNode | The AstManualDatabaseBackupDestinationNode type corresponds directly to an manual backup destination for the SQL Server Integration Services Database Backup task. |
| <PrecedenceConstraints /> | AstTaskflowPrecedenceConstraintsNode | The AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <Databases> <Database /> </Databases> | String | This is a collection of operating system files targeted by backup or restore operations. |
| <Events> <Event /> </Events> | AstTaskEventHandlerNode | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. |
| <Expressions> <Expression /> </Expressions> | AstPropertyExpressionNode | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. |
| <FilegroupsFiles> <FilegroupsFile /> </FilegroupsFiles> | String | This is a container for SQL Server file groups targeted by backup or restore operations. |
| <LogEvents> <LogEvent /> </LogEvents> | AstLogEventNode | This is a container for log event definitions that are specific to this task, container, or package. |
| <LogProviders> Multiple Choices... </LogProviders> | AstLogProviderBaseNode | Defines the log providers to use for the SSIS task or container This is a container for log provider definitions that are specific to this task, container, or package. |
| <Variables> <Variable /> </Variables> | AstVariableNode | This is a container for variable definitions that are specific to this task, container, or package. |