google-cloud-datastore-v1 0.17.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/datastore/v1/datastore/client.rb +8 -2
- data/lib/google/cloud/datastore/v1/datastore/rest/client.rb +8 -2
- data/lib/google/cloud/datastore/v1/version.rb +1 -1
- data/lib/google/datastore/v1/datastore_pb.rb +3 -1
- data/lib/google/datastore/v1/query_profile_pb.rb +51 -0
- data/proto_docs/google/api/client.rb +4 -0
- data/proto_docs/google/datastore/v1/datastore.rb +18 -0
- data/proto_docs/google/datastore/v1/query_profile.rb +98 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 44007e25783b192f7921848ad1c44de61a240582f61107ead054b9e139942874
|
4
|
+
data.tar.gz: '0619912f9cbcdde1286c52702968d1c746cb51c7dd4f394471424ca042215f27'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d1e3ddc4901856b34ce35974a66479e35a1f97cbcf0ca804c7e9a2510651feb089e8245208e232b32e236114511a4eb1b265a4437aee1aadac158b4860ff519b
|
7
|
+
data.tar.gz: 771cc35194a02fbb97e9d307d2d1a04742d310926d1a644c0f4f5f570a7f6648fc63fe1ebbb8e21a92c21019511c1a49ecb1bb12b138f65abd322ac372724b17
|
@@ -301,7 +301,7 @@ module Google
|
|
301
301
|
# @param options [::Gapic::CallOptions, ::Hash]
|
302
302
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
303
303
|
#
|
304
|
-
# @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil)
|
304
|
+
# @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil, explain_options: nil)
|
305
305
|
# Pass arguments to `run_query` via keyword arguments. Note that at
|
306
306
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
307
307
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -324,6 +324,9 @@ module Google
|
|
324
324
|
# The query to run.
|
325
325
|
# @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
|
326
326
|
# The GQL query to run. This query must be a non-aggregation query.
|
327
|
+
# @param explain_options [::Google::Cloud::Datastore::V1::ExplainOptions, ::Hash]
|
328
|
+
# Optional. Explain options for the query. If set, additional query
|
329
|
+
# statistics will be returned. If not, only query results will be returned.
|
327
330
|
#
|
328
331
|
# @yield [response, operation] Access the result along with the RPC operation
|
329
332
|
# @yieldparam response [::Google::Cloud::Datastore::V1::RunQueryResponse]
|
@@ -405,7 +408,7 @@ module Google
|
|
405
408
|
# @param options [::Gapic::CallOptions, ::Hash]
|
406
409
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
407
410
|
#
|
408
|
-
# @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil)
|
411
|
+
# @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil, explain_options: nil)
|
409
412
|
# Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
|
410
413
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
411
414
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -428,6 +431,9 @@ module Google
|
|
428
431
|
# The query to run.
|
429
432
|
# @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
|
430
433
|
# The GQL query to run. This query must be an aggregation query.
|
434
|
+
# @param explain_options [::Google::Cloud::Datastore::V1::ExplainOptions, ::Hash]
|
435
|
+
# Optional. Explain options for the query. If set, additional query
|
436
|
+
# statistics will be returned. If not, only query results will be returned.
|
431
437
|
#
|
432
438
|
# @yield [response, operation] Access the result along with the RPC operation
|
433
439
|
# @yieldparam response [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
|
@@ -284,7 +284,7 @@ module Google
|
|
284
284
|
# @param options [::Gapic::CallOptions, ::Hash]
|
285
285
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
286
286
|
#
|
287
|
-
# @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil)
|
287
|
+
# @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil, explain_options: nil)
|
288
288
|
# Pass arguments to `run_query` via keyword arguments. Note that at
|
289
289
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
290
290
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -307,6 +307,9 @@ module Google
|
|
307
307
|
# The query to run.
|
308
308
|
# @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
|
309
309
|
# The GQL query to run. This query must be a non-aggregation query.
|
310
|
+
# @param explain_options [::Google::Cloud::Datastore::V1::ExplainOptions, ::Hash]
|
311
|
+
# Optional. Explain options for the query. If set, additional query
|
312
|
+
# statistics will be returned. If not, only query results will be returned.
|
310
313
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
311
314
|
# @yieldparam result [::Google::Cloud::Datastore::V1::RunQueryResponse]
|
312
315
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -378,7 +381,7 @@ module Google
|
|
378
381
|
# @param options [::Gapic::CallOptions, ::Hash]
|
379
382
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
380
383
|
#
|
381
|
-
# @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil)
|
384
|
+
# @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil, explain_options: nil)
|
382
385
|
# Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
|
383
386
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
384
387
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -401,6 +404,9 @@ module Google
|
|
401
404
|
# The query to run.
|
402
405
|
# @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
|
403
406
|
# The GQL query to run. This query must be an aggregation query.
|
407
|
+
# @param explain_options [::Google::Cloud::Datastore::V1::ExplainOptions, ::Hash]
|
408
|
+
# Optional. Explain options for the query. If set, additional query
|
409
|
+
# statistics will be returned. If not, only query results will be returned.
|
404
410
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
405
411
|
# @yieldparam result [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
|
406
412
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -11,10 +11,11 @@ require 'google/api/routing_pb'
|
|
11
11
|
require 'google/datastore/v1/aggregation_result_pb'
|
12
12
|
require 'google/datastore/v1/entity_pb'
|
13
13
|
require 'google/datastore/v1/query_pb'
|
14
|
+
require 'google/datastore/v1/query_profile_pb'
|
14
15
|
require 'google/protobuf/timestamp_pb'
|
15
16
|
|
16
17
|
|
17
|
-
descriptor_data = "\n#google/datastore/v1/datastore.proto\x12\x13google.datastore.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x18google/api/routing.proto\x1a,google/datastore/v1/aggregation_result.proto\x1a google/datastore/v1/entity.proto\x1a\x1fgoogle/datastore/v1/query.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xa2\x01\n\rLookupRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x04keys\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\xe6\x01\n\x0eLookupResponse\x12\x30\n\x05\x66ound\x18\x01 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12\x32\n\x07missing\x18\x02 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12*\n\x08\x64\x65\x66\x65rred\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.Key\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12-\n\tread_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\
|
18
|
+
descriptor_data = "\n#google/datastore/v1/datastore.proto\x12\x13google.datastore.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x18google/api/routing.proto\x1a,google/datastore/v1/aggregation_result.proto\x1a google/datastore/v1/entity.proto\x1a\x1fgoogle/datastore/v1/query.proto\x1a\'google/datastore/v1/query_profile.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xa2\x01\n\rLookupRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x04keys\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\xe6\x01\n\x0eLookupResponse\x12\x30\n\x05\x66ound\x18\x01 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12\x32\n\x07missing\x18\x02 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12*\n\x08\x64\x65\x66\x65rred\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.Key\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12-\n\tread_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\xe1\x02\n\x0fRunQueryRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cpartition_id\x18\x02 \x01(\x0b\x32 .google.datastore.v1.PartitionId\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x05query\x18\x03 \x01(\x0b\x32\x1a.google.datastore.v1.QueryH\x00\x12\x32\n\tgql_query\x18\x07 \x01(\x0b\x32\x1d.google.datastore.v1.GqlQueryH\x00\x12\x41\n\x0f\x65xplain_options\x18\x0c \x01(\x0b\x32#.google.datastore.v1.ExplainOptionsB\x03\xe0\x41\x01\x42\x0c\n\nquery_type\"\xc6\x01\n\x10RunQueryResponse\x12\x34\n\x05\x62\x61tch\x18\x01 \x01(\x0b\x32%.google.datastore.v1.QueryResultBatch\x12)\n\x05query\x18\x02 \x01(\x0b\x32\x1a.google.datastore.v1.Query\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12<\n\x0f\x65xplain_metrics\x18\t \x01(\x0b\x32#.google.datastore.v1.ExplainMetrics\"\x83\x03\n\x1aRunAggregationQueryRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cpartition_id\x18\x02 \x01(\x0b\x32 .google.datastore.v1.PartitionId\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12\x42\n\x11\x61ggregation_query\x18\x03 \x01(\x0b\x32%.google.datastore.v1.AggregationQueryH\x00\x12\x32\n\tgql_query\x18\x07 \x01(\x0b\x32\x1d.google.datastore.v1.GqlQueryH\x00\x12\x41\n\x0f\x65xplain_options\x18\x0b \x01(\x0b\x32#.google.datastore.v1.ExplainOptionsB\x03\xe0\x41\x01\x42\x0c\n\nquery_type\"\xe2\x01\n\x1bRunAggregationQueryResponse\x12:\n\x05\x62\x61tch\x18\x01 \x01(\x0b\x32+.google.datastore.v1.AggregationResultBatch\x12\x34\n\x05query\x18\x02 \x01(\x0b\x32%.google.datastore.v1.AggregationQuery\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12<\n\x0f\x65xplain_metrics\x18\t \x01(\x0b\x32#.google.datastore.v1.ExplainMetrics\"\x8d\x01\n\x17\x42\x65ginTransactionRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x44\n\x13transaction_options\x18\n \x01(\x0b\x32\'.google.datastore.v1.TransactionOptions\"/\n\x18\x42\x65ginTransactionResponse\x12\x13\n\x0btransaction\x18\x01 \x01(\x0c\"Y\n\x0fRollbackRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x18\n\x0btransaction\x18\x01 \x01(\x0c\x42\x03\xe0\x41\x02\"\x12\n\x10RollbackResponse\"\xe8\x02\n\rCommitRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x35\n\x04mode\x18\x05 \x01(\x0e\x32\'.google.datastore.v1.CommitRequest.Mode\x12\x15\n\x0btransaction\x18\x01 \x01(\x0cH\x00\x12I\n\x16single_use_transaction\x18\n \x01(\x0b\x32\'.google.datastore.v1.TransactionOptionsH\x00\x12\x30\n\tmutations\x18\x06 \x03(\x0b\x32\x1d.google.datastore.v1.Mutation\"F\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x11\n\rTRANSACTIONAL\x10\x01\x12\x15\n\x11NON_TRANSACTIONAL\x10\x02\x42\x16\n\x14transaction_selector\"\x97\x01\n\x0e\x43ommitResponse\x12=\n\x10mutation_results\x18\x03 \x03(\x0b\x32#.google.datastore.v1.MutationResult\x12\x15\n\rindex_updates\x18\x04 \x01(\x05\x12/\n\x0b\x63ommit_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"o\n\x12\x41llocateIdsRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12+\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"=\n\x13\x41llocateIdsResponse\x12&\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.Key\"n\n\x11ReserveIdsRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12+\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\x14\n\x12ReserveIdsResponse\"\xba\x02\n\x08Mutation\x12-\n\x06insert\x18\x04 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12-\n\x06update\x18\x05 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12-\n\x06upsert\x18\x06 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12*\n\x06\x64\x65lete\x18\x07 \x01(\x0b\x32\x18.google.datastore.v1.KeyH\x00\x12\x16\n\x0c\x62\x61se_version\x18\x08 \x01(\x03H\x01\x12\x31\n\x0bupdate_time\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x01\x42\x0b\n\toperationB\x1d\n\x1b\x63onflict_detection_strategy\"\xc5\x01\n\x0eMutationResult\x12%\n\x03key\x18\x03 \x01(\x0b\x32\x18.google.datastore.v1.Key\x12\x0f\n\x07version\x18\x04 \x01(\x03\x12/\n\x0b\x63reate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x19\n\x11\x63onflict_detected\x18\x05 \x01(\x08\"\xca\x02\n\x0bReadOptions\x12L\n\x10read_consistency\x18\x01 \x01(\x0e\x32\x30.google.datastore.v1.ReadOptions.ReadConsistencyH\x00\x12\x15\n\x0btransaction\x18\x02 \x01(\x0cH\x00\x12\x42\n\x0fnew_transaction\x18\x03 \x01(\x0b\x32\'.google.datastore.v1.TransactionOptionsH\x00\x12/\n\tread_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\"M\n\x0fReadConsistency\x12 \n\x1cREAD_CONSISTENCY_UNSPECIFIED\x10\x00\x12\n\n\x06STRONG\x10\x01\x12\x0c\n\x08\x45VENTUAL\x10\x02\x42\x12\n\x10\x63onsistency_type\"\x92\x02\n\x12TransactionOptions\x12G\n\nread_write\x18\x01 \x01(\x0b\x32\x31.google.datastore.v1.TransactionOptions.ReadWriteH\x00\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.datastore.v1.TransactionOptions.ReadOnlyH\x00\x1a)\n\tReadWrite\x12\x1c\n\x14previous_transaction\x18\x01 \x01(\x0c\x1a\x39\n\x08ReadOnly\x12-\n\tread_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\n\x04mode2\xe1\r\n\tDatastore\x12\xc0\x01\n\x06Lookup\x12\".google.datastore.v1.LookupRequest\x1a#.google.datastore.v1.LookupResponse\"m\xda\x41\x1cproject_id,read_options,keys\x82\xd3\xe4\x93\x02%\" /v1/projects/{project_id}:lookup:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xa9\x01\n\x08RunQuery\x12$.google.datastore.v1.RunQueryRequest\x1a%.google.datastore.v1.RunQueryResponse\"P\x82\xd3\xe4\x93\x02\'\"\"/v1/projects/{project_id}:runQuery:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xd5\x01\n\x13RunAggregationQuery\x12/.google.datastore.v1.RunAggregationQueryRequest\x1a\x30.google.datastore.v1.RunAggregationQueryResponse\"[\x82\xd3\xe4\x93\x02\x32\"-/v1/projects/{project_id}:runAggregationQuery:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xd6\x01\n\x10\x42\x65ginTransaction\x12,.google.datastore.v1.BeginTransactionRequest\x1a-.google.datastore.v1.BeginTransactionResponse\"e\xda\x41\nproject_id\x82\xd3\xe4\x93\x02/\"*/v1/projects/{project_id}:beginTransaction:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xe6\x01\n\x06\x43ommit\x12\".google.datastore.v1.CommitRequest\x1a#.google.datastore.v1.CommitResponse\"\x92\x01\xda\x41%project_id,mode,transaction,mutations\xda\x41\x19project_id,mode,mutations\x82\xd3\xe4\x93\x02%\" /v1/projects/{project_id}:commit:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xc2\x01\n\x08Rollback\x12$.google.datastore.v1.RollbackRequest\x1a%.google.datastore.v1.RollbackResponse\"i\xda\x41\x16project_id,transaction\x82\xd3\xe4\x93\x02\'\"\"/v1/projects/{project_id}:rollback:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xc7\x01\n\x0b\x41llocateIds\x12\'.google.datastore.v1.AllocateIdsRequest\x1a(.google.datastore.v1.AllocateIdsResponse\"e\xda\x41\x0fproject_id,keys\x82\xd3\xe4\x93\x02*\"%/v1/projects/{project_id}:allocateIds:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xc3\x01\n\nReserveIds\x12&.google.datastore.v1.ReserveIdsRequest\x1a\'.google.datastore.v1.ReserveIdsResponse\"d\xda\x41\x0fproject_id,keys\x82\xd3\xe4\x93\x02)\"$/v1/projects/{project_id}:reserveIds:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x1av\xca\x41\x18\x64\x61tastore.googleapis.com\xd2\x41Xhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/datastoreB\xc0\x01\n\x17\x63om.google.datastore.v1B\x0e\x44\x61tastoreProtoP\x01Z<google.golang.org/genproto/googleapis/datastore/v1;datastore\xaa\x02\x19Google.Cloud.Datastore.V1\xca\x02\x19Google\\Cloud\\Datastore\\V1\xea\x02\x1cGoogle::Cloud::Datastore::V1b\x06proto3"
|
18
19
|
|
19
20
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
20
21
|
|
@@ -32,6 +33,7 @@ rescue TypeError
|
|
32
33
|
["google.datastore.v1.Key", "google/datastore/v1/entity.proto"],
|
33
34
|
["google.datastore.v1.EntityResult", "google/datastore/v1/query.proto"],
|
34
35
|
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
36
|
+
["google.datastore.v1.ExplainOptions", "google/datastore/v1/query_profile.proto"],
|
35
37
|
["google.datastore.v1.AggregationResultBatch", "google/datastore/v1/aggregation_result.proto"],
|
36
38
|
]
|
37
39
|
imports.each do |type_name, expected_filename|
|
@@ -0,0 +1,51 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/datastore/v1/query_profile.proto
|
4
|
+
|
5
|
+
require 'google/protobuf'
|
6
|
+
|
7
|
+
require 'google/api/field_behavior_pb'
|
8
|
+
require 'google/protobuf/duration_pb'
|
9
|
+
require 'google/protobuf/struct_pb'
|
10
|
+
|
11
|
+
|
12
|
+
descriptor_data = "\n\'google/datastore/v1/query_profile.proto\x12\x13google.datastore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1cgoogle/protobuf/struct.proto\"&\n\x0e\x45xplainOptions\x12\x14\n\x07\x61nalyze\x18\x01 \x01(\x08\x42\x03\xe0\x41\x01\"\x86\x01\n\x0e\x45xplainMetrics\x12\x36\n\x0cplan_summary\x18\x01 \x01(\x0b\x32 .google.datastore.v1.PlanSummary\x12<\n\x0f\x65xecution_stats\x18\x02 \x01(\x0b\x32#.google.datastore.v1.ExecutionStats\"<\n\x0bPlanSummary\x12-\n\x0cindexes_used\x18\x01 \x03(\x0b\x32\x17.google.protobuf.Struct\"\xa8\x01\n\x0e\x45xecutionStats\x12\x18\n\x10results_returned\x18\x01 \x01(\x03\x12\x35\n\x12\x65xecution_duration\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x17\n\x0fread_operations\x18\x04 \x01(\x03\x12,\n\x0b\x64\x65\x62ug_stats\x18\x05 \x01(\x0b\x32\x17.google.protobuf.StructB\xc3\x01\n\x17\x63om.google.datastore.v1B\x11QueryProfileProtoP\x01Z<google.golang.org/genproto/googleapis/datastore/v1;datastore\xaa\x02\x19Google.Cloud.Datastore.V1\xca\x02\x19Google\\Cloud\\Datastore\\V1\xea\x02\x1cGoogle::Cloud::Datastore::V1b\x06proto3"
|
13
|
+
|
14
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
15
|
+
|
16
|
+
begin
|
17
|
+
pool.add_serialized_file(descriptor_data)
|
18
|
+
rescue TypeError
|
19
|
+
# Compatibility code: will be removed in the next major version.
|
20
|
+
require 'google/protobuf/descriptor_pb'
|
21
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
22
|
+
parsed.clear_dependency
|
23
|
+
serialized = parsed.class.encode(parsed)
|
24
|
+
file = pool.add_serialized_file(serialized)
|
25
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
26
|
+
imports = [
|
27
|
+
["google.protobuf.Struct", "google/protobuf/struct.proto"],
|
28
|
+
["google.protobuf.Duration", "google/protobuf/duration.proto"],
|
29
|
+
]
|
30
|
+
imports.each do |type_name, expected_filename|
|
31
|
+
import_file = pool.lookup(type_name).file_descriptor
|
32
|
+
if import_file.name != expected_filename
|
33
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
34
|
+
end
|
35
|
+
end
|
36
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
37
|
+
warn "This will become an error in the next major version."
|
38
|
+
end
|
39
|
+
|
40
|
+
module Google
|
41
|
+
module Cloud
|
42
|
+
module Datastore
|
43
|
+
module V1
|
44
|
+
ExplainOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ExplainOptions").msgclass
|
45
|
+
ExplainMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ExplainMetrics").msgclass
|
46
|
+
PlanSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.PlanSummary").msgclass
|
47
|
+
ExecutionStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ExecutionStats").msgclass
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -118,6 +118,10 @@ module Google
|
|
118
118
|
# @return [::String]
|
119
119
|
# Optional link to proto reference documentation. Example:
|
120
120
|
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
121
|
+
# @!attribute [rw] rest_reference_documentation_uri
|
122
|
+
# @return [::String]
|
123
|
+
# Optional link to REST reference documentation. Example:
|
124
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rest
|
121
125
|
class Publishing
|
122
126
|
include ::Google::Protobuf::MessageExts
|
123
127
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -100,6 +100,10 @@ module Google
|
|
100
100
|
# @!attribute [rw] gql_query
|
101
101
|
# @return [::Google::Cloud::Datastore::V1::GqlQuery]
|
102
102
|
# The GQL query to run. This query must be a non-aggregation query.
|
103
|
+
# @!attribute [rw] explain_options
|
104
|
+
# @return [::Google::Cloud::Datastore::V1::ExplainOptions]
|
105
|
+
# Optional. Explain options for the query. If set, additional query
|
106
|
+
# statistics will be returned. If not, only query results will be returned.
|
103
107
|
class RunQueryRequest
|
104
108
|
include ::Google::Protobuf::MessageExts
|
105
109
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -122,6 +126,11 @@ module Google
|
|
122
126
|
# {::Google::Cloud::Datastore::V1::ReadOptions#new_transaction ReadOptions.new_transaction}
|
123
127
|
# was set in
|
124
128
|
# {::Google::Cloud::Datastore::V1::RunQueryRequest#read_options RunQueryRequest.read_options}.
|
129
|
+
# @!attribute [rw] explain_metrics
|
130
|
+
# @return [::Google::Cloud::Datastore::V1::ExplainMetrics]
|
131
|
+
# Query explain metrics. This is only present when the
|
132
|
+
# {::Google::Cloud::Datastore::V1::RunQueryRequest#explain_options RunQueryRequest.explain_options}
|
133
|
+
# is provided, and it is sent only once with the last response in the stream.
|
125
134
|
class RunQueryResponse
|
126
135
|
include ::Google::Protobuf::MessageExts
|
127
136
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -153,6 +162,10 @@ module Google
|
|
153
162
|
# @!attribute [rw] gql_query
|
154
163
|
# @return [::Google::Cloud::Datastore::V1::GqlQuery]
|
155
164
|
# The GQL query to run. This query must be an aggregation query.
|
165
|
+
# @!attribute [rw] explain_options
|
166
|
+
# @return [::Google::Cloud::Datastore::V1::ExplainOptions]
|
167
|
+
# Optional. Explain options for the query. If set, additional query
|
168
|
+
# statistics will be returned. If not, only query results will be returned.
|
156
169
|
class RunAggregationQueryRequest
|
157
170
|
include ::Google::Protobuf::MessageExts
|
158
171
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -175,6 +188,11 @@ module Google
|
|
175
188
|
# {::Google::Cloud::Datastore::V1::ReadOptions#new_transaction ReadOptions.new_transaction}
|
176
189
|
# was set in
|
177
190
|
# {::Google::Cloud::Datastore::V1::RunAggregationQueryRequest#read_options RunAggregationQueryRequest.read_options}.
|
191
|
+
# @!attribute [rw] explain_metrics
|
192
|
+
# @return [::Google::Cloud::Datastore::V1::ExplainMetrics]
|
193
|
+
# Query explain metrics. This is only present when the
|
194
|
+
# {::Google::Cloud::Datastore::V1::RunAggregationQueryRequest#explain_options RunAggregationQueryRequest.explain_options}
|
195
|
+
# is provided, and it is sent only once with the last response in the stream.
|
178
196
|
class RunAggregationQueryResponse
|
179
197
|
include ::Google::Protobuf::MessageExts
|
180
198
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -0,0 +1,98 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Datastore
|
23
|
+
module V1
|
24
|
+
# Explain options for the query.
|
25
|
+
# @!attribute [rw] analyze
|
26
|
+
# @return [::Boolean]
|
27
|
+
# Optional. Whether to execute this query.
|
28
|
+
#
|
29
|
+
# When false (the default), the query will be planned, returning only
|
30
|
+
# metrics from the planning stages.
|
31
|
+
#
|
32
|
+
# When true, the query will be planned and executed, returning the full
|
33
|
+
# query results along with both planning and execution stage metrics.
|
34
|
+
class ExplainOptions
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
end
|
38
|
+
|
39
|
+
# Explain metrics for the query.
|
40
|
+
# @!attribute [rw] plan_summary
|
41
|
+
# @return [::Google::Cloud::Datastore::V1::PlanSummary]
|
42
|
+
# Planning phase information for the query.
|
43
|
+
# @!attribute [rw] execution_stats
|
44
|
+
# @return [::Google::Cloud::Datastore::V1::ExecutionStats]
|
45
|
+
# Aggregated stats from the execution of the query. Only present when
|
46
|
+
# {::Google::Cloud::Datastore::V1::ExplainOptions#analyze ExplainOptions.analyze} is set
|
47
|
+
# to true.
|
48
|
+
class ExplainMetrics
|
49
|
+
include ::Google::Protobuf::MessageExts
|
50
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
51
|
+
end
|
52
|
+
|
53
|
+
# Planning phase information for the query.
|
54
|
+
# @!attribute [rw] indexes_used
|
55
|
+
# @return [::Array<::Google::Protobuf::Struct>]
|
56
|
+
# The indexes selected for the query. For example:
|
57
|
+
# [
|
58
|
+
# \\{"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
|
59
|
+
# \\{"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
|
60
|
+
# ]
|
61
|
+
class PlanSummary
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
|
66
|
+
# Execution statistics for the query.
|
67
|
+
# @!attribute [rw] results_returned
|
68
|
+
# @return [::Integer]
|
69
|
+
# Total number of results returned, including documents, projections,
|
70
|
+
# aggregation results, keys.
|
71
|
+
# @!attribute [rw] execution_duration
|
72
|
+
# @return [::Google::Protobuf::Duration]
|
73
|
+
# Total time to execute the query in the backend.
|
74
|
+
# @!attribute [rw] read_operations
|
75
|
+
# @return [::Integer]
|
76
|
+
# Total billable read operations.
|
77
|
+
# @!attribute [rw] debug_stats
|
78
|
+
# @return [::Google::Protobuf::Struct]
|
79
|
+
# Debugging statistics from the execution of the query. Note that the
|
80
|
+
# debugging stats are subject to change as Firestore evolves. It could
|
81
|
+
# include:
|
82
|
+
# {
|
83
|
+
# "indexes_entries_scanned": "1000",
|
84
|
+
# "documents_scanned": "20",
|
85
|
+
# "billing_details" : {
|
86
|
+
# "documents_billable": "20",
|
87
|
+
# "index_entries_billable": "1000",
|
88
|
+
# "min_query_cost": "0"
|
89
|
+
# }
|
90
|
+
# }
|
91
|
+
class ExecutionStats
|
92
|
+
include ::Google::Protobuf::MessageExts
|
93
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-datastore-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.18.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-03-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -72,6 +72,7 @@ files:
|
|
72
72
|
- lib/google/datastore/v1/datastore_services_pb.rb
|
73
73
|
- lib/google/datastore/v1/entity_pb.rb
|
74
74
|
- lib/google/datastore/v1/query_pb.rb
|
75
|
+
- lib/google/datastore/v1/query_profile_pb.rb
|
75
76
|
- proto_docs/README.md
|
76
77
|
- proto_docs/google/api/client.rb
|
77
78
|
- proto_docs/google/api/field_behavior.rb
|
@@ -82,6 +83,7 @@ files:
|
|
82
83
|
- proto_docs/google/datastore/v1/datastore.rb
|
83
84
|
- proto_docs/google/datastore/v1/entity.rb
|
84
85
|
- proto_docs/google/datastore/v1/query.rb
|
86
|
+
- proto_docs/google/datastore/v1/query_profile.rb
|
85
87
|
- proto_docs/google/protobuf/duration.rb
|
86
88
|
- proto_docs/google/protobuf/struct.rb
|
87
89
|
- proto_docs/google/protobuf/timestamp.rb
|