GenerateSQLOnView Method
The GenerateSQLOnView method returns a string that contains a Transact-SQL command batch. This command batch can be used to create the Microsoft® SQL Server™ index defined by the properties of the Index object used to create the index.
Applies To
| Index2 Object |
Syntax
object.GenerateSQLOnView( pView ) as String
Parts
object
Expression that evaluates to an object in the Applies To list
PView
Expression that evaluates to an Index object in SQL-DMO
Prototype (C/C++)
HRESULT GenerateSQLOnView(
LPSQLDMOVIEW pView,
SQLDMO_LPBSTR pRetVal);
Note SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.
Remarks
Use the GenerateSQLOnView or GenerateCreationSQLOnView method to create a command batch for use in another process. For example, to define a new index, capture the command batch using the GenerateSQLOnView or GenerateCreationSQLOnView method, then use the command batch to create a job step for scheduled index creation.
For the Index2 object, the GenerateSQLOnView and GenerateCreationSQLOnView methods perform similar functions. The script returned by the GenerateSQLOnView method includes a Transact-SQL statement that creates an index. The GenerateCreationSQLOnView method prefixes the index creation statement with Transact-SQL syntax that conditionally removes an existing index.
To use the GenerateSQLOnView or GenerateCreationSQLOnView method
- Create a new Index2 object.
- Set the Name property.
- Set the IndexedColumns property; reference columns in the target table by name.
- Set additional properties that define the index, such as FileGroup and Type.
- Get the Table object that references the target table from the Tables collection.
- Call the method that will generate the Transact-SQL command batch and capture the returned text.