Reference documentation and code samples for the Cloud Spanner Client class BatchDmlResult.
Represents the result of a Batch DML operation.
Example:
use Google\Cloud\Spanner\SpannerClient;
use Google\Cloud\Spanner\Transaction;
$spanner = new SpannerClient();
$database = $spanner->connect('my-instance', 'my-database');
$batchDmlResult = $database->runTransaction(function (Transaction $t) {
$result = $t->executeUpdateBatch([
[
'sql' => 'UPDATE posts SET author = @author WHERE id = @id',
'params' => [
'author' => 'John',
'id' => 1
]
]
]);
$t->commit();
return $result;
});
Namespace
Google \ Cloud \ Spanner
Methods
__construct
Parameters
Name
Description
data
array
The executeBatchDml response data.
errorStatement
array|null
The statement (with params and types)
which triggered an error.
rowCounts
Get a list of integers indicating the number of modified rows for each
successful statement.
Example:
$counts = $batchDmlResult->rowCounts();
Returns
Type
Description
int[]
error
Get a Batch DML error, if one exists.
If an error occurred, the method returns an array, where thestatuskey
contains error information, represented asgoogle.rpc.Status,
and the 'statement` key contains the input which caused the 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 Client - Class BatchDmlResult (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/BatchDmlResult)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/BatchDmlResult)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/BatchDmlResult)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/BatchDmlResult)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/BatchDmlResult)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/BatchDmlResult)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/BatchDmlResult)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/BatchDmlResult)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/BatchDmlResult)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/BatchDmlResult)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/BatchDmlResult)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/BatchDmlResult)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/BatchDmlResult)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/BatchDmlResult)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/BatchDmlResult)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/BatchDmlResult)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/BatchDmlResult)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/BatchDmlResult)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/BatchDmlResult)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/BatchDmlResult)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/BatchDmlResult)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/BatchDmlResult)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/BatchDmlResult)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/BatchDmlResult)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/BatchDmlResult)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/BatchDmlResult)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/BatchDmlResult)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/BatchDmlResult)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/BatchDmlResult)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/BatchDmlResult)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/BatchDmlResult)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/BatchDmlResult)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/BatchDmlResult)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/BatchDmlResult)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/BatchDmlResult)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/BatchDmlResult)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/BatchDmlResult)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/BatchDmlResult)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/BatchDmlResult)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/BatchDmlResult)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/BatchDmlResult)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/BatchDmlResult)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/BatchDmlResult) \nReference documentation and code samples for the Cloud Spanner Client class BatchDmlResult.\n\nRepresents the result of a Batch DML operation.\n\nExample: \n\n use Google\\Cloud\\Spanner\\SpannerClient;\n use Google\\Cloud\\Spanner\\Transaction;\n\n $spanner = new SpannerClient();\n $database = $spanner-\u003econnect('my-instance', 'my-database');\n\n $batchDmlResult = $database-\u003erunTransaction(function (Transaction $t) {\n $result = $t-\u003eexecuteUpdateBatch([\n [\n 'sql' =\u003e 'UPDATE posts SET author = @author WHERE id = @id',\n 'params' =\u003e [\n 'author' =\u003e 'John',\n 'id' =\u003e 1\n ]\n ]\n ]);\n\n $t-\u003ecommit();\n\n return $result;\n });\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner\n\nMethods\n-------\n\n### __construct\n\n### rowCounts\n\nGet a list of integers indicating the number of modified rows for each\nsuccessful statement.\n\nExample: \n\n $counts = $batchDmlResult-\u003erowCounts();\n\n### error\n\nGet a Batch DML error, if one exists.\n\nIf an error occurred, the method returns an array, where the `status` key\ncontains error information, represented as\n[google.rpc.Status](https://cloud.google.com/spanner/docs/reference/rpc/google.rpc#status),\nand the 'statement\\` key contains the input which caused the error.\n\nIf no error occurred, this method returns `null`.\n\nExample: \n\n $error = $batchDmlResult-\u003eerror();"]]