spacetimedb-databases

データベースのモジュールのライフサイクルやマイグレーション作業には、このスキルを使用してください。

基本パターン

• モジュールはコードとスキーマであり、データベースは名前または識別子で特定される公開済みのインスタンスです。
• spacetime publish <DATABASE_NAME> はモジュールをビルドしてアップロードし、init が存在する場合は実行して、モジュールのサービスを開始します。
• 既存のデータベースに公開すると、自動マイグレーションが試行され、アクティブなクライアント接続を維持しながらモジュールがアトミックにホットスワップされます。
• 公開スキーマ、リデューサー、プロシージャ、ビューのインターフェイスを変更した後は、クライアントバインディングを再生成して配布してください。
• リデューサーは自動トランザクション内で実行されます。プロシージャでは、データベースへの書き込みが必要な場合に手動でトランザクションを開始します。

マイグレーションのチェックリスト

• 安全：テーブルの追加、インデックスの追加、自動インクリメントのアノテーションの追加または削除、プライベートテーブルの公開、リデューサーの追加、一意制約の削除。
• 破壊的変更となる可能性があるもの：末尾にデフォルト値付きのカラムを追加する、リデューサーの変更または削除、公開テーブルの非公開化、主キーの削除、サブスクリプションで使用されているインデックスの削除。
• 自動マイグレーションでは禁止：テーブルの削除、既存カラムの削除・名前変更・順序変更・変更、デフォルト値のないカラムの追加、途中へのカラムの追加、スケジュールテーブルの状態変更、一意制約または主キー制約の追加。
• 開発中は、--delete-data を使ってデータをリセットできます。恒久的なデータ損失を意図している場合を除き、本番環境では使用しないでください。
• 本番環境で禁止されている変更を行う場合は、追加型のマイグレーション戦略を使用してください。新しい構造を追加し、二重書き込みとバックフィルを行ってクライアントを移行した後、古い構造を廃止します。

リファレンスマップ

必要な情報	開く
概要と学習パス	references/databases.md
ローカル開発	references/databases-developing.md
ビルドと公開	references/databases-building-publishing.md
マイグレーションのルール	references/databases-automatic-migrations.md、references/databases-incremental-migrations.md
トランザクションの動作	references/databases-transactions-atomicity.md
構文の詳細な例	references/databases-cheat-sheet.md

ガイダンス

• テーブル構造、名前、インデックス、制約、公開・非公開の可視性を変更する前に、マイグレーションの安全性を確認してください。
• スキーマ定義については、spacetimedb-tables を読み込んでください。
• リデューサーのトランザクション動作については、spacetimedb-reducers を読み込んでください。