Biml Language Reference
BackupDatabaseTask Element
The Back Up Database task can back up one or more SQL Server databases.
Attributes
  Attribute API Type Default Description
BackupAction BackupDatabaseTaskBackupAction
This value specifies what type of backup will be performed.

[.NET API Property: BackupAction]

BackupCompressionOption BackupDatabaseTaskBackupCompressionOption
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.

[.NET API Property: BackupCompressionOption]

BackupDeviceType BackupDatabaseTaskDevice
This value specifies what type of physical device is used to store the backed up data.

[.NET API Property: BackupDeviceType]

BackupTailLog Boolean
This value specifies whether the tail of the log is backed up.

[.NET API Property: BackupTailLog]

ConnectionName AstAdoNetConnectionNode
This value specifies the server connection to use for the backup procedure.

[.NET API Property: Connection]

CopyOnlyBackup Boolean
TODO

[.NET API Property: CopyOnlyBackup]

DatabaseSelectionMode MaintenancePlanDatabaseSelectionMode
This value specifies whether tables, views, or both can be selected for inclusion in the task.

[.NET API Property: DatabaseSelectionMode]

DelayValidation Boolean
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.

[.NET API Property: DelayValidation]

Disabled Boolean
This value specifies whether the item is disabled. The default value is False.

[.NET API Property: Disabled]

DisableEventHandlers Boolean
This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.

[.NET API Property: DisableEventHandlers]

ExecutionValueVariableName AstVariableBaseNode
Specifies a variable to hold the execution results of this component.

[.NET API Property: ExecutionValueVariable]

ExpireDate DateTime
This value specifies the date and time when the backup data is considered obsolete.

[.NET API Property: ExpireDate]

FailPackageOnFailure Boolean
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.

[.NET API Property: FailPackageOnFailure]

FailParentOnFailure Boolean
This value determines whether the parent container will fail when a child container failes. The default value is False.

[.NET API Property: FailParentOnFailure]

ForcedExecutionValue String
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.

[.NET API Property: ForcedExecutionValue]

ForcedExecutionValueDataType TypeCode
This property specifies the data type of the value stored in the ForceExecutionValue property.

[.NET API Property: ForcedExecutionValueDataType]

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

[.NET API Property: ForceExecutionResult]

ForceExecutionValue Boolean
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.

[.NET API Property: ForceExecutionValue]

Id Guid
Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.

[.NET API Property: Id]

IgnoreDatabasesInNotOnlineState Boolean
This value specifies whether the backup process should skip databases that are offline.

[.NET API Property: IgnoreDatabasesInNotOnlineState]

IgnoreReplicaType Boolean
TODO

[.NET API Property: IgnoreReplicaType]

IsolationLevel IsolationLevel
Sets the Isolation Level which controls how Transactions behave for this container.

[.NET API Property: IsolationLevel]

Language Language
This specifies the default language to be used by this task and its descendants.

[.NET API Property: Language]

LoggingMode LoggingMode
This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.

[.NET API Property: LoggingMode]

MaxErrorCount Int32
This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1.

[.NET API Property: MaximumErrorCount]

Name String
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.

[.NET API Property: Name]

RetainDays Int32
This value specifies how many days must pass before a backup set may be overwritten.

[.NET API Property: RetainDays]

ServerVersion Int32
This value specifies the server version for the backup.

[.NET API Property: ServerVersion]

TransactionMode ContainerTransactionMode
This value specifies the transaction context in which this task will execute.

[.NET API Property: TransactionMode]

VerifyIntegrity Boolean
This value specifies whether the backup/restore application should verify that the backup set is complete and all volumes readable.

[.NET API Property: VerifyIntegrity]

Singleton Children
  Child API Type Description
<AutomaticBackupDestination /> AstAutomaticDatabaseBackupDestinationNode
This value specifies a disk location or tape device to which the backup files will be written.

[.NET API Property: BackupDestination]

<ManualBackupDestination /> AstManualDatabaseBackupDestinationNode
<PrecedenceConstraints /> AstTaskflowPrecedenceConstraintsNode
This is a container for task precedence constraint definitions.

[.NET API Property: PrecedenceConstraints]

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.

[.NET API Property: Annotations]

<LogProviders>
    Multiple Choices...
</LogProviders>
AstLogProviderBaseNode
Defines the log providers to use for the SSIS task or container

[.NET API Property: LogProviders]

<Databases>
    <Database />
</Databases>
String
This is a collection of operating system files targeted by backup or restore operations.

[.NET API Property: Databases]

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

[.NET API Property: Events]

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

[.NET API Property: Expressions]

<FilegroupsFiles>
    <FilegroupsFile />
</FilegroupsFiles>
String
This is a container for SQL Server file groups targeted by backup or restore operations.

[.NET API Property: FilegroupsFiles]

<LogEvents>
    <LogEvent />
</LogEvents>
AstLogEventNode
This is a container for log event definitions that are specific to this task, container, or package.

[.NET API Property: LogEvents]

<Variables>
    <Variable />
</Variables>
AstVariableNode
This is a container for variable definitions that are specific to this task, container, or package.

[.NET API Property: Variables]