Class: Google::Spanner::V1::PartitionQueryRequest

Inherits:

Object

• Object
• Google::Spanner::V1::PartitionQueryRequest

Defined in:

lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb

Overview

The request for PartitionQuery

Instance Attribute Summary

• #param_types ⇒ Hash{String => Google::Spanner::V1::Type}

  It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.

• #params ⇒ Google::Protobuf::Struct

  Parameter names and values that bind to placeholders in the SQL string.

• #partition_options ⇒ Google::Spanner::V1::PartitionOptions

  Additional options that affect how many partitions are created.

• #session ⇒ String

  Required.

• #sql ⇒ String

  Required.

• #transaction ⇒ Google::Spanner::V1::TransactionSelector

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

Instance Attribute Details

#param_types ⇒ Hash{String => Google::Spanner::V1::Type}

Returns 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 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 for more information about SQL types.

Returns:

• (Hash{String => Google::Spanner::V1::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 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 for more information about SQL types.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 409

class PartitionQueryRequest; end

#params ⇒ Google::Protobuf::Struct

Returns 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.

Returns:

• (Google::Protobuf::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.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 409

class PartitionQueryRequest; end

#partition_options ⇒ Google::Spanner::V1::PartitionOptions

Returns Additional options that affect how many partitions are created.

Returns:

• (Google::Spanner::V1::PartitionOptions) —

  Additional options that affect how many partitions are created.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 409

class PartitionQueryRequest; end

#session ⇒ String

Returns Required. The session used to create the partitions.

Returns:

• (String) —

  Required. The session used to create the partitions.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 409

class PartitionQueryRequest; end

#sql ⇒ String

Returns 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 with a PartitionedDml transaction for large, partition-friendly DML operations.

Returns:

• (String) —

  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 with a PartitionedDml transaction for large, partition-friendly DML operations.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 409

class PartitionQueryRequest; end

#transaction ⇒ Google::Spanner::V1::TransactionSelector

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

Returns:

• (Google::Spanner::V1::TransactionSelector) —

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

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 409

class PartitionQueryRequest; end