ScriptingOptions.DdlBodyOnly Property

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Gets or sets the Boolean property value that specifies whether to script only the text definition for data definition language (DDL) objects that have a text body, such as stored procedures and triggers.

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

Syntax

public bool DdlBodyOnly { get; set; }

public:
property bool DdlBodyOnly {
    bool get();
    void set(bool value);
}

member DdlBodyOnly : bool with get, set

Public Property DdlBodyOnly As Boolean

Property Value

Type: System.Boolean

A Boolean value that specifies whether to script only the text body.

If True, only the text body of the object is scripted.

If False (default), the object is scripted completely.

Remarks

The DdlBodyOnly property applies only to objects with a text body containing a Transact-SQL statement that defines the object.

Examples

Legacy Code Example

The following code example specifies that only the text definition of any DDL objects will be scripted.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.DdlBodyOnly = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.DdlBodyOnly = $TRUE