メインコンテンツまでスキップ

コレクション参照

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

コレクションの基本

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

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

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

database connector 内の 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;

コレクションへの参照を取得したら、クエリデータの操作 といった各種操作を行ったり、そのコレクション内の特定の ドキュメント を取得したりできます。

次のステップ

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

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