rspec/rules/S4532/plsql/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
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.
2023-05-25 14:18:12 +02:00

73 lines
1.7 KiB
Plaintext

== Why is this an issue?
Labels are useful to match the begin and end of each PACKAGE, PROCEDURE or FUNCTION, especially when the code is badly indented or too much nested.
This rule raised an issue when the END statement of a PACKAGE, PROCEDURE or FUNCTION is having no label matching the name of the corresponding "begin" statement.
=== Noncompliant code example
[source,sql]
----
CREATE OR REPLACE PACKAGE BODY cust_sal AS
PROCEDURE find_sal(c_id customers.id%TYPE) IS
c_sal customers.salary%TYPE;
BEGIN
SELECT salary INTO c_sal
FROM customers
WHERE id = c_id;
dbms_output.put_line('Salary: '|| c_sal);
END; -- Noncompliant; not a PROCEDURE
END; -- Noncompliant; not a PACKAGE
/
----
=== Compliant solution
[source,sql]
----
CREATE OR REPLACE PACKAGE BODY cust_sal AS
PROCEDURE find_sal(c_id customers.id%TYPE) IS
c_sal customers.salary%TYPE;
BEGIN
SELECT salary INTO c_sal
FROM customers
WHERE id = c_id;
dbms_output.put_line('Salary: '|| c_sal);
END find_sal; -- Compliant; it's matching the name of the PROCEDURE
END cust_sal; -- Compliant: it's matching the name of the PACKAGE
/
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Add the missing "xxx" label to this statement.
=== Highlighting
First: the END statement
Second: the identifier of the matching package, procedure, function name
'''
== Comments And Links
(visible only on this page)
=== on 26 Mar 2018, 21:28:38 Alexandre Gigleux wrote:
This rule can't be applied to T-SQL: \https://docs.microsoft.com/en-us/sql/t-sql/statements/create-function-transact-sql
endif::env-github,rspecator-view[]