Index Index Index Class

Definition

Instance class encapsulating : Server[@Name='']/Database/Table/Index

[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
type Index = class
    inherit ScriptNameObjectBase
    interface ISfcSupportsDesignMode
    interface ICreatable
    interface IDroppable
    interface IDropIfExists
    interface IMarkForDrop
    interface IAlterable
    interface IRenamable
    interface IExtendedProperties
    interface IScriptable
Public NotInheritable Class Index
Inherits ScriptNameObjectBase
Implements IAlterable, ICreatable, IDropIfExists, IDroppable, IExtendedProperties, IMarkForDrop, IRenamable, IScriptable, ISfcSupportsDesignMode
Inheritance
Attributes
EvaluationModeAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute PhysicalFacetAttribute
Implements

Constructors

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

Properties

BoundingBoxXMax BoundingBoxXMax BoundingBoxXMax
BoundingBoxXMin BoundingBoxXMin BoundingBoxXMin
BoundingBoxYMax BoundingBoxYMax BoundingBoxYMax
BoundingBoxYMin BoundingBoxYMin BoundingBoxYMin
BucketCount BucketCount BucketCount
CellsPerObject CellsPerObject CellsPerObject
CompactLargeObjects CompactLargeObjects CompactLargeObjects

Compact LOB data, such as text, image, varchar(MAX), nvarchar(MAX) and varbinary.

CompressAllRowGroups CompressAllRowGroups CompressAllRowGroups

Compress open row groups (delta stores) as well.

CompressionDelay CompressionDelay CompressionDelay

Compression Delay valid only for columnstore indexes.

DatabaseEngineEdition DatabaseEngineEdition DatabaseEngineEdition

Returns the DatabaseEngineEdition of the SMO object

(Inherited from SqlSmoObject)
DatabaseEngineType DatabaseEngineType DatabaseEngineType

Returns the DatabaseEngineType of the SMO object

(Inherited from SqlSmoObject)
DisallowPageLocks DisallowPageLocks DisallowPageLocks
DisallowRowLocks DisallowRowLocks DisallowRowLocks
Events Events Events
ExecuteForScalar ExecuteForScalar ExecuteForScalar Inherited from SqlSmoObject
ExecutionManager ExecutionManager ExecutionManager Inherited from SqlSmoObject
ExtendedProperties ExtendedProperties ExtendedProperties
FileGroup FileGroup FileGroup
FileStreamFileGroup FileStreamFileGroup FileStreamFileGroup
FileStreamPartitionScheme FileStreamPartitionScheme FileStreamPartitionScheme
FillFactor FillFactor FillFactor
FilterDefinition FilterDefinition FilterDefinition
HasCompressedPartitions HasCompressedPartitions HasCompressedPartitions
HasFilter HasFilter HasFilter
HasSparseColumn HasSparseColumn HasSparseColumn
ID ID ID
IgnoreDuplicateKeys IgnoreDuplicateKeys IgnoreDuplicateKeys
IndexedColumns IndexedColumns IndexedColumns
IndexedXmlPathName IndexedXmlPathName IndexedXmlPathName
IndexedXmlPathNamespaces IndexedXmlPathNamespaces IndexedXmlPathNamespaces

Collection of IndexedXMLPath objects that represent all the paths that are indexed by the Selective XML Index.

IndexedXmlPaths IndexedXmlPaths IndexedXmlPaths

Collection of IndexedXMLPath objects that represent all the paths that are indexed by the Selective XML Index.

IndexKeyType IndexKeyType IndexKeyType
IndexType IndexType IndexType
IsClustered IsClustered IsClustered
IsDisabled IsDisabled IsDisabled
IsFileTableDefined IsFileTableDefined IsFileTableDefined
IsFullTextKey IsFullTextKey IsFullTextKey
IsIndexOnComputed IsIndexOnComputed IsIndexOnComputed

The IsOnComputed property indicates whether any column in an index is a computed column.

IsIndexOnTable IsIndexOnTable IsIndexOnTable

The IndexOnTable property specifies whether an index is defined for a table or a view.

IsMemoryOptimized IsMemoryOptimized IsMemoryOptimized
IsPartitioned IsPartitioned IsPartitioned
IsSpatialIndex IsSpatialIndex IsSpatialIndex
IsSystemNamed IsSystemNamed IsSystemNamed
IsSystemObject IsSystemObject IsSystemObject
IsTouched IsTouched IsTouched

Whether the object has been touched for unconditional scripting of Alter

(Inherited from SqlSmoObject)
IsUnique IsUnique IsUnique
IsXmlIndex IsXmlIndex IsXmlIndex
Level1Grid Level1Grid Level1Grid
Level2Grid Level2Grid Level2Grid
Level3Grid Level3Grid Level3Grid
Level4Grid Level4Grid Level4Grid
LowPriorityAbortAfterWait LowPriorityAbortAfterWait LowPriorityAbortAfterWait

Gets or sets the ABORT_AFTER_WAIT action for the WAIT_AT_LOW_PRIORITY option of the DDL operation.

LowPriorityMaxDuration LowPriorityMaxDuration LowPriorityMaxDuration

Gets or sets the MAX_DURATION for the WAIT_AT_LOW_PRIORITY option of the DDL operation.

MaximumDegreeOfParallelism MaximumDegreeOfParallelism MaximumDegreeOfParallelism

Set the maximum number of processors involved in the index operation. The system default is used if not set.

Name Name Name
NoAutomaticRecomputation NoAutomaticRecomputation NoAutomaticRecomputation
ObjectInSpace ObjectInSpace ObjectInSpace Inherited from SqlSmoObject
OnlineIndexOperation OnlineIndexOperation OnlineIndexOperation

Specifies that the index that is created or modified will be kept online during the operation, allowing access to the underlying data structures.

PadIndex PadIndex PadIndex
Parent Parent Parent
ParentXmlIndex ParentXmlIndex ParentXmlIndex
PartitionScheme PartitionScheme PartitionScheme
PartitionSchemeParameters PartitionSchemeParameters PartitionSchemeParameters

Specifies the columns that define the input parameters for the Partition Scheme.

PhysicalPartitions PhysicalPartitions PhysicalPartitions
Properties Properties Properties Inherited from SqlSmoObject
ResumableIndexOperation ResumableIndexOperation ResumableIndexOperation

Sepcifies whether the index is resumable. The resumable index can be resume/abort if it is paused during the rebuild operation.

ResumableMaxDuration ResumableMaxDuration ResumableMaxDuration

Gets or sets the MAX_DURATION for the resumable operation option of the DDL operation.

ResumableOperationState ResumableOperationState ResumableOperationState
ScalarResult ScalarResult ScalarResult Inherited from SqlSmoObject
SecondaryXmlIndexType SecondaryXmlIndexType SecondaryXmlIndexType
SortInTempdb SortInTempdb SortInTempdb

Specifies that the intermediate sort results used to build the index will be stored in the tempdb database.

SpaceUsed SpaceUsed SpaceUsed
SpatialIndexType SpatialIndexType SpatialIndexType
State State State

Returns the state of the object

(Inherited from SmoObjectBase)
Urn Urn Urn

Returns the Urn of the object, computed on the fly

(Inherited from SqlSmoObject)
UserData UserData UserData Inherited from SmoObjectBase

Methods

Abort() Abort() Abort()

Abort the resumable index that is in the PAUSED status.

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

method get called from the create script related method (from derived classes like Table, Index etc..)

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

Changes the index based on supplied index properties

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

Performs an index operation using the current property settings of the object.

AlterAllIndexes() AlterAllIndexes() AlterAllIndexes()

Changes all indexes based on supplied index properties.

AlterImpl() AlterImpl() AlterImpl() Inherited from SqlSmoObject
AlterImplWorker() AlterImplWorker() AlterImplWorker() Inherited from SqlSmoObject
AppendCommaText(StringBuilder, String, Boolean, String) AppendCommaText(StringBuilder, String, Boolean, String) AppendCommaText(StringBuilder, String, Boolean, String) Inherited from ScriptNameObjectBase
AppendWithCommaText(StringBuilder, String, Boolean) AppendWithCommaText(StringBuilder, String, Boolean) AppendWithCommaText(StringBuilder, String, Boolean) Inherited from ScriptNameObjectBase
AppendWithOption(StringBuilder, String, String, Boolean) AppendWithOption(StringBuilder, String, String, Boolean) AppendWithOption(StringBuilder, String, String, Boolean) Inherited from ScriptNameObjectBase
AutoGenerateName() AutoGenerateName() AutoGenerateName() Inherited from ScriptNameObjectBase
BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) Inherited from SqlSmoObject
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) Inherited from SqlSmoObject
CheckIndex() CheckIndex() CheckIndex()

Tests the integrity of database pages implementing storage for the referenced index.

CheckIndexWithResult() CheckIndexWithResult() CheckIndexWithResult()

Tests the integrity of database pages that store data for the referenced index.

CheckObjectDirty() CheckObjectDirty() CheckObjectDirty()

If there are some properties which are respected in special cases then use this function. currently applicable for DatabaseDdltriggers

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

This is a virtual function, so that derived classes can override it if they want to do additional checks on the state of the object

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

Checks object state Because it is not recusrive, this function can be called directly and which means derived classes can't supply their own validation

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

checks text syntax, that it manipulates the right type of object ( PROC, TRIGGER, etc )

(Inherited from ScriptNameObjectBase)
CheckTextCorrectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo) CheckTextCorrectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo) CheckTextCorrectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo)

checks text syntax, that it manipulates the right type of object ( PROC, TRIGGER, etc )

(Inherited from ScriptNameObjectBase)
CheckTextModeSupport() CheckTextModeSupport() CheckTextModeSupport() Inherited from ScriptNameObjectBase
CleanObject() CleanObject() CleanObject() Inherited from ScriptNameObjectBase
Create() Create() Create()
CreateImpl() CreateImpl() CreateImpl() Inherited from SqlSmoObject
CreateOrAlterImpl() CreateOrAlterImpl() CreateOrAlterImpl() Inherited from SqlSmoObject
Disable() Disable() Disable()

Disables the index.

Discover() Discover() Discover()

Best Effort Discovery mechanism : This method reflects upon metadata and gets all available objects

(Inherited from SqlSmoObject)
Drop() Drop() Drop()
DropAndMove(String) DropAndMove(String) DropAndMove(String)

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

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 parameters specified with partitionSchemeParameters.

DropIfExists() DropIfExists() DropIfExists()

Drops the object with IF EXISTS option. If object is invalid for drop function will return without exception.

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

drops the object

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

drops the object

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

Enables the index. The action argument specifies how enable the index. It is possible to call Create() or Rebuild() instead, to enable the index.

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

The EnumStatistics method returns a DataSet object that enumerates index statistics used to support Microsoft® SQL Server™ 2000 query optimization

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

Executes sql statements

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

Creates the Rename query for a SqlSmoObject and Executes it on the Server.

(Inherited from NamedSmoObject)
ExecuteWithModes(SqlExecutionModes, Action) ExecuteWithModes(SqlExecutionModes, Action) ExecuteWithModes(SqlExecutionModes, Action)

Executes the given action under the given execution modes.

Resets the original modes after the action completes or fails.

(Inherited from SqlSmoObject)
ForceTextModeOnTextBody() ForceTextModeOnTextBody() ForceTextModeOnTextBody() Inherited from ScriptNameObjectBase
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object) Inherited from SqlSmoObject
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent() Inherited from SqlSmoObject
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) Inherited from SqlSmoObject
GetBraketNameForText() GetBraketNameForText() GetBraketNameForText() Inherited from ScriptNameObjectBase
GetContextDB() GetContextDB() GetContextDB() Inherited from SqlSmoObject
GetDBName() GetDBName() GetDBName() Inherited from SqlSmoObject
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) Inherited from SqlSmoObject
GetIsSystemNamed() GetIsSystemNamed() GetIsSystemNamed() Inherited from ScriptNameObjectBase
GetIsTextDirty() GetIsTextDirty() GetIsTextDirty() Inherited from ScriptNameObjectBase
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Retrieve the property value from :

  • The property bag directly if property is available (dirty or retrieved)
  • A call to our OnPropertyMissing method otherwise

    Will throw an exception if the property value is NULL in either case.

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

Retrieve the property value from :

  • The property bag if the state is creating or we're in Design Mode (possible NULL value)
  • A call to our OnPropertyMissing method otherwise (will throw exception if value is NULL)
(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Retrieve the property value from :

  • The property bag if the state is creating or we're in Design Mode (possible NULL)
  • A call to our OnPropertyMissing method otherwise (possible NULL)
(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Returns the real value for the property.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName() Inherited from SqlSmoObject
GetServerObject() GetServerObject() GetServerObject() Inherited from SqlSmoObject
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the sqlserver public name for the current connection, e.g: will transfer "SQLTOOLS2008-2" to "SQL Server 2008".

(Inherited from SqlSmoObject)
GetTextBody() GetTextBody() GetTextBody() Inherited from ScriptNameObjectBase
GetTextBody(Boolean) GetTextBody(Boolean) GetTextBody(Boolean) Inherited from ScriptNameObjectBase
GetTextHeader(Boolean) GetTextHeader(Boolean) GetTextHeader(Boolean) Inherited from ScriptNameObjectBase
GetTextHeader(ScriptNameObjectBase+ScriptHeaderType) GetTextHeader(ScriptNameObjectBase+ScriptHeaderType) GetTextHeader(ScriptNameObjectBase+ScriptHeaderType) Inherited from ScriptNameObjectBase
GetTextMode() GetTextMode() GetTextMode() Inherited from ScriptNameObjectBase
GetTextProperty(String) GetTextProperty(String) GetTextProperty(String)

get the text of the object, if not available, throw apropiate exception based on the State of the object

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

Computes the Urn for the object.

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

Computes the Urn for the object, potentially including other fields in the definition besides the key fields.

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

Initializes the object, by reading its properties from the enumerator

(Inherited from SqlSmoObject)
IsExpressSku() IsExpressSku() IsExpressSku()

Returns whether the server containing this object is an Express SKU

(Inherited from SqlSmoObject)
IsObjectDirty() IsObjectDirty() IsObjectDirty() Inherited from ScriptNameObjectBase
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized() Inherited from SqlSmoObject
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace() Inherited from SqlSmoObject
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Validate whether the specified property is supported in current server environment

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3() Inherited from SqlSmoObject
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove() Inherited from SqlSmoObject
MarkDropped() MarkDropped() MarkDropped() Inherited from SqlSmoObject
MarkForDrop(Boolean) MarkForDrop(Boolean) MarkForDrop(Boolean)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) Inherited from SqlSmoObject
Pause() Pause() Pause()

Pause the resumable index that is running.

PostAlter() PostAlter() PostAlter()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after altering the object

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

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after object creation

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

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after dropping the object

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

Re-creates the index based on the current property settings.

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

Rebuild particular partition

RebuildAllIndexes() RebuildAllIndexes() RebuildAllIndexes()

Re-creates all indexes based on the current property settings.

RecalculateSpaceUsage() RecalculateSpaceUsage() RecalculateSpaceUsage()

Forces the update of data reporting the disk resource usage of the referenced index.

Recreate() Recreate() Recreate()
Refresh() Refresh() Refresh()

Refresh the object.

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

Rename the index

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

change object name

(Inherited from NamedSmoObject)
RenameImplWorker(String) RenameImplWorker(String) RenameImplWorker(String) Inherited from NamedSmoObject
Reorganize(Int32) Reorganize(Int32) Reorganize(Int32)

Reorganizes the index based on the current property settings.

ReorganizeAllIndexes() ReorganizeAllIndexes() ReorganizeAllIndexes()

Reorganizes all indexes based on the current property settings.

Resume() Resume() Resume()

Resume the resumable index that is in the PAUSED status.

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

Returns a StringCollection object with the script for the object. This method throws an error if ScriptData is true

(Inherited from SqlSmoObject)
SetAccessToken(IRenewableToken) SetAccessToken(IRenewableToken) SetAccessToken(IRenewableToken)

Set the accessToken for connection.

(Inherited from SqlSmoObject)
SetCollectionTextMode(Boolean, SmoCollectionBase) SetCollectionTextMode(Boolean, SmoCollectionBase) SetCollectionTextMode(Boolean, SmoCollectionBase) Inherited from ScriptNameObjectBase
SetIsSystemNamed(Boolean) SetIsSystemNamed(Boolean) SetIsSystemNamed(Boolean) Inherited from ScriptNameObjectBase
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) Inherited from SqlSmoObject
SetSchemaOwned() SetSchemaOwned() SetSchemaOwned() Inherited from NamedSmoObject
SetTextBody(String) SetTextBody(String) SetTextBody(String) Inherited from ScriptNameObjectBase
SetTextHeader(String) SetTextHeader(String) SetTextHeader(String) Inherited from ScriptNameObjectBase
SetTextMode(Boolean, SmoCollectionBase[]) SetTextMode(Boolean, SmoCollectionBase[]) SetTextMode(Boolean, SmoCollectionBase[]) Inherited from ScriptNameObjectBase
SwitchTextMode(Boolean, SmoCollectionBase[]) SwitchTextMode(Boolean, SmoCollectionBase[]) SwitchTextMode(Boolean, SmoCollectionBase[]) Inherited from ScriptNameObjectBase
ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws an exception if the ServerVersion major version for this object is above 10.0 (SQL 2008)

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

Throws an exception if the ServerVersion major version for this object is above 8.0 (SQL 2000)

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

Throws an exception if the ServerVersion major version for this object is below 10.0 (SQL 2008)

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

Throws an UnsupportedVersionException if either the source or destination server is below 11.0 (SQL 2012)

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

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 11.0 (SQL 2012)

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

Throws an exception if the ServerVersion major version for this object is below 12.0 (SQL 2014)

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

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 12.0 (SQL 2014)

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

Throws an exception if the ServerVersion major version for this object is below 13.0 (SQL 2016)

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

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 13.0 (SQL 2016)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion140(String) ThrowIfBelowVersion140(String) ThrowIfBelowVersion140(String)

Throws an exception if the ServerVersion major version for this object is below 14.0 (SQL 2017)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion140Prop(String) ThrowIfBelowVersion140Prop(String) ThrowIfBelowVersion140Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 14.0 (SQL 2017)

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

Throws an exception if the ServerVersion major version for this object is below 8.0 (SQL 2000)

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

Throws an exception if the ServerVersion for this object is below 8.760 (8.0 SP3)

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

Throws an exception if the ServerVersion major version for this object is below 9.0 (SQL 2005)

(Inherited from SqlSmoObject)
ThrowIfTextIsDirtyForAlter() ThrowIfTextIsDirtyForAlter() ThrowIfTextIsDirtyForAlter() Inherited from ScriptNameObjectBase
ToString() ToString() ToString() Inherited from SqlSmoObject
Touch() Touch() Touch()

Mark the object "touched" for unconditional scripting of Alter.

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

Virtual method to allow derived classes to do additional work when touched.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) Inherited from SqlSmoObject
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) Inherited from SqlSmoObject
UpdateStatistics() UpdateStatistics() UpdateStatistics()

forces data distribution statistics update for a referenced index

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

forces data distribution statistics update for a referenced index

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

forces data distribution statistics update for a referenced index

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

forces data distribution statistics update for a referenced index

UpgradeToClusteredColumnStoreIndex() UpgradeToClusteredColumnStoreIndex() UpgradeToClusteredColumnStoreIndex()

Upgrades a Clustered Rowstore index to Clustered Columnstore Index

Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[]) Inherited from SmoObjectBase

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() IAlienObject.Discover() Inherited from SqlSmoObject
IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() Inherited from SqlSmoObject
IAlienObject.GetParent() IAlienObject.GetParent() IAlienObject.GetParent() Inherited from SqlSmoObject
IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Discovers type of property.

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

Retrieves value for a given property. Throws if property is not found.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() IAlienObject.GetUrn() Inherited from SqlSmoObject
IAlienObject.Resolve(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String) Inherited from SqlSmoObject
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets state of this object based on provided SfcObjectState.

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

Sets the value of given property, if it is writable. If property is not in property bag, reflection is used. Throws exception if the property is not found.

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

This object extend ISfcSupportsDesignMode.

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties Inherited from SqlSmoObject
singletonParent singletonParent singletonParent

Regular SMO objects access the parent class reference through parentColl (corresponding collection in parent class). Singleton class has no collection in parent.

(Inherited from SqlSmoObject)

Events

PropertyChanged PropertyChanged PropertyChanged Inherited from SqlSmoObject
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged Inherited from SqlSmoObject

Applies to