You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1.projects.databases.documents.html
-22Lines changed: 0 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -1750,7 +1750,6 @@ <h3>Method Details</h3>
1750
1750
The object takes the form of:
1751
1751
1752
1752
{ # The request for Firestore.RunAggregationQuery.
1753
-
"mode": "A String", # Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.
1754
1753
"newTransaction": { # Options for creating a new transaction. # Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.
1755
1754
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1756
1755
"readTime": "A String", # Reads documents at the given time. 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.
@@ -1948,16 +1947,6 @@ <h3>Method Details</h3>
1948
1947
},
1949
1948
},
1950
1949
},
1951
-
"stats": { # Planning and execution statistics for the query. # Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream.
1952
-
"queryPlan": { # Plan for the query. # Plan for the query.
1953
-
"planInfo": { # Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] }
1954
-
"a_key": "", # Properties of the object.
1955
-
},
1956
-
},
1957
-
"queryStats": { # Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }
1958
-
"a_key": "", # Properties of the object.
1959
-
},
1960
-
},
1961
1950
"transaction": "A String", # The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.
1962
1951
}</pre>
1963
1952
</div>
@@ -1972,7 +1961,6 @@ <h3>Method Details</h3>
1972
1961
The object takes the form of:
1973
1962
1974
1963
{ # The request for Firestore.RunQuery.
1975
-
"mode": "A String", # Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.
1976
1964
"newTransaction": { # Options for creating a new transaction. # Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
1977
1965
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1978
1966
"readTime": "A String", # Reads documents at the given time. 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.
@@ -2155,16 +2143,6 @@ <h3>Method Details</h3>
2155
2143
"done": True or False, # If present, Firestore has completely finished the request and no more documents will be returned.
2156
2144
"readTime": "A String", # The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.
2157
2145
"skippedResults": 42, # The number of results that have been skipped due to an offset between the last response and the current response.
2158
-
"stats": { # Planning and execution statistics for the query. # Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream.
2159
-
"queryPlan": { # Plan for the query. # Plan for the query.
2160
-
"planInfo": { # Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] }
2161
-
"a_key": "", # Properties of the object.
2162
-
},
2163
-
},
2164
-
"queryStats": { # Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }
2165
-
"a_key": "", # Properties of the object.
2166
-
},
2167
-
},
2168
2146
"transaction": "A String", # The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1beta1.projects.databases.documents.html
-22Lines changed: 0 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -1750,7 +1750,6 @@ <h3>Method Details</h3>
1750
1750
The object takes the form of:
1751
1751
1752
1752
{ # The request for Firestore.RunAggregationQuery.
1753
-
"mode": "A String", # Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.
1754
1753
"newTransaction": { # Options for creating a new transaction. # Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.
1755
1754
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1756
1755
"readTime": "A String", # Reads documents at the given time. 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.
@@ -1948,16 +1947,6 @@ <h3>Method Details</h3>
1948
1947
},
1949
1948
},
1950
1949
},
1951
-
"stats": { # Planning and execution statistics for the query. # Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream.
1952
-
"queryPlan": { # Plan for the query. # Plan for the query.
1953
-
"planInfo": { # Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] }
1954
-
"a_key": "", # Properties of the object.
1955
-
},
1956
-
},
1957
-
"queryStats": { # Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }
1958
-
"a_key": "", # Properties of the object.
1959
-
},
1960
-
},
1961
1950
"transaction": "A String", # The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.
1962
1951
}</pre>
1963
1952
</div>
@@ -1972,7 +1961,6 @@ <h3>Method Details</h3>
1972
1961
The object takes the form of:
1973
1962
1974
1963
{ # The request for Firestore.RunQuery.
1975
-
"mode": "A String", # Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.
1976
1964
"newTransaction": { # Options for creating a new transaction. # Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
1977
1965
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1978
1966
"readTime": "A String", # Reads documents at the given time. 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.
@@ -2155,16 +2143,6 @@ <h3>Method Details</h3>
2155
2143
"done": True or False, # If present, Firestore has completely finished the request and no more documents will be returned.
2156
2144
"readTime": "A String", # The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.
2157
2145
"skippedResults": 42, # The number of results that have been skipped due to an offset between the last response and the current response.
2158
-
"stats": { # Planning and execution statistics for the query. # Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream.
2159
-
"queryPlan": { # Plan for the query. # Plan for the query.
2160
-
"planInfo": { # Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] }
2161
-
"a_key": "", # Properties of the object.
2162
-
},
2163
-
},
2164
-
"queryStats": { # Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }
2165
-
"a_key": "", # Properties of the object.
2166
-
},
2167
-
},
2168
2146
"transaction": "A String", # The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/firestore.v1.json
+1-71Lines changed: 1 addition & 71 deletions
Original file line number
Diff line number
Diff line change
@@ -1672,7 +1672,7 @@
1672
1672
}
1673
1673
}
1674
1674
},
1675
-
"revision": "20240117",
1675
+
"revision": "20240131",
1676
1676
"rootUrl": "https://firestore.googleapis.com/",
1677
1677
"schemas": {
1678
1678
"Aggregation": {
@@ -3712,21 +3712,6 @@
3712
3712
},
3713
3713
"type": "object"
3714
3714
},
3715
-
"QueryPlan": {
3716
-
"description": "Plan for the query.",
3717
-
"id": "QueryPlan",
3718
-
"properties": {
3719
-
"planInfo": {
3720
-
"additionalProperties": {
3721
-
"description": "Properties of the object.",
3722
-
"type": "any"
3723
-
},
3724
-
"description": "Planning phase information for the query. It will include: { \"indexes_used\": [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ] }",
3725
-
"type": "object"
3726
-
}
3727
-
},
3728
-
"type": "object"
3729
-
},
3730
3715
"QueryTarget": {
3731
3716
"description": "A target specified by a query.",
3732
3717
"id": "QueryTarget",
@@ -3766,25 +3751,6 @@
3766
3751
},
3767
3752
"type": "object"
3768
3753
},
3769
-
"ResultSetStats": {
3770
-
"description": "Planning and execution statistics for the query.",
3771
-
"id": "ResultSetStats",
3772
-
"properties": {
3773
-
"queryPlan": {
3774
-
"$ref": "QueryPlan",
3775
-
"description": "Plan for the query."
3776
-
},
3777
-
"queryStats": {
3778
-
"additionalProperties": {
3779
-
"description": "Properties of the object.",
3780
-
"type": "any"
3781
-
},
3782
-
"description": "Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { \"results_returned\": \"20\", \"documents_scanned\": \"20\", \"indexes_entries_scanned\": \"10050\", \"total_execution_time\": \"100.7 msecs\" }",
3783
-
"type": "object"
3784
-
}
3785
-
},
3786
-
"type": "object"
3787
-
},
3788
3754
"RollbackRequest": {
3789
3755
"description": "The request for Firestore.Rollback.",
3790
3756
"id": "RollbackRequest",
@@ -3801,20 +3767,6 @@
3801
3767
"description": "The request for Firestore.RunAggregationQuery.",
3802
3768
"id": "RunAggregationQueryRequest",
3803
3769
"properties": {
3804
-
"mode": {
3805
-
"description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.",
3806
-
"enum": [
3807
-
"NORMAL",
3808
-
"PLAN",
3809
-
"PROFILE"
3810
-
],
3811
-
"enumDescriptions": [
3812
-
"The default mode. Only the query results are returned.",
3813
-
"This mode returns only the query plan, without any results or execution statistics information.",
3814
-
"This mode returns both the query plan and the execution statistics along with the results."
3815
-
],
3816
-
"type": "string"
3817
-
},
3818
3770
"newTransaction": {
3819
3771
"$ref": "TransactionOptions",
3820
3772
"description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream."
@@ -3849,10 +3801,6 @@
3849
3801
"$ref": "AggregationResult",
3850
3802
"description": "A single aggregation result. Not present when reporting partial progress."
3851
3803
},
3852
-
"stats": {
3853
-
"$ref": "ResultSetStats",
3854
-
"description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream."
3855
-
},
3856
3804
"transaction": {
3857
3805
"description": "The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.",
3858
3806
"format": "byte",
@@ -3865,20 +3813,6 @@
3865
3813
"description": "The request for Firestore.RunQuery.",
3866
3814
"id": "RunQueryRequest",
3867
3815
"properties": {
3868
-
"mode": {
3869
-
"description": "Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.",
3870
-
"enum": [
3871
-
"NORMAL",
3872
-
"PLAN",
3873
-
"PROFILE"
3874
-
],
3875
-
"enumDescriptions": [
3876
-
"The default mode. Only the query results are returned.",
3877
-
"This mode returns only the query plan, without any results or execution statistics information.",
3878
-
"This mode returns both the query plan and the execution statistics along with the results."
3879
-
],
3880
-
"type": "string"
3881
-
},
3882
3816
"newTransaction": {
3883
3817
"$ref": "TransactionOptions",
3884
3818
"description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream."
@@ -3922,10 +3856,6 @@
3922
3856
"format": "int32",
3923
3857
"type": "integer"
3924
3858
},
3925
-
"stats": {
3926
-
"$ref": "ResultSetStats",
3927
-
"description": "Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream."
3928
-
},
3929
3859
"transaction": {
3930
3860
"description": "The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.",
0 commit comments