Backup.LogTruncation Property

Gets or sets the method used to truncate the database log as part of the backup operation.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
Public Property LogTruncation As BackupTruncateLogType 
    Get 
    Set
'Usage
Dim instance As Backup 
Dim value As BackupTruncateLogType 

value = instance.LogTruncation

instance.LogTruncation = value
public BackupTruncateLogType LogTruncation { get; set; }
public:
property BackupTruncateLogType LogTruncation {
    BackupTruncateLogType get ();
    void set (BackupTruncateLogType value);
}
member LogTruncation : BackupTruncateLogType with get, set
function get LogTruncation () : BackupTruncateLogType 
function set LogTruncation (value : BackupTruncateLogType)

Property Value

Type: Microsoft.SqlServer.Management.Smo.BackupTruncateLogType
A BackupTruncateLogType object value that specifies the log truncation option that has been selected. By default, the value is set to Truncate.

Remarks

You can use the BackupTruncateLogType object to select one of the following log truncation options:

  • Truncate only. The log is truncated and is not backed up.

  • No truncate. The log is backed up and is not truncated.

  • Truncate (default). The log is backed up, and is then truncated.

Examples

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
Dim bk As New Backup
bk.Action = BackupActionType.Database
bk.Database = "AdventureWorks2012"
bk.LogTruncation = BackupTruncateLogType.Truncate

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup
$bk.Action = [Microsoft.SqlServer.Management.Smo.BackupActionType]::Database
$bk.Database = "AdventureWorks2012"
$bk.LogTruncation = [Microsoft.SqlServer.Management.Smo.BackupTruncateLogType]::Truncate

See Also

Reference

Backup Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

BACKUP (Transact-SQL)

Backing Up and Restoring Databases and Transaction Logs