Share via

Index.CompactLargeObjects Property

  • Article

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
Public Property CompactLargeObjects As Boolean

public bool CompactLargeObjects { get; set; }

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

/** @property */
public boolean get_CompactLargeObjects ()

/** @property */
public void set_CompactLargeObjects (boolean value)

public function get CompactLargeObjects () : boolean

public function set CompactLargeObjects (value : boolean)

Property Value

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

Remarks

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

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Create a Non-Clustered, Composite Index in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Index Class
Index Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Creating, Altering, and Removing Indexes
Indexes
CREATE INDEX (Transact-SQL)