Class PartitionQueryRequest (3.14.0)

PartitionQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

Attributes

Name	Description
session	`str` Required. The session used to create the partitions.
transaction	`google.cloud.spanner_v1.types.TransactionSelector` Read only snapshot transactions are supported, read/write and single use transactions are not.
sql	`str` Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use `ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql]` with a PartitionedDml transaction for large, partition-friendly DML operations.
params	`google.protobuf.struct_pb2.Struct` 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="" is="" an="" error="" to="" execute="" a="" sql="" statement="" with="" unbound="" parameters.="">
param_types	`Mapping[str, google.cloud.spanner_v1.types.Type]` It is not 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][google.spanner.v1.PartitionQueryRequest.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][google.spanner.v1.Type]` for more information about SQL types.
partition_options	`google.cloud.spanner_v1.types.PartitionOptions` Additional options that affect how many partitions are created.

Inheritance

builtins.object > proto.message.Message > PartitionQueryRequest

Classes

ParamTypesEntry

ParamTypesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
kwargs	`dict` Keys and values corresponding to the fields of the message.
mapping	Union[dict, `.Message`] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.