MongoDB\GridFS\Bucket::delete()

On this page

Definition
Errors/Exceptions
Behavior
Examples

Definition

MongoDB\GridFS\Bucket::delete

Delete a file and its chunks from the GridFS bucket.

function delete($id): void

This method has the following parameters:

Parameter	Type	Description
`$id`	mixed	The `_id` of the file.

Errors/Exceptions

MongoDB\GridFS\Exception\FileNotFoundException if no file was found for the selection criteria.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

Behavior

If the files collection document is not found, this method will still attempt to delete orphaned chunks.

Examples

copy

<?php

$bucket = (new MongoDB\Client)->test->selectGridFSBucket();

$stream = fopen('php://temp', 'w+b');
fwrite($stream, "foobar");
rewind($stream);

$id = $bucket->uploadFromStream('filename', $stream);

$bucket->delete($id);

← MongoDB\GridFS\Bucket::__construct() MongoDB\GridFS\Bucket::downloadToStream() →