PHP Class Phalcon\Db\Adapter\MongoDB\BulkWriteResult

Afficher le fichier Open project: phalcon/incubator

Méthodes publiques

Méthode Description
__construct ( MongoDB\Driver\WriteResult $writeResult, array $insertedIds ) Constructor.
getDeletedCount ( ) : integer Return the number of documents that were deleted.
getInsertedCount ( ) : integer Return the number of documents that were inserted.
getInsertedIds ( ) : mixed[] Return a map of the inserted documents' IDs.
getMatchedCount ( ) : integer Return the number of documents that were matched by the filter.
getModifiedCount ( ) : integer | null Return the number of documents that were modified.
getUpsertedCount ( ) : integer Return the number of documents that were upserted.
getUpsertedIds ( ) : mixed[] Return a map of the upserted documents' IDs.
isAcknowledged ( ) : boolean Return whether this update was acknowledged by the server.

Method Details

__construct() public méthode

Constructor.
public __construct ( MongoDB\Driver\WriteResult $writeResult, array $insertedIds )
$writeResult MongoDB\Driver\WriteResult
$insertedIds array

getDeletedCount() public méthode

This method should only be called if the write was acknowledged.
See also: BulkWriteResult::isAcknowledged()
public getDeletedCount ( ) : integer
Résultat integer

getInsertedCount() public méthode

This method should only be called if the write was acknowledged.
See also: BulkWriteResult::isAcknowledged()
public getInsertedCount ( ) : integer
Résultat integer

getInsertedIds() public méthode

The index of each ID in the map corresponds to the document's position in the bulk operation. If the document had an ID prior to insertion (i.e. the driver did not generate an ID), this will contain its "_id" field value. Any driver-generated ID will be an MongoDB\BSON\ObjectID instance.
public getInsertedIds ( ) : mixed[]
Résultat mixed[]

getMatchedCount() public méthode

This method should only be called if the write was acknowledged.
See also: BulkWriteResult::isAcknowledged()
public getMatchedCount ( ) : integer
Résultat integer

getModifiedCount() public méthode

This value is undefined (i.e. null) if the write executed as a legacy operation instead of command. This method should only be called if the write was acknowledged.
See also: BulkWriteResult::isAcknowledged()
public getModifiedCount ( ) : integer | null
Résultat integer | null

getUpsertedCount() public méthode

This method should only be called if the write was acknowledged.
See also: BulkWriteResult::isAcknowledged()
public getUpsertedCount ( ) : integer
Résultat integer

getUpsertedIds() public méthode

The index of each ID in the map corresponds to the document's position in bulk operation. If the document had an ID prior to upserting (i.e. the server did not need to generate an ID), this will contain its "_id". Any server-generated ID will be an MongoDB\BSON\ObjectID instance. This method should only be called if the write was acknowledged.
See also: BulkWriteResult::isAcknowledged()
public getUpsertedIds ( ) : mixed[]
Résultat mixed[]

isAcknowledged() public méthode

If the update was not acknowledged, other fields from the WriteResult (e.g. matchedCount) will be undefined.
public isAcknowledged ( ) : boolean
Résultat boolean