Documentation

ClientBulkWrite
in package

FinalYes

Table of Contents

Properties

$bulkWriteCommand  : BulkWriteCommand
$builderEncoder  : Encoder
$codec  : DocumentCodec|null
$manager  : Manager
$namespace  : string

Methods

createWithCollection()  : self
deleteMany()  : self
deleteOne()  : self
insertOne()  : self
replaceOne()  : self
updateMany()  : self
updateOne()  : self
withCollection()  : self
__construct()  : mixed

Properties

$bulkWriteCommand read-only

public BulkWriteCommand $bulkWriteCommand

$builderEncoder read-only

private Encoder $builderEncoder
Tags
psalm-var

Encoder<array|stdClass|Document|PackedArray, mixed>

Methods

createWithCollection()

public static createWithCollection(Collection $collection[, array<string|int, mixed> $options = [] ]) : self
Parameters
$collection : Collection
$options : array<string|int, mixed> = []
Attributes
#[NoDiscard]
Return values
self

deleteMany()

public deleteMany(array<string|int, mixed>|object $filter[, array<string|int, mixed> $options = [] ]) : self
Parameters
$filter : array<string|int, mixed>|object
$options : array<string|int, mixed> = []
Return values
self

deleteOne()

public deleteOne(array<string|int, mixed>|object $filter[, array<string|int, mixed> $options = [] ]) : self
Parameters
$filter : array<string|int, mixed>|object
$options : array<string|int, mixed> = []
Return values
self

insertOne()

public insertOne(array<string|int, mixed>|object $document[, mixed &$id = null ]) : self
Parameters
$document : array<string|int, mixed>|object
$id : mixed = null
Return values
self

replaceOne()

public replaceOne(array<string|int, mixed>|object $filter, array<string|int, mixed>|object $replacement[, array<string|int, mixed> $options = [] ]) : self
Parameters
$filter : array<string|int, mixed>|object
$replacement : array<string|int, mixed>|object
$options : array<string|int, mixed> = []
Return values
self

updateMany()

public updateMany(array<string|int, mixed>|object $filter, array<string|int, mixed>|object $update[, array<string|int, mixed> $options = [] ]) : self
Parameters
$filter : array<string|int, mixed>|object
$update : array<string|int, mixed>|object
$options : array<string|int, mixed> = []
Return values
self

updateOne()

public updateOne(array<string|int, mixed>|object $filter, array<string|int, mixed>|object $update[, array<string|int, mixed> $options = [] ]) : self
Parameters
$filter : array<string|int, mixed>|object
$update : array<string|int, mixed>|object
$options : array<string|int, mixed> = []
Return values
self

__construct()

private __construct(BulkWriteCommand $bulkWriteCommand, Manager $manager, string $namespace, Encoder $builderEncoder, DocumentCodec|null $codec) : mixed
Parameters
$bulkWriteCommand : BulkWriteCommand
$manager : Manager
$namespace : string
$builderEncoder : Encoder
$codec : DocumentCodec|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results