google-cloud-spanner-v1 1.10.0 → 1.10.1

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.
@@ -269,14 +269,14 @@ module Google
269
269
  # transaction internally, and count toward the one transaction
270
270
  # limit.
271
271
  #
272
- # Active sessions use additional server resources, so it is a good idea to
272
+ # Active sessions use additional server resources, so it's a good idea to
273
273
  # delete idle and unneeded sessions.
274
- # Aside from explicit deletes, Cloud Spanner may delete sessions for which no
274
+ # Aside from explicit deletes, Cloud Spanner can delete sessions when no
275
275
  # operations are sent for more than an hour. If a session is deleted,
276
276
  # requests to it return `NOT_FOUND`.
277
277
  #
278
278
  # Idle sessions can be kept alive by sending a trivial SQL query
279
- # periodically, e.g., `"SELECT 1"`.
279
+ # periodically, for example, `"SELECT 1"`.
280
280
  #
281
281
  # @overload create_session(request, options = nil)
282
282
  # Pass arguments to `create_session` via a request object, either of type
@@ -386,12 +386,12 @@ module Google
386
386
  # @param database [::String]
387
387
  # Required. The database in which the new sessions are created.
388
388
  # @param session_template [::Google::Cloud::Spanner::V1::Session, ::Hash]
389
- # Parameters to be applied to each created session.
389
+ # Parameters to apply to each created session.
390
390
  # @param session_count [::Integer]
391
391
  # Required. The number of sessions to be created in this batch call.
392
- # The API may return fewer than the requested number of sessions. If a
392
+ # The API can return fewer than the requested number of sessions. If a
393
393
  # specific number of sessions are desired, the client can make additional
394
- # calls to BatchCreateSessions (adjusting
394
+ # calls to `BatchCreateSessions` (adjusting
395
395
  # {::Google::Cloud::Spanner::V1::BatchCreateSessionsRequest#session_count session_count}
396
396
  # as necessary).
397
397
  #
@@ -460,7 +460,7 @@ module Google
460
460
  end
461
461
 
462
462
  ##
463
- # Gets a session. Returns `NOT_FOUND` if the session does not exist.
463
+ # Gets a session. Returns `NOT_FOUND` if the session doesn't exist.
464
464
  # This is mainly useful for determining whether a session is still
465
465
  # alive.
466
466
  #
@@ -657,9 +657,9 @@ module Google
657
657
  end
658
658
 
659
659
  ##
660
- # Ends a session, releasing server resources associated with it. This will
661
- # asynchronously trigger cancellation of any operations that are running with
662
- # this session.
660
+ # Ends a session, releasing server resources associated with it. This
661
+ # asynchronously triggers the cancellation of any operations that are running
662
+ # with this session.
663
663
  #
664
664
  # @overload delete_session(request, options = nil)
665
665
  # Pass arguments to `delete_session` via a request object, either of type
@@ -745,7 +745,7 @@ module Google
745
745
 
746
746
  ##
747
747
  # Executes an SQL statement, returning all results in a single reply. This
748
- # method cannot be used to return a result set larger than 10 MiB;
748
+ # method can't be used to return a result set larger than 10 MiB;
749
749
  # if the query yields more data than that, the query fails with
750
750
  # a `FAILED_PRECONDITION` error.
751
751
  #
@@ -758,6 +758,9 @@ module Google
758
758
  # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql ExecuteStreamingSql}
759
759
  # instead.
760
760
  #
761
+ # The query string can be SQL or [Graph Query Language
762
+ # (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
763
+ #
761
764
  # @overload execute_sql(request, options = nil)
762
765
  # Pass arguments to `execute_sql` via a request object, either of type
763
766
  # {::Google::Cloud::Spanner::V1::ExecuteSqlRequest} or an equivalent Hash.
@@ -782,7 +785,7 @@ module Google
782
785
  # transaction with strong concurrency.
783
786
  #
784
787
  # Standard DML statements require a read-write transaction. To protect
785
- # against replays, single-use transactions are not supported. The caller
788
+ # against replays, single-use transactions are not supported. The caller
786
789
  # must either supply an existing transaction ID or begin a new transaction.
787
790
  #
788
791
  # Partitioned DML requires an existing Partitioned DML transaction ID.
@@ -796,19 +799,19 @@ module Google
796
799
  # to the naming requirements of identifiers as specified at
797
800
  # https://cloud.google.com/spanner/docs/lexical#identifiers.
798
801
  #
799
- # Parameters can appear anywhere that a literal value is expected. The same
802
+ # Parameters can appear anywhere that a literal value is expected. The same
800
803
  # parameter name can be used more than once, for example:
801
804
  #
802
805
  # `"WHERE id > @msg_id AND id < @msg_id + 100"`
803
806
  #
804
- # It is an error to execute a SQL statement with unbound parameters.
807
+ # It's an error to execute a SQL statement with unbound parameters.
805
808
  # @param param_types [::Hash{::String => ::Google::Cloud::Spanner::V1::Type, ::Hash}]
806
- # It is not always possible for Cloud Spanner to infer the right SQL type
807
- # from a JSON value. For example, values of type `BYTES` and values
809
+ # It isn't always possible for Cloud Spanner to infer the right SQL type
810
+ # from a JSON value. For example, values of type `BYTES` and values
808
811
  # of type `STRING` both appear in
809
812
  # {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#params params} as JSON strings.
810
813
  #
811
- # In these cases, `param_types` can be used to specify the exact
814
+ # In these cases, you can use `param_types` to specify the exact
812
815
  # SQL type for some or all of the SQL statement parameters. See the
813
816
  # definition of {::Google::Cloud::Spanner::V1::Type Type} for more information
814
817
  # about SQL types.
@@ -827,19 +830,19 @@ module Google
827
830
  # be set to
828
831
  # {::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode::NORMAL QueryMode.NORMAL}.
829
832
  # @param partition_token [::String]
830
- # If present, results will be restricted to the specified partition
831
- # previously created using PartitionQuery(). There must be an exact
833
+ # If present, results are restricted to the specified partition
834
+ # previously created using `PartitionQuery`. There must be an exact
832
835
  # match for the values of fields common to this message and the
833
- # PartitionQueryRequest message used to create this partition_token.
836
+ # `PartitionQueryRequest` message used to create this `partition_token`.
834
837
  # @param seqno [::Integer]
835
838
  # A per-transaction sequence number used to identify this request. This field
836
839
  # makes each request idempotent such that if the request is received multiple
837
- # times, at most one will succeed.
840
+ # times, at most one succeeds.
838
841
  #
839
842
  # The sequence number must be monotonically increasing within the
840
843
  # transaction. If a request arrives for the first time with an out-of-order
841
- # sequence number, the transaction may be aborted. Replays of previously
842
- # handled requests will yield the same response as the first execution.
844
+ # sequence number, the transaction can be aborted. Replays of previously
845
+ # handled requests yield the same response as the first execution.
843
846
  #
844
847
  # Required for DML statements. Ignored for queries.
845
848
  # @param query_options [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions, ::Hash]
@@ -852,18 +855,18 @@ module Google
852
855
  # If this is for a partitioned query and this field is set to `true`, the
853
856
  # request is executed with Spanner Data Boost independent compute resources.
854
857
  #
855
- # If the field is set to `true` but the request does not set
858
+ # If the field is set to `true` but the request doesn't set
856
859
  # `partition_token`, the API returns an `INVALID_ARGUMENT` error.
857
860
  # @param last_statement [::Boolean]
858
- # Optional. If set to true, this statement marks the end of the transaction.
859
- # The transaction should be committed or aborted after this statement
860
- # executes, and attempts to execute any other requests against this
861
- # transaction (including reads and queries) will be rejected.
861
+ # Optional. If set to `true`, this statement marks the end of the
862
+ # transaction. After this statement executes, you must commit or abort the
863
+ # transaction. Attempts to execute any other requests against this
864
+ # transaction (including reads and queries) are rejected.
862
865
  #
863
- # For DML statements, setting this option may cause some error reporting to
864
- # be deferred until commit time (e.g. validation of unique constraints).
865
- # Given this, successful execution of a DML statement should not be assumed
866
- # until a subsequent Commit call completes successfully.
866
+ # For DML statements, setting this option might cause some error reporting to
867
+ # be deferred until commit time (for example, validation of unique
868
+ # constraints). Given this, successful execution of a DML statement shouldn't
869
+ # be assumed until a subsequent `Commit` call completes successfully.
867
870
  #
868
871
  # @yield [response, operation] Access the result along with the RPC operation
869
872
  # @yieldparam response [::Google::Cloud::Spanner::V1::ResultSet]
@@ -936,6 +939,9 @@ module Google
936
939
  # the size of the returned result set. However, no individual row in the
937
940
  # result set can exceed 100 MiB, and no column value can exceed 10 MiB.
938
941
  #
942
+ # The query string can be SQL or [Graph Query Language
943
+ # (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
944
+ #
939
945
  # @overload execute_streaming_sql(request, options = nil)
940
946
  # Pass arguments to `execute_streaming_sql` via a request object, either of type
941
947
  # {::Google::Cloud::Spanner::V1::ExecuteSqlRequest} or an equivalent Hash.
@@ -960,7 +966,7 @@ module Google
960
966
  # transaction with strong concurrency.
961
967
  #
962
968
  # Standard DML statements require a read-write transaction. To protect
963
- # against replays, single-use transactions are not supported. The caller
969
+ # against replays, single-use transactions are not supported. The caller
964
970
  # must either supply an existing transaction ID or begin a new transaction.
965
971
  #
966
972
  # Partitioned DML requires an existing Partitioned DML transaction ID.
@@ -974,19 +980,19 @@ module Google
974
980
  # to the naming requirements of identifiers as specified at
975
981
  # https://cloud.google.com/spanner/docs/lexical#identifiers.
976
982
  #
977
- # Parameters can appear anywhere that a literal value is expected. The same
983
+ # Parameters can appear anywhere that a literal value is expected. The same
978
984
  # parameter name can be used more than once, for example:
979
985
  #
980
986
  # `"WHERE id > @msg_id AND id < @msg_id + 100"`
981
987
  #
982
- # It is an error to execute a SQL statement with unbound parameters.
988
+ # It's an error to execute a SQL statement with unbound parameters.
983
989
  # @param param_types [::Hash{::String => ::Google::Cloud::Spanner::V1::Type, ::Hash}]
984
- # It is not always possible for Cloud Spanner to infer the right SQL type
985
- # from a JSON value. For example, values of type `BYTES` and values
990
+ # It isn't always possible for Cloud Spanner to infer the right SQL type
991
+ # from a JSON value. For example, values of type `BYTES` and values
986
992
  # of type `STRING` both appear in
987
993
  # {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#params params} as JSON strings.
988
994
  #
989
- # In these cases, `param_types` can be used to specify the exact
995
+ # In these cases, you can use `param_types` to specify the exact
990
996
  # SQL type for some or all of the SQL statement parameters. See the
991
997
  # definition of {::Google::Cloud::Spanner::V1::Type Type} for more information
992
998
  # about SQL types.
@@ -1005,19 +1011,19 @@ module Google
1005
1011
  # be set to
1006
1012
  # {::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode::NORMAL QueryMode.NORMAL}.
1007
1013
  # @param partition_token [::String]
1008
- # If present, results will be restricted to the specified partition
1009
- # previously created using PartitionQuery(). There must be an exact
1014
+ # If present, results are restricted to the specified partition
1015
+ # previously created using `PartitionQuery`. There must be an exact
1010
1016
  # match for the values of fields common to this message and the
1011
- # PartitionQueryRequest message used to create this partition_token.
1017
+ # `PartitionQueryRequest` message used to create this `partition_token`.
1012
1018
  # @param seqno [::Integer]
1013
1019
  # A per-transaction sequence number used to identify this request. This field
1014
1020
  # makes each request idempotent such that if the request is received multiple
1015
- # times, at most one will succeed.
1021
+ # times, at most one succeeds.
1016
1022
  #
1017
1023
  # The sequence number must be monotonically increasing within the
1018
1024
  # transaction. If a request arrives for the first time with an out-of-order
1019
- # sequence number, the transaction may be aborted. Replays of previously
1020
- # handled requests will yield the same response as the first execution.
1025
+ # sequence number, the transaction can be aborted. Replays of previously
1026
+ # handled requests yield the same response as the first execution.
1021
1027
  #
1022
1028
  # Required for DML statements. Ignored for queries.
1023
1029
  # @param query_options [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions, ::Hash]
@@ -1030,18 +1036,18 @@ module Google
1030
1036
  # If this is for a partitioned query and this field is set to `true`, the
1031
1037
  # request is executed with Spanner Data Boost independent compute resources.
1032
1038
  #
1033
- # If the field is set to `true` but the request does not set
1039
+ # If the field is set to `true` but the request doesn't set
1034
1040
  # `partition_token`, the API returns an `INVALID_ARGUMENT` error.
1035
1041
  # @param last_statement [::Boolean]
1036
- # Optional. If set to true, this statement marks the end of the transaction.
1037
- # The transaction should be committed or aborted after this statement
1038
- # executes, and attempts to execute any other requests against this
1039
- # transaction (including reads and queries) will be rejected.
1042
+ # Optional. If set to `true`, this statement marks the end of the
1043
+ # transaction. After this statement executes, you must commit or abort the
1044
+ # transaction. Attempts to execute any other requests against this
1045
+ # transaction (including reads and queries) are rejected.
1040
1046
  #
1041
- # For DML statements, setting this option may cause some error reporting to
1042
- # be deferred until commit time (e.g. validation of unique constraints).
1043
- # Given this, successful execution of a DML statement should not be assumed
1044
- # until a subsequent Commit call completes successfully.
1047
+ # For DML statements, setting this option might cause some error reporting to
1048
+ # be deferred until commit time (for example, validation of unique
1049
+ # constraints). Given this, successful execution of a DML statement shouldn't
1050
+ # be assumed until a subsequent `Commit` call completes successfully.
1045
1051
  #
1046
1052
  # @yield [response, operation] Access the result along with the RPC operation
1047
1053
  # @yieldparam response [::Enumerable<::Google::Cloud::Spanner::V1::PartialResultSet>]
@@ -1157,24 +1163,24 @@ module Google
1157
1163
  # @param seqno [::Integer]
1158
1164
  # Required. A per-transaction sequence number used to identify this request.
1159
1165
  # This field makes each request idempotent such that if the request is
1160
- # received multiple times, at most one will succeed.
1166
+ # received multiple times, at most one succeeds.
1161
1167
  #
1162
1168
  # The sequence number must be monotonically increasing within the
1163
1169
  # transaction. If a request arrives for the first time with an out-of-order
1164
- # sequence number, the transaction may be aborted. Replays of previously
1165
- # handled requests will yield the same response as the first execution.
1170
+ # sequence number, the transaction might be aborted. Replays of previously
1171
+ # handled requests yield the same response as the first execution.
1166
1172
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
1167
1173
  # Common options for this request.
1168
1174
  # @param last_statements [::Boolean]
1169
- # Optional. If set to true, this request marks the end of the transaction.
1170
- # The transaction should be committed or aborted after these statements
1171
- # execute, and attempts to execute any other requests against this
1172
- # transaction (including reads and queries) will be rejected.
1175
+ # Optional. If set to `true`, this request marks the end of the transaction.
1176
+ # After these statements execute, you must commit or abort the transaction.
1177
+ # Attempts to execute any other requests against this transaction
1178
+ # (including reads and queries) are rejected.
1173
1179
  #
1174
- # Setting this option may cause some error reporting to be deferred until
1175
- # commit time (e.g. validation of unique constraints). Given this, successful
1176
- # execution of statements should not be assumed until a subsequent Commit
1177
- # call completes successfully.
1180
+ # Setting this option might cause some error reporting to be deferred until
1181
+ # commit time (for example, validation of unique constraints). Given this,
1182
+ # successful execution of statements shouldn't be assumed until a subsequent
1183
+ # `Commit` call completes successfully.
1178
1184
  #
1179
1185
  # @yield [response, operation] Access the result along with the RPC operation
1180
1186
  # @yieldparam response [::Google::Cloud::Spanner::V1::ExecuteBatchDmlResponse]
@@ -1243,7 +1249,7 @@ module Google
1243
1249
  ##
1244
1250
  # Reads rows from the database using key lookups and scans, as a
1245
1251
  # simple key/value style alternative to
1246
- # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql}. This method cannot be
1252
+ # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql}. This method can't be
1247
1253
  # used to return a result set larger than 10 MiB; if the read matches more
1248
1254
  # data than that, the read fails with a `FAILED_PRECONDITION`
1249
1255
  # error.
@@ -1299,15 +1305,15 @@ module Google
1299
1305
  # If the {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token}
1300
1306
  # field is empty, rows are yielded in table primary key order (if
1301
1307
  # {::Google::Cloud::Spanner::V1::ReadRequest#index index} is empty) or index key order
1302
- # (if {::Google::Cloud::Spanner::V1::ReadRequest#index index} is non-empty). If the
1303
- # {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token} field is
1304
- # not empty, rows will be yielded in an unspecified order.
1308
+ # (if {::Google::Cloud::Spanner::V1::ReadRequest#index index} is non-empty). If the
1309
+ # {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token} field
1310
+ # isn't empty, rows are yielded in an unspecified order.
1305
1311
  #
1306
- # It is not an error for the `key_set` to name rows that do not
1312
+ # It isn't an error for the `key_set` to name rows that don't
1307
1313
  # exist in the database. Read yields nothing for nonexistent rows.
1308
1314
  # @param limit [::Integer]
1309
1315
  # If greater than zero, only the first `limit` rows are yielded. If `limit`
1310
- # is zero, the default is no limit. A limit cannot be specified if
1316
+ # is zero, the default is no limit. A limit can't be specified if
1311
1317
  # `partition_token` is set.
1312
1318
  # @param resume_token [::String]
1313
1319
  # If this request is resuming a previously interrupted read,
@@ -1317,8 +1323,8 @@ module Google
1317
1323
  # left off. The rest of the request parameters must exactly match the request
1318
1324
  # that yielded this token.
1319
1325
  # @param partition_token [::String]
1320
- # If present, results will be restricted to the specified partition
1321
- # previously created using PartitionRead(). There must be an exact
1326
+ # If present, results are restricted to the specified partition
1327
+ # previously created using `PartitionRead`. There must be an exact
1322
1328
  # match for the values of fields common to this message and the
1323
1329
  # PartitionReadRequest message used to create this partition_token.
1324
1330
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
@@ -1329,16 +1335,17 @@ module Google
1329
1335
  # If this is for a partitioned read and this field is set to `true`, the
1330
1336
  # request is executed with Spanner Data Boost independent compute resources.
1331
1337
  #
1332
- # If the field is set to `true` but the request does not set
1338
+ # If the field is set to `true` but the request doesn't set
1333
1339
  # `partition_token`, the API returns an `INVALID_ARGUMENT` error.
1334
1340
  # @param order_by [::Google::Cloud::Spanner::V1::ReadRequest::OrderBy]
1335
1341
  # Optional. Order for the returned rows.
1336
1342
  #
1337
- # By default, Spanner will return result rows in primary key order except for
1338
- # PartitionRead requests. For applications that do not require rows to be
1343
+ # By default, Spanner returns result rows in primary key order except for
1344
+ # PartitionRead requests. For applications that don't require rows to be
1339
1345
  # returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting
1340
1346
  # `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval,
1341
- # resulting in lower latencies in certain cases (e.g. bulk point lookups).
1347
+ # resulting in lower latencies in certain cases (for example, bulk point
1348
+ # lookups).
1342
1349
  # @param lock_hint [::Google::Cloud::Spanner::V1::ReadRequest::LockHint]
1343
1350
  # Optional. Lock Hint for the request, it can only be used with read-write
1344
1351
  # transactions.
@@ -1457,15 +1464,15 @@ module Google
1457
1464
  # If the {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token}
1458
1465
  # field is empty, rows are yielded in table primary key order (if
1459
1466
  # {::Google::Cloud::Spanner::V1::ReadRequest#index index} is empty) or index key order
1460
- # (if {::Google::Cloud::Spanner::V1::ReadRequest#index index} is non-empty). If the
1461
- # {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token} field is
1462
- # not empty, rows will be yielded in an unspecified order.
1467
+ # (if {::Google::Cloud::Spanner::V1::ReadRequest#index index} is non-empty). If the
1468
+ # {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token} field
1469
+ # isn't empty, rows are yielded in an unspecified order.
1463
1470
  #
1464
- # It is not an error for the `key_set` to name rows that do not
1471
+ # It isn't an error for the `key_set` to name rows that don't
1465
1472
  # exist in the database. Read yields nothing for nonexistent rows.
1466
1473
  # @param limit [::Integer]
1467
1474
  # If greater than zero, only the first `limit` rows are yielded. If `limit`
1468
- # is zero, the default is no limit. A limit cannot be specified if
1475
+ # is zero, the default is no limit. A limit can't be specified if
1469
1476
  # `partition_token` is set.
1470
1477
  # @param resume_token [::String]
1471
1478
  # If this request is resuming a previously interrupted read,
@@ -1475,8 +1482,8 @@ module Google
1475
1482
  # left off. The rest of the request parameters must exactly match the request
1476
1483
  # that yielded this token.
1477
1484
  # @param partition_token [::String]
1478
- # If present, results will be restricted to the specified partition
1479
- # previously created using PartitionRead(). There must be an exact
1485
+ # If present, results are restricted to the specified partition
1486
+ # previously created using `PartitionRead`. There must be an exact
1480
1487
  # match for the values of fields common to this message and the
1481
1488
  # PartitionReadRequest message used to create this partition_token.
1482
1489
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
@@ -1487,16 +1494,17 @@ module Google
1487
1494
  # If this is for a partitioned read and this field is set to `true`, the
1488
1495
  # request is executed with Spanner Data Boost independent compute resources.
1489
1496
  #
1490
- # If the field is set to `true` but the request does not set
1497
+ # If the field is set to `true` but the request doesn't set
1491
1498
  # `partition_token`, the API returns an `INVALID_ARGUMENT` error.
1492
1499
  # @param order_by [::Google::Cloud::Spanner::V1::ReadRequest::OrderBy]
1493
1500
  # Optional. Order for the returned rows.
1494
1501
  #
1495
- # By default, Spanner will return result rows in primary key order except for
1496
- # PartitionRead requests. For applications that do not require rows to be
1502
+ # By default, Spanner returns result rows in primary key order except for
1503
+ # PartitionRead requests. For applications that don't require rows to be
1497
1504
  # returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting
1498
1505
  # `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval,
1499
- # resulting in lower latencies in certain cases (e.g. bulk point lookups).
1506
+ # resulting in lower latencies in certain cases (for example, bulk point
1507
+ # lookups).
1500
1508
  # @param lock_hint [::Google::Cloud::Spanner::V1::ReadRequest::LockHint]
1501
1509
  # Optional. Lock Hint for the request, it can only be used with read-write
1502
1510
  # transactions.
@@ -1597,16 +1605,14 @@ module Google
1597
1605
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
1598
1606
  # Common options for this request.
1599
1607
  # Priority is ignored for this request. Setting the priority in this
1600
- # request_options struct will not do anything. To set the priority for a
1608
+ # `request_options` struct doesn't do anything. To set the priority for a
1601
1609
  # transaction, set it on the reads and writes that are part of this
1602
1610
  # transaction instead.
1603
1611
  # @param mutation_key [::Google::Cloud::Spanner::V1::Mutation, ::Hash]
1604
1612
  # Optional. Required for read-write transactions on a multiplexed session
1605
- # that commit mutations but do not perform any reads or queries. Clients
1606
- # should randomly select one of the mutations from the mutation set and send
1607
- # it as a part of this request.
1608
- # This feature is not yet supported and will result in an UNIMPLEMENTED
1609
- # error.
1613
+ # that commit mutations but don't perform any reads or queries. You must
1614
+ # randomly select one of the mutations from the mutation set and send it as a
1615
+ # part of this request.
1610
1616
  #
1611
1617
  # @yield [response, operation] Access the result along with the RPC operation
1612
1618
  # @yieldparam response [::Google::Cloud::Spanner::V1::Transaction]
@@ -1679,8 +1685,8 @@ module Google
1679
1685
  # `Commit` might return an `ABORTED` error. This can occur at any time;
1680
1686
  # commonly, the cause is conflicts with concurrent
1681
1687
  # transactions. However, it can also happen for a variety of other
1682
- # reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
1683
- # the transaction from the beginning, re-using the same session.
1688
+ # reasons. If `Commit` returns `ABORTED`, the caller should retry
1689
+ # the transaction from the beginning, reusing the same session.
1684
1690
  #
1685
1691
  # On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
1686
1692
  # for example, if the client job experiences a 1+ hour networking failure.
@@ -1715,7 +1721,7 @@ module Google
1715
1721
  # temporary transaction is non-idempotent. That is, if the
1716
1722
  # `CommitRequest` is sent to Cloud Spanner more than once (for
1717
1723
  # instance, due to retries in the application, or in the
1718
- # transport library), it is possible that the mutations are
1724
+ # transport library), it's possible that the mutations are
1719
1725
  # executed more than once. If this is undesirable, use
1720
1726
  # {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction} and
1721
1727
  # {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit} instead.
@@ -1726,24 +1732,22 @@ module Google
1726
1732
  # mutations are applied atomically, in the order they appear in
1727
1733
  # this list.
1728
1734
  # @param return_commit_stats [::Boolean]
1729
- # If `true`, then statistics related to the transaction will be included in
1735
+ # If `true`, then statistics related to the transaction is included in
1730
1736
  # the {::Google::Cloud::Spanner::V1::CommitResponse#commit_stats CommitResponse}.
1731
1737
  # Default value is `false`.
1732
1738
  # @param max_commit_delay [::Google::Protobuf::Duration, ::Hash]
1733
- # Optional. The amount of latency this request is willing to incur in order
1734
- # to improve throughput. If this field is not set, Spanner assumes requests
1735
- # are relatively latency sensitive and automatically determines an
1736
- # appropriate delay time. You can specify a batching delay value between 0
1737
- # and 500 ms.
1739
+ # Optional. The amount of latency this request is configured to incur in
1740
+ # order to improve throughput. If this field isn't set, Spanner assumes
1741
+ # requests are relatively latency sensitive and automatically determines an
1742
+ # appropriate delay time. You can specify a commit delay value between 0 and
1743
+ # 500 ms.
1738
1744
  # @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
1739
1745
  # Common options for this request.
1740
1746
  # @param precommit_token [::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken, ::Hash]
1741
1747
  # Optional. If the read-write transaction was executed on a multiplexed
1742
- # session, the precommit token with the highest sequence number received in
1743
- # this transaction attempt, should be included here. Failing to do so will
1744
- # result in a FailedPrecondition error.
1745
- # This feature is not yet supported and will result in an UNIMPLEMENTED
1746
- # error.
1748
+ # session, then you must include the precommit token with the highest
1749
+ # sequence number received in this transaction attempt. Failing to do so
1750
+ # results in a `FailedPrecondition` error.
1747
1751
  #
1748
1752
  # @yield [response, operation] Access the result along with the RPC operation
1749
1753
  # @yieldparam response [::Google::Cloud::Spanner::V1::CommitResponse]
@@ -1810,14 +1814,14 @@ module Google
1810
1814
  end
1811
1815
 
1812
1816
  ##
1813
- # Rolls back a transaction, releasing any locks it holds. It is a good
1817
+ # Rolls back a transaction, releasing any locks it holds. It's a good
1814
1818
  # idea to call this for any transaction that includes one or more
1815
1819
  # {::Google::Cloud::Spanner::V1::Spanner::Client#read Read} or
1816
1820
  # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql} requests and ultimately
1817
1821
  # decides not to commit.
1818
1822
  #
1819
1823
  # `Rollback` returns `OK` if it successfully aborts the transaction, the
1820
- # transaction was already aborted, or the transaction is not
1824
+ # transaction was already aborted, or the transaction isn't
1821
1825
  # found. `Rollback` never returns `ABORTED`.
1822
1826
  #
1823
1827
  # @overload rollback(request, options = nil)
@@ -1906,16 +1910,16 @@ module Google
1906
1910
 
1907
1911
  ##
1908
1912
  # Creates a set of partition tokens that can be used to execute a query
1909
- # operation in parallel. Each of the returned partition tokens can be used
1913
+ # operation in parallel. Each of the returned partition tokens can be used
1910
1914
  # by {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql ExecuteStreamingSql} to
1911
- # specify a subset of the query result to read. The same session and
1912
- # read-only transaction must be used by the PartitionQueryRequest used to
1913
- # create the partition tokens and the ExecuteSqlRequests that use the
1915
+ # specify a subset of the query result to read. The same session and
1916
+ # read-only transaction must be used by the `PartitionQueryRequest` used to
1917
+ # create the partition tokens and the `ExecuteSqlRequests` that use the
1914
1918
  # partition tokens.
1915
1919
  #
1916
1920
  # Partition tokens become invalid when the session used to create them
1917
1921
  # is deleted, is idle for too long, begins a new transaction, or becomes too
1918
- # old. When any of these happen, it is not possible to resume the query, and
1922
+ # old. When any of these happen, it isn't possible to resume the query, and
1919
1923
  # the whole operation must be restarted from the beginning.
1920
1924
  #
1921
1925
  # @overload partition_query(request, options = nil)
@@ -1936,21 +1940,22 @@ module Google
1936
1940
  # @param session [::String]
1937
1941
  # Required. The session used to create the partitions.
1938
1942
  # @param transaction [::Google::Cloud::Spanner::V1::TransactionSelector, ::Hash]
1939
- # Read only snapshot transactions are supported, read/write and single use
1940
- # transactions are not.
1943
+ # Read-only snapshot transactions are supported, read and write and
1944
+ # single-use transactions are not.
1941
1945
  # @param sql [::String]
1942
- # Required. The query request to generate partitions for. The request will
1943
- # fail if the query is not root partitionable. For a query to be root
1946
+ # Required. The query request to generate partitions for. The request fails
1947
+ # if the query isn't root partitionable. For a query to be root
1944
1948
  # partitionable, it needs to satisfy a few conditions. For example, if the
1945
1949
  # query execution plan contains a distributed union operator, then it must be
1946
1950
  # the first operator in the plan. For more information about other
1947
1951
  # conditions, see [Read data in
1948
1952
  # parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel).
1949
1953
  #
1950
- # The query request must not contain DML commands, such as INSERT, UPDATE, or
1951
- # DELETE. Use
1952
- # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql ExecuteStreamingSql} with a
1953
- # PartitionedDml transaction for large, partition-friendly DML operations.
1954
+ # The query request must not contain DML commands, such as `INSERT`,
1955
+ # `UPDATE`, or `DELETE`. Use
1956
+ # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql `ExecuteStreamingSql`} with
1957
+ # a `PartitionedDml` transaction for large, partition-friendly DML
1958
+ # operations.
1954
1959
  # @param params [::Google::Protobuf::Struct, ::Hash]
1955
1960
  # Parameter names and values that bind to placeholders in the SQL string.
1956
1961
  #
@@ -1958,15 +1963,15 @@ module Google
1958
1963
  # parameter name (for example, `@firstName`). Parameter names can contain
1959
1964
  # letters, numbers, and underscores.
1960
1965
  #
1961
- # Parameters can appear anywhere that a literal value is expected. The same
1966
+ # Parameters can appear anywhere that a literal value is expected. The same
1962
1967
  # parameter name can be used more than once, for example:
1963
1968
  #
1964
1969
  # `"WHERE id > @msg_id AND id < @msg_id + 100"`
1965
1970
  #
1966
- # It is an error to execute a SQL statement with unbound parameters.
1971
+ # It's an error to execute a SQL statement with unbound parameters.
1967
1972
  # @param param_types [::Hash{::String => ::Google::Cloud::Spanner::V1::Type, ::Hash}]
1968
- # It is not always possible for Cloud Spanner to infer the right SQL type
1969
- # from a JSON value. For example, values of type `BYTES` and values
1973
+ # It isn't always possible for Cloud Spanner to infer the right SQL type
1974
+ # from a JSON value. For example, values of type `BYTES` and values
1970
1975
  # of type `STRING` both appear in
1971
1976
  # {::Google::Cloud::Spanner::V1::PartitionQueryRequest#params params} as JSON strings.
1972
1977
  #
@@ -2043,18 +2048,18 @@ module Google
2043
2048
 
2044
2049
  ##
2045
2050
  # Creates a set of partition tokens that can be used to execute a read
2046
- # operation in parallel. Each of the returned partition tokens can be used
2051
+ # operation in parallel. Each of the returned partition tokens can be used
2047
2052
  # by {::Google::Cloud::Spanner::V1::Spanner::Client#streaming_read StreamingRead} to specify a
2048
- # subset of the read result to read. The same session and read-only
2049
- # transaction must be used by the PartitionReadRequest used to create the
2050
- # partition tokens and the ReadRequests that use the partition tokens. There
2051
- # are no ordering guarantees on rows returned among the returned partition
2052
- # tokens, or even within each individual StreamingRead call issued with a
2053
- # partition_token.
2053
+ # subset of the read result to read. The same session and read-only
2054
+ # transaction must be used by the `PartitionReadRequest` used to create the
2055
+ # partition tokens and the `ReadRequests` that use the partition tokens.
2056
+ # There are no ordering guarantees on rows returned among the returned
2057
+ # partition tokens, or even within each individual `StreamingRead` call
2058
+ # issued with a `partition_token`.
2054
2059
  #
2055
2060
  # Partition tokens become invalid when the session used to create them
2056
2061
  # is deleted, is idle for too long, begins a new transaction, or becomes too
2057
- # old. When any of these happen, it is not possible to resume the read, and
2062
+ # old. When any of these happen, it isn't possible to resume the read, and
2058
2063
  # the whole operation must be restarted from the beginning.
2059
2064
  #
2060
2065
  # @overload partition_read(request, options = nil)
@@ -2098,7 +2103,7 @@ module Google
2098
2103
  # {::Google::Cloud::Spanner::V1::PartitionReadRequest#key_set key_set} instead names
2099
2104
  # index keys in {::Google::Cloud::Spanner::V1::PartitionReadRequest#index index}.
2100
2105
  #
2101
- # It is not an error for the `key_set` to name rows that do not
2106
+ # It isn't an error for the `key_set` to name rows that don't
2102
2107
  # exist in the database. Read yields nothing for nonexistent rows.
2103
2108
  # @param partition_options [::Google::Cloud::Spanner::V1::PartitionOptions, ::Hash]
2104
2109
  # Additional options that affect how many partitions are created.
@@ -2172,15 +2177,15 @@ module Google
2172
2177
  # transactions. All mutations in a group are committed atomically. However,
2173
2178
  # mutations across groups can be committed non-atomically in an unspecified
2174
2179
  # order and thus, they must be independent of each other. Partial failure is
2175
- # possible, i.e., some groups may have been committed successfully, while
2176
- # some may have failed. The results of individual batches are streamed into
2177
- # the response as the batches are applied.
2178
- #
2179
- # BatchWrite requests are not replay protected, meaning that each mutation
2180
- # group may be applied more than once. Replays of non-idempotent mutations
2181
- # may have undesirable effects. For example, replays of an insert mutation
2182
- # may produce an already exists error or if you use generated or commit
2183
- # timestamp-based keys, it may result in additional rows being added to the
2180
+ # possible, that is, some groups might have been committed successfully,
2181
+ # while some might have failed. The results of individual batches are
2182
+ # streamed into the response as the batches are applied.
2183
+ #
2184
+ # `BatchWrite` requests are not replay protected, meaning that each mutation
2185
+ # group can be applied more than once. Replays of non-idempotent mutations
2186
+ # can have undesirable effects. For example, replays of an insert mutation
2187
+ # can produce an already exists error or if you use generated or commit
2188
+ # timestamp-based keys, it can result in additional rows being added to the
2184
2189
  # mutation's table. We recommend structuring your mutation groups to be
2185
2190
  # idempotent to avoid this issue.
2186
2191
  #
@@ -2206,18 +2211,9 @@ module Google
2206
2211
  # @param mutation_groups [::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup, ::Hash>]
2207
2212
  # Required. The groups of mutations to be applied.
2208
2213
  # @param exclude_txn_from_change_streams [::Boolean]
2209
- # Optional. When `exclude_txn_from_change_streams` is set to `true`:
2210
- # * Mutations from all transactions in this batch write operation will not
2211
- # be recorded in change streams with DDL option `allow_txn_exclusion=true`
2212
- # that are tracking columns modified by these transactions.
2213
- # * Mutations from all transactions in this batch write operation will be
2214
- # recorded in change streams with DDL option `allow_txn_exclusion=false or
2215
- # not set` that are tracking columns modified by these transactions.
2216
- #
2217
- # When `exclude_txn_from_change_streams` is set to `false` or not set,
2218
- # mutations from all transactions in this batch write operation will be
2219
- # recorded in all change streams that are tracking columns modified by these
2220
- # transactions.
2214
+ # Optional. If you don't set the `exclude_txn_from_change_streams` option or
2215
+ # if it's set to `false`, then any change streams monitoring columns modified
2216
+ # by transactions will capture the updates made within that transaction.
2221
2217
  #
2222
2218
  # @yield [response, operation] Access the result along with the RPC operation
2223
2219
  # @yieldparam response [::Enumerable<::Google::Cloud::Spanner::V1::BatchWriteResponse>]