Firestore get DocumentSnapshot's field's value

Question

If I have a Firebase Firestore database which I have retrieved a DocumentSnapshot for the document corresponding to the collection on the right and stored in a document variable, then how could I retrieve the value in that DocumentSnapshot at the field "username"? The field has a string value.

Doug Stevenson · Accepted Answer · 2018-01-29T01:16:42.897

56

DocumentSnapshot has a method getString() which takes the name of a field and returns its value as a String.

String value = document.getString("username");

edited Jan 29 '18 at 01:16

answered Jan 29 '18 at 00:58

Doug Stevenson

297,357
32
422
441

1

When I use this code, AndroidStudio does a red underline with `Incompatible types, Required: java.lang.String, found java.lang.Object` Why would it be giving a generic Object? – Paradox Jan 29 '18 at 00:59
You're probably getting a generic Object because the field doesn't have a String. Can you post a screenshot of your document in the Firestore console? – Rosário Pereira Fernandes Jan 29 '18 at 01:01
Updated with screenshot – Paradox Jan 29 '18 at 01:03
@Paradox use get string not get – Abdulrahman Abdelkader Jun 21 '21 at 15:47

score 18 · Answer 2 · edited Jan 08 '20 at 00:28

18

you can use get method to get value of a field

String username = (String) document.get("username");  //if the field is String
Boolean b = (Boolean) document.get("isPublic");       //if the field is Boolean
Integer i = (Integer) document.get("age")             //if the field is Integer

checkout the doc for DocumentSnapshot

edited Jan 08 '20 at 00:28

Evin1_

12,292
9
45
47

answered Jan 29 '18 at 06:41

Ali Faris

17,754
10
45
70

1

This is the standard as per Web9, Modular. – Richard Onslow Roper Oct 30 '21 at 12:33
1

How would you get the array values? or objects? – Eduards Feb 01 '22 at 18:56

Steffo Dimfelt · Answer 3 · 2018-03-04T11:49:16.507

You need to do a DocumentReference to get the content in your document.

A simple one will be like this.

DocumentReference docRef = myDB.collection("users").document("username");
docRef.get().addOnCompleteListener(new OnCompleteListener<DocumentSnapshot>() {
@Override
     public void onComplete(@NonNull Task<DocumentSnapshot> task) {
          if (task.isSuccessful()) {
               DocumentSnapshot document = task.getResult();
                    if (document != null) {
                         Log.i("LOGGER","First "+document.getString("first"));
                         Log.i("LOGGER","Last "+document.getString("last"));
                         Log.i("LOGGER","Born "+document.getString("born"));
                    } else {
                         Log.d("LOGGER", "No such document");
                    }
               } else {
                    Log.d("LOGGER", "get failed with ", task.getException());
                }
          }
     });

The downside is that you need to know your document ID to get the field values.

score 2 · Answer 4 · answered Jun 21 '19 at 07:38

I can only reference the field's data as Strings when I am inside the onComplete, but when I try reference it outside it. I get a nullPointerException and it crashes my activity.

// Gets user document from Firestore as reference
    DocumentReference docRef = mFirestore.collection("users").document(userID);

    docRef.get().addOnCompleteListener(new OnCompleteListener<DocumentSnapshot>() {
        @Override
        public void onComplete(@NonNull Task<DocumentSnapshot> task) {
            if (task.isSuccessful()) {
                DocumentSnapshot document = task.getResult();
                if (document.exists()) {

                    Log.d(TAG, "DocumentSnapshot data: " + document.getData());
                    Log.d(TAG, "db firstName getString() is: " + document.getString("firstName"));
                    Log.d(TAG, "db lastName getString() is: " + document.getString("lastName"));

                    mFirstName = (String) document.getString("firstName");
                    mLastName = (String) document.getString("lastName");
                    Log.d(TAG, "String mFirstName is: " + mFirstName);
                    Log.d(TAG, "String mLastName is: " + mLastName);

                } else {
                    Log.d(TAG, "No such document");
                }
            } else {
                Log.d(TAG, "get failed with ", task.getException());
            }
        }
    });

    //string checking outside the docRef.get().addOnCompleteListener code
    //commented it out because it causes a java.lang.NullPointerException: println needs a message
    //Log.v("NAME", mFirstName);
    //Log.v("NAME", mLastName);

    // sets the text on the TextViews
    tvFirstName = (TextView)findViewById(R.id.tvFirstName);
    tvFirstName.setText(mFirstName);
    tvLastName = (TextView)findViewById(R.id.tvLastName);
    tvLastName.setText(mLastName);

score 2 · Answer 5 · edited Jul 18 '20 at 21:32

2

Here is another simple way to get document value(in your case):

Firestore.instance
.collection('users').document('xsajAansjdna')
.get()
.then((value) =>
print("Fetched ==>>>"+value.data["username"]));

edited Jul 18 '20 at 21:32

Jawad Ali

13,556
3
32
49

answered Jul 18 '20 at 20:13

Muahmmad Tayyib

689
11
28

The point is that this is not performant, because you get whole the document, not just the desired field. – Jalaleddin Hosseini Jan 09 '22 at 19:27

score 1 · Answer 6 · answered Mar 22 '22 at 05:31

1

`Firestore.instance
.collection('users').document('xsajAansjdna')
.get()
.then((value) =>
print("Fetched ==>>>"+value.data()["username"]));`

answered Mar 22 '22 at 05:31

Sanat Kumar

82
5

2

While this code snippet may solve the question, [including an explanation](http://meta.stackexchange.com/questions/114762/explaining-entirely-code-based-answers) will help people understand the reasons for your code suggestion. – Gerhard Mar 22 '22 at 07:31

Firestore get DocumentSnapshot's field's value

6 Answers6

Linked