Index 类

The Index object represents a SQL Server index.

继承层次结构

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
    Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
      Microsoft.SqlServer.Management.Smo. . :: . .NamedSmoObject
        Microsoft.SqlServer.Management.Smo. . :: . .ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo..::..Index

命名空间：  Microsoft.SqlServer.Management.Smo
程序集：  Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Index _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable,  _
    IRenamable, IExtendedProperties, IScriptable
用法
Dim instance As Index

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Index : ScriptNameObjectBase, 
    ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Index sealed : public ScriptNameObjectBase, 
    ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Index =  
    class
        inherit ScriptNameObjectBase
        interface ICreatable
        interface IDroppable
        interface IMarkForDrop
        interface IAlterable
        interface IRenamable
        interface IExtendedProperties
        interface IScriptable
    end

public final class Index extends ScriptNameObjectBase implements ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, IExtendedProperties, IScriptable

Index 类型公开以下成员。

构造函数

	名称	说明
	Index() () () ()	Initializes a new instance of the Index class.
	Index(SqlSmoObject, String)	Initializes a new instance of the Index class on the specified parent object and with the specified name.

页首

属性

	名称	说明
	BoundingBoxXMax	Specifies the x-coordinate of the upper right corner of a bounding box
	BoundingBoxXMin	Specifies the x-coordinate of the lower-left corner of a bounding box.
	BoundingBoxYMax	Specifies the y-coordinate of upper-right corner of a bounding box.
	BoundingBoxYMin	Specifies the y-coordinate of the lower-left corner of a bounding box.
	CellsPerObject	Defines the maximum number of cells that tessellation can count per object.
	CompactLargeObjects	Gets or sets the Boolean property value that specifies whether to compact the large object (LOB) data in the index.
	DisallowPageLocks	Gets or sets the Boolean property value that specifies whether the index allows page locks.
	DisallowRowLocks	Gets or sets the Boolean property value that specifies whether the index allows row locks.
	Events	Gets the index events supported by the Index object.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. （从 SqlSmoObject 继承。）
	ExtendedProperties	Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the Index object.
	FileGroup	Gets or sets the filegroup where the index pages are stored.
	FileStreamFileGroup	Gets or Sets the file group name for the index.
	FileStreamPartitionScheme	Gets or Sets the partition scheme name for the index.
	FillFactor	Gets or sets the percentage of an index page to fill when the index is created or re-created.
	FilterDefinition	Gets or sets the String value that contains the definition for the filter.
	HasCompressedPartitions	Gets or sets the Boolean property value that specifies whether the index has compressed partitions.
	HasFilter	Gets the Boolean property value that specifies whether the index has a filter defined for a range of index values.
	ID	Gets the index ID value that uniquely identifies the index within the database.
	IgnoreDuplicateKeys	Gets or sets the Boolean property value that specifies whether the index ignores duplicate keys.
	IndexedColumns	Gets a collection of IndexedColumn objects that represent all the columns participating in the index.
	IndexKeyType	Gets or sets the index key type.
	IsClustered	Gets or sets the Boolean property value that specifies whether the index is clustered.
	IsDisabled	Gets or sets the Boolean property value that specifies whether the index is disabled.
	IsFullTextKey	Gets the Boolean value that specifies whether the index is enabled for row identification in Microsoft Search.
	IsIndexOnComputed	Gets the Boolean property value that specifies whether the index is based on a computed column.
	IsIndexOnTable	Gets the Boolean property value that specifies whether the index is defined for a table or a view.
	IsPartitioned	Gets the Boolean property value that specifies whether the index is stored in a partitioned scheme.
	IsSpatialIndex	Specifies if an index is a Spatial Index
	IsSystemNamed	Gets the Boolean property value that specifies whether the index was named automatically by the system.
	IsSystemObject	Gets the Boolean property value that specifies whether the index is a system object.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. （从 SqlSmoObject 继承。）
	IsUnique	Gets or sets the Boolean property value that specifies whether the index is unique or not.
	IsXmlIndex	Gets or sets the Boolean property value that specifies whether the index is an XML index.
	Level1Grid	Specifies the first level of decomposition for a geometry data type.
	Level2Grid	Specifies the second level of decomposition for a geometry data type.
	Level3Grid	Specifies the third level of decomposition for a geometry data type.
	Level4Grid	Specifies the fourth level of decomposition for a geometry data type.
	MaximumDegreeOfParallelism	Gets or sets the maximum number of processors that can be used when running a query that uses the index.
	Name	Gets or sets the name of the object. （从 NamedSmoObject 继承。）
	NoAutomaticRecomputation	Gets or sets the Boolean property value that specifies whether statistics are regenerated when an index is created.
	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. （从 SqlSmoObject 继承。）
	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	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	Gets or sets the SqlSmoObject object that is the parent of the Index object.
	ParentXmlIndex	Gets or sets the parent of an XML index.
	PartitionScheme	Gets or sets the partition scheme associated with the index.
	PartitionSchemeParameters	Represents a collection of PartitionSchemeParameter objects. Each PartitionSchemeParameter object represents a parameter in the partition scheme associated with the index.
	PhysicalPartitions	Gets a collection of PhysicalPartition objects that represent all the physical partitions on which the index is stored.
	Properties	Gets a collection of Property objects that represent the object properties. （从 SqlSmoObject 继承。）
	ScalarResult	Gets the scalar result for the referenced object. （从 SqlSmoObject 继承。）
	SecondaryXmlIndexType	Gets or sets the secondary XML index type.
	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	Gets or sets the disk space used to store the index data in kilobytes.
	SpatialIndexType	Gets or sets the Spatial Index Type for a column.
	State	Gets the state of the referenced object. （从 SmoObjectBase 继承。）
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. （从 SqlSmoObject 继承。）
	UserData	Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）

页首

方法

	名称	说明
	AddDatabaseContext	（从 SqlSmoObject 继承。）
	Alter() () () ()	Updates any Index object property changes on the instance of SQL Server.
	Alter(IndexOperation)	Updates any Index object property changes on the instance of SQL Server for a specified index operation.
	AlterAllIndexes	Updates any Index object property changes for all indexes on the instance of SQL Server for a specified index operation.
	AlterImpl	（从 SqlSmoObject 继承。）
	AlterImplFinish	（从 SqlSmoObject 继承。）
	AlterImplInit	（从 SqlSmoObject 继承。）
	AlterImplWorker	（从 SqlSmoObject 继承。）
	AppendCommaText	（从 ScriptNameObjectBase 继承。）
	AppendWithCommaText	（从 ScriptNameObjectBase 继承。）
	AppendWithOption	（从 ScriptNameObjectBase 继承。）
	BindDefaultImpl	（从 SqlSmoObject 继承。）
	BindRuleImpl	（从 SqlSmoObject 继承。）
	CheckCollation	（从 SqlSmoObject 继承。）
	CheckIndex	Tests the integrity of database pages that store the index.
	CheckIndexWithResult	Tests the integrity of database pages that store the index.
	CheckObjectDirty	（从 ScriptNameObjectBase 继承。）
	CheckObjectState() () () ()	Validates the state of the referenced object. （从 SqlSmoObject 继承。）
	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. （从 SqlSmoObject 继承。）
	CheckObjectStateImpl	（从 SqlSmoObject 继承。）
	CheckTextCorectness	（从 ScriptNameObjectBase 继承。）
	CheckTextModeSupport	（从 ScriptNameObjectBase 继承。）
	CheckVersion100	（从 SqlSmoObject 继承。）
	CheckVersion80	Checks the validity of the object on SQL Server 2000. （从 SqlSmoObject 继承。）
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. （从 SqlSmoObject 继承。）
	CheckVersion90	Check the validity of the object on SQL Server 2005. （从 SqlSmoObject 继承。）
	CheckVersionBelow90	（从 SqlSmoObject 继承。）
	CleanObject	Cleans the referenced object. （从 ScriptNameObjectBase 继承。）
	Create	Creates an index on the instance of SQL Server as defined by the Index object.
	CreateImpl	（从 SqlSmoObject 继承。）
	CreateImplFinish	（从 SqlSmoObject 继承。）
	CreateImplInit	（从 SqlSmoObject 继承。）
	Disable	Disables the index.
	Discover	（从 SqlSmoObject 继承。）
	Drop	Drops the index.
	DropAndMove(String)	Drops a clustered index and moves the underlying table data to the specified filegroup.
	DropAndMove(String, StringCollection)	Drops a clustered index and moves the underlying table data to the partition scheme with the specified with partition scheme parameters.
	DropImpl	（从 SqlSmoObject 继承。）
	DropImplWorker	（从 SqlSmoObject 继承。）
	Enable	Enables the index.
	EnumFragmentation() () () ()	Enumerates a list of fragmentation information for the index using the default fast fragmentation option.
	EnumFragmentation(FragmentationOption)	Enumerates a list of fragmentation information for the index with the specified fragmentation option.
	EnumFragmentation(FragmentationOption, Int32)	Enumerates a list of fragmentation information for the index with the specified fragmentation option and partition number.
	EnumScriptImpl	（从 SqlSmoObject 继承。）
	EnumScriptImplWorker	（从 SqlSmoObject 继承。）
	EnumStatistics	Enumerates a list of statistical information for the index.
	Equals	（从 Object 继承。）
	Finalize	（从 Object 继承。）
	ForceTextModeOnTextBody	Enforces text mode on the text body. （从 ScriptNameObjectBase 继承。）
	FormatSqlVariant	（从 SqlSmoObject 继承。）
	GenerateDataSpaceFileStreamScript	（从 SqlSmoObject 继承。）
	GenerateDataSpaceScript	（从 SqlSmoObject 继承。）
	GetBindDefaultScript	（从 SqlSmoObject 继承。）
	GetBindRuleScript	（从 SqlSmoObject 继承。）
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetBraketNameForText	（从 ScriptNameObjectBase 继承。）
	GetDateTimeParameter	（从 SqlSmoObject 继承。）
	GetDateTimeParameterAsInt	（从 SqlSmoObject 继承。）
	GetDBName	Gets the database name that is associated with the object. （从 SqlSmoObject 继承。）
	GetEnumParameter	（从 SqlSmoObject 继承。）
	GetFragOptionString	（从 SqlSmoObject 继承。）
	GetGuidParameter	（从 SqlSmoObject 继承。）
	GetHashCode	（从 Object 继承。）
	GetIsTextDirty	Determines whether the text value is consistent with stored value. （从 ScriptNameObjectBase 继承。）
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetPropValue	（从 SqlSmoObject 继承。）
	GetPropValueOptional	（从 SqlSmoObject 继承。）
	GetPropValueOptionalAllowNull	（从 SqlSmoObject 继承。）
	GetRealValue	（从 SqlSmoObject 继承。）
	GetScriptIncludeExists	（从 ScriptNameObjectBase 继承。）
	GetScriptingOptionsForCreate	（从 SqlSmoObject 继承。）
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetServerObject	（从 SqlSmoObject 继承。）
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetTextBody() () () ()	Returns the text body. （从 ScriptNameObjectBase 继承。）
	GetTextBody(Boolean)	Returns the text body. （从 ScriptNameObjectBase 继承。）
	GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [])	Gets the text for scripting. （从 ScriptNameObjectBase 继承。）
	GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [], Boolean)	（从 ScriptNameObjectBase 继承。）
	GetTextHeader	Returns the text header. （从 ScriptNameObjectBase 继承。）
	GetTextMode	Determines whether the script name is using text mode. （从 ScriptNameObjectBase 继承。）
	GetTextProperty(String)	（从 ScriptNameObjectBase 继承。）
	GetTextProperty(String, ScriptingOptions)	（从 ScriptNameObjectBase 继承。）
	GetTimeSpanParameterAsInt	（从 SqlSmoObject 继承。）
	GetType	（从 Object 继承。）
	GetUrnRecursive(StringBuilder)	（从 SqlSmoObject 继承。）
	GetUrnRecursive(StringBuilder, UrnIdOption)	（从 SqlSmoObject 继承。）
	ImplInitialize	（从 SqlSmoObject 继承。）
	Initialize() () () ()	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. （从 ScriptNameObjectBase 继承。）
	IsObjectInitialized	Verifies whether the object has been initialized. （从 SqlSmoObject 继承。）
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	IsVersion80SP3	（从 SqlSmoObject 继承。）
	MarkDropped	（从 SqlSmoObject 继承。）
	MarkForDrop	Marks the index to be dropped the next time that the Alter method is run on the Index object's parent object.
	MarkForDropImpl	（从 SqlSmoObject 继承。）
	MemberwiseClone	（从 Object 继承。）
	PostAlter	（从 SqlSmoObject 继承。）
	PostCreate	（从 SqlSmoObject 继承。）
	PostDrop	（从 SqlSmoObject 继承。）
	Rebuild() () () ()	Rebuilds the index.
	Rebuild(Int32)	Rebuilds the index on the partition with the specified partition number.
	RebuildAllIndexes	Rebuilds all the indexes.
	RecalculateSpaceUsage	Updates the disk resource usage of the index.
	Recreate	Re-creates the index.
	Refresh	Refreshes the Index object and its properties. （覆盖 ScriptNameObjectBase. . :: . .Refresh() () () ()。）
	Rename	Renames the index.
	RenameImpl	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	RenameImplWorker	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	Reorganize	Reorganizes the index based on current property settings.
	ReorganizeAllIndexes	Reorganizes all the indexes based on current property settings.
	Script() () () ()	Generates a Transact-SQL script that can be used to re-create the index.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the index as specified by the script options.
	ScriptAlter	（从 SqlSmoObject 继承。）
	ScriptAnsiQI	（从 ScriptNameObjectBase 继承。）
	ScriptChangeOwner	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	ScriptCreate	（从 SqlSmoObject 继承。）
	ScriptDdl	（从 SqlSmoObject 继承。）
	ScriptDrop	（从 SqlSmoObject 继承。）
	ScriptImpl() () () ()	（从 SqlSmoObject 继承。）
	ScriptImpl(ScriptingOptions)	（从 SqlSmoObject 继承。）
	ScriptImplWorker	（从 SqlSmoObject 继承。）
	ScriptInformativeHeaders	（从 ScriptNameObjectBase 继承。）
	ScriptRename	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	SetCollectionTextMode	Sets the collection text mode. （从 ScriptNameObjectBase 继承。）
	SetParentImpl	（从 SqlSmoObject 继承。）
	SetTextBody	Specifies the text body. （从 ScriptNameObjectBase 继承。）
	SetTextHeader	Specifies the text header. （从 ScriptNameObjectBase 继承。）
	SetTextMode	Specifies the text mode. （从 ScriptNameObjectBase 继承。）
	SwitchTextMode	Switches the text mode. （从 ScriptNameObjectBase 继承。）
	ThrowIfTextIsDirtyForAlter	（从 ScriptNameObjectBase 继承。）
	ToString	Returns a String that represents the referenced object. （从 SqlSmoObject 继承。）
	TouchImpl	（从 SqlSmoObject 继承。）
	UnbindDefaultImpl	（从 SqlSmoObject 继承。）
	UnbindRuleImpl	（从 SqlSmoObject 继承。）
	UpdateStatistics() () () ()	Updates statistics for the referenced index.
	UpdateStatistics(StatisticsScanType)	Updates statistics for the referenced index with the specified statistics scan type.
	UpdateStatistics(StatisticsScanType, Int32)	Updates statistics for the referenced index with the specified statistics scan type and specified sample size.
	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.
	Validate	（从 SmoObjectBase 继承。）

页首

事件

	名称	说明
	PropertyChanged	（从 SqlSmoObject 继承。）
	PropertyMetadataChanged	（从 SqlSmoObject 继承。）

页首

字段

	名称	说明
	m_ExtendedProperties	（从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObjectDiscover	（从 SqlSmoObject 继承。）
	IAlienObjectGetParent	（从 SqlSmoObject 继承。）
	IAlienObjectGetProperty	（从 SqlSmoObject 继承。）
	ISfcPropertyProviderGetPropertySet	（从 SqlSmoObject 继承。）
	IAlienObjectGetUrn	（从 SqlSmoObject 继承。）
	IAlienObjectResolve	（从 SqlSmoObject 继承。）
	IAlienObjectSetProperty	（从 SqlSmoObject 继承。）

页首

注释

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

此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。 不保证所有实例成员都对于线程安全的。

示例

创建、更改和删除索引

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo 命名空间

其他资源

索引

CREATE INDEX (Transact-SQL)