phpm.ru | Вставляет документ в коллекцию

Описание

public MongoCollection::insert ( array|object $document , array $options = array() ) : bool|array

Все строки, отправляемые в базу данных, должны быть в формате UTF-8. Если строка не UTF-8, будет выдано исключение MongoException. Чтобы вставить (или запросить) строку не-UTF-8, используйте MongoBinData.

Список параметров

document

Массив или объект. Если используется объект, он может не иметь защищенных или закрытых свойств.

Замечание:
Если у параметра нет ключа или свойства _id, будет создан новый экземпляр MongoId и назначен ему. Это специальное поведение не означает, что параметр передается по ссылке.

options

Массив опций для операции вставки. В настоящее время доступны следующие варианты:

"fsync"
Булево, по умолчанию false. Если включено журналирование, то работает также как и "j". Если журналирование не включено, то операции записи блокируются пока не будут синхронизированы с файлами на жестком диске. Если true, то применяется подтвержденная вставка и эта опция переопределяет опцию "w" в значение 0.
Замечание: Если журналирование включено, то пользователю настоятельно рекомендуется использовать опцию "j" вместо "fsync". Не используйте "fsync" и "j" одновременно,так как это может привести к ошибке.
"j"
Булево, по умолчанию false. Блокирует операции записи пока они не будут синхронизированы с журналом на диске. Если true, то применяется подтвержденная вставка и эта опция переопределяет опцию "w" в значение 0.
Замечание: Если применяется эта опция и журналирование отключено, то MongoDB 2.6+ выбросит ошибку и прервет запись; старые версии сервера просто игнорируют эту опцию.
"socketTimeoutMS"
Эта опция определяет время в миллисекундах для общения в socket. Если сервер не ответил за отведенное время, то будет брошено исключение MongoCursorTimeoutException, и не будет никакой возможности определить произвел ли сервер запись или нет. Значение -1 используется для постоянно отключения этой функции. Значением по умолчанию для MongoClient является 30000 (30 секунд).
"w"
Смотрите Контроль записи. Значение по умолчанию для MongoClient является 1.
"wTimeoutMS"
Эта опция определяет лимит времени в миллисекундах для подтверждения контроля записи. Она применима только, если "w" больше 1, так как ограничение времени относится к репликации. Если контроль записи не подтвержден за отведенное время, то будет выброшено исключение MongoCursorException. Значение 0 для постоянного отключения. Значением по умолчанию для MongoClient является 10000 (десять секунд).

Следующие параметры устарели и больше не должны использоваться:

"safe"
Устаревшая опция. Используйте опцию "w" контроля записи.
"timeout"
Устаревший псевдоним для "socketTimeoutMS".
"wtimeout"
Устаревший псевдоним для "wTimeoutMS".

Возвращаемые значения

Возвращает массив, содержащий состояние вставки, если установлена опция "w". В противном случае возвращает true, если вставленный массив не пустой (исключение MongoException будет выдано, если вставленный массив пуст).

Если возвращается массив, могут присутствовать следующие ключи:

ok: Это почти всегда будет 1 (если не произошел сбой самого last_error).
err: Если это поле не null, произошла ошибка в предыдущей операции. Если это поле установлено, это будет строка, описывающая возникшую ошибку.
code: Если произошла ошибка базы данных, соответствующий код ошибки будет передан обратно клиенту.
errmsg: Это поле устанавливается, если что-то идет не так с командой базы данных. Это связано с тем, что ok равно 0. Например, если w установлено и время ожидания истекло, для errmsg будет установлено значение «превышено время ожидания подчиненных устройств», и значение ok будет равно 0. Если это поле установлено, оно будет строкой, описывающей произошла ошибка.
n: Если последней операцией было обновление, удаление или удаление, будет возвращено количество затронутых документов. Для операций вставки это значение всегда равно 0.
wtimeout: Если для предыдущего варианта истекло время ожидания репликации.
waited: Сколько времени операция ожидала до истечения времени ожидания.
wtime: Если w был установлен и операция прошла успешно, сколько времени потребовалось для репликации на w серверов.
upserted: Если произошел сбой, это поле будет содержать поле _id новой записи. Для слияния будет присутствовать это поле или updatedExisting (если ошибка не произошла).
updatedExisting: Если слияние обновило существующий элемент, это поле будет истинным. Для слияния будет присутствовать это поле или upserted (если ошибка не произошла).

Ошибки

Выдает исключение MongoException, если вставленный документ пуст или содержит ключи нулевой длины. Попытка вставить объект с защищенными и закрытыми свойствами приведет к ошибке ключа нулевой длины.

Исключение MongoCursorException бросается, если установлена опция "w" и не прошла запись.

Исключение MongoCursorTimeoutException бросается, если опция "w" установлена в значение больше одного и операция заняла больше, чем MongoCursor::$timeout миллисекунд. При этом операция на сервере не прерывается, так как это ограничение времени работает на клиентской стороне. Операция в миллисекундах в MongoCollection::$wtimeout.

Список изменений

Версия	Описание
PECL mongo 1.5.0	Добавлена опция `"wTimeoutMS"`, которая заменяет `"wtimeout"`. Выдает `E_DEPRECATED`, когда используется `"wtimeout"`. Добавлена опция `"socketTimeoutMS"`, которая заменяет `"timeout"`. Выдает `E_DEPRECATED`, когда используется `"timeout"`. Выдает `E_DEPRECATED`, когда используется `"safe"`.
PECL mongo 1.3.4	Добавлена опция `"wtimeout"`.
PECL mongo 1.3.0	Добавлена опция `"w"` option. Параметр `options` больше не принимает логическое значение для обозначения подтвержденной записи. Вместо этого теперь это должно быть сделано с `array('w' => 1)` (поведение по умолчанию MongoClient).
PECL mongo 1.2.0	Добавлена опция `"timeout"`.
PECL mongo 1.0.11	Отключается при ошибках "not master", если установлен `"safe"`.
PECL mongo 1.0.9	Добавлена возможность передавать целые числа в опцию `"safe"`, которая ранее принимала только логические значения. Добавлена опция `"fsync"`. Тип возвращаемого значения был изменен на массив, содержащий информацию об ошибке, если используется параметр `"safe"`. В противном случае логическое значение возвращается, как и раньше.
PECL mongo 1.0.2	Изменен второй параметр, чтобы он был массивом опций. До версии 1.0.2 вторым параметром был логический параметр, указывающий `"safe"` параметр.
PECL mongo 1.0.1	Выдает исключение MongoCursorException, если установлена опция `"safe"` и вставка завершается неудачно.

Примеры

Пример #1 Пример использования MongoCollection::insert() _id

Поле _id будет добавлено во вставленный документ, если его еще нет. В зависимости от того, как передан параметр, сгенерированный _id может быть или не быть доступен для вызывающего кода.


<?php

$m = new MongoClient();
$collection = $m->selectCollection('test', 'phpmanual');

// Если используется литерал массива, то нет доступа к сгенерированному _id
$collection->insert(array('x' => 1));

// _id доступен для массива, переданного по значению
$a = array('x' => 2);
$collection->insert($a);
var_dump($a);

// _id недоступен для массива, переданного по ссылке
$b = array('x' => 3);
$ref = &$b;
$collection->insert($ref);
var_dump($ref);

// _id доступен, если функция переноса не запускает копирование при записи
function insert_no_cow($collection, $document)
{
    $collection->insert($document);
}

$c = array('x' => 4);
insert_no_cow($collection, $c);
var_dump($c);

// _id недоступен, если функция переноса запускает копирование при записи
function insert_cow($collection, $document)
{
    $document['y'] = 1;
    $collection->insert($document);
}

$d = array('x' => 5);
insert_cow($collection, $d);
var_dump($d);

?>

Результатом выполнения данного примера будет что-то подобное:

array(2) {
  ["x"]=>
  int(2)
  ["_id"]=>
  object(MongoId)#4 (0) {
  }
}
array(1) {
  ["x"]=>
  int(3)
}
array(2) {
  ["x"]=>
  int(4)
  ["_id"]=>
  object(MongoId)#5 (0) {
  }
}
array(1) {
  ["x"]=>
  int(5)
}

Пример #2 Пример использования MongoCollection::insert() c подтверждением записи

В этом примере показана вставка двух элементов с одинаковым _id, которое вызовет исключение MongoCursorException, которое было задано для w.


<?php

$person = array("name" => "Joe", "age" => 20);
$collection->insert($person);

// теперь $person имеет поле _id, поэтому, 
// если мы сохраним его снова, мы получим исключение
try {
    $collection->insert($person, array("w" => 1));
} catch(MongoCursorException $e) {
    echo "Не могу сохранить того же человека дважды!\n";
}

?>

Смотрите также

MongoCollection::batchInsert() - Вставляет несколько документов в коллекцию
MongoCollection::update() - Обновляет записи на основе заданных критериев
MongoCollection::find() - Запрашивает коллекцию, возвращая MongoCursor для набора результатов
MongoCollection::remove() - Удаление записей из коллекции
Основные документы MongoDB по » вставке.