Schema object naming recommendations

This topic provides some recommendations for naming schema objects.

OceanBase Database recommends the following naming conventions:

• Use full, descriptive, and easy-to-spell names or well-known abbreviations.

• Use consistent naming rules.

• Use the same name to describe the same entity or attribute across tables.

When you cannot balance simplicity and descriptiveness, choose a more descriptive name. Database objects may be used for a long time. For example, a column named pmdd in a table may be difficult to understand in 10 years. In contrast, a column named payment_due_date is more clear.

Use consistent naming rules to help users understand the role of each table in the application. For example, name all tables of the FINANCE application with the fin_ prefix.

Use the same name to describe the same content in tables. For example, the department_id column stores the same values in the employee table and the department table. The department_id column in both tables is named department_id.