G-9109

🆓

Warning

Always follow naming conventions for OUT parameters of functions and procedures.

Rule Details

Severity Level: Minor
Quality Area: Maintainability
Fixing times: 60 mins
Other
Database Support: OracleDB (v7.3.4 +)

Reason

PL/SQL identifiers share the same namespace as SQL identifiers. Follow naming conventions to prevent naming conflicts, improve readability, and clearly indicate the scope without forcing the use of qualified names. A common practice is to use a prefix and/or suffix to distinguish the identifier types.

Example

Non-Compliant Example

create or replace package p is
   procedure p2(param out integer);
end p;
/

Issues

Line	Column	Message
2	17	OUT Parameter param does not match '^out_[a-z0-9$#_]+$'.

Compliant Solution - ★★★★★

create or replace package p is
   procedure p2(out_param out integer);
end p;
/

Parameters

Use parameters to customize the rule to your needs.

Parameter	Description	Default Value
OutParameterPattern	Case-insensitive regular expression pattern for PL/SQL OUT parameters of functions and procedures.	^out_[a-z0-9$#_]+$

References

same as Trivadis Naming Conventions for PL/SQL - Out Parameter
similar to plsql:NamingFunctionAndProcedureParametersCheck
The scope of plsql:NamingFunctionAndProcedureParametersCheck is all parameter directions, not just OUT parameters.