侍エンジニア塾
Home » database » ネーミングルール(命名規約)

ネーミングルール(命名規約)

ネーミングルール(命名規約)はどうして必要か

データベースを設計する上で、テーブル名(表名)やカラム名(項目名)を決定するのは設計者に取って結構面倒です。名前なら何でも良いということはなく、規則性を持ち、意味を簡潔に伝え、かつ解りやすく、重複なく、・・・と考えると名前を決めるのも厄介です。生まれた子供の名前を付けるならいざ知らず、大規模システムとなると何百、何千という数のカラムが存在します。その後の開発工程にも影響しますので何かしらのルール(規約)が必要になります

 

ネーミングルール(命名規約)とは何か

その名の通り、テーブル名やカラム名に名前を付けるためのルール(規約)です。そしてネーミングルール(命名規約)も仕様書の一部です。もしなければ仕様書の一部ですので、テーブル設計時には作成します。小規模システムの場合は、省略する場合がありますが、できれば作成するほうが良いでしょう。

 

ネーミングルール(命名規約)を作成するには

構築するシステムの規模や特性にもよりますが、一般的に、会社単位、プロジェクト単位、システム単位などでネーミングルール(命名規約)を作成します。ネーミングルール(命名規約)の対象とするシステムの共通ルール、テーブルのネーミングルール、カラム(項目)のネーミングルール等で構成されます。これ以外にプログラムのネーミングルールも存在します

 

ネーミングルール(命名規約)の例

 

1.共通ルール

・名前は大文字、区切りには”_”(アンダーバー)を用い、あまりに長い名前にしない
・全て名詞にし、出来る限り1~3単語の組み合わせにする

 

2.オブジェクト(テーブル名など)のネーミングルール(命名規約)

・マスタ(リソース系)は、XXXXX_MST
・トランザクション(イベント系)は、XXXXX_TRN
・インデックス(索引)は、XXXXX_IDX
・ビューは、XXXXX_VIEW
・シーケンスは、XXXXX_SEQ

 

3.項目名(カラム名)のネーミングルール(命名規約)

・番号は、XXXXX_NO
・IDは、XXXXX_ID
・コードは、XXXXX_CD
・日付は、XXXXX_DT
・フラグは、XXXXX_FLG
・区分は、XXXXX_KBN

rentry(PS4レンタル) rentry(スイッチレンタル) rentry rentry(VRレンタル)