.. include:: custom_tools.txt

.. _database fields:

***************
Database Fields
***************

There are some special considerations for naming field names that help the reader to
understand what they are dealing with.  Besides 'r' scope and standard type prefixes
as covered :ref:`earlier <scope prefixes>`, there are some special field
characteristics that are only applicable to database fields that should come into
play to be ultra clear:

a.  Primary Key fields should have names with a "PK" suffix.
b.  Foreign Key fields should have names with "FK" suffix if they are indexed as a
    single field.  If they are indexed as a concatenation of multiple fields, then
    the field names would be suffixed by suffixed by "FK1of3", "FK2of3" and "FK3of3"
    in the sequence that they take part in the index.