spacetimedb-clients

言語間で共通する SDK の概念には、このスキルを使用してください。

クライアントの基本的な流れ

1. 古いチェックイン済みのサンプルではなく、現在のモジュールからバインディングを生成します。
2. ホスト URI、データベース名または ID、任意の認証トークン、および接続コールバックを指定して、DbConnection を構築します。
3. SDK に応じて、接続を開始するか、ティックします。SDK によっては、接続を進めるまでコールバックが処理されません。
4. コールバックを利用する前に、行、リデューサー、サブスクリプションのコールバックを登録します。
5. テーブルまたはクエリをサブスクライブします。サブスクリプションが適用されると、サブスクライブされた行がローカルキャッシュに表示されます。
6. 生成されたテーブルハンドルを通じて、ローカルキャッシュからデータを読み取ります。
7. 生成されたリデューサーハンドルを通じてリデューサーを呼び出し、SDK 固有のイベントまたはイベントテーブルでリデューサーの結果を確認します。

SDK 間で共通するルール

• サブスクリプションハンドルが管理するのはライフサイクルであり、行データではありません。行は接続のローカルキャッシュに保存されます。
• subscribeToAllTables は便利ですが、キャンセルや最適化が困難です。本番クライアントでは、対象を絞った型付きクエリを使用してください。
• キャッシュを読み取る前にサブスクライブしてください。キャッシュが空でも、通常はデータベースに行がないのではなく、サブスクリプションが適用されていないことを意味します。
• サブスクリプション解除は非同期です。サーバーが解除を確認するまで、行が残る場合があります。
• 通常のクライアント向けには、公開テーブルと公開リデューサー／プロシージャが生成されます。--include-private は、信頼できるツールでのみ使用してください。
• 生成される名前はモジュールスキーマに従います。ローカルにバインディングがある場合は、アクセサーを推測しないでください。
• テーブルを結合するサブスクリプションでは、結合列にインデックスが必要です。重複するサブスクリプションは作業を重複させ、キャッシュの挙動に関する想定を複雑にすることがあります。

リファレンス一覧

必要な情報	参照先
SDK の概要と言語の選択	references/clients.md
API の一般的な概念	references/clients-api.md
コード生成	references/clients-codegen.md
接続のライフサイクル	references/clients-connection.md
サブスクリプションとその仕様	references/clients-subscriptions.md, references/clients-subscriptions-semantics.md

ガイダンス

• SDK のコードを具体的に記述する場合は、言語固有のクライアントスキルを読み込んでください。
• 選択した SDK のリファレンスに別の指示がない限り、ローカルキャッシュを読み取る前にサブスクライブしてください。
• リデューサーの呼び出し方は、生成されたバインディング名と SpacetimeDB のバージョンに合わせてください。