OSDB Style Guide

Structure of the code

• Callable SQL branch
• Embedded SQL branch
• Non-SQL branch

Coding Rules and Conventions for OSDB

1. Rule #1 -- Copy the style that you find in the module!
2. Use the PostgreSQL tests as your template
3. Tab stops are set at 4 character intervals

Structure of the code

At the top of the tree we have osdb, which provides overall direction and common services for the tests.

• Callable SQL branch

The first branch of the tree under OSDB is Callable SQL. Callable SQL invokes database-specific modules at the next level down to implement tests. In this way, we can help to ensure that anything that can be called via an SQL interface, including user interface programs, will be subjected to the same tests.

• Embedded SQL branch

Like the Callable SQL branch, this branch provides a common driver for embedded SQL implementations. Note that Embedded SQL tests rely on the M4 macro processor to help ensure that the right things happen.

• Non-SQL branch

This is the most tenuous branch because anything tested here, by definition, speaks something other than SQL. The implementor must be especially careful to ensure that the tests here parallel the SQL tests of the other branches.

Coding Rules and Conventions for OSDB

1. Rule #1 -- Copy the style that you find in the module!

Exception: Most of the code puts opening braces "{" on a new line, such as

 
  if (sensible)
  {
    do_something();
  } 
  

On reflection, the more-standard practice is to put the opening brace on the previous line, i.e.,

 
  if (sensible) {
     do_something();
  } 
  

The latter form is preferable, and all new code should be written in that style, even if the rest of the module uses the previous style.
2. Use the PostgreSQL tests as your template

When starting a new program, use the equivalent program from the PostgreSQL test set as your template. By starting from a common base, we should be able to limit the number of unintended mutations over time.

3. Tab stops are set at 4 character intervals

I prefer to translate tabs into whitespace, which helps to ensure that various print utilities, and more or less, will display the same thing as my preferred editor, vim.