Ordering between field paths is primarily to provide canonical orderings for sets of
paths, for example in a FieldMask. This ordering is performed segment-wise,
using ordinal string comparisons.
Constructors
FieldPath(params string[])
public FieldPath(params string[] segments)
Creates a path from multiple segments. Each segment is treated verbatim: it may contain dots, which will lead to the segment being escaped in the
path's string representation.
[[["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."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eFieldPath\u003c/code\u003e class in the Firestore API is 3.10.0, with prior versions ranging down to 2.3.1 also available for reference.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFieldPath\u003c/code\u003e class is an immutable structure used to represent a path of field names within a Firestore document, enabling identification of specific document parts.\u003c/p\u003e\n"],["\u003cp\u003eIt implements the \u003ccode\u003eIEquatable\u003c/code\u003e and \u003ccode\u003eIComparable\u003c/code\u003e interfaces for \u003ccode\u003eFieldPath\u003c/code\u003e and provides functionality for comparing, creating, and obtaining a string representation of field paths.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eDocumentId\u003c/code\u003e property within \u003ccode\u003eFieldPath\u003c/code\u003e serves as a sentinel to refer to a document's ID, which can be used for sorting and filtering.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFieldPath\u003c/code\u003e ordering is segment-wise using ordinal string comparisons to provide canonical ordering for sets of paths, such as in a \u003ccode\u003eFieldMask\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]