Code Style

CodeFormat

Since: PMD 6.9.0

Priority: Medium (3)

This rule verifies that the PLSQL code is properly formatted. The following checks are executed:

SQL Queries:

• The selected columns must be each on a new line
• The keywords (BULK COLLECT INTO, FROM) start on a new line and are indented by one level
• UNION should be on the same indentation level as SELECT
• Each JOIN is on a new line. If there are more than one JOIN conditions, then each condition should be on a separate line.

Parameter definitions for procedures:

• Each parameter should be on a new line
• Variable names as well as their types should be aligned

Variable declarations:

• Each variable should be on a new line
• Variable names as well as their types should be aligned

Calling a procedure:

• If there are more than 3 parameters
  • then named parameters should be used
  • and each parameter should be on a new line

This rule is defined by the following Java class: net.sourceforge.pmd.lang.plsql.rule.codestyle.CodeFormatRule

Example(s):

BEGIN
  -- select columns each on a separate line
  SELECT cmer_id
        ,version
        ,cmp_id
    BULK COLLECT INTO v_cmer_ids
        ,v_versions
        ,v_cmp_ids
    FROM cmer;

  -- each parameter on a new line
  PROCEDURE create_prospect(
    company_info_in      IN    prospects.company_info%TYPE -- Organization
   ,firstname_in         IN    persons.firstname%TYPE      -- FirstName
   ,lastname_in          IN    persons.lastname%TYPE       -- LastName
  );

  -- more than three parameters, each parameter on a separate line
  webcrm_marketing.prospect_ins(
    cmp_id_in            => NULL
   ,company_info_in      => company_info_in
   ,firstname_in         => firstname_in
   ,lastname_in          => lastname_in
   ,slt_code_in          => NULL
  );

END;

This rule has the following properties:

Use this rule by referencing it:

<rule ref="category/plsql/codestyle.xml/CodeFormat" />

ForLoopNaming

Since: PMD 6.7.0

Priority: Medium (3)

In case you have loops please name the loop variables more meaningful.

This rule is defined by the following XPath expression:

//CursorForLoopStatement[
    $allowSimpleLoops = 'false' or
    (Statement//CursorForLoopStatement or ancestor::CursorForLoopStatement)
]
/ForIndex[not(matches(@Image, $cursorPattern))]
|
//ForStatement[
    $allowSimpleLoops = 'false' or
    (Statement//ForStatement or ancestor::ForStatement)
]
/ForIndex[not(matches(@Image, $indexPattern))]

Example(s):

-- good example
BEGIN
FOR company IN (SELECT * FROM companies) LOOP
  FOR contact IN (SELECT * FROM contacts) LOOP
    FOR party IN (SELECT * FROM parties) LOOP
      NULL;
    END LOOP;
  END LOOP;
END LOOP;
END;
/

-- bad example
BEGIN
FOR c1 IN (SELECT * FROM companies) LOOP
  FOR c2 IN (SELECT * FROM contacts) LOOP
    FOR c3 IN (SELECT * FROM parties) LOOP
      NULL;
    END LOOP;
  END LOOP;
END LOOP;
END;
/

This rule has the following properties:

Use this rule by referencing it:

<rule ref="category/plsql/codestyle.xml/ForLoopNaming" />

MisplacedPragma

Since: PMD 5.5.2

Priority: Medium (3)

Oracle states that the PRAQMA AUTONOMOUS_TRANSACTION must be in the declaration block, but the code does not complain, when being compiled on the 11g DB. https://docs.oracle.com/cd/B28359_01/appdev.111/b28370/static.htm#BABIIHBJ

This rule is defined by the following XPath expression:

//ProgramUnit/Pragma

Example(s):

create or replace package inline_pragma_error is

end;
/

create or replace package body inline_pragma_error is
  procedure do_transaction(p_input_token        in varchar(200)) is
  PRAGMA AUTONOMOUS_TRANSACTION; /* this is correct place for PRAGMA */
  begin
    PRAGMA AUTONOMOUS_TRANSACTION; /* this is the wrong place for PRAGMA -> violation */
    /* do something */
    COMMIT;
   end do_transaction;

end inline_pragma_error;
/

Use this rule by referencing it:

<rule ref="category/plsql/codestyle.xml/MisplacedPragma" />