Edit Report a Bug

    MongoCollection::insert

    (PECL mongo >=0.9.0)

    MongoCollection::insert — Вставляет документ в коллекцию

    Описание

    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.

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

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

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

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

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

    1.3.4 Добавлена опция "wtimeout".
    1.3.0

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

    Параметр options больше не принимает логическое значение для обозначения подтвержденной записи. Вместо этого теперь это должно быть сделано с array('w' => 1) (поведение по умолчанию MongoClient).

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

    Добавлена возможность передавать целые числа в опцию "safe", которая ранее принимала только логические значения.

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

    Тип возвращаемого значения был изменен на массив, содержащий информацию об ошибке, если используется параметр "safe". В противном случае логическое значение возвращается, как и раньше.

    1.0.2 Изменен второй параметр, чтобы он был массивом опций. До версии 1.0.2 вторым параметром был логический параметр, указывающий "safe" параметр.
    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";
    }

    ?>

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

    add a note add a note

    User Contributed Notes 6 notes

    up
    3
    Christer Edvartsen
    13 years ago
    Also worth noting is that the MongoCollection::insert() method accepts objects as the first argument as well as arrays.

    <?php
    $data     = new stdClass;
    $data->foo = 'foo';
    $data->bar = 'bar';
    $collection->insert($data);
    var_dump($data->_id); // An instance of MongoId
    ?>

    You can use other classes as well, but MongoCollection::insert() will fail if the object contains any protected or private properties. Public properties listed in the class will also be inserted:

    <?php
    class SomeClass {
        public     $foo = 'bar';
        public     $bar = 'foo';
    }

    $data = new SomeClass;
    $data->foobar = 42;
    $collection->insert($data);
    var_dump($data->_id); // An instance of MongoId
    ?>

    will result in a document with four elements:

    _id => some mongoid
    foo => 'bar'
    bar => 'foo'
    foobar => 42
    up
    2
    gmail.com@mspreij
    11 years ago
    "Note: If the parameter does not have an _id key or property, a new MongoId instance will be created and assigned to it."

    Note on note: this is true even if the insert *fails* (because of, say, duplicate key error). So even if no new document was inserted, the supplied array will still have a new MongoID key ->_id after the ->insert().

    (which can make an attempted update after that fail, because you cannot update the _id value of a document..)
    up
    1
    root at php dot net
    11 years ago
    _id and MongoId can be a source of problems that can make what would seem a trivial operation potentially complicated.

    MongoId is not as predictable or safe as mysql's auto increment (an example that most PHP developers will be familiar with). _id is generated by the client rather than the server and so does not guarantee that it will be collision free.

    By comparison, server side auto_increment mechanisms that PHP programmers might typically be used to wont collide until every single id had been used and with 64bits you can ensure this will almost never happen. You will also know when your table is getting full, and you can predict the rate. Most importantly, no matter the mechanism, being server side guarantees two clients wont collide. Mongo's behaviour is different to this.

    Generally speaking inserting without specifying _id will tend to work, but there are some cases where is can fail or is particularly prone to failure.

    The total size I believe is 96 bits. This might seem like a lot but the value is not created randomly. It is generated like this:

    $unixtime . $machine_id . $pid . $counter

    The counter starts from zero and is attached to each instance of MongoClient thus two MongoClient connections to the same server will almost certainly not work (produce a collision):

    $m=new MongoWrapper();
    $m->insert([0]);
    $m=new MongoWrapper();
    $m->insert([1]);

    If MongoWrapper is not using a singleton for the connection or something to the same effect, the second call will most likely have the same unixtime. It will certainly have the same machine_id, pid and counter. The insert will fail.

    If you are not using a singleton, this will work:

    $m=new MongoWrapper();
    $m->insert([0]);
    $m->insert([1]);

    You may also have difficulties in a multiple machine environment.

    machine_id is a hash of gethostname. This is not guaranteed to be unique across machines. Some people do not set hostnames at all. If you do not ensure that your machines all have unique hostnames then if in the same second, two machines run a script that inserts, the second will have a 1 in 2^15 chance of colliding (assuming the most common PID max). Depending on how the system handles pids, the probability may actually be a little less. In short, make sure any host accessing your mongodb has a hostname that is unique among any other host accessing your mongodb.

    I've seen some specs specify that counter should start from a random value but I highly recommend against this as it merely hides/obscures the problem.
    up
    1
    mike at eastghost dot com
    10 years ago
    Attempting to insert() an array containing a NULL value followed by a blank space, in a non-utf8 encoding, results in the entire array (and all of its data) being ignored and the $opts array parameter being substituted instead as the data.
    up
    0
    cuisdy at gmail dot com
    12 years ago
    Another rarity to keep in mind. Passing references has the same effect as passing a referenced object. Even if there's no different for PHP between those two, it's probably not evident. So, this code would not have the _id field added to $a:

    <?php

    $b     = &$a;

    /* ... more code here ... */

    $m = new MongoClient;
    $collection = $m->test->phpmanual;

    $a = array('x' => 12);

    $collection->insert($a);
    var_dump($a);
    // array(1) { ["x"]=> int(12) }

    ?>

    I've made the assignment above to show how this situation could happen, if you reassigned a var, for example. But it could be some normal referencing after giving $a its final value (but before calling insert), and the consequence would be the same: if a var is referenced, it won't get the _id appended.
    up
    0
    John S.
    12 years ago
    Note, that the _id field will only be added to an inserted array if it does not already exist in the supplied array:

    <?php
    $data     = array('x' => 12);
    var_dump($data);
    $collection->insert($data);
    var_dump($data);
    ?>

    Will output something like:

    array(1) {
      ["x"]=>
      int(12)
    }
    array(2) {
      ["x"]=>
      int(12)
      ["_id"]=>
      object(MongoId)#196 (1) {
        ["$id"]=>
        string(24) "503e21fc0605290912000000"
      }
    }

    however,

    $data = array('x' => 12, '_id' => NULL);
    var_dump($data);
    $collection->insert($data);
    var_dump($data);

    will not have the same result:

    array(2) {
      ["x"]=>
      int(12)
      ["_id"]=>
      NULL
    }
    array(2) {
      ["x"]=>
      int(12)
      ["_id"]=>
      NULL
    }
    add a note add a note
    To Top