sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

PHP-938: please update description of 'fsync' write concern flag.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332016 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2013-10-30 11:05:02 +00:00
parent 5b851f93be
commit 34575dba02
2 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
language-snippets.ent
View file

@ -1729,7 +1729,7 @@ paths</simpara></warning>
<!ENTITY mongo.getreadpreference.returnvalues '<para xmlns="http://docbook.org/ns/docbook">This function returns an array describing the read preference. The array contains the values <literal>type</literal> for the string read preference mode (corresponding to the <classname>MongoClient</classname> constants), and <literal>tagsets</literal> containing a list of all tag set criteria. If no tag sets were specified, <literal>tagsets</literal> will not be present in the array.</para>'>
<!ENTITY mongo.writes.parameters.writeconcern '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"w"</literal></para><para>See <link linkend="mongo.writeconcerns">WriteConcerns</link>. The default value for <classname>MongoClient</classname> is <literal>1</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.writeconcerntimeout '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"wtimeout"</literal></para><para>How long to wait for <link linkend="mongo.writeconcerns">WriteConcern</link> acknowledgement. The default value for <classname>MongoClient</classname> is <literal>10000</literal> milliseconds.</para></listitem>'>
<!ENTITY mongo.writes.parameters.fsync '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"fsync"</literal></para><para>Boolean, defaults to &false;. Forces the insert to be synced to disk before returning success. If &true;, an acknowledged insert is implied and will override setting <literal>w</literal> to <literal>0</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.fsync '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"fsync"</literal></para><para>Boolean, defaults to &false;. If journalling is enabled, it works exactly like <literal>"j"</literal>. If journalling is not enabled, it forces the insert to be synced to disk before returning success. If &true;, an acknowledged insert is implied and will override setting <literal>w</literal> to <literal>0</literal>.</para><note><para>This option is <emphasis>deprecated</emphasis>. Please use the <literal>"j"</literal> option instead.</para></note></listitem>'>
<!-- <!ENTITY mongo.writes.parameters.sockettimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"socketTimeoutMS"</literal></para><para>Integer, defaults to <literal>MongoCursor::$timeout</literal>. If acknowledged writes are used, this sets how long (in milliseconds) for the client to wait for a database response. If the database does not respond within the timeout period, a <classname>MongoCursorTimeoutException</classname> will be thrown.</para></listitem>'> -->
<!ENTITY mongo.writes.parameters.journal '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"j"</literal></para><para>Boolean, defaults to &false;. Forces the insert to be synced to the journal before returning success. If &true;, an acknowledged insert is implied and will override setting <literal>w</literal> to <literal>0</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.safe '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"safe"</literal></para><para><emphasis>Deprecated</emphasis>. Please use the <link linkend="mongo.writeconcerns">WriteConcern</link> <literal>w</literal> option.</para></listitem>'>

18
reference/mongo/mongoclient/construct.xml
View file

@ -131,13 +131,21 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
</para>
<para>
When <literal>fsync</literal> is set, all write operations on the
database will block until the database server has flushed its
database files to disk. This makes write operations a lot slower,
database will only return when the write has been synched to disk.
This makes write operations a lot slower,
but it guarantees that the write operation has succeeded and
committed to disk. Please avoid <emphasis>using</emphasis> this
option and use the <literal>journal</literal> option instead,
perhaps in combination with the <literal>w</literal> option.
committed to disk. If you have journalling enabled in MongoDB (the
default) then the sync happens only to the
<emphasis>journal</emphasis>. If journalling is not enabled, then
using <literal>fsync</literal> requires a full flush to disk.
</para>
<warning>
<para>
Please <emphasis>do not use</emphasis> this option as it is
deprecated, but use <literal>journal</literal> option instead,
perhaps in combination with the <literal>w</literal> option.
</para>
</warning>
</listitem>
<listitem>
<para>