16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
96 lines
2.2 KiB
Plaintext
96 lines
2.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
``++NOCOUNT++`` is by default deactivated (OFF) at server level. It means by default, the server will send to the client the number of rows affected by the SQL query executed which is, in most cases, useless because no one will read this information.
|
|
|
|
Deactivating this feature will save some network traffic and improve the execution performance of stored procedures and triggers that's why it is recommended to define ``++SET NOCOUNT ON++`` at the beginning of the definition of ``++PROCEDURE++``s and ``++TRIGGER++``s, before any query is processed.
|
|
|
|
This rule raises an issue when ``++NOCOUNT++`` is not set or is set to OFF between the beginning of the ``++PROCEDURE++`` (or ``++TRIGGER++``) definition and the first statement that is not a ``++SET++``, ``++IF++`` or ``++DECLARE++``.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,sql]
|
|
----
|
|
CREATE PROCEDURE dbo.MyProc
|
|
AS
|
|
BEGIN
|
|
DECLARE @var INT;
|
|
SET NOCOUNT OFF; -- Noncompliant; deactivate NOCOUNT
|
|
SELECT COUNT(*) FROM MY_TABLE
|
|
END;
|
|
----
|
|
|
|
[source,sql]
|
|
----
|
|
CREATE PROCEDURE dbo.MyProc
|
|
AS
|
|
BEGIN
|
|
-- Noncompliant; SET NOCOUNT is not specified so behaviour of the procedure execution is based on server configuration (OFF by default)
|
|
SELECT COUNT(*) FROM MY_TABLE
|
|
END;
|
|
----
|
|
|
|
[source,sql]
|
|
----
|
|
CREATE PROCEDURE dbo.MyProc
|
|
AS
|
|
BEGIN
|
|
SELECT COUNT(*) FROM MY_TABLE
|
|
SET NOCOUNT ON -- Noncompliant; SET NOCOUNT is set after select statement
|
|
END;
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,sql]
|
|
----
|
|
CREATE PROCEDURE dbo.MyProc(@debug INT)
|
|
AS
|
|
BEGIN
|
|
DECLARE @var INT;
|
|
IF @debug = 0
|
|
BEGIN
|
|
SET NOCOUNT ON;
|
|
END
|
|
SELECT COUNT(*) FROM MY_TABLE
|
|
END;
|
|
----
|
|
|
|
[source,sql]
|
|
----
|
|
CREATE TRIGGER MyTrigger ON MyTable
|
|
AFTER INSERT
|
|
AS
|
|
BEGIN
|
|
SET NOCOUNT ON;
|
|
[...]
|
|
END;
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
\[Add|Set] configuration "NOCOUNT" with expected value "ON".
|
|
|
|
|
|
=== Highlighting
|
|
|
|
If "SET NOCOUNT ON" is missing, highlight the CREATE PROCEDURE or CREATE TRIGGER
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 3 Sep 2018, 15:35:36 Alexandre Gigleux wrote:
|
|
``++ALTER PROCEDURE++`` should be considered the same as ``++CREATE PROCEDURE++`` by this rule.
|
|
|
|
endif::env-github,rspecator-view[]
|