Index Members
Include Protected Members
Include Inherited Members
The Index object represents a SQL Server index.
The Index type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
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. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AddDatabaseContext(StringCollection) | (Inherited from 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() | (Inherited from SqlSmoObject.) |
|
AlterImplFinish(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
AlterImplInit(StringCollection%, ScriptingOptions%) | (Inherited from SqlSmoObject.) |
|
AlterImplWorker() | (Inherited from SqlSmoObject.) |
|
AppendCommaText(StringBuilder, String, Boolean%, String) | (Inherited from ScriptNameObjectBase.) |
|
AppendWithCommaText(StringBuilder, String, Boolean%) | (Inherited from ScriptNameObjectBase.) |
|
AppendWithOption(StringBuilder, String, String, Boolean%) | (Inherited from ScriptNameObjectBase.) |
|
BindDefaultImpl(String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
BindRuleImpl(String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
CheckCollation(String, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
CheckIndex() | Tests the integrity of database pages that store the index. |
|
CheckIndexWithResult() | Tests the integrity of database pages that store the index. |
|
CheckObjectDirty() | (Inherited from ScriptNameObjectBase.) |
|
CheckObjectState() | Validates the state of the referenced object. (Inherited from 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. (Inherited from SqlSmoObject.) |
|
CheckObjectStateImpl(Boolean) | (Inherited from SqlSmoObject.) |
|
CheckTextCorectness(String, Boolean, Boolean, array<String[], DdlTextParserHeaderInfo%) | (Inherited from ScriptNameObjectBase.) |
|
CheckTextModeSupport() | (Inherited from ScriptNameObjectBase.) |
|
CheckVersion100() | (Inherited from SqlSmoObject.) |
|
CheckVersion80() | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) |
|
CheckVersion80SP3() | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) |
|
CheckVersion90() | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) |
|
CheckVersionBelow90() | (Inherited from SqlSmoObject.) |
|
CleanObject() | Cleans the referenced object. (Inherited from ScriptNameObjectBase.) |
|
Create() | Creates an index on the instance of SQL Server as defined by the Index object. |
|
CreateImpl() | (Inherited from SqlSmoObject.) |
|
CreateImplFinish(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
CreateImplInit(StringCollection%, ScriptingOptions%) | (Inherited from SqlSmoObject.) |
|
Disable() | Disables the index. |
|
Discover() | (Inherited from 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() | (Inherited from SqlSmoObject.) |
|
DropImplWorker(Urn%) | (Inherited from SqlSmoObject.) |
|
Enable(IndexEnableAction) | 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(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
EnumScriptImplWorker(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
EnumStatistics() | Enumerates a list of statistical information for the index. |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
ForceTextModeOnTextBody() | Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.) |
|
FormatSqlVariant(Object) | (Inherited from SqlSmoObject.) |
|
GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) | (Inherited from SqlSmoObject.) |
|
GenerateDataSpaceScript(StringBuilder, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
GetBindDefaultScript(ScriptingOptions, String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
GetBindRuleScript(ScriptingOptions, String, String, Boolean) | (Inherited from SqlSmoObject.) |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
|
GetBraketNameForText() | (Inherited from ScriptNameObjectBase.) |
|
GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetDBName() | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
|
GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) | (Inherited from SqlSmoObject.) |
|
GetFragOptionString(FragmentationOption) | (Inherited from SqlSmoObject.) |
|
GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetIsTextDirty() | Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.) |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
|
GetPropValue(String) | (Inherited from SqlSmoObject.) |
|
GetPropValueOptional(String) | (Inherited from SqlSmoObject.) |
|
GetPropValueOptionalAllowNull(String) | (Inherited from SqlSmoObject.) |
|
GetRealValue(Property, Object) | (Inherited from SqlSmoObject.) |
|
GetScriptIncludeExists(ScriptingOptions, String, Boolean) | (Inherited from ScriptNameObjectBase.) |
|
GetScriptingOptionsForCreate() | (Inherited from SqlSmoObject.) |
|
GetServerName() | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
|
GetServerObject() | (Inherited from SqlSmoObject.) |
|
GetSqlServerVersionName() | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
|
GetTextBody() | Returns the text body. (Inherited from ScriptNameObjectBase.) |
|
GetTextBody(Boolean) | Returns the text body. (Inherited from ScriptNameObjectBase.) |
|
GetTextForScript(ScriptingOptions, Boolean, array<String[]) | Gets the text for scripting. (Inherited from ScriptNameObjectBase.) |
|
GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean) | (Inherited from ScriptNameObjectBase.) |
|
GetTextHeader(Boolean) | Returns the text header. (Inherited from ScriptNameObjectBase.) |
|
GetTextMode() | Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.) |
|
GetTextProperty(String) | (Inherited from ScriptNameObjectBase.) |
|
GetTextProperty(String, ScriptingOptions) | (Inherited from ScriptNameObjectBase.) |
|
GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
|
GetType() | (Inherited from Object.) |
|
GetUrnRecursive(StringBuilder) | (Inherited from SqlSmoObject.) |
|
GetUrnRecursive(StringBuilder, UrnIdOption) | (Inherited from SqlSmoObject.) |
|
ImplInitialize(array<String[], array<OrderBy[]) | (Inherited from SqlSmoObject.) |
|
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (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 SQL Server. (Inherited from SqlSmoObject.) |
|
IsVersion80SP3() | (Inherited from SqlSmoObject.) |
|
MarkDropped() | (Inherited from SqlSmoObject.) |
|
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) | (Inherited from SqlSmoObject.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
PostAlter() | (Inherited from SqlSmoObject.) |
|
PostCreate() | (Inherited from SqlSmoObject.) |
|
PostDrop() | (Inherited from 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. (Overrides ScriptNameObjectBase.Refresh().) |
|
Rename(String) | Renames the index. |
|
RenameImpl(String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
RenameImplWorker(String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from 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(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptAnsiQI(SqlSmoObject, ScriptingOptions, StringCollection, StringBuilder, Object%, Object%) | (Inherited from ScriptNameObjectBase.) |
|
ScriptChangeOwner(StringCollection, ScriptingOptions) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
ScriptCreate(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptDdl(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptDrop(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptImpl() | (Inherited from SqlSmoObject.) |
|
ScriptImpl(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptImplWorker(ScriptingOptions) | (Inherited from SqlSmoObject.) |
|
ScriptInformativeHeaders(ScriptingOptions, StringBuilder) | (Inherited from ScriptNameObjectBase.) |
|
ScriptRename(StringCollection, ScriptingOptions, String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
|
SetCollectionTextMode(Boolean, SmoCollectionBase) | Sets the collection text mode. (Inherited from ScriptNameObjectBase.) |
|
SetParentImpl(SqlSmoObject) | (Inherited from SqlSmoObject.) |
|
SetTextBody(String) | Specifies the text body. (Inherited from ScriptNameObjectBase.) |
|
SetTextHeader(String) | Specifies the text header. (Inherited from ScriptNameObjectBase.) |
|
SetTextMode(Boolean, array<SmoCollectionBase[]) | Specifies the text mode. (Inherited from ScriptNameObjectBase.) |
|
SwitchTextMode(Boolean, array<SmoCollectionBase[]) | Switches the text mode. (Inherited from ScriptNameObjectBase.) |
|
ThrowIfTextIsDirtyForAlter() | (Inherited from ScriptNameObjectBase.) |
|
ToString() | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
|
TouchImpl() | (Inherited from SqlSmoObject.) |
|
UnbindDefaultImpl(Boolean) | (Inherited from SqlSmoObject.) |
|
UnbindRuleImpl(Boolean) | (Inherited from 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(String, array<Object[]) | (Inherited from SmoObjectBase.) |
Top
.gif "Protected field")
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. |
.gif "Protected property") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from 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. (Inherited from 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. (Inherited from 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. (Inherited from 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. (Inherited from SqlSmoObject.) |
|
ScalarResult | Gets the scalar result for the referenced object. (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. |
|
SpatialIndexType | Gets or sets the Spatial Index Type for a column. |
|
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
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | (Inherited from SqlSmoObject.) |
|
PropertyMetadataChanged | (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IAlienObjectDiscover() | (Inherited from SqlSmoObject.) |
|
IAlienObjectGetParent() | (Inherited from SqlSmoObject.) |
|
IAlienObjectGetProperty(String) | (Inherited from SqlSmoObject.) |
|
ISfcPropertyProviderGetPropertySet() | (Inherited from SqlSmoObject.) |
|
IAlienObjectGetUrn() | (Inherited from SqlSmoObject.) |
|
IAlienObjectResolve(String) | (Inherited from SqlSmoObject.) |
|
IAlienObjectSetProperty(Object, Object) | (Inherited from SqlSmoObject.) |
Top