Collection reference

コレクション参照により、データベース内のドキュメント (NoSQL) のコレクションまたはテーブル (SQL) にアクセスできます。

Collection basics

コレクション参照の作成は簡単です。単に squid オブジェクトの collection メソッドを呼び出し、最初のパラメータとしてコレクション名を指定するだけです。

コレクション参照は、データベース内の特定のコレクションへのポインタとして機能します。これにより、そのコレクションに保存されているデータへのアクセスや操作が可能になります。以下のコードスニペットは、Squid の組み込みデータベース内の users コレクションへの参照を取得する方法を示しています:

Client code

const collectionRef = squid.collection<User>('users');

データベースコネクタ内の users コレクションへの参照を取得するには、2 番目のパラメータとして Connector ID を渡します。この ID は Squid Console の connectors section で確認できます:

Client code

const collectionRef = squid.collection<User>('users', 'YOUR_CONNECTOR_ID');

もう一つのコレクション属性は参照 ID です。この ID はコレクション参照を一意に識別する文字列です。refId にアクセスするには、単に以下を使用します:

Client code

collectionRef.refId;

コレクションへの参照が得られたら、そのコレクションに対して、querying や manipulating といったデータ操作、または特定の document の取得など、さまざまな操作を行うことができます。

Next steps

Squid のコレクションは、異なるデータベースに保存されたデータと統一的にやり取りする方法を提供します。Squid の組み込みデータベースを利用している場合でも、外部リソースに接続している場合でも、コレクション参照はデータ管理を効率化します。

コレクションからのデータの追加や削除はコレクションレベルでは行えず、必ずドキュメントレベルで行う必要があります。詳細については、document references のページをご覧ください。