MongoDB\Operation\DeleteOne Class Reference

Inheritance diagram for MongoDB\Operation\DeleteOne:

Public Member Functions
	__construct (string $databaseName, string $collectionName, $filter, array $options=[])
	Constructs a delete command.
	execute (Server $server)
	Execute the operation.
	getCommandDocument (Server $server)
	Returns the command document for this operation.

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\DeleteOne::__construct	(	string	$databaseName,
		string	$collectionName,
			$filter,
		array	$options = [] )

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.

Parameters

string	$databaseName	Database name
string	$collectionName	Collection name
array | object	$filter	Query by which to delete documents
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\DeleteOne::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

DeleteResult

Exceptions

UnsupportedException	if collation is used and unsupported
DriverRuntimeException	for other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.

getCommandDocument()

MongoDB\Operation\DeleteOne::getCommandDocument

(

Server

$server

)

Returns the command document for this operation.

See also

Explainable\getCommandDocument()

Return values

array

Implements MongoDB\Operation\Explainable.

---

The documentation for this class was generated from the following file:

• cache/stores/mongodb/MongoDB/Operation/DeleteOne.php