DeleteMany
in package
implements
Explainable
Operation for deleting multiple document with the delete command.
Tags
Table of Contents
Interfaces
- Explainable
Properties
- $delete : Delete
Methods
- __construct() : mixed
- Constructs a delete command.
- execute() : DeleteResult
- Execute the operation.
- getCommandDocument() : array<string|int, mixed>
- Returns the command document for this operation.
Properties
$delete
private
Delete
$delete
Methods
__construct()
Constructs a delete command.
public
__construct(string $databaseName, string $collectionName, array<string|int, mixed>|object $filter[, array<string|int, mixed> $options = [] ]) : mixed
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.
Parameters
- $databaseName : string
-
Database name
- $collectionName : string
-
Collection name
- $filter : array<string|int, mixed>|object
-
Query by which to delete documents
- $options : array<string|int, mixed> = []
-
Command options
Tags
execute()
Execute the operation.
public
execute(Server $server) : DeleteResult
Parameters
- $server : Server
Tags
Return values
DeleteResultgetCommandDocument()
Returns the command document for this operation.
public
getCommandDocument() : array<string|int, mixed>