Skip to content

Commit d7dd78b

Browse files
yoshi-automationyoshi-automation
committed
feat(datastore): update the api
#### datastore:v1 The following keys were added: - 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) #### datastore:v1beta3 The following keys were added: - 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 284d912 commit d7dd78b

File tree

5 files changed

+187
-3
lines changed

5 files changed

+187
-3
lines changed

‎docs/dyn/datastore_v1.projects.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,6 +1014,7 @@ <h3>Method Details</h3>
10141014
],
10151015
&quot;queryString&quot;: &quot;A String&quot;, # A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
10161016
},
1017+
&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.
10171018
&quot;partitionId&quot;: { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `&quot;&quot;`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
10181019
&quot;databaseId&quot;: &quot;A String&quot;, # If not empty, the ID of the database to which the entities belong.
10191020
&quot;namespaceId&quot;: &quot;A String&quot;, # If not empty, the ID of the namespace to which the entities belong.
@@ -1188,6 +1189,16 @@ <h3>Method Details</h3>
11881189
&quot;startCursor&quot;: &quot;A String&quot;, # A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
11891190
},
11901191
},
1192+
&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`.
1193+
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
1194+
&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;} ] }
1195+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1196+
},
1197+
},
1198+
&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; }
1199+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1200+
},
1201+
},
11911202
&quot;transaction&quot;: &quot;A String&quot;, # The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.
11921203
}</pre>
11931204
</div>
@@ -1287,6 +1298,7 @@ <h3>Method Details</h3>
12871298
],
12881299
&quot;queryString&quot;: &quot;A String&quot;, # A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
12891300
},
1301+
&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.
12901302
&quot;partitionId&quot;: { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `&quot;&quot;`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
12911303
&quot;databaseId&quot;: &quot;A String&quot;, # If not empty, the ID of the database to which the entities belong.
12921304
&quot;namespaceId&quot;: &quot;A String&quot;, # If not empty, the ID of the namespace to which the entities belong.
@@ -1546,6 +1558,16 @@ <h3>Method Details</h3>
15461558
],
15471559
&quot;startCursor&quot;: &quot;A String&quot;, # A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
15481560
},
1561+
&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`.
1562+
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
1563+
&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;} ] }
1564+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1565+
},
1566+
},
1567+
&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; }
1568+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1569+
},
1570+
},
15491571
&quot;transaction&quot;: &quot;A String&quot;, # The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.
15501572
}</pre>
15511573
</div>

‎docs/dyn/datastore_v1beta3.projects.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -849,6 +849,7 @@ <h3>Method Details</h3>
849849
],
850850
&quot;queryString&quot;: &quot;A String&quot;, # A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
851851
},
852+
&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.
852853
&quot;partitionId&quot;: { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `&quot;&quot;`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
853854
&quot;namespaceId&quot;: &quot;A String&quot;, # If not empty, the ID of the namespace to which the entities belong.
854855
&quot;projectId&quot;: &quot;A String&quot;, # The ID of the project to which the entities belong.
@@ -1012,6 +1013,16 @@ <h3>Method Details</h3>
10121013
&quot;startCursor&quot;: &quot;A String&quot;, # A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
10131014
},
10141015
},
1016+
&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`.
1017+
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
1018+
&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;} ] }
1019+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1020+
},
1021+
},
1022+
&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; }
1023+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1024+
},
1025+
},
10151026
}</pre>
10161027
</div>
10171028

@@ -1107,6 +1118,7 @@ <h3>Method Details</h3>
11071118
],
11081119
&quot;queryString&quot;: &quot;A String&quot;, # A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
11091120
},
1121+
&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.
11101122
&quot;partitionId&quot;: { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `&quot;&quot;`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
11111123
&quot;namespaceId&quot;: &quot;A String&quot;, # If not empty, the ID of the namespace to which the entities belong.
11121124
&quot;projectId&quot;: &quot;A String&quot;, # The ID of the project to which the entities belong.
@@ -1353,6 +1365,16 @@ <h3>Method Details</h3>
13531365
],
13541366
&quot;startCursor&quot;: &quot;A String&quot;, # A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
13551367
},
1368+
&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`.
1369+
&quot;queryPlan&quot;: { # Plan for the query. # Plan for the query.
1370+
&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;} ] }
1371+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1372+
},
1373+
},
1374+
&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; }
1375+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1376+
},
1377+
},
13561378
}</pre>
13571379
</div>
13581380

‎googleapiclient/discovery_cache/documents/datastore.v1.json

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@
654654
}
655655
}
656656
},
657-
"revision": "20231221",
657+
"revision": "20240117",
658658
"rootUrl": "https://datastore.googleapis.com/",
659659
"schemas": {
660660
"Aggregation": {
@@ -2119,6 +2119,21 @@
21192119
},
21202120
"type": "object"
21212121
},
2122+
"QueryPlan": {
2123+
"description": "Plan for the query.",
2124+
"id": "QueryPlan",
2125+
"properties": {
2126+
"planInfo": {
2127+
"additionalProperties": {
2128+
"description": "Properties of the object.",
2129+
"type": "any"
2130+
},
2131+
"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)\"} ] }",
2132+
"type": "object"
2133+
}
2134+
},
2135+
"type": "object"
2136+
},
21222137
"QueryResultBatch": {
21232138
"description": "A batch of results produced by a query.",
21242139
"id": "QueryResultBatch",
@@ -2275,6 +2290,25 @@
22752290
"properties": {},
22762291
"type": "object"
22772292
},
2293+
"ResultSetStats": {
2294+
"description": "Planning and execution statistics for the query.",
2295+
"id": "ResultSetStats",
2296+
"properties": {
2297+
"queryPlan": {
2298+
"$ref": "QueryPlan",
2299+
"description": "Plan for the query."
2300+
},
2301+
"queryStats": {
2302+
"additionalProperties": {
2303+
"description": "Properties of the object.",
2304+
"type": "any"
2305+
},
2306+
"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\" }",
2307+
"type": "object"
2308+
}
2309+
},
2310+
"type": "object"
2311+
},
22782312
"RollbackRequest": {
22792313
"description": "The request for Datastore.Rollback.",
22802314
"id": "RollbackRequest",
@@ -2313,6 +2347,20 @@
23132347
"$ref": "GqlQuery",
23142348
"description": "The GQL query to run. This query must be an aggregation query."
23152349
},
2350+
"mode": {
2351+
"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.",
2352+
"enum": [
2353+
"NORMAL",
2354+
"PLAN",
2355+
"PROFILE"
2356+
],
2357+
"enumDescriptions": [
2358+
"The default mode. Only the query results are returned.",
2359+
"This mode returns only the query plan, without any results or execution statistics information.",
2360+
"This mode returns both the query plan and the execution statistics along with the results."
2361+
],
2362+
"type": "string"
2363+
},
23162364
"partitionId": {
23172365
"$ref": "PartitionId",
23182366
"description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID."
@@ -2336,6 +2384,10 @@
23362384
"$ref": "AggregationQuery",
23372385
"description": "The parsed form of the `GqlQuery` from the request, if it was set."
23382386
},
2387+
"stats": {
2388+
"$ref": "ResultSetStats",
2389+
"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`."
2390+
},
23392391
"transaction": {
23402392
"description": "The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.",
23412393
"format": "byte",
@@ -2356,6 +2408,20 @@
23562408
"$ref": "GqlQuery",
23572409
"description": "The GQL query to run. This query must be a non-aggregation query."
23582410
},
2411+
"mode": {
2412+
"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.",
2413+
"enum": [
2414+
"NORMAL",
2415+
"PLAN",
2416+
"PROFILE"
2417+
],
2418+
"enumDescriptions": [
2419+
"The default mode. Only the query results are returned.",
2420+
"This mode returns only the query plan, without any results or execution statistics information.",
2421+
"This mode returns both the query plan and the execution statistics along with the results."
2422+
],
2423+
"type": "string"
2424+
},
23592425
"partitionId": {
23602426
"$ref": "PartitionId",
23612427
"description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID."
@@ -2383,6 +2449,10 @@
23832449
"$ref": "Query",
23842450
"description": "The parsed form of the `GqlQuery` from the request, if it was set."
23852451
},
2452+
"stats": {
2453+
"$ref": "ResultSetStats",
2454+
"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`."
2455+
},
23862456
"transaction": {
23872457
"description": "The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.",
23882458
"format": "byte",

‎googleapiclient/discovery_cache/documents/datastore.v1beta1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
}
169169
}
170170
},
171-
"revision": "20231221",
171+
"revision": "20240117",
172172
"rootUrl": "https://datastore.googleapis.com/",
173173
"schemas": {
174174
"GoogleDatastoreAdminV1CommonMetadata": {

0 commit comments

Comments
 (0)