MongoCollection::save

(PECL mongo >=0.9.0)

MongoCollection::save — Сохраняет документ в коллекцию

Описание

public MongoCollection::save ( array|object $document [, array $options = array() ] ) : mixed

Если объект из базы данных, обновляет существующий объект базы данных, в противном случае добавояет этот объект.

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

document

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

Замечание:

Если у параметра нет ключа или свойства _id, будет создан новый экземпляр MongoId и назначен ему. Посмотрите MongoCollection::insert() для получения дополнительной информации об этом поведении.

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.

  • "wtimeout"

    Устаревший псевдоним для "wTimeoutMS".

  • "wTimeoutMS"

    Эта опция определяет лимит времени в миллисекундах для подтверждения контроля записи. Она применима только, если "w" больше 1, так как ограничение времени относится к репликации. Если контроль записи не подтвержден за отведенное время, то будет выброшено исключение MongoCursorException. Значение 0 для постоянного отключения. Значением по умолчанию для MongoClient является 10000 (десять секунд).

  • "safe"

    Устаревшая опция. Используйте опцию "w" контроля записи.

  • "timeout"

    Устаревший псевдоним для "socketTimeoutMS".

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

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

Ошибки

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

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

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

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

Версия Описание
1.5.0

Добавлена опция "wTimeoutMS", которая заменяет "wtimeout". Выдает E_DEPRECATED, когда используется "wtimeout".

Добавлена опция "socketTimeoutMS", которая заменяет "timeout". Выдает E_DEPRECATED, когда используется "timeout".

Выдает E_DEPRECATED, когда используется "safe".

1.2.0 Добавлена опция "timeout".
1.0.11 Отключается при ошибках "not master", если установлен "safe".
1.0.9

Добавлена опция "fsync".

1.0.5 Добавлен параметр options.

Примеры

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

<?php

$obj = array('x' => 1);

// вставляем $obj в БД
$collection->save($obj);
var_dump($obj);

// добавляем другое поле
$obj['foo'] = 'bar';

// $obj не может быть вставлен снова, вызывает ошибку дубликата _id
$collection->insert($obj);

// сохраняем обновления $obj с новым полем
$collection->save($obj);

?>

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

array(2) {
  ["x"]=>
  int(1)
  ["_id"]=>
  object(MongoId)#4 (1) {
    ["$id"]=>
    string(24) "50b6afe544415ed606000000"
  }
}