Skip to content

Commit 8fea3a2

Browse files
feat(firestore): update the api
#### firestore:v1 The following keys were deleted: - schemas.QueryPlan (Total Keys: 4) - schemas.ResultSetStats (Total Keys: 5) - schemas.RunAggregationQueryRequest.properties.mode.type (Total Keys: 1) - schemas.RunAggregationQueryResponse.properties.stats.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.mode.type (Total Keys: 1) - schemas.RunQueryResponse.properties.stats.$ref (Total Keys: 1) #### firestore:v1beta1 The following keys were deleted: - schemas.QueryPlan (Total Keys: 4) - schemas.ResultSetStats (Total Keys: 5) - schemas.RunAggregationQueryRequest.properties.mode.type (Total Keys: 1) - schemas.RunAggregationQueryResponse.properties.stats.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.mode.type (Total Keys: 1) - schemas.RunQueryResponse.properties.stats.$ref (Total Keys: 1)
1 parent 8a4d375 commit 8fea3a2

File tree

5 files changed

+3
-187
lines changed

5 files changed

+3
-187
lines changed

docs/dyn/firestore_v1.projects.databases.documents.html

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1750,7 +1750,6 @@ <h3>Method Details</h3>
17501750
The object takes the form of:
17511751

17521752
{ # The request for Firestore.RunAggregationQuery.
1753-
&quot;mode&quot;: &quot;A String&quot;, # 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.
17541753
&quot;newTransaction&quot;: { # 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.
17551754
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
17561755
&quot;readTime&quot;: &quot;A String&quot;, # 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>
19481947
},
19491948
},
19501949
},
1951-
&quot;stats&quot;: { # 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-
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
1953-
&quot;planInfo&quot;: { # Planning phase information for the query. It will include: { &quot;indexes_used&quot;: [ {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(foo ASC, __name__ ASC)&quot;}, {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(bar ASC, __name__ ASC)&quot;} ] }
1954-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1955-
},
1956-
},
1957-
&quot;queryStats&quot;: { # 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: { &quot;results_returned&quot;: &quot;20&quot;, &quot;documents_scanned&quot;: &quot;20&quot;, &quot;indexes_entries_scanned&quot;: &quot;10050&quot;, &quot;total_execution_time&quot;: &quot;100.7 msecs&quot; }
1958-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1959-
},
1960-
},
19611950
&quot;transaction&quot;: &quot;A String&quot;, # 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.
19621951
}</pre>
19631952
</div>
@@ -1972,7 +1961,6 @@ <h3>Method Details</h3>
19721961
The object takes the form of:
19731962

19741963
{ # The request for Firestore.RunQuery.
1975-
&quot;mode&quot;: &quot;A String&quot;, # 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.
19761964
&quot;newTransaction&quot;: { # 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.
19771965
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
19781966
&quot;readTime&quot;: &quot;A String&quot;, # 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>
21552143
&quot;done&quot;: True or False, # If present, Firestore has completely finished the request and no more documents will be returned.
21562144
&quot;readTime&quot;: &quot;A String&quot;, # 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.
21572145
&quot;skippedResults&quot;: 42, # The number of results that have been skipped due to an offset between the last response and the current response.
2158-
&quot;stats&quot;: { # 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-
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
2160-
&quot;planInfo&quot;: { # Planning phase information for the query. It will include: { &quot;indexes_used&quot;: [ {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(foo ASC, __name__ ASC)&quot;}, {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(bar ASC, __name__ ASC)&quot;} ] }
2161-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
2162-
},
2163-
},
2164-
&quot;queryStats&quot;: { # 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: { &quot;results_returned&quot;: &quot;20&quot;, &quot;documents_scanned&quot;: &quot;20&quot;, &quot;indexes_entries_scanned&quot;: &quot;10050&quot;, &quot;total_execution_time&quot;: &quot;100.7 msecs&quot; }
2165-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
2166-
},
2167-
},
21682146
&quot;transaction&quot;: &quot;A String&quot;, # 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.
21692147
}</pre>
21702148
</div>

docs/dyn/firestore_v1beta1.projects.databases.documents.html

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1750,7 +1750,6 @@ <h3>Method Details</h3>
17501750
The object takes the form of:
17511751

17521752
{ # The request for Firestore.RunAggregationQuery.
1753-
&quot;mode&quot;: &quot;A String&quot;, # 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.
17541753
&quot;newTransaction&quot;: { # 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.
17551754
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
17561755
&quot;readTime&quot;: &quot;A String&quot;, # 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>
19481947
},
19491948
},
19501949
},
1951-
&quot;stats&quot;: { # 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-
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
1953-
&quot;planInfo&quot;: { # Planning phase information for the query. It will include: { &quot;indexes_used&quot;: [ {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(foo ASC, __name__ ASC)&quot;}, {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(bar ASC, __name__ ASC)&quot;} ] }
1954-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1955-
},
1956-
},
1957-
&quot;queryStats&quot;: { # 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: { &quot;results_returned&quot;: &quot;20&quot;, &quot;documents_scanned&quot;: &quot;20&quot;, &quot;indexes_entries_scanned&quot;: &quot;10050&quot;, &quot;total_execution_time&quot;: &quot;100.7 msecs&quot; }
1958-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1959-
},
1960-
},
19611950
&quot;transaction&quot;: &quot;A String&quot;, # 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.
19621951
}</pre>
19631952
</div>
@@ -1972,7 +1961,6 @@ <h3>Method Details</h3>
19721961
The object takes the form of:
19731962

19741963
{ # The request for Firestore.RunQuery.
1975-
&quot;mode&quot;: &quot;A String&quot;, # 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.
19761964
&quot;newTransaction&quot;: { # 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.
19771965
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
19781966
&quot;readTime&quot;: &quot;A String&quot;, # 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>
21552143
&quot;done&quot;: True or False, # If present, Firestore has completely finished the request and no more documents will be returned.
21562144
&quot;readTime&quot;: &quot;A String&quot;, # 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.
21572145
&quot;skippedResults&quot;: 42, # The number of results that have been skipped due to an offset between the last response and the current response.
2158-
&quot;stats&quot;: { # 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-
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
2160-
&quot;planInfo&quot;: { # Planning phase information for the query. It will include: { &quot;indexes_used&quot;: [ {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(foo ASC, __name__ ASC)&quot;}, {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(bar ASC, __name__ ASC)&quot;} ] }
2161-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
2162-
},
2163-
},
2164-
&quot;queryStats&quot;: { # 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: { &quot;results_returned&quot;: &quot;20&quot;, &quot;documents_scanned&quot;: &quot;20&quot;, &quot;indexes_entries_scanned&quot;: &quot;10050&quot;, &quot;total_execution_time&quot;: &quot;100.7 msecs&quot; }
2165-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
2166-
},
2167-
},
21682146
&quot;transaction&quot;: &quot;A String&quot;, # 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.
21692147
}</pre>
21702148
</div>

googleapiclient/discovery_cache/documents/firestore.v1.json

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1672,7 +1672,7 @@
16721672
}
16731673
}
16741674
},
1675-
"revision": "20240117",
1675+
"revision": "20240131",
16761676
"rootUrl": "https://firestore.googleapis.com/",
16771677
"schemas": {
16781678
"Aggregation": {
@@ -3712,21 +3712,6 @@
37123712
},
37133713
"type": "object"
37143714
},
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-
},
37303715
"QueryTarget": {
37313716
"description": "A target specified by a query.",
37323717
"id": "QueryTarget",
@@ -3766,25 +3751,6 @@
37663751
},
37673752
"type": "object"
37683753
},
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-
},
37883754
"RollbackRequest": {
37893755
"description": "The request for Firestore.Rollback.",
37903756
"id": "RollbackRequest",
@@ -3801,20 +3767,6 @@
38013767
"description": "The request for Firestore.RunAggregationQuery.",
38023768
"id": "RunAggregationQueryRequest",
38033769
"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-
},
38183770
"newTransaction": {
38193771
"$ref": "TransactionOptions",
38203772
"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 @@
38493801
"$ref": "AggregationResult",
38503802
"description": "A single aggregation result. Not present when reporting partial progress."
38513803
},
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-
},
38563804
"transaction": {
38573805
"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.",
38583806
"format": "byte",
@@ -3865,20 +3813,6 @@
38653813
"description": "The request for Firestore.RunQuery.",
38663814
"id": "RunQueryRequest",
38673815
"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-
},
38823816
"newTransaction": {
38833817
"$ref": "TransactionOptions",
38843818
"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 @@
39223856
"format": "int32",
39233857
"type": "integer"
39243858
},
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-
},
39293859
"transaction": {
39303860
"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.",
39313861
"format": "byte",

0 commit comments

Comments
 (0)