See Release Notes
Long Term Support Release
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]
(no description)
File Size: | 250 lines (9 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
Delete:: (6 methods):
__construct()
execute()
getCommandDocument()
createBulkWriteOptions()
createDeleteOptions()
createExecuteOptions()
__construct(string $databaseName, string $collectionName, $filter, int $limit, array $options = []) X-Ref |
Constructs a delete command. Supported options: * collation (document): Collation specification. * comment (mixed): BSON value to attach as a comment to this command. This is not supported for servers versions < 4.4. * hint (string|document): The index to use. Specify either the index name as a string or the index key pattern as a document. If specified, then the query system will only consider plans using the hinted index. This is not supported for server versions < 4.4 and will result in an exception at execution time if used. * let (document): Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. "$$var"). * session (MongoDB\Driver\Session): Client session. * writeConcern (MongoDB\Driver\WriteConcern): Write concern. param: string $databaseName Database name param: string $collectionName Collection name param: array|object $filter Query by which to delete documents param: integer $limit The number of matching documents to param: array $options Command options |
execute(Server $server) X-Ref |
Execute the operation. return: DeleteResult |
getCommandDocument(Server $server) X-Ref |
Returns the command document for this operation. return: array |
createBulkWriteOptions() X-Ref |
Create options for constructing the bulk write. |
createDeleteOptions() X-Ref |
Create options for the delete command. Note that these options are different from the bulk write options, which are created in createExecuteOptions(). |
createExecuteOptions() X-Ref |
Create options for executing the bulk write. |