Skip to content

Latest commit

 

History

History
199 lines (78 loc) · 2.11 KB

InsertOne.md

File metadata and controls

199 lines (78 loc) · 2.11 KB

InsertOne

Operation for inserting a single document with the insert command.

See Also:

Properties

databaseName

private string $databaseName

collectionName

private string $collectionName

document

private array|object $document

options

private array $options

Methods

__construct

Constructs an insert command.

public __construct(string $databaseName, string $collectionName, array|object $document, array $options = []): mixed

Supported options:

  • bypassDocumentValidation (boolean): If true, allows the write to circumvent document level validation.

  • session (MongoDB\Driver\Session): Client session.

  • writeConcern (MongoDB\Driver\WriteConcern): Write concern.

Parameters:

Parameter Type Description
$databaseName string Database name
$collectionName string Collection name
$document array|object Document to insert
$options array Command options

execute

Execute the operation.

public execute(\MongoDB\Driver\Server $server): \MongoDB\InsertOneResult

Parameters:

Parameter Type Description
$server \MongoDB\Driver\Server

See Also:

  • \MongoDB\Operation\Executable::execute() -

createBulkWriteOptions

Create options for constructing the bulk write.

private createBulkWriteOptions(): array

See Also:


createExecuteOptions

Create options for executing the bulk write.

private createExecuteOptions(): array

See Also: