Skip to content

Commit e6f91f7

Browse files
lacatoirelacatoire
committed
[Sync EN] MongoDB: document readonly properties and IWM URI options (#5496)
Fixes #2770
1 parent d1f2b96 commit e6f91f7

21 files changed

Lines changed: 1800 additions & 39 deletions

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready -->
2+
<!-- EN-Revision: 36c32a2a930308443ad7fcbbc373c31cc02b9a4e Maintainer: lacatoire Status: ready -->
33
<!-- Reviewed: no -->
44

55
<reference xml:id="class.mongodb-driver-exception-bulkwriteexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -43,7 +43,8 @@
4343
<!-- }}} -->
4444
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
4545
<fieldsynopsis>
46-
<modifier>protected</modifier>
46+
<modifier>public</modifier>
47+
<modifier>readonly</modifier>
4748
<type>MongoDB\Driver\WriteResult</type>
4849
<varname linkend="mongodb-driver-exception-bulkwriteexception.props.writeresult">writeResult</varname>
4950
</fieldsynopsis>
@@ -95,6 +96,15 @@
9596
</row>
9697
</thead>
9798
<tbody>
99+
<row>
100+
<entry>PECL mongodb 2.3.0</entry>
101+
<entry>
102+
<simpara>
103+
La propriété <varname>writeResult</varname> est désormais
104+
<modifier>public</modifier> <modifier>readonly</modifier>.
105+
</simpara>
106+
</entry>
107+
</row>
98108
<row>
99109
<entry>PECL mongodb 2.0.0</entry>
100110
<entry>

‎reference/mongodb/mongodb/driver/exception/commandexception.xml‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready -->
2+
<!-- EN-Revision: 36c32a2a930308443ad7fcbbc373c31cc02b9a4e Maintainer: lacatoire Status: ready -->
33
<!-- Reviewed: yes -->
44
<reference xml:id="class.mongodb-driver-exception-commandexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
55
<title>La classe MongoDB\Driver\Exception\CommandException</title>
@@ -41,7 +41,8 @@
4141
<!-- }}} -->
4242
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
4343
<fieldsynopsis>
44-
<modifier>protected</modifier>
44+
<modifier>public</modifier>
45+
<modifier>readonly</modifier>
4546
<type>object</type>
4647
<varname linkend="mongodb-driver-exception-commandexception.props.resultdocument">resultDocument</varname>
4748
</fieldsynopsis>
@@ -83,6 +84,31 @@
8384
</section>
8485
<!-- }}} -->
8586

87+
<section role="changelog">
88+
&reftitle.changelog;
89+
<informaltable>
90+
<tgroup cols="2">
91+
<thead>
92+
<row>
93+
<entry>&Version;</entry>
94+
<entry>&Description;</entry>
95+
</row>
96+
</thead>
97+
<tbody>
98+
<row>
99+
<entry>PECL mongodb 2.3.0</entry>
100+
<entry>
101+
<simpara>
102+
La propriété <varname>resultDocument</varname> est désormais
103+
<modifier>public</modifier> <modifier>readonly</modifier>.
104+
</simpara>
105+
</entry>
106+
</row>
107+
</tbody>
108+
</tgroup>
109+
</informaltable>
110+
</section>
111+
86112
</partintro>
87113

88114
&reference.mongodb.mongodb.driver.exception.entities.commandexception;

‎reference/mongodb/mongodb/driver/manager/construct.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready -->
2+
<!-- EN-Revision: 36c32a2a930308443ad7fcbbc373c31cc02b9a4e Maintainer: lacatoire Status: ready -->
33
<!-- Reviewed: yes -->
44
<refentry xml:id="mongodb-driver-manager.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
@@ -207,6 +207,16 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
207207
</simpara>
208208
</entry>
209209
</row>
210+
<row>
211+
<entry>enableOverloadRetargeting</entry>
212+
<entry><type>bool</type></entry>
213+
<entry>
214+
<simpara>
215+
Lorsque définie à &true;, force la sélection du serveur après une
216+
<literal>SystemOverloadedError</literal>. Par défaut à &false;.
217+
</simpara>
218+
</entry>
219+
</row>
210220
<row>
211221
<entry>heartbeatFrequencyMS</entry>
212222
<entry><type>int</type></entry>
@@ -260,6 +270,17 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
260270
</simpara>
261271
</entry>
262272
</row>
273+
<row>
274+
<entry>maxAdaptiveRetries</entry>
275+
<entry><type>int</type></entry>
276+
<entry>
277+
<simpara>
278+
Cette option peut être utilisée pour modifier le nombre maximum de tentatives
279+
lorsqu'une <literal>SystemOverloadedError</literal> se produit. Doit être un
280+
entier positif; par défaut à <literal>2</literal>.
281+
</simpara>
282+
</entry>
283+
</row>
263284
<row>
264285
<entry>maxStalenessSeconds</entry>
265286
<entry><type>int</type></entry>

‎reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml‎

Lines changed: 189 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: lacatoire Status: ready -->
3+
<!-- EN-Revision: 36c32a2a930308443ad7fcbbc373c31cc02b9a4e Maintainer: lacatoire Status: ready -->
44
<!-- Reviewed: no -->
55

66
<reference xml:id="class.mongodb-driver-monitoring-commandfailedevent" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -35,14 +35,201 @@
3535
</ooclass>
3636
</classsynopsisinfo>
3737
<!-- }}} -->
38-
38+
39+
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
40+
<fieldsynopsis>
41+
<modifier>public</modifier>
42+
<modifier>readonly</modifier>
43+
<type>string</type>
44+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.host">host</varname>
45+
</fieldsynopsis>
46+
<fieldsynopsis>
47+
<modifier>public</modifier>
48+
<modifier>readonly</modifier>
49+
<type>int</type>
50+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.port">port</varname>
51+
</fieldsynopsis>
52+
<fieldsynopsis>
53+
<modifier>public</modifier>
54+
<modifier>readonly</modifier>
55+
<type>string</type>
56+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.commandname">commandName</varname>
57+
</fieldsynopsis>
58+
<fieldsynopsis>
59+
<modifier>public</modifier>
60+
<modifier>readonly</modifier>
61+
<type>string</type>
62+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.databasename">databaseName</varname>
63+
</fieldsynopsis>
64+
<fieldsynopsis>
65+
<modifier>public</modifier>
66+
<modifier>readonly</modifier>
67+
<type>int</type>
68+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.duration">duration</varname>
69+
</fieldsynopsis>
70+
<fieldsynopsis>
71+
<modifier>public</modifier>
72+
<modifier>readonly</modifier>
73+
<type>Exception</type>
74+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.error">error</varname>
75+
</fieldsynopsis>
76+
<fieldsynopsis>
77+
<modifier>public</modifier>
78+
<modifier>readonly</modifier>
79+
<type>object</type>
80+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.reply">reply</varname>
81+
</fieldsynopsis>
82+
<fieldsynopsis>
83+
<modifier>public</modifier>
84+
<modifier>readonly</modifier>
85+
<type>string</type>
86+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.operationid">operationId</varname>
87+
</fieldsynopsis>
88+
<fieldsynopsis>
89+
<modifier>public</modifier>
90+
<modifier>readonly</modifier>
91+
<type>string</type>
92+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.requestid">requestId</varname>
93+
</fieldsynopsis>
94+
<fieldsynopsis>
95+
<modifier>public</modifier>
96+
<modifier>readonly</modifier>
97+
<type class="union"><type>MongoDB\BSON\ObjectId</type><type>null</type></type>
98+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.serviceid">serviceId</varname>
99+
</fieldsynopsis>
100+
<fieldsynopsis>
101+
<modifier>public</modifier>
102+
<modifier>readonly</modifier>
103+
<type class="union"><type>int</type><type>null</type></type>
104+
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.serverconnectionid">serverConnectionId</varname>
105+
</fieldsynopsis>
106+
39107
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
40108
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-monitoring-commandfailedevent')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
41109
</classsynopsis>
42110
<!-- }}} -->
43111

44112
</section>
45113

114+
<!-- {{{ MongoDB\Driver\Monitoring\CommandFailedEvent properties -->
115+
<section xml:id="mongodb-driver-monitoring-commandfailedevent.props">
116+
&reftitle.properties;
117+
<variablelist>
118+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.host">
119+
<term><varname>host</varname></term>
120+
<listitem>
121+
<simpara>Le nom d'hôte du serveur ayant exécuté la commande.</simpara>
122+
</listitem>
123+
</varlistentry>
124+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.port">
125+
<term><varname>port</varname></term>
126+
<listitem>
127+
<simpara>Le port du serveur ayant exécuté la commande.</simpara>
128+
</listitem>
129+
</varlistentry>
130+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.commandname">
131+
<term><varname>commandName</varname></term>
132+
<listitem>
133+
<simpara>Le nom de la commande.</simpara>
134+
</listitem>
135+
</varlistentry>
136+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.databasename">
137+
<term><varname>databaseName</varname></term>
138+
<listitem>
139+
<simpara>Le nom de la base de données.</simpara>
140+
</listitem>
141+
</varlistentry>
142+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.duration">
143+
<term><varname>duration</varname></term>
144+
<listitem>
145+
<simpara>
146+
La durée de la commande en microsecondes. La durée est une valeur
147+
calculée qui inclut le temps d'envoi du message et de réception de
148+
la réponse du serveur.
149+
</simpara>
150+
</listitem>
151+
</varlistentry>
152+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.error">
153+
<term><varname>error</varname></term>
154+
<listitem>
155+
<simpara>L'exception qui a été levée lorsque la commande a échoué.</simpara>
156+
</listitem>
157+
</varlistentry>
158+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.reply">
159+
<term><varname>reply</varname></term>
160+
<listitem>
161+
<simpara>Le document de réponse d'échec retourné par le serveur.</simpara>
162+
</listitem>
163+
</varlistentry>
164+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.operationid">
165+
<term><varname>operationId</varname></term>
166+
<listitem>
167+
<simpara>
168+
L'identifiant d'opération. Il peut être utilisé pour relier des
169+
évènements entre eux, comme les écritures groupées (bulk writes),
170+
qui peuvent dispatcher plusieurs commandes.
171+
</simpara>
172+
</listitem>
173+
</varlistentry>
174+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.requestid">
175+
<term><varname>requestId</varname></term>
176+
<listitem>
177+
<simpara>
178+
L'identifiant de requête. Il peut être utilisé pour associer cet
179+
<classname>MongoDB\Driver\Monitoring\CommandFailedEvent</classname>
180+
avec un
181+
<classname>MongoDB\Driver\Monitoring\CommandStartedEvent</classname>
182+
correspondant.
183+
</simpara>
184+
</listitem>
185+
</varlistentry>
186+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.serviceid">
187+
<term><varname>serviceId</varname></term>
188+
<listitem>
189+
<simpara>
190+
L'identifiant de service, ou &null; si le serveur ne le prend pas
191+
en charge (c'est-à-dire qu'il n'utilise pas le mode équilibrage de
192+
charge).
193+
</simpara>
194+
</listitem>
195+
</varlistentry>
196+
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.serverconnectionid">
197+
<term><varname>serverConnectionId</varname></term>
198+
<listitem>
199+
<simpara>
200+
L'identifiant de connexion au serveur, ou &null; s'il n'est pas
201+
disponible.
202+
</simpara>
203+
</listitem>
204+
</varlistentry>
205+
</variablelist>
206+
</section>
207+
<!-- }}} -->
208+
209+
<section role="changelog">
210+
&reftitle.changelog;
211+
<informaltable>
212+
<tgroup cols="2">
213+
<thead>
214+
<row>
215+
<entry>&Version;</entry>
216+
<entry>&Description;</entry>
217+
</row>
218+
</thead>
219+
<tbody>
220+
<row>
221+
<entry>PECL mongodb 2.3.0</entry>
222+
<entry>
223+
Ajout des propriétés publiques <modifier>readonly</modifier>. La
224+
propriété <varname>duration</varname> remplace la méthode
225+
<methodname>getDurationMicros</methodname>.
226+
</entry>
227+
</row>
228+
</tbody>
229+
</tgroup>
230+
</informaltable>
231+
</section>
232+
46233
</partintro>
47234

48235
&reference.mongodb.mongodb.driver.monitoring.entities.commandfailedevent;

0 commit comments

Comments
 (0)