Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
MongoDB\Operation\InsertOne Class Reference
Inheritance diagram for MongoDB\Operation\InsertOne:
MongoDB\Operation\Executable

Public Member Functions

 __construct (string $databaseName, string $collectionName, $document, array $options=[])
 Constructs an insert command.
 
 execute (Server $server)
 Execute the operation.
 

Constructor & Destructor Documentation

◆ __construct()

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

Constructs an insert command.

Supported options:

  • bypassDocumentValidation (boolean): If true, allows the write to circumvent document level validation.
  • 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
string$databaseNameDatabase name
string$collectionNameCollection name
array | object$documentDocument to insert
array$optionsCommand options
Exceptions
InvalidArgumentExceptionfor parameter/option parsing errors

Member Function Documentation

◆ execute()

MongoDB\Operation\InsertOne::execute ( Server $server)

Execute the operation.

See also
Executable\execute()
Return values
InsertOneResult
Exceptions
UnsupportedExceptionif write concern is used and unsupported
DriverRuntimeExceptionfor other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.


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