データ項目のネーミングルール

この記事を書いたチーム:frontier

対象&目的

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90%、年休124日以上 etc.  詳細はこちらから>

プロジェクトと関わるデータベースのテーブル設計時、以下のネーミングルールを導入されることが多いです。これよりもっと細かいルールもあります。ここは以下のものを対象として基本的なルールを明記する。

・データベース
・テーブル
・カラム
・エイリアス

 

通用

  • テーブル名、カラム名ともに大文字を利用しない。

 

名前

OK/NG

DOCUMENTS

×

Documents

×

documents

 

  • テーブル名、カラム名ともにスネークケースを利用する。

 

  名前

OK/NG

tableName

×

TableName

×

tablename

×

table_name

 

  • 基本的にはローマ字ではなく、英語で。
  • 略名は利用しない

 

名前

OK/NG

start_dt

×

maker_cd

×

start_date

maker_code

 

データベース名

  • 先頭大文字.あとは区切りを大文字(/\.を除く)。最大長(バイト)=64

例:OkrTaskDB

 

テーブル名

  • 小文字英数字とアンダースコアだけ使う。大文字は避ける。(/\.を除く)。最大長(バイト)=64

例:m_division

 

  • 一般的な英単語、ローマ字(ヘボン式)でつける。多少長くなってもいい。

例:t_photo  英単語

  t_shashin ローマ字(ヘボン式)

 

  • 頭に種別表記を付ける(m_t_c_など)

例:m_user_info  ユーザマスタ

  t_hachu_list  発注一覧テーブル

  c_kubun    共通区分テーブル

 

カラム名

  • 小文字英数字とアンダースコアだけ使う。大文字は避ける。(/\.を除く)。最大長(バイト)=64

例:user_id

 

  • 一般的な英単語、ローマ字(ヘボン式)でつける。多少長くなってもいい。

例: photo_id  英単語

   shashin_id ローマ字(ヘボン式)

 

  • flg/kbnなどの略名は利用しない

 

名前

OK/NG

delete_flg

×

is_deleted

※この場合、delete_flgの意味は分かりにくいです。

 

エイリアス(別名)の使用

  • 小文字英数字とアンダースコアだけ使う。大文字は避ける。最大長(バイト)=255

例:SELECT Age, COUNT(Age) AS cnt FROM tbl_Customer GROUP BY Age HAVING cnt > 0;

  SELECt COUNT(userID) AS user_max FROM tbl_Customer;

 

 

【エンジニア募集中】フルリモートも◎(リモート率85.7%)、平均残業8時間、年休124日以上、有給取得率90% etc. 詳細はこちらから>

Smallitのサービス