PartitionQueryRequest

com.google.spanner.v1.spanner.PartitionQueryRequest
See thePartitionQueryRequest companion object
final case class PartitionQueryRequest(session: String, transaction: Option[TransactionSelector], sql: String, params: Option[Struct], paramTypes: Map[String, Type], partitionOptions: Option[PartitionOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PartitionQueryRequest]

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

Value parameters

paramTypes

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.

params

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.

partitionOptions

Additional options that affect how many partitions are created.

session

Required. The session used to create the partitions.

sql

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.

transaction

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

Attributes

Companion
object
Source
PartitionQueryRequest.scala
Graph
Supertypes
trait Updatable[PartitionQueryRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllParamTypes(`__vs`: Iterable[(String, Type)]): PartitionQueryRequest

Attributes

Source
PartitionQueryRequest.scala
def addParamTypes(`__vs`: (String, Type)*): PartitionQueryRequest

Attributes

Source
PartitionQueryRequest.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
PartitionQueryRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
PartitionQueryRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
PartitionQueryRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
PartitionQueryRequest.scala
def withParamTypes(`__v`: Map[String, Type]): PartitionQueryRequest

Attributes

Source
PartitionQueryRequest.scala
def withSession(`__v`: String): PartitionQueryRequest

Attributes

Source
PartitionQueryRequest.scala
def withSql(`__v`: String): PartitionQueryRequest

Attributes

Source
PartitionQueryRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): PartitionQueryRequest

Attributes

Source
PartitionQueryRequest.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
PartitionQueryRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala