G-9215
🆓Always follow naming conventions for functions.
Reason
SQL identifiers share the same namespace as PL/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.
Recommendations
Name is built from a verb followed by a noun in general. Nevertheless, it is not sensible to call a function get_... as a function always gets something.
The name of the function should answer the question “What is the outcome of the function?”
Optionally prefixed by a project abbreviation.
Example: employee_by_id
If more than one function provides the same outcome, you have to be more specific with the name.
Example
Non-Compliant Example
create or replace package departement_api is -- ... function département_id_par_nom(in_nom in varchar2) return number; end; /
Issues
| Line | Column | Message |
|---|---|---|
| 3 | 13 | function département_id_par_nom does not match '^[a-z][a-z0-9$#_]*$'. |
Explanation
We do not want accented letters in function names.
Compliant Solution - ★★★★★
create or replace package departement_api is -- ... function departement_id_par_nom(in_nom in varchar2) return number; end; /
Explanation
All accented letters are replaced with plain Latin letters.
Parameters
Use parameters to customize the rule to your needs.
| Parameter | Description | Default Value |
|---|---|---|
| FunctionPattern | Case-insensitive regular expression pattern for functions in PL/SQL packages and types. | ^[a-z][a-z0-9$#_]*$ |
References
- similar to plsql:PlSql.FunctionAndProcedureNaming
The scope of plsql:PlSql.FunctionAndProcedureNaming is functions and procedures.