Send feedback
Class QueryDocumentSnapshot (7.9.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with [data()] or [get()] to get a specific field.
A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot . Since query results contain only existing documents, the [exists] property will always be true and [data()] will never return 'undefined'.
QueryDocumentSnapshot DocumentSnapshot
Package
@google-cloud/firestore
Properties
createTime
/** @ override */
get createTime (): Timestamp ;
The time the document was created.
{Timestamp} QueryDocumentSnapshot#createTime
Example
let query = firestore.collection('col');
query.get().forEach(snapshot => {
console.log(`Document created at '${ snapshot . createTime . toDate () } '`);
});
updateTime
/** @ override */
get updateTime (): Timestamp ;
The time the document was last updated (at the time the snapshot was generated).
{Timestamp} QueryDocumentSnapshot#updateTime
Example
let query = firestore.collection('col');
query.get().forEach(snapshot => {
console.log(`Document updated at '${ snapshot . updateTime . toDate () } '`);
});
Methods
data()
/** @ override */
data (): AppModelType ;
Retrieves all fields in the document as an object.
Returns
Type
Description
AppModelType
{T} An object containing all fields in the document.
Example
let query = firestore.collection('col');
query.get().forEach(documentSnapshot => {
let data = documentSnapshot.data();
console.log(`Retrieved data: ${ JSON . stringify ( data ) } `);
});
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-24 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-24 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-24 UTC."]]