Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::PartitionQueryRequest (v1.1.0)

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

The request for PartitionQuery

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#param_types

def param_types() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::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.

#param_types=

def param_types=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::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.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::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.

#params

def params() -> ::Google::Protobuf::Struct
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.

#params=

def params=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::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.

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.

#partition_options

def partition_options() -> ::Google::Cloud::Spanner::V1::PartitionOptions
Returns

#partition_options=

def partition_options=(value) -> ::Google::Cloud::Spanner::V1::PartitionOptions
Parameter
Returns

#session

def session() -> ::String
Returns
  • (::String) — Required. The session used to create the partitions.

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The session used to create the partitions.
Returns
  • (::String) — Required. The session used to create the partitions.

#sql

def sql() -> ::String
Returns
  • (::String) — Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see Read data in parallel.

    The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.

#sql=

def sql=(value) -> ::String
Parameter
  • value (::String) — Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see Read data in parallel.

    The query request 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. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see Read data in parallel.

    The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.

#transaction

def transaction() -> ::Google::Cloud::Spanner::V1::TransactionSelector
Returns

#transaction=

def transaction=(value) -> ::Google::Cloud::Spanner::V1::TransactionSelector
Parameter
Returns