Export (0) Print
Expand All

Index Members

The Index object represents a SQL Server index.

The Index type exposes the following members.

  NameDescription
Public method Index() Initializes a new instance of the Index class.
Public method Index(SqlSmoObject, String) Initializes a new instance of the Index class on the specified parent object and with the specified name.
Top

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

  NameDescription
Protected field m_ExtendedProperties (Inherited from SqlSmoObject.)
Top

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

  NameDescription
Public event PropertyChanged (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged (Inherited from SqlSmoObject.)
Top

Community Additions

ADD
Show:
© 2014 Microsoft