This article includes
- Introduction
- General concepts
- OLE Automation Stored Procedures
- sp_OACreate
- sp_OADestroy
- sp_OAGetProperty
- sp_OASetProperty
- sp_OAMethod
- sp_OAGetErrorInfo
- sp_OAStop
- Example: generate script
- Literature
--------------------------------------------------------------------------------
Introduction
In this article, I want to tell you about how you can work with COM objects from within Transact SQL. You can use OLE Automation Stored Procedures (extended stored procedures with sp_OA prefix) to create a COM object in T-SQL and use the object's methods and properties.
General concepts
The OLE Automation Stored Procedures, in other words, sp_OA procedures (where OA stands for OLE Automation), allow a connection, through T-SQL commands, to create and use Component Object Model (COM) based objects. These procedures are built into SQL Server as an extended stored procedure.
Each OLE Automation stored procedure returns an integer code that is the HRESULT returned by the underlying OLE Automation operation. If HRESULT is equal to 0, then everything is okay, a nonzero HRESULT indicates OLE error (in hexadecimal format).
You can use the sp_displayoaerrorinfo stored procedure to display OLE Automation error information (error description, not only hexadecimal code), when error occurs. This very useful procedure is not installed by default, so you can create it manually from SQL Server Books Online.
OLE Automation Stored Procedures
SQL Server supports seven OLE Automation Stored Procedures:
- sp_OACreate
- sp_OADestroy
- sp_OAGetProperty
- sp_OASetProperty
- sp_OAMethod
- sp_OAGetErrorInfo
- sp_OAStop
You can find the description of these stored procedures below.
sp_OACreate
First of all, you should call the sp_OACreate stored procedure to create an instance of the OLE object. You should pass two parameters into the sp_OACreate stored procedure: program ID or class ID and variable. The variable will be a reference to the OLE object for the further using by other sp_OA stored procedures.
This is the example: |
 Click here to copy the following block | DECLARE @object int
DECLARE @hr int
EXEC @hr = sp_OACreate 'SQLDMO.SQLServer', @object OUT
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END |
Note If you use SQL Server 6.5, you must write 'SQLOLE.SQLServer' instead of 'SQLDMO.SQLServer'.
See this link for more information: sp_OACreate (T-SQL)
sp_OADestroy
This stored procedure can be used to destroy the created OLE object. If you don't call the sp_OADestroy, the created OLE object will be destroyed automatically when the batch completes execution.
This is the example: |
See this link for more information: sp_OADestroy (T-SQL)
sp_OAGetProperty
You can use the sp_OAGetProperty stored procedure to get a property value of an OLE object.
See this link for more information: sp_OAGetProperty (T-SQL)
sp_OASetProperty
You can use the sp_OASetProperty stored procedure to set a property of an OLE object to a new value.
See this link for more information: sp_OASetProperty (T-SQL)
sp_OAMethod
You can use the sp_OAMethod stored procedure to call a method of an OLE object.
This example calls the VerifyConnection method of the previously created SQL Server object: |
| See this link for more information: sp_OAMethod (T-SQL) |
This stored procedure can be used to display the OLE Automation error information when error occurs.
However, easier to use the sp_displayoaerrorinfo stored procedure instead of sp_OAGetErrorInfo, because sp_displayoaerrorinfo is a wrapped stored procedure for sp_OAGetErrorInfo.
See this link for more information: sp_OAGetErrorInfo (T-SQL)
sp_OAStop
This stored procedure can be used to stop the OLE Automation Stored Procedures execution environment.
The execution environment will automatically restart the next time you call sp_OACreate stored procedure.
See this link for more information: sp_OAStop (T-SQL)
Example: generate script
This script will generate script for all tables and all dependent objects for the given database. You can pass the server name, user name, user password, database name and file name into sp_GenerateScript stored procedure, as in the example below: |
You can specify different number of parameters (from zero to five parameters).
If you not specify server name, then the current server will be used;
if you not specify database name, then the current database will be used;
if you use Windows NT Authentication mode, then you should not specify username and password;
if you not specify user name, but specify password, then the current user name will be used;
if you not specify password, then password will not be used (for example: username = 'sa' and empty password, you can pass only username in this case);
if you not specify file name, then script will be placed into file script.sql on the drive 'c:'.
This stored procedure can be used for learning some general SQL Server features (how to work with OLE objects from the SQL Server, how to use some system functions, how to work with cursors and so on).
Note : sp_displayoaerrorinfo is a user defined SP to display COM errors. Refer to the following article for more information.
How to display COM error description in SQL Stored procedure ? |
| Click here to copy the following block | if object_id('sp_GenerateScript') is not null drop proc sp_GenerateScript
GO
CREATE PROC sp_GenerateScript (
@server varchar(30) = null,
@uname varchar(30) = null,
@pwd varchar(30) = null,
@dbname varchar(30) = null,
@filename varchar(200) = 'c:\script.sql'
)
AS
DECLARE @object int
DECLARE @hr int
DECLARE @return varchar(200)
DECLARE @exec_str varchar(200)
DECLARE @tbname varchar(30)
SET NOCOUNT ON
IF @server is NULL
SELECT @server = @@servername
IF @dbname is NULL
SELECT @dbname = db_name()
EXEC @hr = sp_OACreate 'SQLDMO.SQLServer', @object OUT
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
IF (@uname is NULL) AND (@pwd is NULL)
BEGIN
EXEC @hr = sp_OAMethod @object, 'Connect', NULL, @server
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
END
ELSE
IF (@uname is NULL)
BEGIN
SELECT @uname = SYSTEM_USER
EXEC @hr = sp_OAMethod @object,'Connect',NULL,@server,@uname,@pwd
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
END
ELSE
IF (@pwd is NULL)
BEGIN
EXEC @hr = sp_OAMethod @object, 'Connect', NULL, @server, @uname
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
END
ELSE
BEGIN
EXEC @hr = sp_OAMethod @object,'Connect',NULL,@server,@uname,@pwd
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
END
EXEC @hr = sp_OAMethod @object, 'VerifyConnection', @return OUT
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
SET @exec_str = "DECLARE script_cursor CURSOR FOR SELECT name FROM "
+ @dbname + "..sysobjects WHERE type = 'U' ORDER BY Name"
EXEC (@exec_str)
OPEN script_cursor
FETCH NEXT FROM script_cursor INTO @tbname
WHILE (@@fetch_status <> -1)
BEGIN
SET @exec_str = 'Databases("'+ @dbname +'").Tables("'
+ RTRIM(UPPER(@tbname))+'").Script(74077,"'
+ @filename +'")'
EXEC @hr = sp_OAMethod @object, @exec_str, @return OUT
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
FETCH NEXT FROM script_cursor INTO @tbname
END
CLOSE script_cursor
DEALLOCATE script_cursor
EXEC @hr = sp_OADestroy @object
IF @hr <> 0
BEGIN
EXEC sp_displayoaerrorinfo @object, @hr
RETURN
END
GO |
|