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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 295518 $ -->
<refentry xml:id="mongodb.execute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB::execute</refname>
<refpurpose>Runs JavaScript code on the database server.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>MongoDB::execute</methodname>
<methodparam><type>mixed</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>args</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
The Mongo database server runs a JavaScript engine. This method allows you
to run arbitary JavaScript on the database. This can be useful if you want
touch a number of collections lightly, or process some results on the
database side to reduce the amount that has to be sent to the client.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>code</parameter>
</term>
<listitem>
<para>
<classname>MongoCode</classname> or string to execute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>args</parameter>
</term>
<listitem>
<para>
Arguments to be passed to <literal>code</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result of the evaluation.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Simple <function>MongoDB::execute</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$response = $db->execute("function() { return 'Hello, world!'; }");
echo $response['retval'];
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
Hello, world!
</screen>
</example>
<example>
<title>Parameter <function>MongoDB::execute</function> example</title>
<para>
The optional array of parameters will be passed to the JavaScript function.
</para>
<programlisting role="php">
<![CDATA[
<?php
$response = $db->execute("function(greeting, name) { return greeting+', '+name+'!'; }", array("Good bye", "Joe"));
echo $response['retval'];
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
Good bye, Joe!
</screen>
</example>
<example>
<title>Scope example</title>
<para>
If a <classname>MongoCode</classname> object is used instead of a string for
the first parameter, a scope can be passed in which the JavaScript will be
executed.
</para>
<programlisting role="php">
<![CDATA[
<?php
$func =
"function(greeting, name) { ".
"return greeting+', '+name+', says '+greeter;".
"}";
$scope = array("greeter" => "Fred");
$code = new MongoCode($func, $scope);
$response = $db->execute($code, array("Goodbye", "Joe"));
echo $response['retval'];
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
Goodbye, Joe, says Fred
</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
-->
|
