オブジェクトの命名規則

このドキュメントでは、データベース、テーブル、インデックス、ユーザーなどのデータベース オブジェクトに名前を付けるルールを紹介します。

一般的なルール

  • 意味のある英単語をアンダースコアで区切って使用することをお勧めします。
  • 名前には文字、数字、アンダースコアのみを使用してください。
  • grouporderなどの TiDB 予約語を列名として使用しないでください。
  • すべてのデータベース オブジェクトには小文字を使用することをお勧めします。

データベースの命名規則

データベース名をビジネス、製品、またはその他の指標によって区別し、データベース名には 20 文字以内を使用することをお勧めします。たとえば、一時ライブラリにtmp_crm 、テスト ライブラリにtest_crmという名前を付けることができます。

テーブルの命名規則

  • 同じビジネスまたはモジュールのテーブルには同じプレフィックスを使用し、テーブル名ができる限りわかりやすいものになるようにしてください。
  • 名前内の単語はアンダースコアで区切ります。テーブル名には 32 文字以内を使用することをお勧めします。
  • 理解を深めるために、表の目的に注釈を付けることをお勧めします。例えば:
    • 一時テーブル: tmp_t_crm_relation_0425
    • バックアップテーブル: bak_t_crm_relation_20170425
    • 業務一時表: tmp_st_{business code}_{creator abbreviation}_{date}
    • 勘定科目表の期間を記録します: t_crm_ec_record_YYYY{MM}{dd}
  • さまざまなビジネス モジュールのテーブルに個別のデータベースを作成し、それに応じて注釈を追加します。

カラムの命名規則

  • 列の名前は、列の実際の意味または略称です。
  • 同じ意味を持つテーブル間では同じ列名を使用することをお勧めします。
  • 列に注釈を追加し、列挙型に「0: オフライン、1: オンライン」などの名前付き値を指定することをお勧めします。
  • ブール列の名前はis_{description}にすることをお勧めします。たとえば、メンバーが有効かどうかを示すmemberテーブルの列には、 is_enabledという名前を付けることができます。
  • 列に 30 文字を超える名前を付けることはお勧めできません。また、列の数は 60 未満にする必要があります。
  • orderfromdescなどの TiDB 予約語を列名として使用しないでください。キーワードが予約されているかどうかを確認するには、 TiDB キーワード参照してください。

インデックスの命名規則

  • 主キーインデックス: pk_{table_name_abbreviation}_{field_name_abbreviation}
  • 一意のインデックス: uk_{table_name_abbreviation}_{field_name_abbreviation}
  • 共通インデックス: idx_{table_name_abbreviation}_{field_name_abbreviation}
  • 複数の単語を含むカラム名: 意味のある略語を使用してください

このページは役に立ちましたか?