OrientDB - рекомендации именования полей

Именование полей должно подчиняться следующим правилам:

1. «Имя» — отражает содержимое поля. Обязано быть простым, должно начинаться с маленькой буквы и может быть в множественном числе.

2. Поля типа «tinyint», принимающие значения 1 или 0 формируются так: префикс «flag» + «Имя». Должно отражать содержимое поля, при состоянии флага равному 1.

Перечень зарезервированных имен (имена, которые нельзя использовать):

Любой класс всегда имеет:

  • rid — PK (Primary key) уникальный номер строки (автоинкрементное поле)
  • class — имя класса, к которому относится данное поле

Перечень имен полей для обязательного использования:

  • parentRid — rid родительского объекта (при условии, что в б.д. не будет класса с именем parent);
  • name — краткое наименование (название);
  • position — позиция (например для сортировки)
  • flagConfirm — флаг, например утверждения на должность (1 = утвержден, 0 = не утвержден);
  • type — тип объекта, например: человек, робот и т.д.;
  • flagType — тип объекта в виде флага, например: 0 = человек, 1 = робот (обязательно писать пояснение в комментарии к полю);
  • flagGender - пол человека (0 - жен. 1 - муж.);
  • comment — комментарий;
  • info — информация о объекте;
  • quantity — количество чего-либо;
  • amount — сумма например на счету (т.к. sum является зарезервированным именем);

Перечень имен при совпадении назначения (примеры):

  • name — краткое наименование (название);
  • surname — сокращенное наименование (псевдоним);
  • fullName — полное наименование;
  • dateStart — дата начала;
  • dateSet — дата утверждения;
  • dateEnd — дата конца;
  • flagShow — флаг отображения (1 = отображать, 0 = не отображать);
  • flagShowSite — флаг отображения на сайте (1 = отображать, 0 = не отображать);
  • flagShowIntranet — флаг отображения на внутреннем сайте (1 = отображать, 0 = не отображать);

И помните, это лишь мои рекомендации, которые я готов обсудить.


17.03.2014 11:29