技術記事

micomia株式会社の井上です。今回はQuery Collectionについて解説していきます。

初心者にも分かりやすく解説していくのでぜひご一読ください。

1. Query Collectionとは？

そもそも、Query CollectionとはBackend Queryの一種で、FireStoreのコレクションからデータを取得するための仕組みです。

これだけでは少し難しいかもしれないのでそんな人向けに、Query Collectionという言葉がそもそもどういう意味なのかが分かるとかなり分かりやすくなると思います。

まず、それぞれの単語の本来の意味は、

Query=質問・要求

Collection=(そのままの)コレクション

です。

これを実装環境向けに少し言い方を変えてみると、Queryとは「データベースに対する質問・要求」と言えます。具体的にどんな質問、要求かというと、

「○○のデータを取得して」

「最新10件だけ取ってきて」

などです。

つまり、 Query Collection = コレクションに対して質問してデータを取り出す行為となります。

2. Query Collectionの実装

今回はこのような自分が作成した投稿を投稿履歴画面に一覧表示していきます。

一覧表示なので、まずはListViewを追加して先ほどのPostコンポーネントをListViewの中に追加します。

このままでは、投稿が1つしか表示されていません。今回は投稿履歴＝複数の投稿を表示させたいのでここでQuery Collectionを使用します。

Add QueryからQuery Collectionを選択します。

すると、どのコレクションを一覧表示させるのかの選択肢が表示されます。

今回は投稿履歴を表示させる、つまりpostコレクションを表示させたいのでpostを選択します。

※データベースにコレクションを作成していない方はこの時点で何も表示されないので先にコレクションを作成してから実装を進めてください。

次に、Query Typeを選択できます。

この3つのそれぞれの目的は以下です。

List of Documents=複数ドキュメントを取得

Single Document=1つのドキュメントを取得

Count=件数だけを取得

今回は複数のドキュメントを取得したいのでList of Documentを使用します。

その下に、Limitを入力する欄があります。30と入力すると最大30個まで投稿が表示されるイメージです。

その下にあるのが、FiltersとOrderingです。

Filtersは表示させる投稿に制限をかけるものです。なので、以下のようなFilterをかけます。

これは、その投稿の作成者(created_by)がログインしているユーザー(Authenticated User)と一致するときにその投稿を表示させると言うフィルターです。

次に、Orderingです。

OrderはIncreasingとDecreasingがありますが、Increasingは古いもの順、Decreasingは新しいもの順と覚えておくと便利です。

これで、投稿履歴が一覧表示できるようになりました。

3. 最後に

今回はQuery Collectionについて解説しました。Query Collectionは投稿履歴だけではなく、投稿一覧やユーザー一覧など多くのアプリで使用する機能で必要になってくるのでぜひ今回の内容を活用してください。

本記事の内容を動画で見たい方は以下をご覧ください。

動画でもっと知りたい方はこちら