Класс MongoDB\Driver\WriteResult

(mongodb >=1.0.0)

Введение

Класс MongoDB\Driver\WriteResult инкапсулирует информацию о выполненном MongoDB\Driver\BulkWrite и может быть возвращён MongoDB\Driver\Manager::executeBulkWrite().

Обзор класса

final class MongoDB\Driver\WriteResult {

/* Свойства */

public readonly ?int $insertedCount;

public readonly ?int $matchedCount;

public readonly ?int $modifiedCount;

public readonly ?int $deletedCount;

public readonly ?int $upsertedCount;

public readonly MongoDB\Driver\Server $server;

public readonly array $upsertedIds;

public readonly array $writeErrors;

public readonly ?MongoDB\Driver\WriteConcernError $writeConcernError;

public readonly ?MongoDB\Driver\WriteConcern $writeConcern;

public readonly array $errorReplies;

/* Методы */

final public function getDeletedCount(): int

final public function getInsertedCount(): int

final public function getMatchedCount(): int

final public function getModifiedCount(): int

final public function getServer(): MongoDB\Driver\Server

final public function getUpsertedCount(): int

final public function getUpsertedIds(): array

final public function getWriteConcernError(): ?MongoDB\Driver\WriteConcernError

final public function getWriteErrors(): array

final public function isAcknowledged(): bool

}

Свойства

insertedCount: Количество вставленных документов (без upsert) или null, если write concern не запросил подтверждение.
matchedCount: Количество документов, найденных операциями обновления и замены, или null, если write concern не запросил подтверждение.
modifiedCount: Количество документов, изменённых операциями обновления и замены, или null, если write concern не запросил подтверждение или если сервер не сообщил эту информацию.
deletedCount: Количество удалённых документов или null, если write concern не запросил подтверждение.
upsertedCount: Количество upsert-документов или null, если write concern не запросил подтверждение.
server: Сервер, который выполнил bulk-операцию записи.
upsertedIds: Массив значений _id для upsert-документов. Ключи массива соответствуют индексу операции записи из MongoDB\Driver\BulkWrite.
writeErrors: Массив объектов MongoDB\Driver\WriteError для всех ошибок записи, которые возникли при выполнении.
writeConcernError: Объект MongoDB\Driver\WriteConcernError, если возникла ошибка write concern, или null, если ошибки не было.
writeConcern: Объект MongoDB\Driver\WriteConcern, который использовался для bulk-операции записи, или null, если недоступен.
errorReplies: Массив документов ответа об ошибке, который вернул сервер.

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

Версия	Описание
PECL-модуль mongodb 2.3.0	Добавлены свойства public readonly.

Содержание

MongoDB\Driver\WriteResult::getDeletedCount — Возвращает количество удалённых документов
MongoDB\Driver\WriteResult::getInsertedCount — Возвращает количество вставленных документов без учёта операций upsert
MongoDB\Driver\WriteResult::getMatchedCount — Возвращает количество документов, которые сервер выбрал для обновления
MongoDB\Driver\WriteResult::getModifiedCount — Возвращает количество существующих обновлённых документов
MongoDB\Driver\WriteResult::getServer — Возвращает сервер, который связан с этим результатом записи
MongoDB\Driver\WriteResult::getUpsertedCount — Возвращает количество документов, вставленных операцией upsert
MongoDB\Driver\WriteResult::getUpsertedIds — Возвращает массив идентификаторов для объединённых документов
MongoDB\Driver\WriteResult::getWriteConcernError — Возвращает любую ошибку гарантий записи, которая произошла
MongoDB\Driver\WriteResult::getWriteErrors — Возвращает любые ошибки записи, которые произошли
MongoDB\Driver\WriteResult::isAcknowledged — Возвращает, была ли запись подтверждена

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы