- 3.51.0 (latest)
- 3.50.1
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
BatchSnapshot(database, read_timestamp=None, exact_staleness=None)Wrapper for generating and processing read / query batches.
Parameters
| Name | Description |
| database |
Database
database to use |
| read_timestamp |
`datetime.datetime`
Execute all reads at the given timestamp. |
| exact_staleness |
`datetime.timedelta`
Execute all reads at a timestamp that is |
Inheritance
builtins.object > BatchSnapshotMethods
close
close()Clean up underlying session.
execute_sql
execute_sql(*args, **kw)Convenience method: perform query operation via snapshot.
See execute_sql.
from_dict
from_dict(database, mapping)Reconstruct an instance from a mapping.
| Name | Description |
| database |
Database
database to use |
| mapping |
mapping
serialized state of the instance |
generate_query_batches
generate_query_batches(sql, params=None, param_types=None, partition_size_bytes=None, max_partitions=None, query_options=None, *, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>)Start a partitioned query operation.
Uses the PartitionQuery API request to start a partitioned
query operation. Returns a list of batch information needed to
perform the actual queries.
| Name | Description |
| sql |
str
SQL query statement |
| params |
dict, {str -> column value}
values for parameter replacement. Keys must match the names used in |
| param_types |
dict[str -> Union[dict, .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. |
| query_options |
QueryOptions or `dict`
(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 |
| retry |
`google.api_core.retry.Retry`
(Optional) The retry settings for this request. |
| timeout |
float
(Optional) The timeout for this request. |
| Type | Description |
| iterable of dict | mappings of information used perform actual partitioned reads via `process_read_batch`. |
generate_read_batches
generate_read_batches(table, columns, keyset, index='', partition_size_bytes=None, max_partitions=None, *, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>)Start a partitioned batch read operation.
Uses the PartitionRead API request to initiate the partitioned
read. Returns a list of batch information needed to perform the
actual reads.
| Name | Description |
| 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. |
| retry |
`google.api_core.retry.Retry`
(Optional) The retry settings for this request. |
| timeout |
float
(Optional) The timeout for this request. |
| Type | Description |
| iterable of dict | mappings of information used perform actual partitioned reads via `process_read_batch`. |
process
process(batch)Process a single, partitioned query or read.
| Name | Description |
| batch |
mapping
one of the mappings returned from an earlier call to |
| Type | Description |
| ValueError | if batch does not contain either 'read' or 'query' |
| Type | Description |
| StreamedResultSet | a result set instance which can be used to consume rows. |
process_query_batch
process_query_batch(batch, *, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>)Process a single, partitioned query.
| Name | Description |
| batch |
mapping
one of the mappings returned from an earlier call to |
| retry |
`google.api_core.retry.Retry`
(Optional) The retry settings for this request. |
| timeout |
float
(Optional) The timeout for this request. |
| Type | Description |
| StreamedResultSet | a result set instance which can be used to consume rows. |
process_read_batch
process_read_batch(batch, *, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>)Process a single, partitioned read.
| Name | Description |
| batch |
mapping
one of the mappings returned from an earlier call to |
| retry |
`google.api_core.retry.Retry`
(Optional) The retry settings for this request. |
| timeout |
float
(Optional) The timeout for this request. |
| Type | Description |
| StreamedResultSet | a result set instance which can be used to consume rows. |
read
read(*args, **kw)Convenience method: perform read operation via snapshot.
See read.
to_dict
to_dict()Return state as a dictionary.
Result can be used to serialize the instance and reconstitute
it later using from_dict.