G-9218

🆓

Warning

Always follow naming conventions for object type attributes.

Rule Details

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

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

Singular name of what is stored in the attribute (unless the attribute data type is a collection, in this case you use plural names).

Example

Non-Compliant Example

create or replace type dept_ot as object (
   département_id number
   -- ...
);
/

Issues

Line	Column	Message
2	4	attribute département_id does not match '(?i)^[a-z][a-z0-9$#_]*$'.

We do not want accented letters in attribute names.

Compliant Solution - ★★★★★

create or replace type dept_ot as object (
   departement_id number
   -- ...
);
/

All accented letters are replaced with plain Latin letters.

Parameters

Use parameters to customize the rule to your needs.

Parameter	Description	Default Value
AttributePattern	Regular expression pattern for SQL object type attributes.	(?i)^[a-z][a-z0-9$#_]*$

References

same as plsql:NamingObjectAttribute
similar to Trivadis Database Object Naming Conventions - Column
Columns and attributes should follow the same naming conventions.