スキップしてメイン コンテンツに移動

Firestoreでコレクションの要素数をカウントする方法

Firestoreで子要素の数をカウントする方法を紹介します。SQL文で言うところの、COUNT()文でレコード件数を取得する方法の、Firestoreでのやり方です。

簡単な件数の取得方法から、件数が膨大になるコレクションの効率的なカウント方法についても紹介していきます。

100件程度の小さいコレクションのカウント方法

コレクションの数が100件程度の場合は、クライアントサイドでカウントするのが楽です。以下のサンプルコードは、usersコレクションを取得しsizeプロパティで要素の数を取得しています。

db.collection('users').get().then(snap => {
   size = snap.size // will return the collection size
});

usersコレクションの全データをクライアント側でダウンロードし、要素数をカウントしていますが、100程度のコレクションであれば、対して問題ではないでしょう。

1000件ほどの少し量が多いコレクションのカウント方法

コレクションの数が1000件程度の場合、件数をカウントする為だけに、クライアントサイドに全データをダウンロードするのは時間がかかるため、Cloud Functionでコレクションの数をカウントするサーバー側のHTTP関数を用意し、クライアント側でそれを呼び出すようにします。

Cloud Function側の関数

const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp();
const db = admin.firestore()

exports.someMethod = functions.https.onRequest((req, res) => {
  db.collection("users").get().then(snap => {
      res.status(200).send({length: snap.size});
  });
});

クライアント側の処理

yourHttpClient.post(https://xxx.cloudfunctions.net/someMethod).toPromise().then(snap => {
  size = snap.length
})

データ数が多いコレクションのカウント方法

件数が1万を超えるような件数が多いコレクションの場合、上で紹介したCloud FunctionのHTTP関数でデータの件数を数える方法でも、全データをロードしてから件数を数えるため、処理に時間がかかってしまいます。

このような件数が多いコレクションの場合、データが登録されるタイミングで件数をカウントする方法が効率がよいと言われています。

次のサンプルコードは、 Cloud Function でusersコレクションに対する変更を監視するトリガ関数を作成し、その中で、別で用意しておいたカウント値を保存する要素(sharedコレクションのcountドキュメト)に対し、登録時はインクリメントした値、削除時はデクリメントした値を設定しています。

const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp();
const db = admin.firestore()

exports.incrementUser = functions.firestore
      .document('users/{userId}')
      .onWrite((change, context) => {

  const FieldValue = admin.firestore.FieldValue;
    
  if (!change.before.exists) {
    // 登録時に件数をインクリメント
    return db.doc("shared/count").update({user: FieldValue.increment(1)});
  } else if (change.before.exists && !change.after.exists) {
    // 削除時に件数をデクリメント
    return db.doc("shared/count").update({user: FieldValue.increment(-1)});
  }
});

まとめ

Firestoreでコレクションの要素数をカウントする方法を紹介してきました。コレクションの件数が今後増えていくことが予想される場合は、最後に紹介した方法でコレクションの数をカウントすることをオススメします。

RDBだったらCOUNT()と書けば簡単にカウントが取れるところが、Firestoreの場合は割と工夫する必要があります。といってもRDBでも件数が膨大になるとCOUNT()が遅くなる為、結局は工夫が必要ですが…

これとは別に、Firebase Realtime Databaseで要素数をカウントする方法は、以下の記事で紹介しています。
Firebase Databaseで要素の数をカウントする方法

コメント

  1. こちらのページの3つ目のやり方(データ数が多いコレクションのカウント方法)を参考にしながら、コレクションの要素数をカウントすることに成功しました!!ありがとうございます!

    しかし、これだと今までのデータ数がカウントされません。
    例えば、users/{userId}/events/以下のコレクションに、すでに50件のドキュメントがあったとします。
    新たにevent(/events以下に生成される{eventId})が追加されても、カウントは「51」では無く、「1」となります。
    元のデータも含めてカウントを開始するには、どうすればよいでしょうか?

    返信削除

コメントを投稿

このブログの人気の投稿

axiosの使い方まとめ (GET/POST/例外処理)

axiosの使い方まとめ (GET/POST/例外処理)最近何かとよく使うJavaScriptでAJAX通信を行うaxiosについて、簡単に使い方をまとめました。GETリクエストをaxiosで送るまずはGETリクエストをaxiosで送る方法です。const res =await axios.get('/users') console.log(res.data)分割代入の記法を使うと、以下のようにも書けますconst{data}=await axios.get('/users') console.log(data)クエリパラメータ (URLパラメータ)を指定クエリパラメータを指定する方法は2つあります。1つ目は、axios.getに指定するURLに直接記述する方法です。axios.get('/user?id=123')2つめは、axios.getの第2引数に、オプション指定する方法です。axios.get('/user',{ params:{ id:123}})POSTリクエストをaxiosで送る次はPOSTリクエストをaxiosで送る方法です。JSON形式でPOSTするJSON形式でPOSTする場合は、axios.postの第2引数に、送信するデータをJavaScriptオブジェクトで指定します。const res =await axios.post('/user',{ id:123, name:'Yamada Tarou'})application/x-www-form-urlencoded形式でPOSTするapplication/x-www-form-urlencoded形式でPOSTする場合は、URLSearchParamsを使います。var params =newURLSearchParams() params.append('id',123) params.append('name','Yamada Tarou')const res =await axios.post('/user', params)スポンサーリンク axios でファイルをアップロードする画像などのファイルを、…

[VB, C#] Windows 8, Window 10 で ImeModeが制御できない問題を解決する

[VB, C#] Windows 8, Window 10 で ImeModeが制御できない問題を解決するタイトルの通りですが、Windows 8 以降では Windows Form アプリケーションで、コントロールの ImeMode に Katakana や KatakanaHalf を設定しても、カタカナになってくれません。なぜ ImeMode が効かないのか?Windows 8 以降、IME Mode の切り替えは、ユーザー単位で切り替わるようになった為、アプリから IME Mode 制御が出来ないようになりました。
(IME をON にした場合、常に ひらがな モードになます)※ Windows 7までは、IME Modeの切り替えはアプリ単位で行われていた為、問題なくアプリから IME制御が行えました。スポンサーリンク 対処方法Windows 8 以降、IMEの制御は、InputScope クラスの利用が推奨されています。
しかし、InputScope クラスは、WPF、Windows ストアアプリでしか使えない為、Windows Formアプリでは使用できません。
(Windows Form はもう使うな!という事でしょうか (涙) )結論としては、コントールパネルの設定で、IMEの制御をユーザ単位から アプリ単位に変更する事ができます。
これで、Windows Formアプリでも 従来通りIMEの制御を行う事が出来ます。おわりにこの方法だと、アプリをインストールする端末すべてに設定が必要となり、とっても面倒です。。。
しかし、今の所これしか方法がない状態です。
これからは Windows Formではなく、WPFや Windows ストアアプリで作れという事ですかね (^^;)

MailKitの使い方! エンコーディング指定や添付ファイをメールで送信する方法[C#/VB Tips]

MailKitの使い方! エンコーディング指定や添付ファイをメールで送信する方法[C#/VB Tips]MailKitを使ってメールを送るサンプルコードです。(C#)UTF8/iso-2022-jpのエンコーディング指定、GMail/YahooのSMTPサーバで送るなど、4つのサンプルコードでMailKitの使い方を紹介します。MailKitって何?2017年に.NET標準のSystem.Net.Mail.SmtpClientが廃止予定となり、Microsoftより今後はオープンソースライブラリである、MailKitに置き換えるとアナウンスがありました。既にSmtpClientは非推奨になっており、今後は廃止されていきます。現在、SmtpClientを使用したソースコードには、Visual StudioからMailKitを使うよう警告が出るようになっています。さっそく、MailKitを使ってメールを送信するサンプルコードを作っていきます。UTF8でメールを送信文字エンコーディングを、UTF8でメールを送信するサンプルコードです。
MailKitは、デフォルトの文字エンコーディングがUTF8なっている為、シンプルなコードでメールを送信する事ができます。var host ="<smtp server name>"; var port =25;// or 587using(var smtp =new MailKit.Net.Smtp.SmtpClient()){//SMTPサーバに接続する smtp.Connect(host, port, MailKit.Security.SecureSocketOptions.Auto);//認証が必要な場合は、以下のコメントを解除//smtp.Authenticate("<id>", "<password>");//送信するメールを作成する var mail =new MimeKit.MimeMessage(); var builder =new MimeKit.BodyBuilder(); mail.From.Add(new MimeKit.MailboxAddress("",&quo…