• Article

Index.CompactLargeObjects Property

Gets or sets the Boolean property value that specifies whether to compact the large object (LOB) data in the index.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property CompactLargeObjects As Boolean
    Get
    Set
'Usage
Dim instance As Index
Dim value As Boolean

value = instance.CompactLargeObjects

instance.CompactLargeObjects = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public bool CompactLargeObjects { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property bool CompactLargeObjects {
    bool get ();
    void set (bool value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member CompactLargeObjects : bool with get, set

function get CompactLargeObjects () : boolean
function set CompactLargeObjects (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether to compact the index if the data is large.
If True, the index is compacted for large data. Otherwise, False (default).

Remarks

Setting this property to true compacts large object (LOB) data, such as text, image, varchar(max), nvarchar(max), and varbinary columns.