DeleteOne
in package
implements
Executable, Explainable
Operation for deleting a single document with the delete command.
Tags
Interfaces, Classes, Traits and Enums
- Executable
- Explainable
Table of Contents
- $delete : Delete
- __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.
-
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.
-
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
Return values
mixed —execute()
Execute the operation.
public
execute(Server $server) : DeleteResult
Parameters
- $server : Server
Tags
Return values
DeleteResult —getCommandDocument()
Returns the command document for this operation.
public
getCommandDocument(Server $server) : array<string|int, mixed>
Parameters
- $server : Server