Google Cloud Spanner v1 API - Class PartitionQueryRequest (4.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class PartitionQueryRequest : IMessage<PartitionQueryRequest>, IEquatable<PartitionQueryRequest>, IDeepCloneable<PartitionQueryRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner v1 API class PartitionQueryRequest.

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

Inheritance

Object > PartitionQueryRequest

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

PartitionQueryRequest()

public PartitionQueryRequest()

PartitionQueryRequest(PartitionQueryRequest)

public PartitionQueryRequest(PartitionQueryRequest other)
Parameter
NameDescription
otherPartitionQueryRequest

Properties

Params

public Struct Params { get; set; }

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:

&quot;WHERE id > @msg_id AND id < @msg_id + 100&quot;

It is an error to execute a SQL statement with unbound parameters.

Property Value
TypeDescription
Struct

ParamTypes

public MapField<string, Type> ParamTypes { get; }

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.

Property Value
TypeDescription
MapField<String, Type>

PartitionOptions

public PartitionOptions PartitionOptions { get; set; }

Additional options that affect how many partitions are created.

Property Value
TypeDescription
PartitionOptions

Session

public string Session { get; set; }

Required. The session used to create the partitions.

Property Value
TypeDescription
String

SessionAsSessionName

public SessionName SessionAsSessionName { get; set; }

SessionName-typed view over the Session resource name property.

Property Value
TypeDescription
SessionName

Sql

public string Sql { get; set; }

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.

Property Value
TypeDescription
String

Transaction

public TransactionSelector Transaction { get; set; }

Read only snapshot transactions are supported, read/write and single use transactions are not.

Property Value
TypeDescription
TransactionSelector