spacetimedb-tables

モジュールのスキーマとテーブルのパフォーマンスには、このスキルを使用してください。

テーブルの基本パターン

TypeScript のテーブルでは table(options, columns) を使用し、オブジェクトとして schema() に渡す必要があります。

import { schema, table, t } from "spacetimedb/server";

const player = table(
  { name: "player", public: true },
  {
    id: t.u64().primaryKey().autoInc(),
    identity: t.identity().unique(),
    name: t.string().index("btree"),
  },
);

export default schema({ player });

言語ごとのテーブル宣言：

• TypeScript：{ name: "player_score" } により ctx.db.playerScore が作成されます。
• C#：[SpacetimeDB.Table(Accessor = "Player", Public = true)] により ctx.Db.Player が作成されます。型は partial である必要があります。
• Rust：#[spacetimedb::table(accessor = player, public)] により ctx.db.player() が作成されます。pub struct を指定しても、テーブルは公開されません。
• C++：SPACETIMEDB_TABLE(Type, player, Public) により ctx.db[player] が作成されます。

設計ルール

• データはアクセス／更新のパターンに応じて整理してください。頻繁に更新されるホットな状態は、変更頻度の低いプロフィール、設定、統計のフィールドから分離してください。
• 公開テーブルはサブスクリプションを通じてクライアントから参照できます。サーバー専用の状態は非公開にし、必要に応じてビューを通じて派生した一部のデータを公開してください。
• 主キーと一意制約は自動的にインデックスを作成します。それらに重複するインデックスを追加しないでください。
• 頻繁に使われる等価検索、範囲検索、サブスクリプション、結合の経路に限ってインデックスを追加してください。デフォルトでは B-tree を使用してください。ダイレクトインデックスは密な符号なし整数キー向けであり、すべての言語でサポートされているわけではありません。
• 既存の公開済みテーブルに列を追加する場合は、デフォルト値を設定し、末尾に追加する必要があります。既存のスキーマを変更する前に、データベースのマイグレーションルールを確認してください。
• 自動インクリメント値はデータベースによって生成され、トランザクションの失敗後に欠番が生じることがあります。
• 追記専用のクライアント通知にはイベントテーブルを使用してください。イベントフラグは公開後に変更できません。
• スケジュールテーブルには ScheduleAt 列と、リンクされたスケジュール済みリデューサーが必要です。TypeScript では、ScheduleAt を spacetimedb/server ではなく spacetimedb からインポートしてください。

リファレンス一覧

必要な情報	開く
テーブル定義と基本パターン	references/tables.md
アクセス制御	references/tables-access-permissions.md
ID とデフォルト値	references/tables-auto-increment.md, references/tables-default-values.md
型と制約	references/tables-column-types.md, references/tables-constraints.md
インデックス設計	references/tables-indexes.md
イベントテーブルとスケジュールテーブル	references/tables-event-tables.md, references/tables-schedule-tables.md
ストレージとパフォーマンス	references/tables-file-storage.md, references/tables-performance.md

ガイダンス

• 既存のスキーマを変更する前に、spacetimedb-databases でマイグレーションへの影響を確認してください。
• 頻繁に実行されるリデューサーの処理経路や、大きなテーブルに触れる処理経路では、インデックスを使った検索を優先してください。
• 特に、リデューサーの結果コールバックパターンを置き換える場合は、追記専用のクライアント通知にイベントテーブルを使用してください。