Backup.CopyOnly Property
Gets or sets a Boolean property value that specifies the backup is a copy-only backup. This does not affect the sequence of backups in the usual backup schedule.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)
Syntax
'Declaration
Public Property CopyOnly As Boolean
Get
Set
'Usage
Dim instance As Backup
Dim value As Boolean
value = instance.CopyOnly
instance.CopyOnly = value
public bool CopyOnly { get; set; }
public:
property bool CopyOnly {
bool get ();
void set (bool value);
}
member CopyOnly : bool with get, set
function get CopyOnly () : boolean
function set CopyOnly (value : boolean)
Property Value
Type: System.Boolean
A Boolean value that specifies whether the backup is a copy-only backup.If True, the backup is a copy-only backup.If False (default), the backup is not a copy-only backup, and is part of the usual sequence of backups.
Remarks
A copy-only backup does not affect your overall backup and restore procedures for the database.
Copy-only backups were introduced in SQL Server 2005 for use in situations in which a backup is taken for a special purpose, such as backing up the log before an online file restore. Typically, a copy-only log backup is used one time and then deleted.
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.CopyOnly = true
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.CopyOnly = $TRUE
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace