Index Index Index Class

Definition

The Index object represents a SQL Server index.

public ref class Index sealed : Microsoft::SqlServer::Management::Smo::ScriptNameObjectBase, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDropIfExists, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Common::IMarkForDrop, Microsoft::SqlServer::Management::Common::IRenamable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcSupportsDesignMode, Microsoft::SqlServer::Management::Smo::IExtendedProperties, Microsoft::SqlServer::Management::Smo::IScriptable
[Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone | Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.SqlAzureDatabase)]
[Microsoft.SqlServer.Management.Sdk.Sfc.PhysicalFacet]
public sealed class Index : Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDropIfExists, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IMarkForDrop, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcSupportsDesignMode, Microsoft.SqlServer.Management.Smo.IExtendedProperties, Microsoft.SqlServer.Management.Smo.IScriptable
Public NotInheritable Class Index
Inherits ScriptNameObjectBase
Implements IAlterable, ICreatable, IDropIfExists, IDroppable, IExtendedProperties, IMarkForDrop, IRenamable, IScriptable, ISfcSupportsDesignMode
Inheritance
Attributes
Microsoft.SqlServer.Management.Facets.EvaluationModeAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute PhysicalFacetAttribute
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatable Microsoft.SqlServer.Management.Common.IDropIfExistsMicrosoft.SqlServer.Management.Common.IDropIfExistsMicrosoft.SqlServer.Management.Common.IDropIfExists Microsoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppable Microsoft.SqlServer.Management.Common.IMarkForDropMicrosoft.SqlServer.Management.Common.IMarkForDropMicrosoft.SqlServer.Management.Common.IMarkForDrop Microsoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamable ISfcSupportsDesignModeISfcSupportsDesignModeISfcSupportsDesignMode IExtendedPropertiesIExtendedPropertiesIExtendedProperties IScriptableIScriptableIScriptable

Examples

Creating, Altering, and Removing Indexes

Remarks

To get Index object properties, users can be a member of the public fixed server role.

To set Index object properties, create or drop an index, update statistics on an index, or rebuild, reorganize, or re-create an index, users must have one of the following:

  • ALTER permission on the parent table or view

  • Membership of the db_owner or the db_ddladmin fixed database roles

  • Membership of the sysadmin fixed server role

Thread Safety

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

Constructors

Index() Index() Index()

Initializes a new instance of the Index class.

Index(SqlSmoObject, String) Index(SqlSmoObject, String) Index(SqlSmoObject, String)

Initializes a new instance of the Index class on the specified parent object and with the specified name.

Properties

BoundingBoxXMax BoundingBoxXMax BoundingBoxXMax

Gets or sets the x-coordinate of the upper right corner of a bounding box.

BoundingBoxXMin BoundingBoxXMin BoundingBoxXMin

Gets or sets the x-coordinate of the lower-left corner of a bounding box.

BoundingBoxYMax BoundingBoxYMax BoundingBoxYMax

Gets or sets the y-coordinate of upper-right corner of a bounding box.

BoundingBoxYMin BoundingBoxYMin BoundingBoxYMin

Gets or sets the y-coordinate of the lower-left corner of a bounding box.

BucketCount BucketCount BucketCount

Gets or sets the value of the bucket count for a hash index.

CellsPerObject CellsPerObject CellsPerObject

Gets or sets the maximum number of cells that tessellation can count per object.

CompactLargeObjects CompactLargeObjects CompactLargeObjects

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

CompressAllRowGroups CompressAllRowGroups CompressAllRowGroups

Gets or sets a value that indicates whether the object compress all row groups.

DisallowPageLocks DisallowPageLocks DisallowPageLocks

Gets or sets the Boolean property value that specifies whether the index allows page locks.

DisallowRowLocks DisallowRowLocks DisallowRowLocks

Gets or sets the Boolean property value that specifies whether the index allows row locks.

Events Events Events

Gets the index events supported by the Index object.

ExecuteForScalar ExecuteForScalar ExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

(Inherited from SqlSmoObject)
ExecutionManager ExecutionManager ExecutionManager

Gets the object to execute to the manager.

(Inherited from SqlSmoObject)
ExtendedProperties ExtendedProperties ExtendedProperties

Gets a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the Index object.

FileGroup FileGroup FileGroup

Gets or sets the filegroup where the index pages are stored.

FileStreamFileGroup FileStreamFileGroup FileStreamFileGroup

Gets or Sets the file group name for the index.

FileStreamPartitionScheme FileStreamPartitionScheme FileStreamPartitionScheme

Gets or Sets the partition scheme name for the index.

FillFactor FillFactor FillFactor

Gets or sets the percentage of an index page to fill when the index is created or re-created.

FilterDefinition FilterDefinition FilterDefinition

Gets or sets the String value that contains the definition for the filter.

HasCompressedPartitions HasCompressedPartitions HasCompressedPartitions

Gets or sets the Boolean property value that specifies whether the index has compressed partitions.

HasFilter HasFilter HasFilter

Gets the Boolean property value that specifies whether the index has a filter defined for a range of index values.

ID ID ID

Gets the index ID value that uniquely identifies the index within the database.

IgnoreDuplicateKeys IgnoreDuplicateKeys IgnoreDuplicateKeys

Gets or sets the Boolean property value that specifies whether the index ignores duplicate keys.

IndexedColumns IndexedColumns IndexedColumns

Gets a collection of IndexedColumn objects that represent all the columns participating in the index.

IndexedXmlPathName IndexedXmlPathName IndexedXmlPathName

Gets or sets the name of the indexed XML path.

IndexedXmlPathNamespaces IndexedXmlPathNamespaces IndexedXmlPathNamespaces

Gets the collection of indexed XML path namespace.

IndexedXmlPaths IndexedXmlPaths IndexedXmlPaths

Gets or sets the collection of indexed XML paths.

IndexKeyType IndexKeyType IndexKeyType

Gets or sets the index key type.

IndexType IndexType IndexType

Gets or sets the type of index.

IsClustered IsClustered IsClustered

Gets or sets the Boolean property value that specifies whether the index is clustered.

IsDisabled IsDisabled IsDisabled

Gets or sets the Boolean property value that specifies whether the index is disabled.

IsFileTableDefined IsFileTableDefined IsFileTableDefined

Gets or sets whether the file table is defined.

IsFullTextKey IsFullTextKey IsFullTextKey

Gets the Boolean value that specifies whether the index is enabled for row identification in Microsoft Search.

IsIndexOnComputed IsIndexOnComputed IsIndexOnComputed

Gets the Boolean property value that specifies whether the index is based on a computed column.

IsIndexOnTable IsIndexOnTable IsIndexOnTable

Gets the Boolean property value that specifies whether the index is defined for a table or a view.

IsMemoryOptimized IsMemoryOptimized IsMemoryOptimized

Gets or sets the Boolean property value that specifies whether the index is memory optimized.

IsPartitioned IsPartitioned IsPartitioned

Gets the Boolean property value that specifies whether the index is stored in a partitioned scheme.

IsSpatialIndex IsSpatialIndex IsSpatialIndex

Gets a value that indicates whether an index is a spatial index.

IsSystemNamed IsSystemNamed IsSystemNamed

Gets the Boolean property value that specifies whether the index was named automatically by the system.

IsSystemObject IsSystemObject IsSystemObject

Gets the Boolean property value that specifies whether the index is a system object.

IsTouched IsTouched IsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.

(Inherited from SqlSmoObject)
IsUnique IsUnique IsUnique

Gets or sets the Boolean property value that specifies whether the index is unique or not.

IsXmlIndex IsXmlIndex IsXmlIndex

Gets or sets the Boolean property value that specifies whether the index is an XML index.

Level1Grid Level1Grid Level1Grid

Gets or sets the first level of decomposition for a geometry data type.

Level2Grid Level2Grid Level2Grid

Gets or sets the second level of decomposition for a geometry data type.

Level3Grid Level3Grid Level3Grid

Gets or sets the third level of decomposition for a geometry data type.

Level4Grid Level4Grid Level4Grid

Gets or sets the fourth level of decomposition for a geometry data type.

LowPriorityAbortAfterWait LowPriorityAbortAfterWait LowPriorityAbortAfterWait

Gets or sets the action that will be taken after the Low Priority expires during an online index build operation on this index.

LowPriorityMaxDuration LowPriorityMaxDuration LowPriorityMaxDuration

Gets or sets the amount of time (in minutes) to wait with Low Priority for acquiring the locks required for the online index build operations on this Index.

MaximumDegreeOfParallelism MaximumDegreeOfParallelism MaximumDegreeOfParallelism

Gets or sets the maximum number of processors that can be used when running a query that uses the index.

Name Name Name

Gets or sets the name of the index property.

NoAutomaticRecomputation NoAutomaticRecomputation NoAutomaticRecomputation

Gets or sets the Boolean property value that specifies whether statistics are regenerated when an index is created.

ObjectInSpace ObjectInSpace ObjectInSpace

Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
OnlineIndexOperation OnlineIndexOperation OnlineIndexOperation

Gets or sets the Boolean property value that specifies whether the index will be kept online during index operations thus allowing access to the data.

PadIndex PadIndex PadIndex

Gets or sets the Boolean property value that specifies whether space is left open on each page of the intermediate levels of the index.

Parent Parent Parent

Gets or sets the SqlSmoObject object that is the parent of the Index object.

ParentXmlIndex ParentXmlIndex ParentXmlIndex

Gets or sets the parent of an XML index.

PartitionScheme PartitionScheme PartitionScheme

Gets or sets the partition scheme associated with the index.

PartitionSchemeParameters PartitionSchemeParameters PartitionSchemeParameters

Represents a collection of PartitionSchemeParameter objects. Each PartitionSchemeParameter object represents a parameter in the partition scheme associated with the index.

PhysicalPartitions PhysicalPartitions PhysicalPartitions

Gets a collection of PhysicalPartition objects that represent all the physical partitions on which the index is stored.

Properties Properties Properties

Gets a collection of Property objects that represent the object properties.

(Inherited from SqlSmoObject)
ScalarResult ScalarResult ScalarResult

Gets the scalar result for the referenced object.

(Inherited from SqlSmoObject)
SecondaryXmlIndexType SecondaryXmlIndexType SecondaryXmlIndexType

Gets or sets the secondary XML index type.

SortInTempdb SortInTempdb SortInTempdb

Gets or sets the Boolean property value that specifies whether the index is sorted using the tempdb database for intermediate storage of data.

SpaceUsed SpaceUsed SpaceUsed

Gets or sets the disk space used to store the index data in kilobytes.

SpatialIndexType SpatialIndexType SpatialIndexType

Gets or sets the Spatial Index Type for a column.

State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
Urn Urn Urn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.

(Inherited from SqlSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)

Methods

AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

(Inherited from SqlSmoObject)
Alter() Alter() Alter()

Updates any Index object property changes on the instance of SQL Server.

Alter(IndexOperation) Alter(IndexOperation) Alter(IndexOperation)

Updates any Index object property changes on the instance of SQL Server for a specified index operation.

AlterAllIndexes() AlterAllIndexes() AlterAllIndexes()

Updates any Index object property changes for all indexes on the instance of SQL Server for a specified index operation.

AlterImpl() AlterImpl() AlterImpl()

Activates the object altered event.

(Inherited from SqlSmoObject)
AlterImplWorker() AlterImplWorker() AlterImplWorker()

Calls the Alter methods.

(Inherited from SqlSmoObject)
AppendCommaText(StringBuilder, String, Boolean, String) AppendCommaText(StringBuilder, String, Boolean, String) AppendCommaText(StringBuilder, String, Boolean, String)

Appends text, optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AppendWithCommaText(StringBuilder, String, Boolean) AppendWithCommaText(StringBuilder, String, Boolean) AppendWithCommaText(StringBuilder, String, Boolean)

Appends text, optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AppendWithOption(StringBuilder, String, String, Boolean) AppendWithOption(StringBuilder, String, String, Boolean) AppendWithOption(StringBuilder, String, String, Boolean)

Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AutoGenerateName() AutoGenerateName() AutoGenerateName()

Generates a name automatically based on the object Guid.

(Inherited from ScriptNameObjectBase)
BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

(Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.

(Inherited from SqlSmoObject)
CheckIndex() CheckIndex() CheckIndex()

Tests the integrity of database pages that store the index.

CheckIndexWithResult() CheckIndexWithResult() CheckIndexWithResult()

Tests the integrity of database pages that store the index.

CheckObjectDirty() CheckObjectDirty() CheckObjectDirty()

Checks whether object has been modified and not persisted.

(Inherited from ScriptNameObjectBase)
CheckObjectState() CheckObjectState() CheckObjectState()

Validates the state of the referenced object.

(Inherited from SqlSmoObject)
CheckObjectState(Boolean) CheckObjectState(Boolean) CheckObjectState(Boolean)

Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created.

(Inherited from SqlSmoObject)
CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.

(Inherited from SqlSmoObject)
CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo) CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo) CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo)

Checks text for correctness against the parameters.

(Inherited from ScriptNameObjectBase)
CheckTextModeSupport() CheckTextModeSupport() CheckTextModeSupport()

Checks mode of support.

(Inherited from ScriptNameObjectBase)
CleanObject() CleanObject() CleanObject()

Cleans the referenced object.

(Inherited from ScriptNameObjectBase)
Create() Create() Create()

Creates an index on the instance of SQL Server as defined by the Index object.

CreateImpl() CreateImpl() CreateImpl()

Creates an object with scripting options.

(Inherited from SqlSmoObject)
Disable() Disable() Disable()

Disables the index.

Discover() Discover() Discover()

Discovers a list of type Object.

(Inherited from SqlSmoObject)
Drop() Drop() Drop()

Drops the index.

DropAndMove(String) DropAndMove(String) DropAndMove(String)

Drops a clustered index and moves the underlying table data to the specified filegroup.

DropAndMove(String, StringCollection) DropAndMove(String, StringCollection) DropAndMove(String, StringCollection)

Drops a clustered index and moves the underlying table data to the partition scheme with the specified partition scheme parameters.

DropIfExists() DropIfExists() DropIfExists()

Drops the index object if exist in the server.

DropImpl(Boolean) DropImpl(Boolean) DropImpl(Boolean)

Drops a SqlSmoObject.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean)

Drops the IMPL worker.

(Inherited from SqlSmoObject)
Enable(IndexEnableAction) Enable(IndexEnableAction) Enable(IndexEnableAction)

Enables the index.

EnumFragmentation() EnumFragmentation() EnumFragmentation()

Enumerates a list of fragmentation information for the index using the default fast fragmentation option.

EnumFragmentation(FragmentationOption) EnumFragmentation(FragmentationOption) EnumFragmentation(FragmentationOption)

Enumerates a list of fragmentation information for the index with the specified fragmentation option.

EnumFragmentation(FragmentationOption, Int32) EnumFragmentation(FragmentationOption, Int32) EnumFragmentation(FragmentationOption, Int32)

Enumerates a list of fragmentation information for the index with the specified fragmentation option and partition number.

EnumStatistics() EnumStatistics() EnumStatistics()

Enumerates a list of statistical information for the index.

ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String) ExecuteRenameQuery(String) ExecuteRenameQuery(String)

Executes the rename query for the object.

(Inherited from NamedSmoObject)
ForceTextModeOnTextBody() ForceTextModeOnTextBody() ForceTextModeOnTextBody()

Enforces text mode on the text body.

(Inherited from ScriptNameObjectBase)
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object)

Formats an object as Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.

(Inherited from SqlSmoObject)
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent()

Generates the alter event with the specified value.

(Inherited from SqlSmoObject)
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.

(Inherited from SqlSmoObject)
GetBraketNameForText() GetBraketNameForText() GetBraketNameForText()

Gets the bracket name for the text.

(Inherited from ScriptNameObjectBase)
GetContextDB() GetContextDB() GetContextDB()

Gets the context database that is associated with this object.

(Inherited from SqlSmoObject)
GetDBName() GetDBName() GetDBName()

Gets the database name that is associated with the object.

(Inherited from SqlSmoObject)
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.

(Inherited from SqlSmoObject)
GetIsSystemNamed() GetIsSystemNamed() GetIsSystemNamed()

Indicates a value that specifies whether the system is named.

(Inherited from ScriptNameObjectBase)
GetIsTextDirty() GetIsTextDirty() GetIsTextDirty()

Determines whether the text value is consistent with stored value.

(Inherited from ScriptNameObjectBase)
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptional(String) GetPropValueOptional(String) GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName()

Gets the name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetServerObject() GetServerObject() GetServerObject()

Gets the server of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetTextBody() GetTextBody() GetTextBody()

Returns the text body.

(Inherited from ScriptNameObjectBase)
GetTextBody(Boolean) GetTextBody(Boolean) GetTextBody(Boolean)

Returns the text body.

(Inherited from ScriptNameObjectBase)
GetTextHeader(Boolean) GetTextHeader(Boolean) GetTextHeader(Boolean)

Returns the text header.

(Inherited from ScriptNameObjectBase)
GetTextMode() GetTextMode() GetTextMode()

Determines whether the script name is using text mode.

(Inherited from ScriptNameObjectBase)
GetTextProperty(String) GetTextProperty(String) GetTextProperty(String)

Gets the text of the object, if not available, throw appropriate exception based on the state of the object.

(Inherited from ScriptNameObjectBase)
GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Initialize() Initialize() Initialize()

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
Initialize(Boolean) Initialize(Boolean) Initialize(Boolean)

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
IsObjectDirty() IsObjectDirty() IsObjectDirty()

Determines whether the referenced object is consistent with the stored object.

(Inherited from ScriptNameObjectBase)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Verifies whether the object has been initialized.

(Inherited from SqlSmoObject)
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.

(Inherited from SqlSmoObject)
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.

(Inherited from SqlSmoObject)
MarkDropped() MarkDropped() MarkDropped()

Sets the SqlSmoState to dropped.

(Inherited from SqlSmoObject)
MarkForDrop(Boolean) MarkForDrop(Boolean) MarkForDrop(Boolean)

Marks the index to be dropped the next time that the Alter() method is run on the Index object's parent object.

MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

(Inherited from SqlSmoObject)
PostAlter() PostAlter() PostAlter()

The method that is activated after the SqlSmoObject is altered.

(Inherited from SqlSmoObject)
PostCreate() PostCreate() PostCreate()

The method that is activated after the SqlSmoObject is created.

(Inherited from SqlSmoObject)
PostDrop() PostDrop() PostDrop()

The method that is activated after the SqlSmoObject is dropped.

(Inherited from SqlSmoObject)
Rebuild() Rebuild() Rebuild()

Rebuilds the index.

Rebuild(Int32) Rebuild(Int32) Rebuild(Int32)

Rebuilds the index on the partition with the specified partition number.

RebuildAllIndexes() RebuildAllIndexes() RebuildAllIndexes()

Rebuilds all the indexes.

RecalculateSpaceUsage() RecalculateSpaceUsage() RecalculateSpaceUsage()

Updates the disk resource usage of the index.

Recreate() Recreate() Recreate()

Re-creates the index.

Refresh() Refresh() Refresh()

Refreshes the Index object and its properties.

Rename(String) Rename(String) Rename(String)

Renames the index.

RenameImpl(String) RenameImpl(String) RenameImpl(String)

This method supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from NamedSmoObject)
RenameImplWorker(String) RenameImplWorker(String) RenameImplWorker(String)

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

(Inherited from NamedSmoObject)
Reorganize(Int32) Reorganize(Int32) Reorganize(Int32)

Reorganizes the index based on the partition number.

ReorganizeAllIndexes() ReorganizeAllIndexes() ReorganizeAllIndexes()

Reorganizes all the indexes based on current property settings.

Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the index.

Script(ScriptingOptions) Script(ScriptingOptions) Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the index as specified by the script options.

ScriptImpl() ScriptImpl() ScriptImpl()

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
SetCollectionTextMode(Boolean, SmoCollectionBase) SetCollectionTextMode(Boolean, SmoCollectionBase) SetCollectionTextMode(Boolean, SmoCollectionBase)

Sets the collection text mode.

(Inherited from ScriptNameObjectBase)
SetIsSystemNamed(Boolean) SetIsSystemNamed(Boolean) SetIsSystemNamed(Boolean)

Specifies a value that indicates whether the system is named.

(Inherited from ScriptNameObjectBase)
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

(Inherited from SqlSmoObject)
SetSchemaOwned() SetSchemaOwned() SetSchemaOwned()

Sets the schema owned value for the named Smo object.

(Inherited from NamedSmoObject)
SetTextBody(String) SetTextBody(String) SetTextBody(String)

Specifies the text body.

(Inherited from ScriptNameObjectBase)
SetTextHeader(String) SetTextHeader(String) SetTextHeader(String)

Specifies the text header.

(Inherited from ScriptNameObjectBase)
SetTextMode(Boolean, SmoCollectionBase[]) SetTextMode(Boolean, SmoCollectionBase[]) SetTextMode(Boolean, SmoCollectionBase[])

Specifies the text mode.

(Inherited from ScriptNameObjectBase)
SwitchTextMode(Boolean, SmoCollectionBase[]) SwitchTextMode(Boolean, SmoCollectionBase[]) SwitchTextMode(Boolean, SmoCollectionBase[])

Switches the text mode.

(Inherited from ScriptNameObjectBase)
ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws the object if above version 100.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String)

Throws exception if the version is below 100.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String)

Throws the object if the version belows 110.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String)

Throws the object if the version is below 120.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String)

Throws the object if the version is below 130.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String)

Throws the object if the version is below 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String)

Throws the object if the version is below 90.

(Inherited from SqlSmoObject)
ThrowIfTextIsDirtyForAlter() ThrowIfTextIsDirtyForAlter() ThrowIfTextIsDirtyForAlter()

Throws an exception of text has been modified and not persisted.

(Inherited from ScriptNameObjectBase)
ToString() ToString() ToString()

Returns a String that represents the referenced object.

(Inherited from SqlSmoObject)
TouchImpl() TouchImpl() TouchImpl()

Implements a touch object.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

(Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

(Inherited from SqlSmoObject)
UpdateStatistics() UpdateStatistics() UpdateStatistics()

Updates statistics for the referenced index.

UpdateStatistics(StatisticsScanType) UpdateStatistics(StatisticsScanType) UpdateStatistics(StatisticsScanType)

Updates statistics for the referenced index with the specified statistics scan type.

UpdateStatistics(StatisticsScanType, Int32) UpdateStatistics(StatisticsScanType, Int32) UpdateStatistics(StatisticsScanType, Int32)

Updates statistics for the referenced index with the specified statistics scan type and specified sample size.

UpdateStatistics(StatisticsScanType, Int32, Boolean) UpdateStatistics(StatisticsScanType, Int32, Boolean) UpdateStatistics(StatisticsScanType, Int32, Boolean)

Updates statistics for the referenced index with the specified statistics scan type and specified sample size and with the option to recompute the statistics.

UpgradeToClusteredColumnStoreIndex() UpgradeToClusteredColumnStoreIndex() UpgradeToClusteredColumnStoreIndex()

Upgrades the index to either clustered index or column store index.

Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() IAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot()

Returns the root of the domain.

(Inherited from SqlSmoObject)
IAlienObject.GetParent() IAlienObject.GetParent() IAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Gets the type of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() IAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.Resolve(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

(Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
ISfcSupportsDesignMode.IsDesignMode ISfcSupportsDesignMode.IsDesignMode ISfcSupportsDesignMode.IsDesignMode

Gets a value whether the index supports design mode.

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.

(Inherited from SqlSmoObject)
singletonParent singletonParent singletonParent

Represents the singleton parent.

(Inherited from SqlSmoObject)

Events

PropertyChanged PropertyChanged PropertyChanged

Represents the event that occurs when a property is changed.

(Inherited from SqlSmoObject)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Represents the event that occurs when property metadata changes.

(Inherited from SqlSmoObject)

Applies to

See Also