SQL Server 2005 - 如何从CLR存储过程传回表格结果与讯息（一）

引用了章立民先生的文章：http://www.cnblogs.com/liminzhang/archive/2007/01/15/620932.html

除了通过输出参数传回数据之外，我们还可以使用 SqlPipe 对象将表格结果与讯息传回给客户端。一般来说，我们是通过 SqlContext 类别的Pipe 属性取得 SqlPipe 对象，然后呼叫 SqlPipe 对象的 Send 方法将表格结果或讯息传送给客户端。

 

SqlPipe 对象的 Send 方法拥有下列三个多载版本：

 

q          SqlPipe.Send(message As String)

此多载版本的 Send 方法能够将字符串讯息直接传送至客户端。文字讯息最长不可超过 8000 个字符，超出 8000 个字符的部分将会被截掉。

讯息字符串会被当作一个信息讯息传送给客户端，至于客户端要通过哪一种机制来聆听此讯息，则视客户端所采用的数据存取应用程序接口（API）而定。比方说，假设客户端使用 ADO.NET，则讯息会通过事件 InfoMessage 来传送。

 

q          SqlPipe.Send(record As SqlDataRecord)

此多载版本的 Send 方法能够将单一数据列结果集（也就是一个SqlDataRecord 对象）直接传送至客户端。如果您于 Send 方法中所使用的 SqlDataReader 对象拥有隐藏字段，这些字段将不会填入传送给客户端的结果集当中。

以前一篇文章所建立的CLR存储过程 SayHello 而言，它除了使用输出参数来传回文字数据之外，还呼叫此多载版本的 Send 方法将单一数据列结果集直接传送至客户端，如下所示：

SqlContext.Pipe.Send(greetingRecord)

q          SqlPipe.Send(reader As SqlDataReader)

此多载版本的 Send 方法能够将一个多数据列结果集（也就是一个SqlDataReader 对象）直接传送至客户端。

如果您要传送先前通过同处理序（In-Process）提供者所执行的查询结果，或是想要使用 SqlDataReader 的自订实作来预先处理数据，请使此多载版本的 Send 方法来接收一个 SqlDataReader 对象并将其直接传送给客户端。虽然 Send 方法的执行效率稍稍慢于ExecuteAndSend 方法，不过在数据被传送至客户端之前，它提供了最大的弹性来处理数据。

 

请大家注意，除了使用 Send 方法之外，CLR 存储过程还可以使用SqlPipe 对象的 ExecuteAndSend 方法将查询结果传送给客户端。ExecuteAndSend 方法的最大好处，就是它提供了一种最高效率的方式将查询结果传送给客户端，之所以如此，是因为数据是通过网络缓冲区来传送，而不需被复制到受管理的内存中。

 

以下是 ExecuteAndSend 方法的语法：

 

SqlPipi.ExecuteAndSend (command As SqlCommand)

 

从语法可以看出，ExecuteAndSend 方法其实是以一个 SqlCommand对象作为其参数，它会执行 SqlCommand 对象并将结果传送至客户端。大家必须了解，除了所有实际的执行结果之外，其它的讯息与错误也会直接传送给客户端。

 

程序范例

 

以下我们示范如何使用 SqlPipe 对象的 Send 方法将文字符串直接传送至客户端：

 

q          下面这一个CLR存储过程存放于类别库项目 GiveYouString 中，它示范如何使用 SqlPipe 对象的 Send 方法将文字符串直接传送至客户端：

namespace GiveYouString
{
 public class GiveYouStringClass
 {
  [Microsoft.SqlServer.Server.SqlProcedure()]
  public static void GiveYouString()
  {
   // 呼叫 Pipe 对象的 Send 方法将文字符串直接传送给客户端。
   SqlContext.Pipe.Send("章立民研究室");
  }
 }
}

请注意，这一个CLR存储过程并没有任何参数。

q          请执行如下所示之 SQL 指令码，登录组件 GiveYouString.dll、建立一个参考所登录之组件 GiveYouString.dll 的存储过程、然后执行此CLR 存储过程：

USE 北风贸易;
GO

IF EXISTS (SELECT * FROM sys.procedures WHERE [name] =
'GiveYouString')
DROP PROCEDURE GiveYouString;
GO

IF EXISTS (SELECT * FROM sys.assemblies WHERE [name] =
'GiveYouString')
DROP ASSEMBLY GiveYouString;
GO

-- 登录组件GiveYouString.dll
CREATE ASSEMBLY GiveYouString
FROM 'C:\SQL2005Demo\CH13\GiveYouString\GiveYouString\bin\GiveYouString.dll'
WITH permission_set = Safe;
GO

-- 建立一个会参考所登录之组件GiveYouString.dll的存储过程
CREATE PROCEDURE dbo.GiveYouString
AS EXTERNAL NAME GiveYouString.[GiveYouString.GiveYouStringClass].GiveYouString;
GO

EXEC sp_configure 'clr enabled', '1';
GO
RECONFIGURE;
GO

DECLARE @return_value int

-- 执行CLR存储过程
EXECUTE @return_value = dbo.GiveYouString;

q          在您执行了上述 SQL 指令后将会发现， 执行CLR 存储过程GiveYouString 之后并无法取得所传回的文字符串。事实上我们之前就曾经提及，SqlPipe 对象之 Send 方法所传回的讯息字符串会被当作一个信息讯息传送给客户端，至于客户端要通过哪一种机制来聆听此讯息，则视客户端所采用的数据存取应用程序接口（API）而定。如果客户端使用 ADO.NET，则讯息会通过事件 InfoMessage来传送。

为了示范如何在前端应用程序中通过 ADO.NET 取得 SqlPipe 对象之 Send 方法所传回的讯息字符串，我们特别设计了一个Windows应用程序 TakeReturnString 来加以实作。从图表1的执行画面可以看出，我们果然能够顺利取得 CLR 存储过程使用 SqlPipe 对象之 Send 方法所传回的文字符串。

相关的前端程序代码列示如下：

private void btnRun_Click(object sender, EventArgs e)
{
 // 利用 SqlConnectionStringBuilder 对象来构建连接字符串。
 SqlConnectionStringBuilder connectStringBuilder = new
   SqlConnectionStringBuilder();
 connectStringBuilder.DataSource = @"(local)";
 connectStringBuilder.InitialCatalog = "北风贸易";
 connectStringBuilder.IntegratedSecurity = true;
 
 try
 {
  using(SqlConnection northwindConnection = new
    SqlConnection(connectStringBuilder.ConnectionString))
  {
   northwindConnection.InfoMessage += new
     SqlInfoMessageEventHandler(OnInfoMessage);
  
   northwindConnection.Open();
  
   SqlCommand cmdLiming = new SqlCommand("dbo.GiveYouString",
     northwindConnection);
  
   cmdLiming.CommandType = CommandType.StoredProcedure;
   cmdLiming.ExecuteNonQuery();
  }
 }
 catch(Exception ex)
 {
  MessageBox.Show(ex.Message);
 }
}

private static void OnInfoMessage(object sender,
  SqlInfoMessageEventArgs args)
{
 // 显示 CLR 存储过程利用 SqlPipe.Send 方法所传回的文字符串。
 MessageBox.Show(args.Message);
}