Query a Firestore collection with a cursor start at field filter
Stay organized with collections
Save and categorize content based on your preferences.
Query a Firestore collection with a cursor start at field filter
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 page demonstrates how to query a Firestore collection using a cursor to start at a specific field value, allowing you to retrieve data from a certain point in the dataset.\u003c/p\u003e\n"],["\u003cp\u003eThe examples provided showcase the \u003ccode\u003eStartAt\u003c/code\u003e method in various programming languages, including C#, Go, Java, Node.js, PHP, Python, and Ruby.\u003c/p\u003e\n"],["\u003cp\u003eEach code sample requires authentication to Firestore, achieved by setting up Application Default Credentials, as detailed in the linked documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe query used in these samples orders the collection by the "population" field and then uses \u003ccode\u003eStartAt\u003c/code\u003e to begin the results from a specified population value.\u003c/p\u003e\n"],["\u003cp\u003eAdditional code samples for Google Cloud products, including Firestore, can be found using the Google Cloud sample browser.\u003c/p\u003e\n"]]],[],null,["# Query a Firestore collection with a cursor start at field filter\n\nExplore further\n---------------\n\n\nFor detailed documentation that includes this code sample, see the following:\n\n- [Paginate data with query cursors](/firestore/native/docs/query-data/query-cursors)\n- [Paginate data with query cursors](https://firebase.google.com/docs/firestore/query-data/query-cursors)\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 Query query = citiesRef.OrderBy(\"Population\").StartAt(1000000);\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 query := client.Collection(\"cities\").OrderBy(\"population\", firestore.Asc).StartAt(1000000)\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 Query query = cities.orderBy(\"population\").startAt(4921000L);\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 startAtRes = await db.collection('cities')\n .orderBy('population')\n .startAt(1000000)\n .get();\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 $query = $citiesRef\n -\u003eorderBy('population')\n -\u003estartAt([1000000]);\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 cities_ref = db.collection(\"cities\")\n query_start_at = cities_ref.order_by(\"population\").start_at({\"population\": 1000000})\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 query = cities_ref.order(\"population\").start_at(1_000_000)\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)."]]