GenerateSQL Method (Index) (SQL-DMO)

The GenerateSQL method returns a string containing a Transact-SQL command batch that can be used to create the the Microsoft® SQL Server™ index defined by the properties of the Index object used.

Applies To

Index Object

Syntax

object.GenerateSQL( Table ) as String

Returns

A Transact-SQL command batch as a string.

Remarks

Use the GenerateSQL or GenerateCreationSQL method to create a command batch for use in another process. For example, to define a new index, capture the command batch by using the GenerateSQL or GenerateCreationSQL method, then use the command batch to create a job step for scheduled index creation.

For the Index object, the GenerateSQL and GenerateCreationSQL methods perform similar functions. The script returned by the GenerateSQL method includes a Transact-SQL statement creating an index. The GenerateCreationSQL method prefixes the index creation statement with Transact-SQL syntax that conditionally removes an existing index.

To use the GenerateSQL or GenerateCreationSQL method

1. Create a new Index object.
2. Set the Name property.
3. Set the IndexedColumns property, referencing columns in the target table by name.
4. Set additional properties defining the index such as FileGroup and Type.
5. Get the Table object referencing the target table from the Tables collection.
6. Call the method that will generate the Transact-SQL command batch, capturing the returned text.

Important The GenerateSQL and GenerateCreationSQL methods generate a Transact-SQL batch that can be used to create an index. The method fails if the Index object used references an existing SQL Server index. Use the Script method of the Index object to create a Transact-SQL command batch defining an existing index.

Prototype (C/C++)

HRESULT GenerateSQL(
LPSQLDMOTABLE pTable,
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 by using SysFreeString.