Reference documentation and code samples for the Cloud Spanner V1 Client class ExecuteBatchDmlResponse.
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:
Check the status in the response message. The
google.rpc.Code enum
value OK indicates that all statements were executed successfully.
If the status was not OK, check the number of result sets in the
response. If the response contains NResultSet messages, then statement N+1 in
the request failed.
Example 1:
Request: 5 DML statements, all executed successfully.
Response: 5 ResultSet messages, with the
status OK.
Example 2:
Request: 5 DML statements. The third statement has a syntax error.
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.
Generated from protobuf message google.spanner.v1.ExecuteBatchDmlResponse
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.
Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.
getResultSets
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.
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.
Optional. A precommit token will be included if the read-write transaction
is on a multiplexed session.
The precommit token with the highest sequence number from this transaction
attempt should be passed to the
Commit request for this transaction.
This feature is not yet supported and will result in an UNIMPLEMENTED
error.
Optional. A precommit token will be included if the read-write transaction
is on a multiplexed session.
The precommit token with the highest sequence number from this transaction
attempt should be passed to the
Commit request for this transaction.
This feature is not yet supported and will result in an UNIMPLEMENTED
error.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class ExecuteBatchDmlResponse (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/V1.ExecuteBatchDmlResponse)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/V1.ExecuteBatchDmlResponse)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/V1.ExecuteBatchDmlResponse)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/V1.ExecuteBatchDmlResponse)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/V1.ExecuteBatchDmlResponse)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/V1.ExecuteBatchDmlResponse)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/V1.ExecuteBatchDmlResponse)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/V1.ExecuteBatchDmlResponse)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/V1.ExecuteBatchDmlResponse)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/V1.ExecuteBatchDmlResponse)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/V1.ExecuteBatchDmlResponse)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/V1.ExecuteBatchDmlResponse)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/V1.ExecuteBatchDmlResponse)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/V1.ExecuteBatchDmlResponse)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/V1.ExecuteBatchDmlResponse)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/V1.ExecuteBatchDmlResponse)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/V1.ExecuteBatchDmlResponse)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/V1.ExecuteBatchDmlResponse)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/V1.ExecuteBatchDmlResponse)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/V1.ExecuteBatchDmlResponse)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/V1.ExecuteBatchDmlResponse)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/V1.ExecuteBatchDmlResponse)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/V1.ExecuteBatchDmlResponse)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/V1.ExecuteBatchDmlResponse)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/V1.ExecuteBatchDmlResponse)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/V1.ExecuteBatchDmlResponse)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/V1.ExecuteBatchDmlResponse)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/V1.ExecuteBatchDmlResponse)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/V1.ExecuteBatchDmlResponse)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/V1.ExecuteBatchDmlResponse)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/V1.ExecuteBatchDmlResponse)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/V1.ExecuteBatchDmlResponse)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/V1.ExecuteBatchDmlResponse)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/V1.ExecuteBatchDmlResponse)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/V1.ExecuteBatchDmlResponse)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/V1.ExecuteBatchDmlResponse)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/V1.ExecuteBatchDmlResponse)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/V1.ExecuteBatchDmlResponse)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/V1.ExecuteBatchDmlResponse)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/V1.ExecuteBatchDmlResponse)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/V1.ExecuteBatchDmlResponse)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/V1.ExecuteBatchDmlResponse)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/V1.ExecuteBatchDmlResponse) \nReference documentation and code samples for the Cloud Spanner V1 Client class ExecuteBatchDmlResponse.\n\nThe response for\nExecuteBatchDml. Contains a list\nof [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) messages, one for each DML\nstatement that has successfully executed, in the same order as the statements\nin the request. If a statement fails, the status in the response body\nidentifies the cause of the failure.\n\nTo check for DML statements that failed, use the following approach:\n\n1. Check the status in the response message. The [google.rpc.Code](https://cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html) enum value `OK` indicates that all statements were executed successfully.\n2. If the status was not `OK`, check the number of result sets in the response. If the response contains `N` [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) messages, then statement `N+1` in the request failed. Example 1:\n3. Request: 5 DML statements, all executed successfully.\n4. Response: 5 [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) messages, with the status `OK`. Example 2:\n5. Request: 5 DML statements. The third statement has a syntax error.\n6. Response: 2 [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) messages, and a syntax error (`INVALID_ARGUMENT`) status. The number of [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) messages indicates that the third statement failed, and the fourth and fifth statements were not executed.\n\nGenerated from protobuf message `google.spanner.v1.ExecuteBatchDmlResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getResultSets\n\nOne [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) for each statement in the\nrequest that ran successfully, in the same order as the statements in the\nrequest. Each [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) does not contain any\nrows. The [ResultSetStats](/php/docs/reference/cloud-spanner/latest/V1.ResultSetStats) in each\n[ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) contain the number of rows\nmodified by the statement.\n\nOnly the first [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) in the response\ncontains valid [ResultSetMetadata](/php/docs/reference/cloud-spanner/latest/V1.ResultSetMetadata).\n\n### setResultSets\n\nOne [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) for each statement in the\nrequest that ran successfully, in the same order as the statements in the\nrequest. Each [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) does not contain any\nrows. The [ResultSetStats](/php/docs/reference/cloud-spanner/latest/V1.ResultSetStats) in each\n[ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) contain the number of rows\nmodified by the statement.\n\nOnly the first [ResultSet](/php/docs/reference/cloud-spanner/latest/V1.ResultSet) in the response\ncontains valid [ResultSetMetadata](/php/docs/reference/cloud-spanner/latest/V1.ResultSetMetadata).\n\n### getStatus\n\nIf all DML statements are executed successfully, the status is `OK`.\n\nOtherwise, the error status of the first failed statement.\n\n### hasStatus\n\n### clearStatus\n\n### setStatus\n\nIf all DML statements are executed successfully, the status is `OK`.\n\nOtherwise, the error status of the first failed statement.\n\n### getPrecommitToken\n\nOptional. A precommit token will be included if the read-write transaction\nis on a multiplexed session.\n\nThe precommit token with the highest sequence number from this transaction\nattempt should be passed to the\nCommit request for this transaction.\nThis feature is not yet supported and will result in an UNIMPLEMENTED\nerror.\n\n### hasPrecommitToken\n\n### clearPrecommitToken\n\n### setPrecommitToken\n\nOptional. A precommit token will be included if the read-write transaction\nis on a multiplexed session.\n\nThe precommit token with the highest sequence number from this transaction\nattempt should be passed to the\nCommit request for this transaction.\nThis feature is not yet supported and will result in an UNIMPLEMENTED\nerror."]]