1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 332247 $ -->
<refentry xml:id="mongodb.repair" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB::repair</refname>
<refpurpose>Repairs and compacts this database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>MongoDB::repair</methodname>
<methodparam choice="opt"><type>bool</type><parameter>preserve_cloned_files</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>backup_original_files</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
This creates a fresh copy of all database data. It will remove any corrupt
data and compact and large stretches of free space it finds. This is a very
slow operation on a large database.
</para>
<para>
This is usually run from the shell or the command line, not the driver.
</para>
<para>
It is equivalent to the function:
<programlisting role="php">
<![CDATA[
<?php
public function repair() {
return $this->command(array('repairDatabase' => 1));
}
?>
]]>
</programlisting>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>preserve_cloned_files</parameter>
</term>
<listitem>
<para>
If cloned files should be kept if the repair fails.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>backup_original_files</parameter>
</term>
<listitem>
<para>
If original files should be backed up.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns db response.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.repairdatabase;">repairDatabase</link>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoDB::repair</function> example</title>
<para>This example demonstrates how to repare and compact a database.</para>
<programlisting role="php">
<![CDATA[
<?php
$db = $mongo->foo;
$response = $db->repair();
print_r($response);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[ok] => 1
)
]]>
</screen>
</example>
</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
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
-->
|
