Create getwriteresult.xml

Author: mmalferov

reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml

@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: 4639881688d3faaf0073ad71fe0a4b730aea15a0 Maintainer: malferov Status: ready -->
+<!-- Reviewed: no -->
+<refentry xml:id="mongodb-driver-bulkwriteexception.getwriteresult" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoDB\Driver\Exception\BulkWriteException::getWriteResult</refname>
+  <refpurpose>Возвращает объект WriteResult для неудачной операции записи</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>final</modifier> <modifier>public</modifier> <type>MongoDB\Driver\WriteResult</type><methodname>MongoDB\Driver\Exception\BulkWriteException::getWriteResult</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Метод возвращает объект <classname>MongoDB\Driver\WriteResult</classname> для неудачной
+   операции записи. Более подробную информацию о сбое получают методами
+   <function>MongoDB\Driver\WriteResult::getWriteErrors</function>
+   и <function>MongoDB\Driver\WriteResult::getWriteConcernError</function>.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Метод возвращает объект <classname>MongoDB\Driver\WriteResult</classname> для неудачной
+   операции записи.
+  </para>
+ </refsect1>
+
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title>Пример получения результата для неудачной операции записи методом <function>MongoDB\Driver\Exception\BulkWriteException::getWriteResult</function></title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+$manager = new MongoDB\Driver\Manager('mongodb://localhost');
+$bulk = new MongoDB\Driver\BulkWrite();
+$bulk->insert(['_id' => 1]);
+$bulk->insert(['_id' => 1]);
+
+try {
+    $manager->executeBulkWrite('db.collection', $bulk);
+} catch (MongoDB\Driver\Exception\BulkWriteException $e) {
+    $writeResult = $e->getWriteResult();
+
+    if ($writeConcernError = $writeResult->getWriteConcernError()) {
+        var_dump($writeConcernError);
+    }
+
+    if ($writeErrors = $writeResult->getWriteErrors()) {
+        var_dump($writeErrors);
+    }
+}
+
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+array(1) {
+  [0]=>
+  object(MongoDB\Driver\WriteError)#5 (4) {
+    ["message"]=>
+    string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }"
+    ["code"]=>
+    int(11000)
+    ["index"]=>
+    int(1)
+    ["info"]=>
+    NULL
+  }
+}
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><classname>MongoDB\Driver\WriteResult</classname></member>
+   <member><function>MongoDB\Driver\Manager::executeBulkWrite</function></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->