Spanner read-write transaction support.
class google.cloud.spanner_v1.transaction.Transaction(session)Implement read-write transaction semantics for a session.
Parameters
session (Session) – the session used to perform the commit
Raises
ValueError – if session has an existing transaction
Begin with block.
End with block.
Perform a batch of DML statements via an ExecuteBatchDml request.
Parameters
statements (Sequence[Union[ *[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str), Tuple[[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str), Dict[[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str), [Any](gapic/v1/admin_database_types.md#google.cloud.spanner_admin_database_v1.types.Any)], **Dict[[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str), Union[[dict](https://python.readthedocs.io/en/latest/library/stdtypes.html#dict), [types.Type](gapic/v1/types.md#google.cloud.spanner_v1.types.Type)]]]]]*) – List of DML statements, with optional params / param types. If passed, ‘params’ is a dict mapping names to the values for parameter replacement. Keys must match the names used in the corresponding DML statement. If ‘params’ is passed, ‘param_types’ must also be passed, as a dict mapping names to the type of value passed in ‘params’.
Return type
Tuple(status, Sequence[int])
Returns
Status code, plus counts of rows affected by each completed DML statement. Note that if the staus code is not OK, the statement triggering the error will not have an entry in the list, nor will any statements following that one.
Begin a transaction on the database.
Return type
Returns
the ID for the newly-begun transaction.
Raises
ValueError – if the transaction is already begun, committed, or rolled back.
Commit mutations to the database.
Return type
datetime
Returns
timestamp of the committed changes.
Raises
ValueError – if there are no mutations to commit.
Timestamp at which the transaction was successfully committed.
delete(table, keyset)Delete one or more table rows.
Parameters
table (str) – Name of the table to be modified.
keyset (Keyset) – Keys/ranges identifying rows to delete.
Perform an ExecuteStreamingSql API request.
Parameters
sql (str) – SQL query statement
params (dict, **{str -> column value}) – values for parameter replacement. Keys must match the names used in sql.
param_types (dict[str -> Union[dict, *[types.Type](gapic/v1/types.md#google.cloud.spanner_v1.types.Type)]*]) – (Optional) maps explicit types for one or more param values; required if parameters are passed.
query_mode (google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode) – Mode governing return of results / query plan. See https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1
query_options – (Optional) Query optimizer configuration to use for the given query. If a dict is provided, it must be of the same form as the protobuf message QueryOptions
partition (bytes) – (Optional) one of the partition tokens returned from partition_query().
Return type
Returns
a result set instance which can be used to consume rows.
Raises
ValueError – for reuse of single-use snapshots, or if a transaction ID is already pending for multiple-use snapshots.
Perform an ExecuteSql API request with DML.
Parameters
dml (str) – SQL DML statement
params (dict, **{str -> column value}) – values for parameter replacement. Keys must match the names used in dml.
param_types (dict[str -> Union[dict, *[types.Type](gapic/v1/types.md#google.cloud.spanner_v1.types.Type)]*]) – (Optional) maps explicit types for one or more param values; required if parameters are passed.
query_mode (google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode) – Mode governing return of results / query plan. See https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1
query_options (google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions or dict) – (Optional) Options that are provided for query plan stability.
Return type
Returns
Count of rows affected by the DML statement.
Insert one or more new table rows.
Parameters
table (str) – Name of the table to be modified.
columns (list of str) – Name of the table columns to be modified.
values (list of lists) – Values to be modified.
Insert/update one or more table rows.
Parameters
table (str) – Name of the table to be modified.
columns (list of str) – Name of the table columns to be modified.
values (list of lists) – Values to be modified.
Perform a ParitionQuery API request.
Parameters
sql (str) – SQL query statement
params (dict, **{str -> column value}) – values for parameter replacement. Keys must match the names used in sql.
param_types (dict[str -> Union[dict, *[types.Type](gapic/v1/types.md#google.cloud.spanner_v1.types.Type)]*]) – (Optional) maps explicit types for one or more param values; required if parameters are passed.
partition_size_bytes (int) – (Optional) desired size for each partition generated. The service uses this as a hint, the actual partition size may differ.
max_partitions (int) – (Optional) desired maximum number of partitions generated. The service uses this as a hint, the actual number of partitions may differ.
Return type
iterable of bytes
Returns
a sequence of partition tokens
Raises
ValueError – for single-use snapshots, or if a transaction ID is already associtated with the snapshot.
Perform a ParitionRead API request for rows in a table.
Parameters
table (str) – name of the table from which to fetch data
columns (list of str) – names of columns to be retrieved
keyset (KeySet) – keys / ranges identifying rows to be retrieved
index (str) – (Optional) name of index to use, rather than the table’s primary key
partition_size_bytes (int) – (Optional) desired size for each partition generated. The service uses this as a hint, the actual partition size may differ.
max_partitions (int) – (Optional) desired maximum number of partitions generated. The service uses this as a hint, the actual number of partitions may differ.
Return type
iterable of bytes
Returns
a sequence of partition tokens
Raises
ValueError – for single-use snapshots, or if a transaction ID is already associtated with the snapshot.
Perform a StreamingRead API request for rows in a table.
Parameters
table (str) – name of the table from which to fetch data
columns (list of str) – names of columns to be retrieved
keyset (KeySet) – keys / ranges identifying rows to be retrieved
index (str) – (Optional) name of index to use, rather than the table’s primary key
limit (int) – (Optional) maximum number of rows to return. Incompatible with partition.
partition (bytes) – (Optional) one of the partition tokens returned from partition_read(). Incompatible with limit.
Return type
Returns
a result set instance which can be used to consume rows.
Raises
ValueError – for reuse of single-use snapshots, or if a transaction ID is already pending for multiple-use snapshots.
Replace one or more table rows.
Parameters
table (str) – Name of the table to be modified.
columns (list of str) – Name of the table columns to be modified.
values (list of lists) – Values to be modified.
Roll back a transaction on the database.
update(table, columns, values)Update one or more existing table rows.
Parameters
table (str) – Name of the table to be modified.
columns (list of str) – Name of the table columns to be modified.
values (list of lists) – Values to be modified.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4