<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns the WriteError's error message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-writeerror.getinfo.html">MongoDB\Driver\WriteError::getInfo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mongodb-driver-writeresult.html">MongoDB\Driver\WriteResult</a></div>
<div class="up"><a href="class.mongodb-driver-writeerror.html">MongoDB\Driver\WriteError</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-writeerror.getmessage" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\WriteError::getMessage</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\WriteError::getMessage</span> — <span class="dc-title">Returns the WriteError's error message</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-writeerror.getmessage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>MongoDB\Driver\WriteError::getMessage</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-writeerror.getmessage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-writeerror.getmessage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the WriteError's error message.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-writeerror.getmessage-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
</ul>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-driver-writeerror.getmessage-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1739">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\WriteError::getMessage()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$bulk </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">BulkWrite</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /><br />try {<br /> </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeBulkWrite</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">);<br />} catch(</span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Exception</span><span style="color: #007700">\</span><span style="color: #0000BB">BulkWriteException $e</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getWriteResult</span><span style="color: #007700">()-></span><span style="color: #0000BB">getWriteErrors</span><span style="color: #007700">()[</span><span style="color: #0000BB">0</span><span style="color: #007700">]-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }"
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-writeerror.getinfo.html">MongoDB\Driver\WriteError::getInfo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mongodb-driver-writeresult.html">MongoDB\Driver\WriteResult</a></div>
<div class="up"><a href="class.mongodb-driver-writeerror.html">MongoDB\Driver\WriteError</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
