Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/collectionreference below:

Class CollectionReference (7.11.0) | Node.js client library

Stay organized with collections Save and categorize content based on your preferences.

• 7.11.0 (latest)
• 7.9.0
• 7.7.0
• 7.6.0
• 7.5.0
• 7.4.0
• 7.3.1
• 7.2.0
• 7.1.0
• 6.4.1
• 6.3.0
• 6.0.0
• 5.0.2
• 4.15.1
• 4.14.2
• 4.9.8

A CollectionReference object can be used for adding documents, getting document references, and querying for documents (using the methods inherited from [Query]Query).

CollectionReference Query

constructor(firestore: Firestore, path: ResourcePath, converter?: firestore.FirestoreDataConverter<AppModelType, DbModelType>);

Constructs a new instance of the CollectionReference class

The Firestore Database client.

The Path of this collection.

The last path element of the referenced collection.

{string} CollectionReference#id

let collectionRef = firestore.collection('col/doc/subcollection');
console.log(`ID of the subcollection: ${collectionRef.id}`);

get parent(): DocumentReference | null;

A reference to the containing Document if this is a subcollection, else null.

{DocumentReference|null} CollectionReference#parent

let collectionRef = firestore.collection('col/doc/subcollection');
let documentRef = collectionRef.parent;
console.log(`Parent name: ${documentRef.path}`);

A string representing the path of the referenced collection (relative to the root of the database).

{string} CollectionReference#path

let collectionRef = firestore.collection('col/doc/subcollection');
console.log(`Path of the subcollection: ${collectionRef.path}`);

add(data: firestore.WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

Add a new document to this collection with the specified data, assigning it a document ID automatically.

An Object containing the data for the new document.

{Promise.

let collectionRef = firestore.collection('col');
collectionRef.add({foo: 'bar'}).then(documentReference => {
  console.log(`Added document with name: ${documentReference.id}`);
});

doc(): DocumentReference<AppModelType, DbModelType>;

doc(documentPath: string): DocumentReference<AppModelType, DbModelType>;

isEqual(other: firestore.CollectionReference<AppModelType, DbModelType>): boolean;

Returns true if this CollectionReference is equal to the provided value.

The value to compare against. {boolean} true if this CollectionReference is equal to the provided value.

listDocuments(): Promise<Array<DocumentReference<AppModelType, DbModelType>>>;

Retrieves the list of documents in this collection.

The document references returned may include references to "missing documents", i.e. document locations that have no document present but which contain subcollections with documents. Attempting to read such a document reference (e.g. via .get() or .onSnapshot()) will return a DocumentSnapshot whose .exists property is false.

{Promise<DocumentReference[]>} The list of documents in this collection.

let collectionRef = firestore.collection('col');

return collectionRef.listDocuments().then(documentRefs => {
   return firestore.getAll(...documentRefs);
}).then(documentSnapshots => {
   for (let documentSnapshot of documentSnapshots) {
      if (documentSnapshot.exists) {
        console.log(`Found document with data: ${documentSnapshot.id}`);
      } else {
        console.log(`Found missing document: ${documentSnapshot.id}`);
      }
   }
});

withConverter(converter: null): CollectionReference;

withConverter<NewAppModelType, NewDbModelType extends firestore.DocumentData = firestore.DocumentData>(converter: firestore.FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;

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 2025-08-07 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 2025-08-07 UTC."],[],[]]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4