{// Union fieldconsistency_typecan be only one of the following:"readConsistency":enum (ReadConsistency),"transaction":string,"readTime":string// End of list of possible types for union fieldconsistency_type.}
Fields
Union fieldconsistency_type. For Cloud Firestore in Datastore mode, if you don't specify read_consistency then all lookups and queries default toread_consistency=STRONG. Note that, in Cloud Datastore, global queries defaulted toread_consistency=EVENTUAL.
Explicitly settingread_consistency=EVENTUALwill result in eventually consistent lookups and queries.consistency_typecan be only one of the following:
Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
[[["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-04-30 UTC."],[[["\u003cp\u003eRead requests in Cloud Firestore in Datastore mode default to \u003ccode\u003eSTRONG\u003c/code\u003e consistency if \u003ccode\u003eread_consistency\u003c/code\u003e is not specified, whereas global queries in Cloud Datastore defaulted to \u003ccode\u003eEVENTUAL\u003c/code\u003e consistency.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003econsistency_type\u003c/code\u003e field, a union field, determines the read consistency, transaction identifier, or read time.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereadConsistency\u003c/code\u003e enum allows selection between \u003ccode\u003eSTRONG\u003c/code\u003e and \u003ccode\u003eEVENTUAL\u003c/code\u003e consistency for non-transactional reads.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etransaction\u003c/code\u003e field uses a base64-encoded string to specify the transaction in which to read, with the identifier returned by \u003ccode\u003eDatastore.BeginTransaction\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereadTime\u003c/code\u003e field, only supported for Cloud Firestore in Datastore mode, lets you read entities as they existed at a given microsecond-precision timestamp within the past hour, or within the past seven days if Point-in-Time Recovery is enabled.\u003c/p\u003e\n"]]],[],null,["# ReadOptions\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ReadConsistency](#ReadConsistency)\n\nThe options shared by read requests.\n\nReadConsistency\n---------------\n\nThe possible values for read consistencies."]]
