Index Members
The Index object represents a Microsoft SQL Server index.
The following tables list the members exposed by the Index type.
Public Constructors
| Name | Description | |
|---|---|---|
| Index | Overloaded. Initializes a new instance of the Index class. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms219652.protfield(en-US,SQL.90).gif") |
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms219652.pubproperty(en-US,SQL.90).gif") |
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. |
|
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. |
|
FillFactor | Gets or sets the percentage of an index page to fill when the index is created or re-created. |
|
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 or sets 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. |
|
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. |
|
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. |
|
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. (inherited from NamedSmoObject) |
|
NoAutomaticRecomputation | Gets or sets the Boolean property value that specifies whether statistics are regenerated when an index is created. |
|
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. |
|
Properties | Gets a collection of Property objects that represent the object properties. (inherited from 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. |
|
State | Gets the state of the referenced object. (inherited from SmoObjectBase) |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms219652.protproperty(en-US,SQL.90).gif") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) |
|
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) |
|
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms219652.pubmethod(en-US,SQL.90).gif") |
Alter | Overloaded. Updates any Index object property changes on the instance of Microsoft SQL Server. |
|
AlterAllIndexes | Updates any Index object property changes for all indexes on the instance of Microsoft SQL Server for a specified index operation. |
|
CheckIndex | Tests the integrity of database pages that store the index. |
|
CheckIndexWithResult | Tests the integrity of database pages that store the index. |
|
Create | Creates an index on the instance of Microsoft SQL Server as defined by the Index object. |
|
Disable | Disables the index. |
|
Drop | Drops the index. |
|
DropAndMove | Overloaded. Drops the index and re-creates the index in a specified filegroup. |
|
Enable | Enables the index. |
|
EnumFragmentation | Overloaded. Enumerates a list of fragmentation information for the index using the fast fragmentation option. |
|
EnumStatistics | Enumerates a list of statistical information for the index. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) |
|
MarkForDrop | Marks the index to be dropped the next time that the Alter method is run on the Index object's parent object. |
|
Rebuild | Rebuilds the index. |
|
RebuildAllIndexes | Rebuilds all the indexes. |
|
RecalculateSpaceUsage | Updates the disk resource usage of the index. |
|
Recreate | Re-creates the index. |
.gif "ms219652.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
Refresh | Overridden. Refreshes the Index object and its properties. |
|
Rename | Renames the index. |
|
Reorganize | Reorganizes the index based on current property settings. |
|
ReorganizeAllIndexes | Reorganizes all the indexes based on current property settings. |
|
Script | Overloaded. Generates a Transact-SQL script that can be used to re-create the index. |
|
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) |
|
UpdateStatistics | Overloaded. Updates the statistics for the referenced index. |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms219652.protmethod(en-US,SQL.90).gif") |
AlterImpl | (inherited from SqlSmoObject ) |
|
AlterImplFinish | (inherited from SqlSmoObject ) |
|
AlterImplInit | (inherited from SqlSmoObject ) |
|
AlterImplWorker | (inherited from SqlSmoObject ) |
|
AppendCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithOption | (inherited from ScriptNameObjectBase ) |
|
BindDefaultImpl | (inherited from SqlSmoObject ) |
|
BindRuleImpl | (inherited from SqlSmoObject ) |
|
CheckCollation | (inherited from SqlSmoObject ) |
|
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) |
|
CheckObjectStateImpl | (inherited from SqlSmoObject ) |
|
CheckTextCorectness | (inherited from ScriptNameObjectBase ) |
|
CheckTextModeSupport | (inherited from ScriptNameObjectBase ) |
|
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) |
|
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) |
|
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) |
|
CheckVersionBelow90 | (inherited from SqlSmoObject ) |
|
CleanObject | Cleans the referenced object. (inherited from ScriptNameObjectBase) |
|
CreateImpl | (inherited from SqlSmoObject ) |
|
CreateImplFinish | (inherited from SqlSmoObject ) |
|
CreateImplInit | (inherited from SqlSmoObject ) |
|
DropImpl | (inherited from SqlSmoObject ) |
|
DropImplWorker | (inherited from SqlSmoObject ) |
|
Finalize | (inherited from Object ) |
|
ForceTextModeOnTextBody | Enforces text mode on the text body. (inherited from ScriptNameObjectBase) |
|
FormatSqlVariant | (inherited from SqlSmoObject ) |
|
GenerateDataSpaceScript | (inherited from SqlSmoObject ) |
|
GetBindDefaultScript | (inherited from SqlSmoObject ) |
|
GetBindRuleScript | (inherited from SqlSmoObject ) |
|
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetBraketNameForText | (inherited from ScriptNameObjectBase ) |
|
GetDateTimeParameter | (inherited from SqlSmoObject ) |
|
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) |
|
GetDBName | Gets the database name associated with the object. (inherited from SqlSmoObject) |
|
GetEnumParameter | (inherited from SqlSmoObject ) |
|
GetFragOptionString | (inherited from SqlSmoObject ) |
|
GetGuidParameter | (inherited from SqlSmoObject ) |
|
GetIsTextDirty | Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase) |
|
GetParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetPropValue | (inherited from SqlSmoObject ) |
|
GetPropValueOptional | (inherited from SqlSmoObject ) |
|
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) |
|
GetRealValue | (inherited from SqlSmoObject ) |
|
GetScriptIncludeExists | (inherited from ScriptNameObjectBase ) |
|
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) |
|
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetTextBody | Overloaded. Returns the text body. (inherited from ScriptNameObjectBase) |
|
GetTextForScript | (inherited from ScriptNameObjectBase ) |
|
GetTextHeader | (inherited from ScriptNameObjectBase ) |
|
GetTextMode | Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase) |
|
GetTextProperty | (inherited from ScriptNameObjectBase ) |
|
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) |
|
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) |
|
ImplInitialize | (inherited from SqlSmoObject ) |
|
IsCollectionDirty | (inherited from SqlSmoObject ) |
|
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (inherited from ScriptNameObjectBase) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (inherited from SqlSmoObject) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsVersion80SP3 | (inherited from SqlSmoObject ) |
|
MarkDropped | (inherited from SqlSmoObject ) |
|
MarkForDropImpl | (inherited from SqlSmoObject ) |
|
MemberwiseClone | (inherited from Object ) |
|
PostAlter | (inherited from SqlSmoObject ) |
|
PostCreate | (inherited from SqlSmoObject ) |
|
PostDrop | (inherited from SqlSmoObject ) |
|
RenameImpl | (inherited from NamedSmoObject ) |
|
RenameImplWorker | (inherited from NamedSmoObject ) |
|
ScriptAlter | (inherited from SqlSmoObject ) |
|
ScriptAnsiQI | (inherited from ScriptNameObjectBase ) |
|
ScriptChangeOwner | (inherited from NamedSmoObject ) |
|
ScriptCreate | (inherited from SqlSmoObject ) |
|
ScriptDdl | (inherited from SqlSmoObject ) |
|
ScriptDrop | (inherited from SqlSmoObject ) |
|
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) |
|
ScriptImplWorker | (inherited from SqlSmoObject ) |
|
ScriptInformativeHeaders | (inherited from ScriptNameObjectBase ) |
|
ScriptRename | (inherited from NamedSmoObject ) |
|
SetCollectionTextMode | (inherited from ScriptNameObjectBase ) |
|
SetParentImpl | (inherited from SqlSmoObject ) |
|
SetTextBody | (inherited from ScriptNameObjectBase ) |
|
SetTextHeader | (inherited from ScriptNameObjectBase ) |
|
SetTextMode | (inherited from ScriptNameObjectBase ) |
|
SwitchTextMode | (inherited from ScriptNameObjectBase ) |
|
ThrowIfTextIsDirtyForAlter | (inherited from ScriptNameObjectBase ) |
|
Trace | (inherited from SqlSmoObject ) |
|
UnbindDefaultImpl | (inherited from SqlSmoObject ) |
|
UnbindRuleImpl | (inherited from SqlSmoObject ) |
|
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
Index Class
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
Creating, Altering, and Removing Indexes
Indexes
CREATE INDEX (Transact-SQL)