スキーマリント
これは誰に向けたものですか
設計段階で、命名規則への準拠、不適切なタイプの選択、その他の潜在的な問題を発見したいユーザー向け。
これで解決すること
「チームの基準を満たしているか」を手動チェックから自動チェックに変えることができ、レビューフェーズでの手戻りを軽減できます。
前提条件
- 現在のテーブルには少なくとも 1 つのフィールドまたは 1 つのインデックスがあります。
- 基本的なチーム命名規則はすでに理解されています (組み込みルールが一般的なシナリオをカバーしています)。
ステップ
- テーブル構成領域で
Schema LintまたはLintをクリックします。結果: lint パネルが開き、検出されたすべての問題がリストされます。 - 各問題の説明、リスク レベル (情報/警告/エラー)、および提案される修正を確認します。結果: 非準拠アイテムをすぐに見つけることができます。
- 優先度の高い項目 (エラー レベル) については、フィールドまたはインデックスの設定に戻って変更します。結果: 変更後、lint を再クリックすると、問題リストが更新されます。
- 受け入れられる優先度の低い項目については、無視するか、承認済みとしてマークするかを選択します。結果: lint パネルには、後で確認できるように履歴が保持されます。
組み込みチェックルール (例)
- 命名規則: フィールド名に小文字 + アンダースコア (snake_case) を使用するかどうか。インデックス名にテーブル名のプレフィックスが含まれるかどうか。外部キー名が標準化されているかどうか。
- 型ルール: 大きなテキストフィールドが適切な型を使用するかどうか。通貨フィールドが
FLOAT/DOUBLEを回避するかどうか。自動インクリメントフィールドタイプがターゲットデータベースの規則と一致するかどうか。 - 冗長性検出: 重複したインデックスが存在するかどうか。フィールドのない空のインデックスが存在するかどうか。
- リスク アラート: フィールド タイプを変更するときのデータ互換性リスク (フィールド レベルのリスク プロンプトとリンク)。
いつ完了するか
- lint パネルにエラーレベルの問題はありません。
- 警告および情報レベルの問題が確認または修正されました。
- 生成された DDL はチームの標準レビューに合格しました。
よくある落とし穴
- スキーマ lint は組み込みルールに基づいており、特別なチーム規約をすべてカバーしているわけではない可能性があります。重要なプロジェクトには手動レビューが推奨されます。
- 一部のルールには、データベースの種類ごとに異なる判断基準があります (例: Oracle の
NUMBERと MySQL のDECIMAL)。データベースを切り替えた後に再確認してください。 - 無視された問題は自動的には消えません。無視された項目を定期的に確認することをお勧めします。