コンテンツにスキップ

スキーマ生成

設定ファイル

mysqlToZod.config.js ファイルを使用して、データソースとスキーマ出力のフォーマットを定義します。

元の mysqlToZod.config.js をバックアップとしてコピーしてください。

ドキュメントの オプション ページを確認し、データベースと出力要件に合わせて .config.js ファイルを設定します。

生成の実行

package.json のスクリプトを使用してプロジェクトを実行します。

エラーがなければ、設定ファイルで指定された outputDir と fileName(s) に新しいスキーマファイルが生成されるはずです。

確認、修正、繰り返し

スキーマ .ts ファイルを確認し、望ましいデータが含まれており、適切なフォーマットであることを確認します。

  • 必要なテーブルはすべて含まれていますか?
  • スキーマにテーブルとフィールドのコメントは欲しいですか?
  • “nullish” と “nullable” の使用は許容できますか?
  • スキーマの定数とタイプの名前は正しいですか?
  • アプリケーションのためのケースは正しいですか?
  • テーブル/スキーマ名やフィールド名を変更するために、さらに置換設定が必要ですか?

必要に応じて設定ファイルを変更し、生成プロセスを再実行してください。

データベース内のスキーマにコメントが不足している場合や、データベーススキーマ自体のタイプや制約の詳細に小さな変更が必要な場合があるでしょう。これがこの作業の利点の一つです。必要に応じてデータベースを変更し、生成プロセスを再実行してください。

再現性

生成プロセスが完了し、利用可能なコードが得られたら、mysqlToZod.config.js ファイルを保存し、それをドキュメント化(任意の方法で)して、全く同じプロセスを再現できるようにします。コードを修正するために再度戻ってきたり、データベースの変更に基づいてスキーマを更新したり、特定のアプリケーションのためにすべてのスキーマの詳細を一括変更する必要があるのは一般的です。