按 ID 查询 Firebase Firestore 文档

Question

As I got from 'Cloud Firestore Data Model' guide "each document is identified by a name." Is it possible to query a collection by that document identifier (which is the name or ID)?

For example, documents in the collection "Things" have IDs: 0, 1, 2 etc.:

Is it possible to query documents which IDs are less than 100?

Answer 1

You can query by documentId using the special sentinel FieldPath.documentId() , eg:

const querySnap = collection.where(firebase.firestore.FieldPath.documentId(), '<', '100').get();

But be aware that document IDs are strings and therefore this will include documents with ID '0' or '1', but not '2' since '2' > '100' lexicographically.

So if you want a numeric query, you'll need to write the document ID as a numeric field in the document and then do a normal query on it.

Answer 2

In python, you should use full documents names

from google.cloud import firestore
from google.cloud.firestore_v1.field_path import FieldPath

db = firestore.Client()
colRef = db.collection(u'docs')
filter = [db.document(u'docs/doc1'), db.collection(u'docs/doc3')]
query = colRef.where(FieldPath.document_id(), u'in', filter)

Answer 3

You can also try "filling" your ids so that '1' becomes '001', '2' becomes '002', and so on. If you have no idea your total number of items it may not seem convenient but it should make your query work.

Answer 4

i've found this way

constructor(private afs: AngularFirestore) { }

ngOnInit() {
  private thingsDoc: AngularFirestoreDocument<Item>;
  this.thingsDoc = this.afs.collection<any('Things').doc(INSERT_YOUR_ID);

  this.thingsDoc.valueChanges().subscribe((value: any) => {
   console.log('thing', value);
  });
}

Answer 5

I was struggling to find this for the Golang Firebase SDK but finally got it. Hope this helps somebody out there!

package main
    
import (
  "context"
  "fmt"
  "log"

  "cloud.google.com/go/firestore"
  firebase "firebase.google.com/go/v4"
  "google.golang.org/api/option"
)

type (
  Car struct {
    ID    string
    Name  string  `firestore:"name"`
    Make  string  `firestore:"make"`
    Price float64 `firestore:"make"`
  }
)

func main() {
  ctx := context.Background()

  // Use a service account
  options := option.WithCredentialsFile("PATH/TO/SERVICE/FILE.json")

  // Set project id
  conf := &firebase.Config{ProjectID: "PROJECT_NAME"}

  // Initialize app
  app, err := firebase.NewApp(ctx, conf, options)
  if err != nil {
    log.Fatal(err)
  }

  // Get firestore client
  client, err := app.Firestore(ctx)
  if err != nil {
    log.Fatal(err)
  }
  defer client.Close()

  collectionRef := client.Collection("CAR_COLLECTION")
  
  // Create docment list of documents from "CAR_COLLECTION"
  var skipDocs []*firestore.DocumentRef
  idList := []string{"001", "002", "003"}
  for _, id := range idList {
    skipDocs = append(skipDocs, collectionRef.Doc(id))
  }

  // firestore.DocumentID == "__name__" 
  docs, err := collectionRef.Where(firestore.DocumentID, "not-in", skipDocs).Documents(ctx).GetAll()
  if err != nil {
    log.Fatal(err)
  }

  var carList []Car
  for _, doc := range docs {
    var car Car

    // Unmarshall item
    doc.DataTo(&car)
    car.ID = doc.Ref.ID

    // Add car to list
    carList = append(carList, car)
  }

  // Print car list
  fmt.Println(carList)
}

Answer 6

Yes you can query a document identified by an id like suggested in @Michael Lehenbaur's response .

I want to add as an aside that it is bad practice to have predictable sequential keys since they lend themselves to scalability issues. You should use randomly generated keys to avoid hotspots in the database. For reference, see the firebase mailing list discussion