Index.Script Index.Script Index.Script Method

Definition

Generates a Transact-SQL script that can be used to re-create the index.

Overloads

Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the index.

Script(ScriptingOptions) Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the index as specified by the script options.

Remarks

The following options do not appear in the script for the Index object:

PAD_INDEX

ALLOW_PAGE_LOCKS

ALLOW_ROW_LOCKS

ONLINE

Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the index.

public:
 virtual System::Collections::Specialized::StringCollection ^ Script();
public System.Collections.Specialized.StringCollection Script ();
Public Function Script () As StringCollection
Returns

A StringCollection system object value that contains a list of Transact-SQL statements in the script.

Implements

Examples

Scripting

Remarks

The generated script might contain undocumented, internal procedures, which are required for the complete script output.

Note

Indexes based partly on the UserDefinedTableType object do not support this method and running this method will generate an exception.

Script(ScriptingOptions) Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the index as specified by the script options.

public:
 virtual System::Collections::Specialized::StringCollection ^ Script(Microsoft::SqlServer::Management::Smo::ScriptingOptions ^ scriptingOptions);
public System.Collections.Specialized.StringCollection Script (Microsoft.SqlServer.Management.Smo.ScriptingOptions scriptingOptions);
Parameters
scriptingOptions
ScriptingOptions ScriptingOptions ScriptingOptions

A ScriptingOptions object value that is used to specify the script options.

Returns

A StringCollection system object value that contains a list of Transact-SQL statements in the script.

Implements

Examples

Scripting

Remarks

The generated script might contain undocumented, internal procedures, which are required for the complete script output.

Note

Indexes based partly on the UserDefinedTableType object do not support this method and running this method will generate an exception.

Applies to