Class: Google::Apis::SpannerV1::ExecuteBatchDmlResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb

Overview

The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure. To check for DML statements that failed, use the following approach:

  1. Check the status in the response message. The google.rpc.Code enum value OK indicates that all statements were executed successfully.
  2. If the status was not OK, check the number of result sets in the response. If the response contains N ResultSet messages, then statement N+1 in the request failed. Example 1:
  3. Request: 5 DML statements, all executed successfully.
  4. Response: 5 ResultSet messages, with the status OK. Example 2:
  5. Request: 5 DML statements. The third statement has a syntax error.
  6. Response: 2 ResultSet messages, and a syntax error (INVALID_ARGUMENT) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ExecuteBatchDmlResponse

Returns a new instance of ExecuteBatchDmlResponse.



1003
1004
1005
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1003

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#result_sets ⇒ Array<Google::Apis::SpannerV1::ResultSet>

One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata. Corresponds to the JSON property resultSets

Returns:



991
992
993
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 991

def result_sets
  @result_sets
end

#status ⇒ Google::Apis::SpannerV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property status

Returns:



1001
1002
1003
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1001

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1008
1009
1010
1011
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1008

def update!(**args)
  @result_sets = args[:result_sets] if args.key?(:result_sets)
  @status = args[:status] if args.key?(:status)
end