mirror of
https://github.com/php/doc-ru.git
synced 2025-08-16 18:22:04 +00:00
de36369f6d
git-svn-id: https://svn.php.net/repository/phpdoc/ru/trunk@347236 c90b9560-bf6c-de11-be94-00142212c4b1
584 lines
15 KiB
XML
584 lines
15 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
<!-- EN-Revision: 0d871eae6ef2187b9b89c16109afc4697ab6fa12 Maintainer: sergey Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
|
||
<refentry xml:id="mongocollection.aggregate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>MongoCollection::aggregate</refname>
|
||
<refpurpose>Выполняет агрегацию с использованием структуры агрегации</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<modifier>public</modifier> <type>array</type><methodname>MongoCollection::aggregate</methodname>
|
||
<methodparam><type>array</type><parameter>pipeline</parameter></methodparam>
|
||
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<methodsynopsis>
|
||
<modifier>public</modifier> <type>array</type><methodname>MongoCollection::aggregate</methodname>
|
||
<methodparam><type>array</type><parameter>op</parameter></methodparam>
|
||
<methodparam choice="opt"><type>array</type><parameter>op</parameter></methodparam>
|
||
<methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
<link xlink:href="&url.mongodb.docs.aggregation;">Платформа агрегации</link> MongoDB
|
||
предоставляет средства для вычисления агрегированных значений без использования MapReduce.
|
||
Несмотря на то, что MapReduce является мощным средством, оно зачастую сложнее,
|
||
чем необходимо для многих простых задач агрегирования, таких как суммирование
|
||
или вычисление среднего значения полей.
|
||
</para>
|
||
<para>
|
||
Метод принимает либо переменное количество операторов конвейера,
|
||
либо один массив операторов, составляющих конвейер.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>pipeline</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Массив операторов конвейера.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>options</parameter></term>
|
||
<listitem>
|
||
<para>Опции для команды агрегации. Допустимые варианты:</para>
|
||
<itemizedlist>
|
||
<listitem>
|
||
<para><literal>"allowDiskUse"</literal></para>
|
||
<para>Разрешить этапы агрегации для записи во временные файлы</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para><literal>"cursor"</literal></para>
|
||
<para>
|
||
Опции, управляющие созданием объекта курсора.
|
||
Эта опция заставляет команду возвращать результат документа,
|
||
подходящий для создания <classname>MongoCommandCursor</classname>.
|
||
Если вам нужно использовать эту опцию,
|
||
вы должны рассмотреть возможность
|
||
использования <methodname>MongoCollection::aggregateCursor</methodname>.
|
||
</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para><literal>"explain"</literal></para>
|
||
<para>Вернуть информацию об обработке конвейера.</para>
|
||
</listitem>
|
||
&mongo.command.parameters.maxtimems;
|
||
</itemizedlist>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
<para>Or</para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>op</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Первый оператор конвейера.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>op</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Второй оператор конвейера.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>...</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Дополнительные операторы конвейера.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Результат агрегации в виде массива. <varname>ok</varname> будет
|
||
установлен в качестве <literal>1</literal> в случае успеха,
|
||
<literal>0</literal> в случае ошибки.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="errors">
|
||
&reftitle.errors;
|
||
<para>
|
||
При возникновении ошибки возвращается массив со следующими ключами:
|
||
<itemizedlist>
|
||
<listitem>
|
||
<simpara>
|
||
<varname>errmsg</varname> - с указанием причины отказа
|
||
</simpara>
|
||
</listitem>
|
||
<listitem>
|
||
<simpara>
|
||
<varname>code</varname> - код ошибки сбоя
|
||
</simpara>
|
||
</listitem>
|
||
<listitem>
|
||
<simpara>
|
||
<varname>ok</varname> - будет установлен 0.
|
||
</simpara>
|
||
</listitem>
|
||
</itemizedlist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="changelog"><!-- {{{ -->
|
||
&reftitle.changelog;
|
||
<informaltable>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>&Version;</entry>
|
||
<entry>&Description;</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
<row>
|
||
<entry>1.5.0</entry>
|
||
<entry>
|
||
Добавлен необязательный аргумент <parameter>options</parameter>
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</refsect1><!-- }}} -->
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<example xml:id="mongocollection.aggregate.example.basic">
|
||
<title>Пример использования <methodname>MongoCollection::aggregate</methodname></title>
|
||
<para>
|
||
В следующем примере операция агрегирования поворачивает данные,
|
||
чтобы создать набор имен авторов, сгруппированных по тегам,
|
||
примененным к статье. Вызовите структуру агрегации, введя следующую команду:
|
||
</para>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$m = new MongoClient("localhost");
|
||
$c = $m->selectDB("examples")->selectCollection("article");
|
||
$data = array (
|
||
'title' => 'this is my title',
|
||
'author' => 'bob',
|
||
'posted' => new MongoDate,
|
||
'pageViews' => 5,
|
||
'tags' => array ( 'fun', 'good', 'fun' ),
|
||
'comments' => array (
|
||
array (
|
||
'author' => 'joe',
|
||
'text' => 'this is cool',
|
||
),
|
||
array (
|
||
'author' => 'sam',
|
||
'text' => 'this is bad',
|
||
),
|
||
),
|
||
'other' =>array (
|
||
'foo' => 5,
|
||
),
|
||
);
|
||
$d = $c->insert($data, array("w" => 1));
|
||
|
||
$ops = array(
|
||
array(
|
||
'$project' => array(
|
||
"author" => 1,
|
||
"tags" => 1,
|
||
)
|
||
),
|
||
array('$unwind' => '$tags'),
|
||
array(
|
||
'$group' => array(
|
||
"_id" => array("tags" => '$tags'),
|
||
"authors" => array('$addToSet' => '$author'),
|
||
),
|
||
),
|
||
);
|
||
$results = $c->aggregate($ops);
|
||
var_dump($results);
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
array(2) {
|
||
["result"]=>
|
||
array(2) {
|
||
[0]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
array(1) {
|
||
["tags"]=>
|
||
string(4) "good"
|
||
}
|
||
["authors"]=>
|
||
array(1) {
|
||
[0]=>
|
||
string(3) "bob"
|
||
}
|
||
}
|
||
[1]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
array(1) {
|
||
["tags"]=>
|
||
string(3) "fun"
|
||
}
|
||
["authors"]=>
|
||
array(1) {
|
||
[0]=>
|
||
string(3) "bob"
|
||
}
|
||
}
|
||
}
|
||
["ok"]=>
|
||
float(1)
|
||
}
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
|
||
<para>
|
||
В следующих примерах используется
|
||
<link xlink:href="&url.mongodb.examples.zipcode;">набор данных zipcode</link>.
|
||
Используйте mongoimport для загрузки этого набора данных в ваш экземпляр mongod.
|
||
</para>
|
||
|
||
<example xml:id="mongocollection.aggregate.example.zipcode.population">
|
||
<title>Пример использования <methodname>MongoCollection::aggregate</methodname></title>
|
||
<para>
|
||
Чтобы вернуть все штаты с населением более 10 миллионов, используйте следующую операцию агрегирования:
|
||
</para>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$m = new MongoClient("localhost");
|
||
$c = $m->selectDB("test")->selectCollection("zips");
|
||
|
||
$pipeline = array(
|
||
array(
|
||
'$group' => array(
|
||
'_id' => array('state' => '$state'),
|
||
'totalPop' => array('$sum' => '$pop')
|
||
)
|
||
),
|
||
array(
|
||
'$match' => array(
|
||
'totalPop' => array('$gte' => 10 * 1000 * 1000)
|
||
)
|
||
),
|
||
);
|
||
$out = $c->aggregate($pipeline);
|
||
var_dump($out);
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs.similar;
|
||
<screen>
|
||
<![CDATA[
|
||
array(2) {
|
||
["result"]=>
|
||
array(7) {
|
||
[0]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "TX"
|
||
["totalPop"]=>
|
||
int(16986510)
|
||
}
|
||
[1]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "PA"
|
||
["totalPop"]=>
|
||
int(11881643)
|
||
}
|
||
[2]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "NY"
|
||
["totalPop"]=>
|
||
int(17990455)
|
||
}
|
||
[3]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "IL"
|
||
["totalPop"]=>
|
||
int(11430602)
|
||
}
|
||
[4]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "CA"
|
||
["totalPop"]=>
|
||
int(29760021)
|
||
}
|
||
[5]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "OH"
|
||
["totalPop"]=>
|
||
int(10847115)
|
||
}
|
||
[6]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "FL"
|
||
["totalPop"]=>
|
||
int(12937926)
|
||
}
|
||
}
|
||
["ok"]=>
|
||
float(1)
|
||
}
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
|
||
<example xml:id="mongocollection.aggregate.example.zipcode.population.average">
|
||
<title>Пример использования <methodname>MongoCollection::aggregate</methodname></title>
|
||
<para>
|
||
Чтобы получить среднюю численность населения по городам в каждом штате, используйте следующую операцию агрегирования:
|
||
</para>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$m = new MongoClient;
|
||
$c = $m->selectDB("test")->selectCollection("zips");
|
||
|
||
$out = $c->aggregate(
|
||
array(
|
||
'$group' => array(
|
||
'_id' => array('state' => '$state', 'city' => '$city' ),
|
||
'pop' => array('$sum' => '$pop' )
|
||
)
|
||
),
|
||
array(
|
||
'$group' => array(
|
||
'_id' => '$_id.state',
|
||
'avgCityPop' => array('$avg' => '$pop')
|
||
)
|
||
)
|
||
);
|
||
|
||
var_dump($out);
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs.similar;
|
||
<screen>
|
||
<![CDATA[
|
||
array(2) {
|
||
["result"]=>
|
||
array(51) {
|
||
[0]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "DC"
|
||
["avgCityPop"]=>
|
||
float(303450)
|
||
}
|
||
[1]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "DE"
|
||
["avgCityPop"]=>
|
||
float(14481.913043478)
|
||
}
|
||
...
|
||
[49]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "WI"
|
||
["avgCityPop"]=>
|
||
float(7323.0074850299)
|
||
}
|
||
[50]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(2) "WV"
|
||
["avgCityPop"]=>
|
||
float(2759.1953846154)
|
||
}
|
||
}
|
||
["ok"]=>
|
||
float(1)
|
||
}
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
|
||
<example xml:id="mongocollection.aggregate.example.zipcode.explain">
|
||
<title><methodname>MongoCollection::aggregate</methodname>с параметрами команды</title>
|
||
<para>
|
||
Чтобы вернуть информацию о том, как будет обрабатываться конвейер,
|
||
мы используем опцию команды <literal>explain</literal>:
|
||
</para>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$m = new MongoClient;
|
||
$c = $m->selectDB("test")->selectCollection("zips");
|
||
|
||
$pipeline = array(
|
||
array(
|
||
'$group' => array(
|
||
'_id' => '$state',
|
||
'totalPop' => array('$sum' => '$pop'),
|
||
),
|
||
),
|
||
array(
|
||
'$match' => array(
|
||
'totalPop' => array('$gte' => 10 * 1000 * 1000)
|
||
)
|
||
),
|
||
array(
|
||
'$sort' => array("totalPop" => -1),
|
||
),
|
||
);
|
||
|
||
$options = array("explain" => true);
|
||
$out = $c->aggregate($pipeline, $options);
|
||
var_dump($out);
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs.similar;
|
||
<screen>
|
||
<![CDATA[
|
||
array(2) {
|
||
["stages"]=>
|
||
array(4) {
|
||
[0]=>
|
||
array(1) {
|
||
["$cursor"]=>
|
||
array(3) {
|
||
["query"]=>
|
||
array(0) {
|
||
}
|
||
["fields"]=>
|
||
array(3) {
|
||
["pop"]=>
|
||
int(1)
|
||
["state"]=>
|
||
int(1)
|
||
["_id"]=>
|
||
int(0)
|
||
}
|
||
["plan"]=>
|
||
array(4) {
|
||
["cursor"]=>
|
||
string(11) "BasicCursor"
|
||
["isMultiKey"]=>
|
||
bool(false)
|
||
["scanAndOrder"]=>
|
||
bool(false)
|
||
["allPlans"]=>
|
||
array(1) {
|
||
[0]=>
|
||
array(3) {
|
||
["cursor"]=>
|
||
string(11) "BasicCursor"
|
||
["isMultiKey"]=>
|
||
bool(false)
|
||
["scanAndOrder"]=>
|
||
bool(false)
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
[1]=>
|
||
array(1) {
|
||
["$group"]=>
|
||
array(2) {
|
||
["_id"]=>
|
||
string(6) "$state"
|
||
["totalPop"]=>
|
||
array(1) {
|
||
["$sum"]=>
|
||
string(4) "$pop"
|
||
}
|
||
}
|
||
}
|
||
[2]=>
|
||
array(1) {
|
||
["$match"]=>
|
||
array(1) {
|
||
["totalPop"]=>
|
||
array(1) {
|
||
["$gte"]=>
|
||
int(10000000)
|
||
}
|
||
}
|
||
}
|
||
[3]=>
|
||
array(1) {
|
||
["$sort"]=>
|
||
array(1) {
|
||
["sortKey"]=>
|
||
array(1) {
|
||
["totalPop"]=>
|
||
int(-1)
|
||
}
|
||
}
|
||
}
|
||
}
|
||
["ok"]=>
|
||
float(1)
|
||
}
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<simplelist>
|
||
<member><methodname>MongoCollection::aggregateCursor</methodname></member>
|
||
<member><link xlink:href="&url.mongodb.docs.aggregation;">Структуры агрегации</link> MongoDB</member>
|
||
</simplelist>
|
||
</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
|
||
indent-tabs-mode:nil
|
||
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
|
||
-->
|