PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    MongoDB\Driver\BulkWrite::update

    (mongodb >=1.0.0)

    MongoDB\Driver\BulkWrite::update — Add an update operation to the bulk

    説明

    public MongoDB\Driver\BulkWrite::update(array|object $filter, array|object $newObj, ?array $updateOptions = null): void

    Adds an update operation to the MongoDB\Driver\BulkWrite.

    パラメータ

    filter (array|object)

    The » query predicate. An empty predicate will match all documents in the collection.

    注意: When evaluating query criteria, MongoDB compares types and values according to its own » comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class (e.g. use MongoDB\BSON\ObjectId to match an » ObjectId).

    newObj (array|object)

    A document containing either update operators (e.g. $set), a replacement document (i.e. only field:value expressions), or an » aggregation pipeline.

    updateOptions

    updateOptions
    Option Type Description Default
    arrayFilters array

    An array of filter documents that determines which array elements to modify for an update operation on an array field. See » Specify arrayFilters for Array Update Operations in the MongoDB manual for more information.

    This option is available in MongoDB 3.6+ and will result in an exception at execution time if specified for an older server version.

    collation array|object

    » Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see » Collation Document.

    If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.

    This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.

    hint string|array|object

    Index specification. Specify either the index name as a string or the index key pattern. If specified, then the query system will only consider plans using the hinted index.

    This option is available in MongoDB 4.2+ and will result in an exception at execution time if specified for an older server version.

    multi bool Update only the first matching document if false, or all matching documents true. This option cannot be true if newObj is a replacement document. false
    upsert bool If filter does not match an existing document, insert a single document. The document will be created from newObj if it is a replacement document (i.e. no update operators); otherwise, the operators in newObj will be applied to filter to create the new document. false

    戻り値

    値を返しません。

    エラー / 例外

    変更履歴

    バージョン 説明
    PECL mongodb 1.7.0 Added the "hint" option.
    PECL mongodb 1.6.0 The newObj parameter now accepts an aggregation pipeline. This feature requires MongoDB 4.2+ and will result in an exception at execution time if specified for an older server version.
    PECL mongodb 1.5.0 Using the "arrayFilters" option will result in an exception at execution time if unsupported by the server. Previously, no exception would be thrown and the option may have been ignored.
    PECL mongodb 1.4.0 Added the "arrayFilters" option.
    PECL mongodb 1.2.0 Added the "collation" option.

    例

    例1 MongoDB\Driver\BulkWrite::update() example

    <?php

    $bulk     = new MongoDB\Driver\BulkWrite;
    $bulk->update(
    [    'x' => 2],
    [    '$set' => ['y' => 3]],
    [    'multi' => false, 'upsert' => false]
    );

    $manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
    $result = $manager->executeBulkWrite('db.collection', $bulk);

    ?>

    参考

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top