【保存版】Firestoreコレクションのドキュメント数取得：countクエリ、ループ処理、その他

2024-07-03

Cloud Firestore でコレクション内のドキュメント数を取得する方法

count() 集計クエリを使用する

概要:

これは、コレクション内のドキュメント数を取得する最も一般的な方法です。 count() 関数は、コレクション内のドキュメントをカウントし、その数を単一のフィールドとして返します。

利点:

シンプルでわかりやすい
読み取り操作に最適化されている
フィールドの値に基づいてドキュメントをフィルタリングするなど、クエリをさらに制限することができます。

例:

// コレクション 'users' のドキュメント数を取得
const usersRef = firebase.firestore().collection('users');
usersRef.get().then((querySnapshot) => {
  const count = querySnapshot.size;
  console.log(`users コレクション内のドキュメント数: ${count}`);
});

コレクション内のすべてのドキュメントをループする

この方法は、コレクション内のすべてのドキュメントをループ処理し、その数をカウントすることで、ドキュメント数を取得します。

ドキュメント自体にアクセスできる
各ドキュメントに対して処理を実行できる

count() 集計クエリよりも非効率的な場合がある
大規模なコレクションの場合、パフォーマンスが低下する可能性がある

// コレクション 'messages' 内のドキュメント数を取得
let count = 0;
const messagesRef = firebase.firestore().collection('messages');
messagesRef.get().then((querySnapshot) => {
  querySnapshot.forEach((doc) => {
    count++;
  });
  console.log(`messages コレクション内のドキュメント数: ${count}`);
});

補足:

上記の例は、JavaScript で記述されていますが、他の言語でも同様の方法でドキュメント数を取得できます。
コレクション内のドキュメント数をリアルタイムで取得したい場合は、onSnapshot() リスナーを使用する必要があります。

Cloud Firestore でコレクション内のドキュメント数を取得する - サンプルコード

以下に、count() 集計クエリ と コレクション内のすべてのドキュメントをループする の 2 つの方法のサンプルコードを示します。

count() 集計クエリを使用する

// コレクション 'users' のドキュメント数を取得
const usersRef = firebase.firestore().collection('users');
usersRef.get().then((querySnapshot) => {
  const count = querySnapshot.size;
  console.log(`users コレクション内のドキュメント数: ${count}`);
});

解説:

usersRef 変数に、users コレクションへの参照を格納します。
get() メソッドを使用して、コレクション内のすべてのドキュメントを取得します。
querySnapshot には、取得されたドキュメントのスナップショットが格納されます。
size プロパティを使用して、スナップショット内のドキュメント数を取得します。
コンソールに、コレクション内のドキュメント数が表示されます。

コレクション内のすべてのドキュメントをループする

// コレクション 'messages' 内のドキュメント数を取得
let count = 0;
const messagesRef = firebase.firestore().collection('messages');
messagesRef.get().then((querySnapshot) => {
  querySnapshot.forEach((doc) => {
    count++;
  });
  console.log(`messages コレクション内のドキュメント数: ${count}`);
});

count 変数に、初期値 0 を設定します。
forEach() メソッドを使用して、スナップショット内の各ドキュメントに対して処理を実行します。
各ドキュメントのループ処理において、count 変数を 1 ずつインクリメントします。

補足

上記のコードはあくまで一例であり、状況に応じて適宜修正する必要があります。
ドキュメントのフィールドにアクセスするには、doc.data() メソッドを使用できます。
コレクション内のドキュメントを条件に基づいてフィルタリングするには、where() メソッドを使用できます。

Cloud Firestore でコレクション内のドキュメント数を取得する - その他の方法

カスタムドキュメントIDを使用する

この方法は、各ドキュメントにユニークな ID を割り当て、その ID をドキュメント数のカウントに使用する方法です。

手順:

各ドキュメントに、ランダムな ID またはシーケンシャルな ID を割り当てます。
コレクションに count というドキュメントを作成し、そのドキュメントのフィールドにドキュメント数を格納します。
ドキュメントを追加または削除するたびに、count ドキュメントのフィールド値を更新します。

// ドキュメントを追加
const usersRef = firebase.firestore().collection('users');
usersRef.add({
  name: 'Taro Yamada',
  age: 30
}).then(() => {
  // 'count' ドキュメントのフィールド値を更新
  const countRef = firebase.firestore().doc('counts/users');
  countRef.get().then((docSnapshot) => {
    let count = docSnapshot.exists ? docSnapshot.data().count : 0;
    count++;
    countRef.update({ count: count });
  });
});

リアルタイムでドキュメント数を取得できます。
追加のクエリを実行する必要がありません。

複雑なロジックが必要になります。
エラーが発生しやすい可能性があります。

トリガーを使用する

この方法は、Cloud Firestore のトリガーを使用して、ドキュメントの追加または削除を検出し、ドキュメント数をカウントする方法です。

コレクションに対して、ドキュメントが追加または削除されたときに実行されるトリガーを作成します。
トリガー関数は、ドキュメント数のカウントを更新する処理を実行します。

// トリガーを作成
firebase.functions().firestore.document('users').onWrite((change) => {
  const countRef = firebase.firestore().doc('counts/users');
  return countRef.get().then((docSnapshot) => {
    let count = docSnapshot.exists ? docSnapshot.data().count : 0;
    if (change.after.exists) {
      count++;
    } else {
      count--;
    }
    return countRef.update({ count: count });
  });
});