The scope of this document is to propose a naming convention for the database schema.
The main objectives are:
- Ensure portability of Mifos database code to different operating systems. Namely, Linux, Windows, and Mac OS X.
- Encourage intuitive naming of database identifiers like tables and columns.
- Improve readability and maintainability of database code.
Portability to databases other than MySQL is out of scope of this document.
- Allowed characters for identifiers are a-z, A-Z, 0-9, and _.
- All identifiers shall be in English.
- Underscores should be used to separate words, e.g. account_name.
- Do not use commonly reserved database keywords like table, column, index, etc.
In addition to the constraints above, particular database identifier types have additional constraints. Maximum lengths were initially derived from the MySQL manual. While some of these restrictions are not mandatory, following them to the letter will help ensure database portability.
| case: | lower |
|---|
| maxlength: | 64 characters |
|---|
| example: | mifos |
|---|
| case: | lower (mandatory) |
|---|
| maxlength: | 64 characters |
|---|
| example: | customer_transactions |
|---|
| case: | lower |
|---|
| maxlength: | 64 characters |
|---|
| example: | transaction_date |
|---|
| case: | lower |
|---|
| maxlength: | 64 characters |
|---|
| example: | cust_hierarchy_idx |
|---|
| case: | lower |
|---|
| maxlength: | 64 characters |
|---|
| example: | customer_loan_view |
|---|
| case: | lower |
|---|
| maxlength: | 255 characters |
|---|
| example: | |
|---|
