Create a Firestore subcollection reference
Stay organized with collections
Save and categorize content based on your preferences.
Create a Firestore subcollection reference
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
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.
[[["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"]],[],[[["\u003cp\u003eThis content demonstrates how to create a reference to a document within a Firestore subcollection, using various programming languages.\u003c/p\u003e\n"],["\u003cp\u003eThe examples show a consistent pattern where a subcollection named "messages" is nested under a "rooms" collection, specifically referencing "message1" within "roomA".\u003c/p\u003e\n"],["\u003cp\u003eEach code sample, in C#, Go, Java, Node.js, PHP, Python, and Ruby, illustrates the specific syntax for establishing this subcollection reference.\u003c/p\u003e\n"],["\u003cp\u003eSetting up Application Default Credentials is a prerequisite for authenticating with Firestore, as per the instructions provided across the different languages.\u003c/p\u003e\n"],["\u003cp\u003eThe Cloud Firestore Data Model documentation provides further information and context on how the data structure functions.\u003c/p\u003e\n"]]],[],null,["# Create a Firestore subcollection reference\n\nExplore further\n---------------\n\n\nFor detailed documentation that includes this code sample, see the following:\n\n- [Cloud Firestore Data model](https://firebase.google.com/docs/firestore/data-model)\n- [Data model](/firestore/native/docs/data-model)\n\nCode sample\n-----------\n\n### C#\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n DocumentReference documentRef = db\n .Collection(\"Rooms\").Document(\"RoomA\")\n .Collection(\"Messages\").Document(\"Message1\");\n\n### Go\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n\n import (\n \t\"cloud.google.com/go/firestore\"\n )\n\n func createSubcollectionReference(client *firestore.Client) {\n \tmessageRef := client.Collection(\"rooms\").Doc(\"roomA\").\n \t\tCollection(\"messages\").Doc(\"message1\")\n\n \t_ = messageRef\n }\n\n### Java\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n // Reference to a document in subcollection \"messages\"\n DocumentReference document =\n db.collection(\"rooms\").document(\"roomA\").collection(\"messages\").document(\"message1\");\n\n### Node.js\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n const messageRef = db.collection('rooms').doc('roomA')\n .collection('messages').doc('message1');\n\n### PHP\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n $document = $db\n -\u003ecollection('rooms')\n -\u003edocument('roomA')\n -\u003ecollection('messages')\n -\u003edocument('message1');\n\n### Python\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n room_a_ref = db.collection(\"rooms\").document(\"roomA\")\n message_ref = room_a_ref.collection(\"messages\").document(\"message1\")\n\n### Ruby\n\n\nTo authenticate to Firestore, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n message_ref = firestore.col(\"rooms\").doc(\"roomA\").col(\"messages\").doc(\"message1\")\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=firestore)."]]