InsertOne
in package
FinalYes
Operation for inserting a single document with the insert command.
Tags
Table of Contents
Properties
- $collectionName : string
- $databaseName : string
- $document : array<string|int, mixed>|object
- $options : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructs an insert command.
- execute() : InsertOneResult
- Execute the operation.
- createBulkWriteOptions() : array<string|int, mixed>
- Create options for constructing the bulk write.
- createExecuteOptions() : array<string|int, mixed>
- Create options for executing the bulk write.
- validateDocument() : array<string|int, mixed>|object
Properties
$collectionName
private
string
$collectionName
$databaseName
private
string
$databaseName
$document
private
array<string|int, mixed>|object
$document
$options
private
array<string|int, mixed>
$options
= []
Methods
__construct()
Constructs an insert command.
public
__construct(string $databaseName, string $collectionName, array<string|int, mixed>|object $document[, array<string|int, mixed> $options = [] ]) : mixed
Supported options:
-
bypassDocumentValidation (boolean): If true, allows the write to circumvent document level validation.
-
codec (MongoDB\Codec\DocumentCodec): Codec used to encode PHP objects into BSON.
-
comment (mixed): BSON value to attach as a comment to this command.
This is not supported for servers versions < 4.4.
-
session (MongoDB\Driver\Session): Client session.
-
writeConcern (MongoDB\Driver\WriteConcern): Write concern.
Parameters
- $databaseName : string
-
Database name
- $collectionName : string
-
Collection name
- $document : array<string|int, mixed>|object
-
Document to insert
- $options : array<string|int, mixed> = []
-
Command options
Tags
execute()
Execute the operation.
public
execute(Server $server) : InsertOneResult
Parameters
- $server : Server
Tags
Return values
InsertOneResultcreateBulkWriteOptions()
Create options for constructing the bulk write.
private
createBulkWriteOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>createExecuteOptions()
Create options for executing the bulk write.
private
createExecuteOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>validateDocument()
private
validateDocument(array<string|int, mixed>|object $document, DocumentCodec|null $codec) : array<string|int, mixed>|object
Parameters
- $document : array<string|int, mixed>|object
- $codec : DocumentCodec|null