记录存储过程参数值

Question

我之前曾在 SQL Server 环境中工作过，其中日志记录是我们存储过程的一部分，用于捕获执行开始/结束、参数值和错误消息，我发现这非常有用，并且是我希望在新环境中引入的内容。

用于此日志记录的表如下所示，使用语句将参数捕获INSERT到表中，并将 with 值隐式转换为NVARCHAR。

CREATE TABLE dbo.Execution
(
    Id                  INT IDENTITY(1,1)           NOT NULL
,   SchemaName          NVARCHAR(128)               NOT NULL
,   ProcedureName       NVARCHAR(128)               NOT NULL
,   ExecutionStart      DATETIME                    NOT NULL
,   ExecutionEnd        DATETIME                    NULL
,   ExecutionFailed     BIT                         NOT NULL
)

CREATE TABLE dbo.ExecutionError
(
    Id                  INT IDENTITY(1,1)           NOT NULL
,   ExecutionId         INT                         NOT NULL
,   CustomErrorMessage  NVARCHAR(8000)              NULL
,   SqlErrorMessage     NVARCHAR(8000)              NULL
)

CREATE TABLE dbo.ExecutionParameter
(
    Id                  INT IDENTITY(1,1)           NOT NULL
,   ExecutionId         INT                         NOT NULL
,   ParameterName       NVARCHAR(128)               NOT NULL
,   ParameterValue      NVARCHAR(MAX)               NULL
)

我一直在重新考虑ExecutionParameter使用SQL_VARIANT数据类型的表，以便在分析和报告目的需要时可以获得基本数据类型，而不必根据名称/值进行猜测。

NVARCHAR(MAX)但是，这对于数据类型为or的参数不起作用，因此在大多数情况下VARCHAR(MAX)仍需要保留该列。NVARCHAR(MAX)NULL

使用SQL_VARIANT很诱人，但我觉得原始的表结构工作得很好，并且在不使过程变得更加复杂的情况下无法真正变得更好。

这是您以前做过的事情吗？如果是的话，您是如何实施的？您能否看到上述模式在不使其变得过于复杂的情况下还有改进的空间吗？

也许还有一个包含可以引用的存储过程及其参数详细信息的附加表？尽管我觉得这很难维护，并且随着存储过程随着时间的推移而修改，会变得混乱。

Answer 1

是的，我们几年前在我工作过的一家公司做过这种事情。尽管我们这样做只是为了记录错误，但它是相同的一般概念。您只需编写包含所有输入参数的 SELECT 语句，使用FOR XML并将其存储在可以插入到Execution表中的新字段中的变量中：Parameters XML NULL。然后你就可以废弃ExecutionParameter桌子了。

请尝试以下操作，因为它显示了生成 XML 的三种方法：基于属性、基于元素和基于元素（包括 NULL 元素）。默认行为是通过不包含属性或元素FOR XML来指示值。NULL但是，如果您正在执行基于元素的 XML 并且希望显示参数，即使它们是NULL，那么您需要XSINIL在FOR XML子句中指定。NULL基于属性的 XML 不提供包含指示符的功能。

请注意，就存储大小而言，基于属性的 XML 和默认的基于元素的 XML（默认 = 不包括项目）之间没有很大差异NULL（如下例所示）。查看 XML 时，确实会发现基于元素的“膨胀”程度更高，如果将数据存储在字段NVARCHAR或文本文件中，就会出现这种情况。但是XML数据类型使用一种优化的方法在内部存储数据，这种方式是看不见的，但在结果DATALENGTH输出中清楚地表明了。

然而，使用XSINIL基于元素的 XML 选项时，大小会略有增加，并且需要跟踪NULL从其他两种类型中排除的元素。大小的增加是由于在根元素中声明命名空间的一次性命中xsi，然后是每个NULL元素的命中。

DECLARE @Param1 INT = 5,
        @Param2 DATETIME = NULL,
        @Param3 NVARCHAR(50) = N'Test < some & XML chars "',
        @Param4 DATETIME = '2016-04-09';

DECLARE @Parameters XML;

SELECT @Parameters = (
   SELECT @Param1 AS [Param1],
          @Param2 AS [Param2],
          @Param3 AS [Param3],
          @Param4 AS [Param4]
   FOR XML RAW(N'Params') -- Attribute-based XML (NULL attributes are missing)
);

SELECT @Parameters, DATALENGTH(@Parameters); -- 183

SELECT @Parameters = (
   SELECT @Param1 AS [Param1],
          @Param2 AS [Param2],
          @Param3 AS [Param3],
          @Param4 AS [Param4]
   FOR XML RAW(N'Params'), ELEMENTS -- Element-based XML (NULL elements are missing)
);

SELECT @Parameters, DATALENGTH(@Parameters); -- 185

SELECT @Parameters = (
   SELECT @Param1 AS [Param1],
          @Param2 AS [Param2],
          @Param3 AS [Param3],
          @Param4 AS [Param4]
   FOR XML PATH(N'Params'), ELEMENTS XSINIL -- Element-based XML (NULL elements included)
);

SELECT @Parameters, DATALENGTH(@Parameters); -- 434

返回的 XML 值：

<!-- Attribute-based -->
<Params Param1="5" Param3="Test &lt; some &amp; XML chars &quot;"
 Param4="2016-04-09T00:00:00" />


<!-- Element-based -->
<Params>
  <Param1>5</Param1>
  <Param3>Test &lt; some &amp; XML chars "</Param3>
  <Param4>2016-04-09T00:00:00</Param4>
</Params>


<!-- Element-based including NULL elements -->
<Params xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Param1>5</Param1>
  <Param2 xsi:nil="true" />
  <Param3>Test &lt; some &amp; XML chars "</Param3>
  <Param4>2016-04-09T00:00:00</Param4>
</Params>

补充笔记：

• 对于SchemaName和ProcedureName列，我将使用它sysname作为数据类型，因为这就是它在系统表中的定义方式。并且请务必使用小写 for，sysname因为它是存在的别名，master并且具有二进制或区分大小写的默认排序规则的服务器将无法找到该别名（如果它不是全部小写）。您当前的服务器可能不区分大小写，但这仍然是使用sysname.

• 对于ExecutionError表，请确保包含INT要捕获的列：ERROR_LINE()、ERROR_NUMBER()、ERROR_STATE()和ERROR_SEVERITY()。

• 不，您不想使用SQL_VARIANT，因为这会阻止您存储 LOB 类型：VARCHAR(MAX)、NVARCHAR(MAX)、VARBINARY(MAX)和XML。

• 不，您不能使用NVARCHAR(8000)，因为NVARCHAR最大尺寸为 4000，除非您使用MAX.