重要
このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

オブジェクト命名規則

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

一般的なルール

  • アンダースコアで区切った意味のある英語の単語を使用することをお勧めします。
  • 名前には、文字、数字、およびアンダースコアのみを使用してください。
  • 列名として、 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未満にする必要があります。
  • orderなどのfrom予約語を列descとして使用することは避けてください。キーワードが予約されているかどうかを確認するには、 TiDBキーワードを参照してください。

インデックスの命名規則

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