Firestore: How to get random documents in a collection

Question

It is crucial for my application to be able to select multiple documents at random from a collection in firebase.

Since there is no native function built in to Firebase (that I know of) to achieve a query that does just this, my first thought was to use query cursors to select a random start and end index provided that I have the number of documents in the collection.

This approach would work but only in a limited fashion since every document would be served up in sequence with its neighboring documents every time; however, if I was able to select a document by its index in its parent collection I could achieve a random document query but the problem is I can't find any documentation that describes how you can do this or even if you can do this.

Here's what I'd like to be able to do, consider the following firestore schema:

root/
  posts/
     docA
     docB
     docC
     docD

Then in my client (I'm in a Swift environment) I'd like to write a query that can do this:

db.collection("posts")[0, 1, 3] // would return: docA, docB, docD

Is there anyway I can do something along the lines of this? Or, is there a different way I can select random documents in a similar fashion?

Please help.

Answer 1

Using randomly generated indexes and simple queries, you can randomly select documents from a collection or collection group in Cloud Firestore.

This answer is broken into 4 sections with different options in each section:

1. How to generate the random indexes
2. How to query the random indexes
3. Selecting multiple random documents
4. Reseeding for ongoing randomness

How to generate the random indexes

The basis of this answer is creating an indexed field that when ordered ascending or descending, results in all the document being randomly ordered. There are different ways to create this, so let's look at 2, starting with the most readily available.

Auto-Id version

If you are using the randomly generated automatic ids provided in our client libraries, you can use this same system to randomly select a document. In this case, the randomly ordered index is the document id.

Later in our query section, the random value you generate is a new auto-id (iOS, Android, Web) and the field you query is the __name__ field, and the 'low value' mentioned later is an empty string. This is by far the easiest method to generate the random index and works regardless of the language and platform.

By default, the document name (__name__) is only indexed ascending, and you also cannot rename an existing document short of deleting and recreating. If you need either of these, you can still use this method and just store an auto-id as an actual field called random rather than overloading the document name for this purpose.

Random Integer version

When you write a document, first generate a random integer in a bounded range and set it as a field called random. Depending on the number of documents you expect, you can use a different bounded range to save space or reduce the risk of collisions (which reduce the effectiveness of this technique).

You should consider which languages you need as there will be different considerations. While Swift is easy, JavaScript notably can have a gotcha:

• 32-bit integer: Great for small (~10K unlikely to have a collision) datasets
• 64-bit integer: Large datasets (note: JavaScript doesn't natively support, yet)

This will create an index with your documents randomly sorted. Later in our query section, the random value you generate will be another one of these values, and the 'low value' mentioned later will be -1.

How to query the random indexes

Now that you have a random index, you'll want to query it. Below we look at some simple variants to select a 1 random document, as well as options to select more than 1.

For all these options, you'll want to generate a new random value in the same form as the indexed values you created when writing the document, denoted by the variable random below. We'll use this value to find a random spot on the index.

Wrap-around

Now that you have a random value, you can query for a single document:

let postsRef = db.collection("posts")
queryRef = postsRef.whereField("random", isGreaterThanOrEqualTo: random)
                   .order(by: "random")
                   .limit(to: 1)

Check that this has returned a document. If it doesn't, query again but use the 'low value' for your random index. For example, if you did Random Integers then lowValue is 0:

let postsRef = db.collection("posts")
queryRef = postsRef.whereField("random", isGreaterThanOrEqualTo: lowValue)
                   .order(by: "random")
                   .limit(to: 1)

As long as you have a single document, you'll be guaranteed to return at least 1 document.

Bi-directional

The wrap-around method is simple to implement and allows you to optimize storage with only an ascending index enabled. One downside is the possibility of values being unfairly shielded. E.g if the first 3 documents (A,B,C) out of 10K have random index values of A:409496, B:436496, C:818992, then A and C have just less than 1/10K chance of being selected, whereas B is effectively shielded by the proximity of A and only roughly a 1/160K chance.

Rather than querying in a single direction and wrapping around if a value is not found, you can instead randomly select between >= and <=, which reduces the probability of unfairly shielded values by half, at the cost of double the index storage.

If one direction returns no results, switch to the other direction:

queryRef = postsRef.whereField("random", isLessThanOrEqualTo: random)
                   .order(by: "random", descending: true)
                   .limit(to: 1)

queryRef = postsRef.whereField("random", isGreaterThanOrEqualTo: random)
                   .order(by: "random")
                   .limit(to: 1)

Selecting multiple random documents

Often, you'll want to select more than 1 random document at a time. There are 2 different ways to adjust the above techniques depending on what trade offs you want.

Rinse & Repeat

This method is straight forward. Simply repeat the process, including selecting a new random integer each time.

This method will give you random sequences of documents without worrying about seeing the same patterns repeatedly.

The trade-off is it will be slower than the next method since it requires a separate round trip to the service for each document.

Keep it coming

In this approach, simply increase the number in the limit to the desired documents. It's a little more complex as you might return 0..limit documents in the call. You'll then need to get the missing documents in the same manner, but with the limit reduced to only the difference. If you know there are more documents in total than the number you are asking for, you can optimize by ignoring the edge case of never getting back enough documents on the second call (but not the first).

The trade-off with this solution is in repeated sequences. While the documents are randomly ordered, if you ever end up overlapping ranges you'll see the same pattern you saw before. There are ways to mitigate this concern discussed in the next section on reseeding.

This approach is faster than 'Rinse & Repeat' as you'll be requesting all the documents in the best case a single call or worst case 2 calls.

Reseeding for ongoing randomness

While this method gives you documents randomly if the document set is static the probability of each document being returned will be static as well. This is a problem as some values might have unfairly low or high probabilities based on the initial random values they got. In many use cases, this is fine but in some, you may want to increase the long term randomness to have a more uniform chance of returning any 1 document.

Note that inserted documents will end up weaved in-between, gradually changing the probabilities, as will deleting documents. If the insert/delete rate is too small given the number of documents, there are a few strategies addressing this.

Multi-Random

Rather than worrying out reseeding, you can always create multiple random indexes per document, then randomly select one of those indexes each time. For example, have the field random be a map with subfields 1 to 3:

{'random': {'1': 32456, '2':3904515723, '3': 766958445}}

Now you'll be querying against random.1, random.2, random.3 randomly, creating a greater spread of randomness. This essentially trades increased storage to save increased compute (document writes) of having to reseed.

Reseed on writes

Any time you update a document, re-generate the random value(s) of the random field. This will move the document around in the random index.

Reseed on reads

If the random values generated are not uniformly distributed (they're random, so this is expected), then the same document might be picked a dispropriate amount of the time. This is easily counteracted by updating the randomly selected document with new random values after it is read.

Since writes are more expensive and can hotspot, you can elect to only update on read a subset of the time (e.g, if random(0,100) === 0) update;).

Answer 2

Posting this to help anyone that has this problem in the future.

If you are using Auto IDs you can generate a new Auto ID and query for the closest Auto ID as mentioned in Dan McGrath's Answer.

I recently created a random quote api and needed to get random quotes from a firestore collection.
This is how I solved that problem:

var db = admin.firestore();
var quotes = db.collection("quotes");

var key = quotes.doc().id;

quotes.where(admin.firestore.FieldPath.documentId(), '>=', key).limit(1).get()
.then(snapshot => {
    if(snapshot.size > 0) {
        snapshot.forEach(doc => {
            console.log(doc.id, '=>', doc.data());
        });
    }
    else {
        var quote = quotes.where(admin.firestore.FieldPath.documentId(), '<', key).limit(1).get()
        .then(snapshot => {
            snapshot.forEach(doc => {
                console.log(doc.id, '=>', doc.data());
            });
        })
        .catch(err => {
            console.log('Error getting documents', err);
        });
    }
})
.catch(err => {
    console.log('Error getting documents', err);
});

The key to the query is this:

.where(admin.firestore.FieldPath.documentId(), '>', key)

And calling it again with the operation reversed if no documents are found.

I hope this helps!

Answer 3

Just made this work in Angular 7 + RxJS, so sharing here with people who want an example.

I used @Dan McGrath 's answer, and I chose these options: Random Integer version + Rinse & Repeat for multiple numbers. I also used the stuff explained in this article: RxJS, where is the If-Else Operator? to make if/else statements on stream level (just if any of you need a primer on that).

Also note I used angularfire2 for easy Firebase integration in Angular.

Here is the code:

import { Component, OnInit } from '@angular/core';
import { Observable, merge, pipe } from 'rxjs';
import { map, switchMap, filter, take } from 'rxjs/operators';
import { AngularFirestore, QuerySnapshot } from '@angular/fire/firestore';

@Component({
  selector: 'pp-random',
  templateUrl: './random.component.html',
  styleUrls: ['./random.component.scss']
})
export class RandomComponent implements OnInit {

  constructor(
    public afs: AngularFirestore,
  ) { }

  ngOnInit() {
  }

  public buttonClicked(): void {
    this.getRandom().pipe(take(1)).subscribe();
  }

  public getRandom(): Observable<any[]> {
    const randomNumber = this.getRandomNumber();
    const request$ = this.afs.collection('your-collection', ref => ref.where('random', '>=', randomNumber).orderBy('random').limit(1)).get();
    const retryRequest$ = this.afs.collection('your-collection', ref => ref.where('random', '<=', randomNumber).orderBy('random', 'desc').limit(1)).get();

    const docMap = pipe(
      map((docs: QuerySnapshot<any>) => {
        return docs.docs.map(e => {
          return {
            id: e.id,
            ...e.data()
          } as any;
        });
      })
    );

    const random$ = request$.pipe(docMap).pipe(filter(x => x !== undefined && x[0] !== undefined));

    const retry$ = request$.pipe(docMap).pipe(
      filter(x => x === undefined || x[0] === undefined),
      switchMap(() => retryRequest$),
      docMap
    );

    return merge(random$, retry$);
  }

  public getRandomNumber(): number {
    const min = Math.ceil(Number.MIN_VALUE);
    const max = Math.ceil(Number.MAX_VALUE);
    return Math.floor(Math.random() * (max - min + 1)) + min;
  }
}

Answer 4

You can use listDocuments() property for get only Query list of documents id. Then generate random id using the following way and get DocumentSnapshot with get() property.

  var restaurantQueryReference = admin.firestore().collection("Restaurant"); //have +500 docs
  var restaurantQueryList = await restaurantQueryReference.listDocuments(); //get all docs id; 

  for (var i = restaurantQueryList.length - 1; i > 0; i--) {
    var j = Math.floor(Math.random() * (i + 1));
    var temp = restaurantQueryList[i];
    restaurantQueryList[i] = restaurantQueryList[j];
    restaurantQueryList[j] = temp;
}

var restaurantId = restaurantQueryList[Math.floor(Math.random()*restaurantQueryList.length)].id; //this is random documentId 

Answer 5

The other solutions are better but seems hard for me to understand, so I came up with another method

1. Use incremental number as ID like 1,2,3,4,5,6,7,8,9, watch out for delete documents else we have an I'd that is missing

2. Get total number of documents in the collection, something like this, I don't know of a better solution than this

    let totalDoc = db.collection("stat").get().then(snap=>snap.size)
   

3. Now that we have these, create an empty array to store random list of number, let's say we want 20 random documents.

    let  randomID = [ ]
   
    while(randomID.length < 20) {
        const randNo = Math.floor(Math.random() * totalDoc) + 1;
        if(randomID.indexOf(randNo) === -1) randomID.push(randNo);
    }
   

   now we have our 20 random documents id

4. finally we fetch our data from fire store, and save to randomDocs array by mapping through the randomID array

    const  randomDocs =  randomID.map(id => {
        db.collection("posts").doc(id).get()
            .then(doc =>  {
                 if (doc.exists) return doc.data()
             })
            .catch(error => {
                 console.log("Error getting document:", error);
            });
      })
   

I'm new to firebase, but I think with this answers we can get something better or a built-in query from firebase soon

Answer 6

After intense argument with my friend, we finally found some solution

If you don't need to set document's id to be RandomID, just name documents as size of collection's size.

For example, first document of collection is named '0'. second document name should be '1'.

Then, we just read the size of collection, for example N, and we can get random number A in range of [0~N).

And then, we can query the document named A.

This way can give same probability of randomness to every documents in collection.

Answer 7

undoubtedly Above accepted Answer is SuperUseful but There is one case like If we had a collection of some Documents(about 100-1000) and we want some 20-30 random Documents Provided that Document must not be repeated. (case In Random Problems App etc...).

Problem with the Above Solution: For a small number of documents in the Collection(say 50) Probability of repetition is high. To avoid it If I store Fetched Docs Id and Add-in Query like this:

queryRef = postsRef.whereField("random", isGreaterThanOrEqualTo: lowValue).where("__name__", isNotEqualTo:"PreviousId")
               .order(by: "random")
               .limit(to: 1)

here PreviousId is Id of all Elements that were fetched Already means A loop of n previous Ids. But in this case, network Call would be high.

My Solution: Maintain one Special Document and Keep a Record of Ids of this Collection only, and fetched this document First Time and Then Do all Randomness Stuff and check for previously not fetched on App site. So in this case network call would be only the same as the number of documents requires (n+1).

Disadvantage of My solution: Have to maintain A document so Write on Addition and Deletion. But it is good If reads are very often then Writes which occurs in most cases.

Answer 8

Unlike rtdb, firestore ids are not ordered chronologically. So using Auto-Id version described by Dan McGrath is easily implemented if you use the auto-generated id by the firestore client.

      new Promise<Timeline | undefined>(async (resolve, reject) => {
        try {
          let randomTimeline: Timeline | undefined;
          let maxCounter = 5;
          do {
            const randomId = this.afs.createId(); // AngularFirestore
            const direction = getRandomIntInclusive(1, 10) <= 5;
            // The firestore id is saved with your model as an "id" property.
            let list = await this.list(ref => ref
              .where('id', direction ? '>=' : '<=', randomId)
              .orderBy('id', direction ? 'asc' : 'desc')
              .limit(10)
            ).pipe(take(1)).toPromise();
            // app specific filtering
            list = list.filter(x => notThisId !== x.id && x.mediaCounter > 5);
            if (list.length) {
              randomTimeline = list[getRandomIntInclusive(0, list.length - 1)];
            }
          } while (!randomTimeline && maxCounter-- >= 0);
          resolve(randomTimeline);
        } catch (err) {
          reject(err);
        }
      })

Answer 9

I have one way to get random a list document in Firebase Firestore, it really easy. When i upload data on Firestore i creat a field name "position" with random value from 1 to 1 milions. When i get data from Fire store i will set Order by field "Position" and update value for it, a lot of user load data and data always update and it's will be random value.

Answer 10

For those using Angular + Firestore, building on @Dan McGrath techniques, here is the code snippet.

Below code snippet returns 1 document.

  getDocumentRandomlyParent(): Observable<any> {
    return this.getDocumentRandomlyChild()
      .pipe(
        expand((document: any) => document === null ? this.getDocumentRandomlyChild() : EMPTY),
      );
  }

  getDocumentRandomlyChild(): Observable<any> {
      const random = this.afs.createId();
      return this.afs
        .collection('my_collection', ref =>
          ref
            .where('random_identifier', '>', random)
            .limit(1))
        .valueChanges()
        .pipe(
          map((documentArray: any[]) => {
            if (documentArray && documentArray.length) {
              return documentArray[0];
            } else {
              return null;
            }
          }),
        );
  }

1) .expand() is a rxjs operation for recursion to ensure we definitely get a document from the random selection.

2) For recursion to work as expected we need to have 2 separate functions.

3) We use EMPTY to terminate .expand() operator.

import { Observable, EMPTY } from 'rxjs';

Answer 11

Ok I will post answer to this question even thou I am doing this for Android. Whenever i create a new document i initiate random number and set it to random field, so my document looks like

"field1" : "value1"
"field2" : "value2"
...
"random" : 13442 //this is the random number i generated upon creating document

When I query for random document I generate random number in same range that I used when creating document.

private val firestore: FirebaseFirestore = FirebaseFirestore.getInstance()
private var usersReference = firestore.collection("users")

val rnds = (0..20001).random()

usersReference.whereGreaterThanOrEqualTo("random",rnds).limit(1).get().addOnSuccessListener {
  if (it.size() > 0) {
          for (doc in it) {
               Log.d("found", doc.toString())
           }
} else {
    usersReference.whereLessThan("random", rnds).limit(1).get().addOnSuccessListener {
          for (doc in it) {
                  Log.d("found", doc.toString())
           }
        }
}
}

Answer 12

Based on @ajzbc answer I wrote this for Unity3D and its working for me.

FirebaseFirestore db;

    void Start()
    {
        db = FirebaseFirestore.DefaultInstance;
    }

    public void GetRandomDocument()
    {

       Query query1 = db.Collection("Sports").WhereGreaterThanOrEqualTo(FieldPath.DocumentId, db.Collection("Sports").Document().Id).Limit(1);
       Query query2 = db.Collection("Sports").WhereLessThan(FieldPath.DocumentId, db.Collection("Sports").Document().Id).Limit(1);

        query1.GetSnapshotAsync().ContinueWithOnMainThread((querySnapshotTask1) =>
        {

             if(querySnapshotTask1.Result.Count > 0)
             {
                 foreach (DocumentSnapshot documentSnapshot in querySnapshotTask1.Result.Documents)
                 {
                     Debug.Log("Random ID: "+documentSnapshot.Id);
                 }
             } else
             {
                query2.GetSnapshotAsync().ContinueWithOnMainThread((querySnapshotTask2) =>
                {

                    foreach (DocumentSnapshot documentSnapshot in querySnapshotTask2.Result.Documents)
                    {
                        Debug.Log("Random ID: " + documentSnapshot.Id);
                    }

                });
             }
        });
    }

Answer 13

If you are using autoID this may also work for you...

  let collectionRef = admin.firestore().collection('your-collection');
  const documentSnapshotArray = await collectionRef.get();
  const records = documentSnapshotArray.docs;
  const index = documentSnapshotArray.size;
  let result = '';
  console.log(`TOTAL SIZE=====${index}`);

  var randomDocId = Math.floor(Math.random() * index);

  const docRef = records[randomDocId].ref;

  result = records[randomDocId].data();

  console.log('----------- Random Result --------------------');
  console.log(result);
  console.log('----------- Random Result --------------------');

Answer 14

Easy (2022). You need something like:

  export const getAtRandom = async (me) => {
    const collection = admin.firestore().collection('...').where(...);
    const { count } = (await collection.count().get()).data();

    const numberAtRandom = Math.floor(Math.random() * count);

    const snap = await accountCollection.limit(1).offset(numberAtRandom).get()

    if (accountSnap.empty) return null;

    const doc = { id: snap.docs[0].id, ...snap.docs[0].data(), ref: snap.docs[0].ref };

    return doc;
}

Answer 15

The next code (Flutter) will return one or up to 30 random documents from a Firebase collection.

• None of the documents will be repeated
• Max 30 documents can be retrieved
• If you pass a greater numberOfDocuments than existing documents in the collection, the loop will never end.

  Future<Iterable<QueryDocumentSnapshot>> getRandomDocuments(int numberOfDocuments) async {
    // Queried documents
    final docs = <QueryDocumentSnapshot>[];

    // Queried documents id's. We will use later to avoid querying same documents
    final currentIds = <String>[];
    do {

      // Generate random id explained by @Dan McGrath's answer (autoId)
      final randomId = FirebaseFirestore.instance.collection('random').doc().id;
      var query = FirebaseFirestore.instance
          .collection('myCollection') // Change this for you collection name
          .where(FieldPath.documentId, isGreaterThanOrEqualTo: randomId)
          .limit(1);
      
      if (currentIds.isNotEmpty) {
        // If previously we fetched a document we avoid fetching the same
        query = query.where(FieldPath.documentId, whereNotIn: currentIds);
      }
      final querySnap = await query.get();

      for (var element in querySnap.docs) {
        currentIds.add(element.id);
        docs.add(element);
      }
    } while (docs.length < numberOfDocuments); // <- Run until we have all documents we want
    return docs;
  }

Answer 16

simple answer

get the total number of documents in the collection

final nofUsers = await `_firebaseFirestore.collection('users').count().get().then((value) => `value.count, onError: (e)=>print('error counting'));

then generate a list of 10 random numbers with max bound of the count

List<int> randoms = [];
    for(int i=0; i< 10; i++){
      randoms.add(Random().nextInt(nofUsers)); 
    }

so we can use WhereIn to retrieve random docs but we already has to have numbers assigned to docs when they are created, in my case 'numbers' field, which increases by 1 every time a new doc is added

.where('number', whereIn: randoms)

List<User> filler = await _firebaseFirestore
  .collection('users')
  .where('gender', isEqualTo: user.gender)
  .where('number', whereIn: randoms)
  .get().then(
    (value) => value.docs.map(
      (doc) => User.fromSnapshoot(doc)).toList()
  );

repeat the process to get more than 10 random docs

Answer 17

Some people seem overwhelmed by the perceived complexity of the accepted answer but it's rather straightforward.

Give every document in this particular collection a string field called random. Then construct a function that generates a random string in exactly the same way the random field was generated, which will be our delimiter, and use it to find the closest document nearby (which will either be before or after the delimiter).

To simplify the randomly-generated string, let's just use the autoIDs generated by Firestore.

async function getRandomDocument() {
    try {
        const db = admin.firestore();

        // Generate a random string structured like a Firestore document ID that will 
        // be the delimiter for this operation. The delimiter will divide the
        // collection into two parts, the documents before the delimiter and the 
        // documents after.
        const delimiter = db.collection("someCollection").doc().id;

        // Because the delimiter only contains integers, uppercase letters, and 
        // lowercase letters, there is exactly a 50% chance that the first 
        // character will be less than "V", which we can use as a random binary 
        // generator to pick whether we want to start with a less-than 
        // operation or a greater-than operation. The more randomness, the 
        // better.
        const lessThanFirst = delimiter[0] < "V";

        if (lessThanFirst) {
            // Let's use a less-than operator first.
            const randomDoc = await getRandomDocumentLessThanOperator(delimiter);

            if (randomDoc === null) {
                // We did not get a document because there weren't any documents 
                // before this delimiter. Therefore, get the  document after this 
                // delimiter by switching from a less-than to a greater-than operator 
                // and using the same delimiter. If the collection is empty, this 
                // will also return null. If the collection has at least one
                // document, this will always return a document.
                return getRandomDocumentGreaterThanOperator(delimiter);
            } else {
                // We got a document!
                return randomDoc;
            }
        } else {
            // Let's use a greater-than operator first.
            const randomDoc = await getRandomDocumentGreaterThanOperator(delimiter);

            if (randomDoc === null) {
                // Just like above, we didn't get a document. Either the collection 
                // is empty or the delimiter was above all of the random seeds in 
                // the collection. Switch from a greater-than operator to a 
                // less-than operator using the same delimiter.
                return getRandomDocumentLessThanOperator(delimiter);
            } else {
                // We got a document!
                return randomDoc;
            }
        }
    } catch (error) {
        throw new Error(error);
    }
}

async function getRandomDocumentLessThanOperator(delimiter) {
    try {
        const db = admin.firestore();
        const snapshot = await db.collection("someCollection").where("random", "<=", delimiter)
                                                              .limit(1)
                                                              .get();
        if (snapshot.empty) {
            // This query found no documents before the delimiter, return null.
            return null;
        } else {
            // We found a document!
            const doc = snapshot.docs[0];

            // Before we return this random document, let's update this document's
            // random seed using the delimiter for extra future randomness!
            await doc.ref.update({"random": delimiter});

            return doc;
        }
    } catch (error) {
        throw new Error(error);
    }
}

async function getRandomDocumentGreaterThanOperator(delimiter) {
    try {
        const db = admin.firestore();
        const snapshot = await db.collection("someCollection").where("random", ">=", delimiter)
                                                              .limit(1)
                                                              .get();
        if (snapshot.empty) {
            // This query found no documents after the delimiter, return null.
            return null;
        } else {
            // We found a document!
            const doc = snapshot.docs[0];

            // Before we return this random document, let's update this document's
            // random seed using the delimiter for extra future randomness!
            await doc.ref.update({"random": delimiter});

            return doc;
        }
    } catch (error) {
        throw new Error(error);
    }
}