Query a single document from Firestore in Flutter (cloud_firestore Plugin)

Question

Edit: This Question is outdated, and I am sure, new documentation and more recent answers are available as of now.

I want to retrieve data of only a single document via its ID. My approach with example data of:

TESTID1 {
     'name': 'example', 
     'data': 'sample data',
}

was something like this:

Firestore.instance.document('TESTID1').get() => then(function(document) {
    print(document('name'));
}

but that does not seem to be correct syntax.

I was not able to find any detailed documentation on querying firestore within flutter (dart) since the firebase documentation only addresses Native WEB, iOS, Android etc. but not Flutter. The documentation of cloud_firestore is also way too short. There is only one example that shows how to query multiple documents into a stream which is not what i want to do.

Related issue on missing documentation: https://github.com/flutter/flutter/issues/14324

It can't be that hard to get data from a single document.

UPDATE:

Firestore.instance.collection('COLLECTION').document('ID')
.get().then((DocumentSnapshot) =>
      print(DocumentSnapshot.data['key'].toString());
);

is not executed.

Answer 1

but that does not seem to be correct syntax.

It is not the correct syntax because you are missing a collection() call. You cannot call document() directly on your Firestore.instance. To solve this, you should use something like this:

var document = await Firestore.instance.collection('COLLECTION_NAME').document('TESTID1'); document.get() => then(function(document) {     print(document("name")); }); 

Or in more simpler way:

var document = await Firestore.instance.document('COLLECTION_NAME/TESTID1'); document.get() => then(function(document) {     print(document("name")); }); 

If you want to get data in realtime, please use the following code:

Widget build(BuildContext context) {   return new StreamBuilder(       stream: Firestore.instance.collection('COLLECTION_NAME').document('TESTID1').snapshots(),       builder: (context, snapshot) {         if (!snapshot.hasData) {           return new Text("Loading");         }         var userDocument = snapshot.data;         return new Text(userDocument["name"]);       }   ); } 

It will help you set also the name to a text view.

Answer 2

If you want to use a where clause

await Firestore.instance.collection('collection_name').where(     FieldPath.documentId,     isEqualTo: "some_id" ).getDocuments().then((event) {     if (event.documents.isNotEmpty) {         Map<String, dynamic> documentData = event.documents.single.data; //if it is a single document     } }).catchError((e) => print("error fetching data: $e")); 

Answer 3

Null safe code (Recommended)

You can either query the document in a function (for example on press of a button) or inside a widget (like a FutureBuilder).

• In a method: (one time listen)

  var collection = FirebaseFirestore.instance.collection('users');
  var docSnapshot = await collection.doc('doc_id').get();
  if (docSnapshot.exists) {
    Map<String, dynamic>? data = docSnapshot.data();
    var value = data?['some_field']; // <-- The value you want to retrieve. 
    // Call setState if needed.
  }
  

• In a FutureBuilder (one time listen)

  FutureBuilder<DocumentSnapshot<Map<String, dynamic>>>(
    future: collection.doc('doc_id').get(),
    builder: (_, snapshot) {
      if (snapshot.hasError) return Text ('Error = ${snapshot.error}');
  
      if (snapshot.hasData) {
        var data = snapshot.data!.data();
        var value = data!['some_field']; // <-- Your value
        return Text('Value = $value');
      }
  
      return Center(child: CircularProgressIndicator());
    },
  )
  

• In a StreamBuilder: (always listening)

  StreamBuilder<DocumentSnapshot<Map<String, dynamic>>>(
    stream: collection.doc('doc_id').snapshots(),
    builder: (_, snapshot) {
      if (snapshot.hasError) return Text('Error = ${snapshot.error}');
  
      if (snapshot.hasData) {
        var output = snapshot.data!.data();
        var value = output!['some_field']; // <-- Your value
        return Text('Value = $value');
      }
  
      return Center(child: CircularProgressIndicator());
    },
  )