Index Class

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

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

Compress open row groups (delta stores) as well.

Compression Delay valid only for columnstore indexes.

Returns the DatabaseEngineEdition of the SMO object

Returns the DatabaseEngineType of the SMO object

Whether to drop and rebuild the existing clustered or nonclustered index with modified column specifications and keep the same name for the index. The default is false.

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

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

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

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

Returns a value indicating whether the index supports online rebuild

Whether the object has been touched for unconditional scripting of Alter

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

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

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

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

Returns the collection that contains the object. May be null.

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

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

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

Returns the ServerVersion of the Server that contains the object. If the object is not associated with a connected Server, the highest known server version is returned.

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

Returns the state of the object

Returns the Urn of the object, computed on the fly

Returns the name of the type in the urn expression

Abort the resumable index that is in the PAUSED status.

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

Changes the index based on supplied index properties

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

Changes all indexes based on supplied index properties.

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

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

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

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

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

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

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

Disables the index.

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

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

Drops a clustered index and moves the underlying table data to the partition scheme with the parameters specified with partitionSchemeParameters.

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

drops the object

For drop calls on the user database in Azure, the connection will be closed as the database is dropped The ExecutionManager will normally attempt to retry such calls by reopening the connection We want to avoid this retry when handleSevereError is true.

drops the object

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

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

Executes sql statements

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

Executes the given action under the given execution modes.

Resets the original modes after the action completes or fails.

Provides an enumerable of properties that are explicitly disabled for specific server types or editions. This is not a list of all properties that don't work for the specified target.

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.

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)

Returns the value of the named property. If the object is in the Creating state and the property has not yet been set the defaultValue is returned. If the object exists the defaultValue is ignored and the actual value is returned.

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)

Returns the real value for the property.

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

Returns the comparer used by all child object collections to perform comparison of object names. The comparer of a Server is based on the collation of master The comparer of a Database and its children is based on the database collation

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

Computes the Urn for the object.

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

Initializes the child object collection associated with the given type. For example, the name Column would initialize the Columns collection.

Initializes the object, by reading its properties from the enumerator

Returns whether the server containing this object is an Express SKU

Validate whether the specified property is supported in current server environment

Pause the resumable index that is running.

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

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

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

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

Rebuild particular partition

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

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

Refresh the object.

Rename the index

change object name

Reorganizes the index based on the current property settings.

Reorganizes all indexes based on the current property settings.

Resume the resumable index that is in the PAUSED status.

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

Set the accessToken for connection.

Sets the object state (Existing, Dropped etc.) Applications should avoid using this method.

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

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

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

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

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)

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

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)

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

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)

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

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)

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

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

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

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

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

forces data distribution statistics update for a referenced index

forces data distribution statistics update for a referenced index

forces data distribution statistics update for a referenced index

forces data distribution statistics update for a referenced index

Upgrades a Clustered Rowstore index to Clustered Columnstore Index

Discovers type of property.

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

Sets state of this object based on provided SfcObjectState.

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.

This object extend ISfcSupportsDesignMode.

Finds all available checks for given smoObject.

Synchronously runs assessment for given smoObject and gives a IEnumerable<T> describing discovered issues. This method performs only given checks from checks.

Synchronously runs assessment for given smoObject and gives a IEnumerable<T> describing discovered issues.

Asynchronously runs assessment for given smoObject and gives a List<T> describing discovered issues. This method performs only given checks from checks.

Asynchronously runs assessment for given smoObject and gives a List<T> describing discovered issues.

Checks if the specified type is supported by the ServerVersion and DatabaseEngineType of the root server for this object. If ScriptingPreferences are non-null will also check if specified type is supported by the ServerVersion and DatabaseEngineType of the target server.