Skip to content

MongoDB: document readonly properties #5496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alcaeus wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

MongoDB: document readonly properties #5496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>protected</modifier>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>MongoDB\Driver\WriteResult</type>
<varname linkend="mongodb-driver-exception-bulkwriteexception.props.writeresult">writeResult</varname>
</fieldsynopsis>
Expand Down Expand Up @@ -96,6 +97,13 @@
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
The <varname>writeResult</varname> property is now
<modifier>public</modifier> <modifier>readonly</modifier>.
</entry>
</row>
<row>
<entry>PECL mongodb 2.0.0</entry>
<entry>
Expand Down
28 changes: 27 additions & 1 deletion reference/mongodb/mongodb/driver/exception/commandexception.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>protected</modifier>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>object</type>
<varname linkend="mongodb-driver-exception-commandexception.props.resultdocument">resultDocument</varname>
</fieldsynopsis>
Expand Down Expand Up @@ -84,6 +85,31 @@
</section>
<!-- }}} -->

<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
The <varname>resultDocument</varname> property is now
<modifier>public</modifier> <modifier>readonly</modifier>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>

</partintro>

&reference.mongodb.mongodb.driver.exception.entities.commandexception;
Expand Down
187 changes: 186 additions & 1 deletion reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,199 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->


<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.host">host</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.port">port</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.commandname">commandName</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.databasename">databaseName</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.duration">duration</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>Exception</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.error">error</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>object</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.reply">reply</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.operationid">operationId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.requestid">requestId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>MongoDB\BSON\ObjectId</type><type>null</type></type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.serviceid">serviceId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type class="union"><type>int</type><type>null</type></type>
<varname linkend="mongodb-driver-monitoring-commandfailedevent.props.serverconnectionid">serverConnectionId</varname>
</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<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')])" />
</classsynopsis>
<!-- }}} -->

</section>

<!-- {{{ MongoDB\Driver\Monitoring\CommandFailedEvent properties -->
<section xml:id="mongodb-driver-monitoring-commandfailedevent.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.host">
<term><varname>host</varname></term>
<listitem>
<para>The hostname of the server that executed the command.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.port">
<term><varname>port</varname></term>
<listitem>
<para>The port of the server that executed the command.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.commandname">
<term><varname>commandName</varname></term>
<listitem>
<para>The command name.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.databasename">
<term><varname>databaseName</varname></term>
<listitem>
<para>The database name.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.duration">
<term><varname>duration</varname></term>
<listitem>
<para>
The duration of the command in microseconds. The duration is a
calculated value that includes the time to send the message and
receive the response from the server.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.error">
<term><varname>error</varname></term>
<listitem>
<para>The exception that was thrown when the command failed.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.reply">
<term><varname>reply</varname></term>
<listitem>
<para>The failure reply document returned by the server.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.operationid">
<term><varname>operationId</varname></term>
<listitem>
<para>
The operation ID. This may be used to link events together such as
bulk writes, which may dispatch multiple commands.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.requestid">
<term><varname>requestId</varname></term>
<listitem>
<para>
The request ID. This may be used to associate this
<classname>MongoDB\Driver\Monitoring\CommandFailedEvent</classname>
with a corresponding
<classname>MongoDB\Driver\Monitoring\CommandStartedEvent</classname>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.serviceid">
<term><varname>serviceId</varname></term>
<listitem>
<para>
The service ID, or &null; if the server does not support it (i.e.
not using load-balanced mode).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-driver-monitoring-commandfailedevent.props.serverconnectionid">
<term><varname>serverConnectionId</varname></term>
<listitem>
<para>
The server connection ID, or &null; if not available.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->

<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 2.3.0</entry>
<entry>
Added public <modifier>readonly</modifier> properties. The
<varname>duration</varname> property replaces the
<methodname>getDurationMicros</methodname> method.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>

</partintro>

&reference.mongodb.mongodb.driver.monitoring.entities.commandfailedevent;
Expand Down
Loading