@maxim_mazurok/gapi.client.spanner-v1 0.0.20250304 → 0.0.20250321
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.
- package/index.d.ts +66 -62
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://spanner.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250321
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -160,9 +160,9 @@ declare namespace gapi.client {
|
|
|
160
160
|
cronSpec?: CrontabSpec;
|
|
161
161
|
}
|
|
162
162
|
interface BatchCreateSessionsRequest {
|
|
163
|
-
/** Required. The number of sessions to be created in this batch call. The API
|
|
163
|
+
/** Required. The number of sessions to be created in this batch call. The API can return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to `BatchCreateSessions` (adjusting session_count as necessary). */
|
|
164
164
|
sessionCount?: number;
|
|
165
|
-
/** Parameters to
|
|
165
|
+
/** Parameters to apply to each created session. */
|
|
166
166
|
sessionTemplate?: Session;
|
|
167
167
|
}
|
|
168
168
|
interface BatchCreateSessionsResponse {
|
|
@@ -170,7 +170,7 @@ declare namespace gapi.client {
|
|
|
170
170
|
session?: Session[];
|
|
171
171
|
}
|
|
172
172
|
interface BatchWriteRequest {
|
|
173
|
-
/** Optional. When `exclude_txn_from_change_streams` is set to `true`: * Modifications from all transactions in this batch write operation
|
|
173
|
+
/** Optional. When `exclude_txn_from_change_streams` is set to `true`: * Modifications from all transactions in this batch write operation are not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from all transactions in this batch write operation are recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from all transactions in this batch write operation are recorded in all change streams that are tracking columns modified by these transactions. */
|
|
174
174
|
excludeTxnFromChangeStreams?: boolean;
|
|
175
175
|
/** Required. The groups of mutations to be applied. */
|
|
176
176
|
mutationGroups?: MutationGroup[];
|
|
@@ -186,11 +186,11 @@ declare namespace gapi.client {
|
|
|
186
186
|
status?: Status;
|
|
187
187
|
}
|
|
188
188
|
interface BeginTransactionRequest {
|
|
189
|
-
/** Optional. Required for read-write transactions on a multiplexed session that commit mutations but
|
|
189
|
+
/** Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request. */
|
|
190
190
|
mutationKey?: Mutation;
|
|
191
191
|
/** Required. Options for the new transaction. */
|
|
192
192
|
options?: TransactionOptions;
|
|
193
|
-
/** Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct
|
|
193
|
+
/** Common options for this request. Priority is ignored for this request. Setting the priority in this `request_options` struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. */
|
|
194
194
|
requestOptions?: RequestOptions;
|
|
195
195
|
}
|
|
196
196
|
interface Binding {
|
|
@@ -226,27 +226,27 @@ declare namespace gapi.client {
|
|
|
226
226
|
variable?: string;
|
|
227
227
|
}
|
|
228
228
|
interface CommitRequest {
|
|
229
|
-
/** Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field
|
|
229
|
+
/** Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms. */
|
|
230
230
|
maxCommitDelay?: string;
|
|
231
231
|
/** The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. */
|
|
232
232
|
mutations?: Mutation[];
|
|
233
|
-
/** Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt
|
|
233
|
+
/** Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a `FailedPrecondition` error. */
|
|
234
234
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
235
235
|
/** Common options for this request. */
|
|
236
236
|
requestOptions?: RequestOptions;
|
|
237
|
-
/** If `true`, then statistics related to the transaction
|
|
237
|
+
/** If `true`, then statistics related to the transaction is included in the CommitResponse. Default value is `false`. */
|
|
238
238
|
returnCommitStats?: boolean;
|
|
239
|
-
/** Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it
|
|
239
|
+
/** Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. */
|
|
240
240
|
singleUseTransaction?: TransactionOptions;
|
|
241
241
|
/** Commit a previously-started transaction. */
|
|
242
242
|
transactionId?: string;
|
|
243
243
|
}
|
|
244
244
|
interface CommitResponse {
|
|
245
|
-
/** The statistics about this Commit
|
|
245
|
+
/** The statistics about this `Commit`. Not returned by default. For more information, see CommitRequest.return_commit_stats. */
|
|
246
246
|
commitStats?: CommitStats;
|
|
247
247
|
/** The Cloud Spanner timestamp at which the transaction committed. */
|
|
248
248
|
commitTimestamp?: string;
|
|
249
|
-
/** If specified, transaction has not committed yet.
|
|
249
|
+
/** If specified, transaction has not committed yet. You must retry the commit with the new precommit token. */
|
|
250
250
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
251
251
|
}
|
|
252
252
|
interface CommitStats {
|
|
@@ -452,9 +452,9 @@ declare namespace gapi.client {
|
|
|
452
452
|
shortMessage?: LocalizedString;
|
|
453
453
|
}
|
|
454
454
|
interface DirectedReadOptions {
|
|
455
|
-
/** Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner
|
|
455
|
+
/** `Exclude_replicas` indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list. */
|
|
456
456
|
excludeReplicas?: ExcludeReplicas;
|
|
457
|
-
/** Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner
|
|
457
|
+
/** `Include_replicas` indicates the order of replicas (as they appear in this list) to process the request. If `auto_failover_disabled` is set to `true` and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to `DEADLINE_EXCEEDED` errors. */
|
|
458
458
|
includeReplicas?: IncludeReplicas;
|
|
459
459
|
}
|
|
460
460
|
interface DualRegionQuorum {}
|
|
@@ -478,11 +478,11 @@ declare namespace gapi.client {
|
|
|
478
478
|
replicaSelections?: ReplicaSelection[];
|
|
479
479
|
}
|
|
480
480
|
interface ExecuteBatchDmlRequest {
|
|
481
|
-
/** Optional. If set to true
|
|
481
|
+
/** Optional. If set to `true`, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent `Commit` call completes successfully. */
|
|
482
482
|
lastStatements?: boolean;
|
|
483
483
|
/** Common options for this request. */
|
|
484
484
|
requestOptions?: RequestOptions;
|
|
485
|
-
/** Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one
|
|
485
|
+
/** Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction might be aborted. Replays of previously handled requests yield the same response as the first execution. */
|
|
486
486
|
seqno?: string;
|
|
487
487
|
/** Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. */
|
|
488
488
|
statements?: Statement[];
|
|
@@ -490,7 +490,7 @@ declare namespace gapi.client {
|
|
|
490
490
|
transaction?: TransactionSelector;
|
|
491
491
|
}
|
|
492
492
|
interface ExecuteBatchDmlResponse {
|
|
493
|
-
/** Optional. A precommit token
|
|
493
|
+
/** Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. */
|
|
494
494
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
495
495
|
/** One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata. */
|
|
496
496
|
resultSets?: ResultSet[];
|
|
@@ -498,17 +498,17 @@ declare namespace gapi.client {
|
|
|
498
498
|
status?: Status;
|
|
499
499
|
}
|
|
500
500
|
interface ExecuteSqlRequest {
|
|
501
|
-
/** If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request
|
|
501
|
+
/** If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error. */
|
|
502
502
|
dataBoostEnabled?: boolean;
|
|
503
503
|
/** Directed read options for this request. */
|
|
504
504
|
directedReadOptions?: DirectedReadOptions;
|
|
505
|
-
/** Optional. If set to true
|
|
505
|
+
/** Optional. If set to `true`, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent `Commit` call completes successfully. */
|
|
506
506
|
lastStatement?: boolean;
|
|
507
|
-
/** Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It
|
|
507
|
+
/** Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters. */
|
|
508
508
|
params?: {[P in string]: any};
|
|
509
|
-
/** It
|
|
509
|
+
/** It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, you can use `param_types` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */
|
|
510
510
|
paramTypes?: {[P in string]: Type};
|
|
511
|
-
/** If present, results
|
|
511
|
+
/** If present, results are restricted to the specified partition previously created using `PartitionQuery`. There must be an exact match for the values of fields common to this message and the `PartitionQueryRequest` message used to create this `partition_token`. */
|
|
512
512
|
partitionToken?: string;
|
|
513
513
|
/** Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. */
|
|
514
514
|
queryMode?: string;
|
|
@@ -518,7 +518,7 @@ declare namespace gapi.client {
|
|
|
518
518
|
requestOptions?: RequestOptions;
|
|
519
519
|
/** If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. */
|
|
520
520
|
resumeToken?: string;
|
|
521
|
-
/** A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one
|
|
521
|
+
/** A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries. */
|
|
522
522
|
seqno?: string;
|
|
523
523
|
/** Required. The SQL string. */
|
|
524
524
|
sql?: string;
|
|
@@ -565,7 +565,7 @@ declare namespace gapi.client {
|
|
|
565
565
|
requestedPolicyVersion?: number;
|
|
566
566
|
}
|
|
567
567
|
interface IncludeReplicas {
|
|
568
|
-
/** If true
|
|
568
|
+
/** If `true`, Spanner doesn't route requests to a replica outside the <`include_replicas` list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. */
|
|
569
569
|
autoFailoverDisabled?: boolean;
|
|
570
570
|
/** The directed read replica selector. */
|
|
571
571
|
replicaSelections?: ReplicaSelection[];
|
|
@@ -920,38 +920,40 @@ declare namespace gapi.client {
|
|
|
920
920
|
interface PartialResultSet {
|
|
921
921
|
/** If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value. */
|
|
922
922
|
chunkedValue?: boolean;
|
|
923
|
+
/** Optional. Indicates whether this is the last `PartialResultSet` in the stream. The server might optionally set this field. Clients shouldn't rely on this field being set in all cases. */
|
|
924
|
+
last?: boolean;
|
|
923
925
|
/** Metadata about the result set, such as row type information. Only present in the first response. */
|
|
924
926
|
metadata?: ResultSetMetadata;
|
|
925
|
-
/** Optional. A precommit token
|
|
927
|
+
/** Optional. A precommit token is included if the read-write transaction has multiplexed sessions enabled. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction. */
|
|
926
928
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
927
929
|
/** Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token. */
|
|
928
930
|
resumeToken?: string;
|
|
929
|
-
/** Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field
|
|
931
|
+
/** Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field is also present in the last response for DML statements. */
|
|
930
932
|
stats?: ResultSetStats;
|
|
931
|
-
/** A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It
|
|
933
|
+
/** A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It's possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: can't be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: Strings are concatenated. "foo", "bar" => "foobar" Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] Lists are concatenated, but the last and first elements are merged because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] Lists are concatenated, but the last and first elements are merged because they are lists. Recursively, the last and first elements of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` yields results from the `PartialResultSet` with value "orl". */
|
|
932
934
|
values?: any[];
|
|
933
935
|
}
|
|
934
936
|
interface Partition {
|
|
935
|
-
/** This token can be passed to Read
|
|
937
|
+
/** This token can be passed to `Read`, `StreamingRead`, `ExecuteSql`, or `ExecuteStreamingSql` requests to restrict the results to those identified by this partition token. */
|
|
936
938
|
partitionToken?: string;
|
|
937
939
|
}
|
|
938
940
|
interface PartitionedDml {}
|
|
939
941
|
interface PartitionOptions {
|
|
940
|
-
/** **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this
|
|
942
|
+
/** **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests. The desired maximum number of partitions to return. For example, this might be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned can be smaller or larger than this maximum count request. */
|
|
941
943
|
maxPartitions?: string;
|
|
942
|
-
/** **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition
|
|
944
|
+
/** **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition can be smaller or larger than this size request. */
|
|
943
945
|
partitionSizeBytes?: string;
|
|
944
946
|
}
|
|
945
947
|
interface PartitionQueryRequest {
|
|
946
|
-
/** Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It
|
|
948
|
+
/** Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters. */
|
|
947
949
|
params?: {[P in string]: any};
|
|
948
|
-
/** It
|
|
950
|
+
/** It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. */
|
|
949
951
|
paramTypes?: {[P in string]: Type};
|
|
950
952
|
/** Additional options that affect how many partitions are created. */
|
|
951
953
|
partitionOptions?: PartitionOptions;
|
|
952
|
-
/** Required. The query request to generate partitions for. The request fails if the query
|
|
954
|
+
/** Required. The query request to generate partitions for. The request fails if the query isn't root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a `PartitionedDml` transaction for large, partition-friendly DML operations. */
|
|
953
955
|
sql?: string;
|
|
954
|
-
/** Read
|
|
956
|
+
/** Read-only snapshot transactions are supported, read and write and single-use transactions are not. */
|
|
955
957
|
transaction?: TransactionSelector;
|
|
956
958
|
}
|
|
957
959
|
interface PartitionReadRequest {
|
|
@@ -959,7 +961,7 @@ declare namespace gapi.client {
|
|
|
959
961
|
columns?: string[];
|
|
960
962
|
/** If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. */
|
|
961
963
|
index?: string;
|
|
962
|
-
/** Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It
|
|
964
|
+
/** Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows. */
|
|
963
965
|
keySet?: KeySet;
|
|
964
966
|
/** Additional options that affect how many partitions are created. */
|
|
965
967
|
partitionOptions?: PartitionOptions;
|
|
@@ -1015,9 +1017,9 @@ declare namespace gapi.client {
|
|
|
1015
1017
|
indexAdvice?: IndexAdvice[];
|
|
1016
1018
|
}
|
|
1017
1019
|
interface QueryOptions {
|
|
1018
|
-
/** An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option
|
|
1020
|
+
/** An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option isn't set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: ```sql ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an `INVALID_ARGUMENT` error. */
|
|
1019
1021
|
optimizerStatisticsPackage?: string;
|
|
1020
|
-
/** An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS
|
|
1022
|
+
/** An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from `SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS`. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting. */
|
|
1021
1023
|
optimizerVersion?: string;
|
|
1022
1024
|
}
|
|
1023
1025
|
interface QueryPlan {
|
|
@@ -1059,21 +1061,21 @@ declare namespace gapi.client {
|
|
|
1059
1061
|
interface ReadRequest {
|
|
1060
1062
|
/** Required. The columns of table to be returned for each row matching this request. */
|
|
1061
1063
|
columns?: string[];
|
|
1062
|
-
/** If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request
|
|
1064
|
+
/** If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error. */
|
|
1063
1065
|
dataBoostEnabled?: boolean;
|
|
1064
1066
|
/** Directed read options for this request. */
|
|
1065
1067
|
directedReadOptions?: DirectedReadOptions;
|
|
1066
1068
|
/** If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. */
|
|
1067
1069
|
index?: string;
|
|
1068
|
-
/** Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field
|
|
1070
|
+
/** Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field isn't empty, rows are yielded in an unspecified order. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows. */
|
|
1069
1071
|
keySet?: KeySet;
|
|
1070
|
-
/** If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit
|
|
1072
|
+
/** If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit can't be specified if `partition_token` is set. */
|
|
1071
1073
|
limit?: string;
|
|
1072
1074
|
/** Optional. Lock Hint for the request, it can only be used with read-write transactions. */
|
|
1073
1075
|
lockHint?: string;
|
|
1074
|
-
/** Optional. Order for the returned rows. By default, Spanner
|
|
1076
|
+
/** Optional. Order for the returned rows. By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't require rows to be returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (for example, bulk point lookups). */
|
|
1075
1077
|
orderBy?: string;
|
|
1076
|
-
/** If present, results
|
|
1078
|
+
/** If present, results are restricted to the specified partition previously created using `PartitionRead`. There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. */
|
|
1077
1079
|
partitionToken?: string;
|
|
1078
1080
|
/** Common options for this request. */
|
|
1079
1081
|
requestOptions?: RequestOptions;
|
|
@@ -1107,7 +1109,7 @@ declare namespace gapi.client {
|
|
|
1107
1109
|
type?: string;
|
|
1108
1110
|
}
|
|
1109
1111
|
interface ReplicaSelection {
|
|
1110
|
-
/** The location or region of the serving requests,
|
|
1112
|
+
/** The location or region of the serving requests, for example, "us-east1". */
|
|
1111
1113
|
location?: string;
|
|
1112
1114
|
/** The type of replica. */
|
|
1113
1115
|
type?: string;
|
|
@@ -1115,9 +1117,9 @@ declare namespace gapi.client {
|
|
|
1115
1117
|
interface RequestOptions {
|
|
1116
1118
|
/** Priority for the request. */
|
|
1117
1119
|
priority?: string;
|
|
1118
|
-
/** A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (
|
|
1120
|
+
/** A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. */
|
|
1119
1121
|
requestTag?: string;
|
|
1120
|
-
/** A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag
|
|
1122
|
+
/** A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. */
|
|
1121
1123
|
transactionTag?: string;
|
|
1122
1124
|
}
|
|
1123
1125
|
interface RestoreDatabaseEncryptionConfig {
|
|
@@ -1159,11 +1161,11 @@ declare namespace gapi.client {
|
|
|
1159
1161
|
interface ResultSet {
|
|
1160
1162
|
/** Metadata about the result set, such as row type information. */
|
|
1161
1163
|
metadata?: ResultSetMetadata;
|
|
1162
|
-
/** Optional. A precommit token
|
|
1164
|
+
/** Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction. */
|
|
1163
1165
|
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
1164
1166
|
/** Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here. */
|
|
1165
1167
|
rows?: any[][];
|
|
1166
|
-
/** Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields
|
|
1168
|
+
/** Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode. */
|
|
1167
1169
|
stats?: ResultSetStats;
|
|
1168
1170
|
}
|
|
1169
1171
|
interface ResultSetMetadata {
|
|
@@ -1181,7 +1183,7 @@ declare namespace gapi.client {
|
|
|
1181
1183
|
queryStats?: {[P in string]: any};
|
|
1182
1184
|
/** Standard DML returns an exact count of rows that were modified. */
|
|
1183
1185
|
rowCountExact?: string;
|
|
1184
|
-
/** Partitioned DML
|
|
1186
|
+
/** Partitioned DML doesn't offer exactly-once semantics, so it returns a lower bound of the rows modified. */
|
|
1185
1187
|
rowCountLowerBound?: string;
|
|
1186
1188
|
}
|
|
1187
1189
|
interface RollbackRequest {
|
|
@@ -1209,7 +1211,7 @@ declare namespace gapi.client {
|
|
|
1209
1211
|
startTime?: string;
|
|
1210
1212
|
}
|
|
1211
1213
|
interface Session {
|
|
1212
|
-
/** Output only. The approximate timestamp when the session is last used. It
|
|
1214
|
+
/** Output only. The approximate timestamp when the session is last used. It's typically earlier than the actual last use time. */
|
|
1213
1215
|
approximateLastUseTime?: string;
|
|
1214
1216
|
/** Output only. The timestamp when the session is created. */
|
|
1215
1217
|
createTime?: string;
|
|
@@ -1217,7 +1219,7 @@ declare namespace gapi.client {
|
|
|
1217
1219
|
creatorRole?: string;
|
|
1218
1220
|
/** The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. */
|
|
1219
1221
|
labels?: {[P in string]: string};
|
|
1220
|
-
/** Optional. If true
|
|
1222
|
+
/** Optional. If `true`, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. */
|
|
1221
1223
|
multiplexed?: boolean;
|
|
1222
1224
|
/** Output only. The name of the session. This is always system-assigned. */
|
|
1223
1225
|
name?: string;
|
|
@@ -1247,9 +1249,9 @@ declare namespace gapi.client {
|
|
|
1247
1249
|
table?: string;
|
|
1248
1250
|
}
|
|
1249
1251
|
interface Statement {
|
|
1250
|
-
/** Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It
|
|
1252
|
+
/** Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters. */
|
|
1251
1253
|
params?: {[P in string]: any};
|
|
1252
|
-
/** It
|
|
1254
|
+
/** It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */
|
|
1253
1255
|
paramTypes?: {[P in string]: Type};
|
|
1254
1256
|
/** Required. The DML string. */
|
|
1255
1257
|
sql?: string;
|
|
@@ -1285,6 +1287,8 @@ declare namespace gapi.client {
|
|
|
1285
1287
|
interface TransactionOptions {
|
|
1286
1288
|
/** When `exclude_txn_from_change_streams` is set to `true`: * Modifications from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error. */
|
|
1287
1289
|
excludeTxnFromChangeStreams?: boolean;
|
|
1290
|
+
/** Isolation level for the transaction. */
|
|
1291
|
+
isolationLevel?: string;
|
|
1288
1292
|
/** Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. */
|
|
1289
1293
|
partitionedDml?: any;
|
|
1290
1294
|
/** Transaction will not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource. */
|
|
@@ -3122,7 +3126,7 @@ declare namespace gapi.client {
|
|
|
3122
3126
|
},
|
|
3123
3127
|
body: BatchCreateSessionsRequest,
|
|
3124
3128
|
): Request<BatchCreateSessionsResponse>;
|
|
3125
|
-
/** Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible,
|
|
3129
|
+
/** Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, that is, some groups might have been committed successfully, while some might have failed. The results of individual batches are streamed into the response as the batches are applied. `BatchWrite` requests are not replay protected, meaning that each mutation group can be applied more than once. Replays of non-idempotent mutations can have undesirable effects. For example, replays of an insert mutation can produce an already exists error or if you use generated or commit timestamp-based keys, it can result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue. */
|
|
3126
3130
|
batchWrite(request: {
|
|
3127
3131
|
/** V1 error format. */
|
|
3128
3132
|
'$.xgafv'?: string;
|
|
@@ -3238,7 +3242,7 @@ declare namespace gapi.client {
|
|
|
3238
3242
|
},
|
|
3239
3243
|
body: BeginTransactionRequest,
|
|
3240
3244
|
): Request<Transaction>;
|
|
3241
|
-
/** Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should
|
|
3245
|
+
/** Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should retry the transaction from the beginning, reusing the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now. */
|
|
3242
3246
|
commit(request: {
|
|
3243
3247
|
/** V1 error format. */
|
|
3244
3248
|
'$.xgafv'?: string;
|
|
@@ -3296,7 +3300,7 @@ declare namespace gapi.client {
|
|
|
3296
3300
|
},
|
|
3297
3301
|
body: CommitRequest,
|
|
3298
3302
|
): Request<CommitResponse>;
|
|
3299
|
-
/** Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it
|
|
3303
|
+
/** Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it's a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions when no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, for example, `"SELECT 1"`. */
|
|
3300
3304
|
create(request: {
|
|
3301
3305
|
/** V1 error format. */
|
|
3302
3306
|
'$.xgafv'?: string;
|
|
@@ -3354,7 +3358,7 @@ declare namespace gapi.client {
|
|
|
3354
3358
|
},
|
|
3355
3359
|
body: CreateSessionRequest,
|
|
3356
3360
|
): Request<Session>;
|
|
3357
|
-
/** Ends a session, releasing server resources associated with it. This
|
|
3361
|
+
/** Ends a session, releasing server resources associated with it. This asynchronously triggers the cancellation of any operations that are running with this session. */
|
|
3358
3362
|
delete(request?: {
|
|
3359
3363
|
/** V1 error format. */
|
|
3360
3364
|
'$.xgafv'?: string;
|
|
@@ -3439,7 +3443,7 @@ declare namespace gapi.client {
|
|
|
3439
3443
|
},
|
|
3440
3444
|
body: ExecuteBatchDmlRequest,
|
|
3441
3445
|
): Request<ExecuteBatchDmlResponse>;
|
|
3442
|
-
/** Executes an SQL statement, returning all results in a single reply. This method
|
|
3446
|
+
/** Executes an SQL statement, returning all results in a single reply. This method can't be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). */
|
|
3443
3447
|
executeSql(request: {
|
|
3444
3448
|
/** V1 error format. */
|
|
3445
3449
|
'$.xgafv'?: string;
|
|
@@ -3555,7 +3559,7 @@ declare namespace gapi.client {
|
|
|
3555
3559
|
},
|
|
3556
3560
|
body: ExecuteSqlRequest,
|
|
3557
3561
|
): Request<PartialResultSet>;
|
|
3558
|
-
/** Gets a session. Returns `NOT_FOUND` if the session
|
|
3562
|
+
/** Gets a session. Returns `NOT_FOUND` if the session doesn't exist. This is mainly useful for determining whether a session is still alive. */
|
|
3559
3563
|
get(request?: {
|
|
3560
3564
|
/** V1 error format. */
|
|
3561
3565
|
'$.xgafv'?: string;
|
|
@@ -3615,7 +3619,7 @@ declare namespace gapi.client {
|
|
|
3615
3619
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3616
3620
|
uploadType?: string;
|
|
3617
3621
|
}): Request<ListSessionsResponse>;
|
|
3618
|
-
/** Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it
|
|
3622
|
+
/** Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the `PartitionQueryRequest` used to create the partition tokens and the `ExecuteSqlRequests` that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the query, and the whole operation must be restarted from the beginning. */
|
|
3619
3623
|
partitionQuery(request: {
|
|
3620
3624
|
/** V1 error format. */
|
|
3621
3625
|
'$.xgafv'?: string;
|
|
@@ -3673,7 +3677,7 @@ declare namespace gapi.client {
|
|
|
3673
3677
|
},
|
|
3674
3678
|
body: PartitionQueryRequest,
|
|
3675
3679
|
): Request<PartitionResponse>;
|
|
3676
|
-
/** Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token
|
|
3680
|
+
/** Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the `PartitionReadRequest` used to create the partition tokens and the `ReadRequests` that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual `StreamingRead` call issued with a `partition_token`. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the read, and the whole operation must be restarted from the beginning. */
|
|
3677
3681
|
partitionRead(request: {
|
|
3678
3682
|
/** V1 error format. */
|
|
3679
3683
|
'$.xgafv'?: string;
|
|
@@ -3731,7 +3735,7 @@ declare namespace gapi.client {
|
|
|
3731
3735
|
},
|
|
3732
3736
|
body: PartitionReadRequest,
|
|
3733
3737
|
): Request<PartitionResponse>;
|
|
3734
|
-
/** Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method
|
|
3738
|
+
/** Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method can't be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. */
|
|
3735
3739
|
read(request: {
|
|
3736
3740
|
/** V1 error format. */
|
|
3737
3741
|
'$.xgafv'?: string;
|
|
@@ -3789,7 +3793,7 @@ declare namespace gapi.client {
|
|
|
3789
3793
|
},
|
|
3790
3794
|
body: ReadRequest,
|
|
3791
3795
|
): Request<ResultSet>;
|
|
3792
|
-
/** Rolls back a transaction, releasing any locks it holds. It
|
|
3796
|
+
/** Rolls back a transaction, releasing any locks it holds. It's a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction isn't found. `Rollback` never returns `ABORTED`. */
|
|
3793
3797
|
rollback(request: {
|
|
3794
3798
|
/** V1 error format. */
|
|
3795
3799
|
'$.xgafv'?: string;
|