JavaScript、Node.js、Firebase を使って Firestore から複数ドキュメントを 1 ラウンドトリップで取得

2024-05-23

JavaScript、Node.js、Firebase を使用して Firestore から複数のドキュメントを 1 つのラウンドトリップで取得する方法

getMultiple メソッドは、ドキュメント参照の配列を受け取り、それらに対応するドキュメントを 1 つの要求で返します。これは、ドキュメント ID がわかっている場合に最適です。

// 複数のドキュメント参照の配列を作成
const docRefs = [
  firestore.doc('users/alice'),
  firestore.doc('users/bob'),
  firestore.doc('users/charlie'),
];

// 1 つの要求でドキュメントを取得
firestore.getMultiple(docRefs)
  .then(documents => {
    // ドキュメントを処理
    documents.forEach(doc => {
      console.log(doc.id, '=>', doc.data());
    });
  })
  .catch(error => {
    console.error('Error getting documents:', error);
  });

利点:

シンプルで使いやすい
ドキュメント ID がわかっている場合に効率的

フィールドによるフィルタリングなどの高度なクエリができない

in フィールドを使用して、クエリ内で複数のドキュメント ID を指定できます。これは、ドキュメント ID の一部がわかっている場合に役立ちます。

// コレクションとフィールド名を指定
const collectionRef = firestore.collection('users');
const field = 'userId';

// 複数のドキュメント ID を指定したクエリを作成
const query = collectionRef.where(field, 'in', ['alice', 'bob', 'charlie']);

// クエリを実行
query.get()
  .then(querySnapshot => {
    // ドキュメントを処理
    querySnapshot.forEach(doc => {
      console.log(doc.id, '=>', doc.data());
    });
  })
  .catch(error => {
    console.error('Error getting documents:', error);
  });

getMultiple メソッドよりも複雑

バッチ処理を使用して、複数の読み取り操作を 1 つの要求にまとめることができます。これは、一度に多くのドキュメントを取得する必要がある場合に役立ちます。

// バッチを作成
const batch = firestore.batch();

// 複数のドキュメント参照を取得
const docRef1 = firestore.doc('users/alice');
const docRef2 = firestore.doc('users/bob');
const docRef3 = firestore.doc('users/charlie');

// バッチに読み取り操作を追加
batch.get(docRef1);
batch.get(docRef2);
batch.get(docRef3);

// バッチを実行
batch.commit()
  .then(responses => {
    // ドキュメントを処理
    responses.forEach((response, index) => {
      const doc = response.get();
      if (doc.exists) {
        console.log(doc.id, '=>', doc.data());
      } else {
        console.log('Document does not exist:', doc.id);
      }
    });
  })
  .catch(error => {
    console.error('Error getting documents:', error);
  });

一度に多くのドキュメントを取得できる
ネットワーク要求を削減できる

コードが複雑になる

適切な方法を選択

上記の方法はそれぞれ長所と短所があります。ドキュメント ID がわかっている場合は getMultiple メソッドを使用するのが最も簡単です。フィールドによるフィルタリングが必要な場合は、in フィールドを使用します。一度に多くのドキュメントを取得する必要がある場合は、バッチ処理を使用します。

[クエリ内で

getMultiple メソッドを使用する

// 複数のドキュメント参照の配列を作成
const docRefs = [
  firestore.doc('users/alice'),
  firestore.doc('users/bob'),
  firestore.doc('users/charlie'),
];

// 1 つの要求でドキュメントを取得
firestore.getMultiple(docRefs)
  .then(documents => {
    // ドキュメントを処理
    documents.forEach(doc => {
      console.log(doc.id, '=>', doc.data());
    });
  })
  .catch(error => {
    console.error('Error getting documents:', error);
  });

in フィールドを使用する

// コレクションとフィールド名を指定
const collectionRef = firestore.collection('users');
const field = 'userId';

// 複数のドキュメント ID を指定したクエリを作成
const query = collectionRef.where(field, 'in', ['alice', 'bob', 'charlie']);

// クエリを実行
query.get()
  .then(querySnapshot => {
    // ドキュメントを処理
    querySnapshot.forEach(doc => {
      console.log(doc.id, '=>', doc.data());
    });
  })
  .catch(error => {
    console.error('Error getting documents:', error);
  });

バッチ処理を使用する

// バッチを作成
const batch = firestore.batch();

// 複数のドキュメント参照を取得
const docRef1 = firestore.doc('users/alice');
const docRef2 = firestore.doc('users/bob');
const docRef3 = firestore.doc('users/charlie');

// バッチに読み取り操作を追加
batch.get(docRef1);
batch.get(docRef2);
batch.get(docRef3);

// バッチを実行
batch.commit()
  .then(responses => {
    // ドキュメントを処理
    responses.forEach((response, index) => {
      const doc = response.get();
      if (doc.exists) {
        console.log(doc.id, '=>', doc.data());
      } else {
        console.log('Document does not exist:', doc.id);
      }
    });
  })
  .catch(error => {
    console.error('Error getting documents:', error);
  });

説明

これらのサンプルコードはそれぞれ、Firestore から複数のドキュメントを取得する方法を示しています。

getMultiple メソッド は、ドキュメント ID がわかっている場合に最適です。
in フィールド は、フィールドによるフィルタリングが必要な場合に役立ちます。
バッチ処理 は、一度に多くのドキュメントを取得する必要がある場合に役立ちます。

その他の注意事項

上記のサンプルコードはあくまでも例であり、必要に応じて変更する必要があります。
エラー処理を適切に行うようにしてください。

Firestore から複数のドキュメントを取得するその他の方法

カーソル付きページネーション:

大量のドキュメントを効率的に処理する必要がある場合は、カーソル付きページネーションを使用できます。この方法は、一度に少数のドキュメントを取得し、必要に応じて次のページへ進むことで、メモリ使用量を抑え、パフォーマンスを向上させることができます。

// 最初のドキュメントを取得
const firstDoc = query.get().then(querySnapshot => querySnapshot.docs[0]);

// カーソルを使用して次のページを取得
firstDoc.get().then(doc => {
  const cursor = doc.ref;
  return query.startAt(cursor).get();
});

コレクショングループのクエリ:

複数のサブコレクションにまたがってドキュメントを検索する必要がある場合は、コレクショングループのクエリを使用できます。これにより、サブコレクション名に関係なく、一致するドキュメントをすべて取得できます。

// コレクショングループの参照を作成
const collectionGroupRef = firestore.collectionGroup('users');

// クエリを実行
collectionGroupRef.where('age', '>', 30).get().then(querySnapshot => {
  // ドキュメントを処理
  querySnapshot.forEach(doc => {
    console.log(doc.id, '=>', doc.data());
  });
});

watchListener を使用する:

リアルタイムでドキュメントの変更を監視する必要がある場合は、watchListener を使用できます。これにより、ドキュメントが作成、更新、または削除されるたびに、コールバック関数が呼び出されます。

const query = firestore.collection('users').where('city', '==', 'San Francisco');

query.onSnapshot(querySnapshot => {
  // ドキュメントの変更を処理
  querySnapshot.docChanges().forEach(change => {
    if (change.type === 'added') {
      console.log('New document added:', change.doc.id, '=>', change.doc.data());
    }
    if (change.type === 'modified') {
      console.log('Document modified:', change.doc.id, '=>', change.doc.data());
    }
    if (change.type === 'removed') {
      console.log('Document removed:', change.doc.id);
    }
  });
});