MySQL :: X DevAPI 用户指南，针对 Python 模式下的 MySQL Shell :: 4.3.3 Collection.modify()

针对 Python 模式下的 MySQL Shell 的 X DevAPI 用户指南 / ... / Collection.modify()

4.3.3 Collection.modify()

modify(SearchConditionStr) 函数用于修改集合中的文档，类似于 SQL 数据库中的 UPDATE 语句。它接受一个搜索条件字符串 (SearchConditionStr) 作为参数，以指定要修改的文档 - 关于 SearchConditionStr 的详细讨论可以在第 4.3.2 节， “Collection.find()” 中找到。

如果一个或多个文档与搜索条件字符串匹配，则它们将通过在 modify() 方法之后链接的任何方法进行修改。它们可以一个接一个地链起来，并多次链接。

注意

下面的方法无法修改或删除文档的 _id 。
对于以下任何以 DocPath 表达式作为其参数之一的方法，以下规则适用
- 在 DocPath 表达式中，任何包含空格或特殊字符的字段名都必须用引号括起来；例如，set("name.'last name'", "Smith")，unset("name.'last%name'")
- DocPath 表达式不能包含通配符标记（* 或 **）。
- DocPath 表达式不能为 null 或空。

set("DocPath", ExprOrLiteral)：使用表达式或文字 (ExprOrLiteral) 表达式表示的值来设置由文档路径 (DocPath) 表达式匹配的元素。

DocPath 表达式是一个 JSON 路径表达式，用于标识由 modify() 函数找到的文档中的一个或多个 JSON 元素。有关 JSON 路径的讨论，请参见第 4.3.2 节， “Collection.find()”。如果由 DocPath 指定的元素不存在，则将其作为新元素添加到文档中。

ExprOrLiteral 指定要为由 DocPath 表示的元素设置的值。它可以是以下任何一项
- 一个文字值。例如，10 或 "John"。
- 任何 X DevAPI 表达式，包装在 expr() 函数中（或对于 MySQL Shell 和某些连接器而言，为 mysql.expr()），以便它不会被视为文字值。以下是一些示例，这些示例并没有穷尽使用 mysql.expr(表达式) 的可能性来作为 ExprOrLiteral
  - 另一个 DocPath 从正在修改的文档中选择一个值（例如，set("favorNums[0]", mysqlx.expr("favorNums[1]"))，或 set("name", mysqlx.expr("$.'last name'"))）。
  - 一个包含一个或多个表达式的函数表达式（例如，set("favorNums[0]", mysqlx.expr("abs(favorNums[1])"))）。
  - 一个或多个由运算符连接的表达式（例如，set("favorNums[0]", mysqlx.expr("favorNums[1]+favorNums[2]+favorNums[3]+3")) ，或 set("SameValueOrNot", mysqlx.expr("favorNums[1] = favorNums[2]"))）。
  - 一个 JSON 文档（例如，set("Greeting", mysqlx.expr("{'season':'winter', 'phrase': 'Happy Holiday'}"))
注意

set("$", mysqlx.expr("json_document") 用提供的 json_document 替换所有由 modify() 匹配的文档，除了原始的 _id 字段，它在文档创建后是不可更改的。
unset("DocPath[, DocPath] ...")：删除一个或多个由一个或多个 DocPath 表示的字段或数组元素（例如，unset("name")，unset("name.'last name'", name.'first name'")，或 unset("favorNums[0]")）。

如果未提供任何 DocPath，或者 DocPath 为 $（如果要删除整个文档，请改用 remove()），则会返回错误。
警告

请注意，当取消设置或删除多个数组元素时，它们将被逐个删除，因此语句中相同的数组索引可能会在每次取消设置操作中引用不同的元素。在删除数组元素时，请考虑这一点。例如，对于文档
```
mysql-js> myColl.find("name = 'Ann'");
{
    "_id": "00006239f74a0000000000000004",
    "name": "Ann",
    "favorNums": [
        1,
        2,
        3,
        4,
        5
    ]
}
```
以下语句不会按预期删除数组的第一个和第二个元素
```
mysql-js> myColl.modify("name = 'Ann'").unset("favorNums[0]","favorNums[1]");
Query OK, 1 item affected (0.0038 sec)

mysql-js> myColl.find("name = 'Ann'").fields("favorNums");
{
    "favorNums": [
        2,
        4,
        5
    ]
}
1 document in set (0.0007 sec)
```
相反，它删除了数组的第一个和第三个元素。要删除前两个元素，可以执行以下操作
```
mysql-js> myColl.modify("name = 'Ann'").unset("favorNums[0]","favorNums[0]");
Query OK, 1 item affected (0.0108 sec)

Rows matched: 1  Changed: 1  Warnings: 0
mysql-js > myColl.find("name = 'Ann'").fields("favorNums");
{
    "favorNums": [
        3,
        4,
        5
    ]
}
1 document in set (0.0005 sec)
```

patch(Document)：对所有由 modify() 和作为其参数提供的 JSON Document 匹配的文档执行合并修补。该操作遵循由互联网工程任务组 (IETF) 创建的 JSON 合并修补的 RFC 7396 规范。下表解释了对字段的操作，该操作取决于两个文档中的字段状态（注意这是一个递归操作）

表 4.1 文档字段的 JSON 修补合并

原始文档中的字段状态	修补文档中的字段状态	将在原始文档中的字段上执行的操作
任何值	值为 Null	删除字段
值 B	值 A（非 Null）	如果值 A 或 B 都是标量，则用值 A 替换值 B 如果值 A 和 B 都是 JSON 对象，则使用本表中描述的相同规则合并它们（即，合并将递归地应用于 JSON 文档）。
字段不存在	值 A（非 Null）	添加值为 A 的字段
值 C	字段不存在	字段无变化

以下是一个使用 patch() 进行合并的简单示例

mysql-js> myColl.find("name = 'John Doe'");
{
    "DOB": "1970-01-01",
    "_id": "0000626028c30000000000000002",
    "name": "John Doe",
    "Phone": 1234567,
    "Standing": "Good",
    "favorNums": {
       "a": 1,
       "b":2 
    }
}
1 document in set (0.0009 sec)
 
mysql-js> myColl.modify("name = 'John Doe'")
    .patch({ name: "Jane Doe", DOB: null, Phone: 9876543, favorNums: { a: 3, b:4 } });
Query OK, 1 item affected (0.0413 sec)

Rows matched: 1  Changed: 1  Warnings: 0
 
mysql-js> myColl.find("name = 'Jane Doe'");
{
    "_id": "0000626028c30000000000000002",
    "name": "Jane Doe",
    "Phone": 9876543,
    "Standing": "Good",
    "favorNums": {
        "a": 3,
        "b": 4
    }
}
1 document in set (0.0008 sec)

arrayInsert(DocPath, ExprOrLiteral)：将 ExprOrLiteral（见上面的解释）插入由 DocPath 标识的位置的数组中，将数组中任何后续值向右移动。例如：arrayInsert("favorNums[1]", 7)，arrayInsert("favorNums[1]", {even: 2, odd: 3, irrational: 'pi'})。以下规则适用
- 如果 DocPath 未标识数组元素，则会返回错误。
- 如果 DocPath 标识数组末尾之外的数组位置，则该值将插入数组末尾。

arrayAppend(DocPath, ExprOrLiteral)：将由 ExprOrLiteral 表示的值追加到由 DocPath 标识的数组的末尾。例如，arrayAppend("favorNums", 555)。

请注意，如果 DocPath 指向标量或文档值，则该值将自动包装在数组中，并且由 ExprOrLiteral 表示的值将添加到该数组中。例如

mysql-js> myColl.find("name='Jane Doe'");
{
    "_id": "000062b0faf90000000000000001",
    "name": "Jane Doe",
    "favorNum": 2
}
1 document in set (0.0011 sec)

mysql-js> myColl.modify("name='Jane Doe'").arrayAppend("favorNum",3);
Query OK, 1 item affected (0.0094 sec)

Rows matched: 1  Changed: 1  Warnings: 0
mysql-js> myColl.find("name='Jane Doe'");
{
    "_id": "000062b0faf90000000000000001",
    "name": "Jane Doe",
    "favorNum": [
        2,
        3
    ]
}
1 document in set (0.0006 sec)

以下方法可以链接到上面描述的修改方法，以配置修改

sort(sortCriteriaList): 根据sortCriteriaList排序要修改的文档顺序，sortCriteriaList可以是逗号分隔的列表或sortCriteria数组。每个sortCriteria包含一个组件名称和一个排序顺序（asc表示升序，desc表示降序）。例如
- sort('name asc', 'age desc')
- sort(['name asc', 'age desc'])
该方法与limit()方法结合使用，以确定由modify(SearchConditionStr)匹配的文档中哪些文档需要修改。
limit(int): 将要修改的文档数量限制为int。当与sort()方法链式调用时，仅修改排序列表中的前int个文档。

这是一个使用sort().limit()限制文档修改的示例

mysql-js> myColl.find("name like '%Doe'");
{
    "_id": "000062b0faf90000000000000001",
    "name": "Jane Doe",
    "favorNum": [
        2,
        3
    ]
}
{
    "_id": "000062b372f80000000000000001",
    "name": "Bob Doe",
    "favorNum": [
        1,
        2
    ]
}
{
    "_id": "000062b372f80000000000000002",
    "name": "Mark Doe",
    "favorNum": [
        7,
        8
    ]
}
{
    "_id": "000062b372f80000000000000003",
    "name": "John Doe",
    "favorNum": [
        0,
        4
    ]
}
mysql-js> myColl.modify("name like '%Doe'").unset("favorNum").sort("name asc").limit(2);
Query OK, 2 items affected (0.0082 sec)

Rows matched: 2  Changed: 2  Warnings: 0
mysql-js> myColl.find("name like '%Doe'").sort('name asc');
{
    "_id": "000062b372f80000000000000001",
    "name": "Bob Doe"
}
{
    "_id": "000062b0faf90000000000000001",
    "name": "Jane Doe"
}
{
    "_id": "000062b372f80000000000000003",
    "name": "John Doe",
    "favorNum": [
        0,
        4
    ]
}
{
    "_id": "000062b372f80000000000000002",
    "name": "Mark Doe",
    "favorNum": [
        7,
        8
    ]
}
4 documents in set (0.0068 sec)

还支持使用bind()进行参数绑定。execute()函数触发modify()操作的实际执行。以下示例说明了modify()的使用方法

# Use the collection 'my_collection'
myColl = db.get_collection('my_collection')
# Add a new document to the collection 
myColl.add({ "name":"John Doe", "DOB":"1970-01-01", "Phone":1234567, "Standing": "Good" }).execute()

# Patch the added document, adding, removing, and changing some fields 
myColl.modify("name = 'John Doe'").patch({ "name": "Jane Doe", "DOB": None, "Phone": 9876543, "favorNums": [1,2,3,4,5] }).execute()

# Modify fields with different methods
myColl.modify("name like :param").set("Standing", "Bad").bind("param", "J%Doe").execute()
myColl.modify("name like :param").unset("Phone").bind("param", "J%Doe").execute()
myColl.modify("name like :param").array_insert("favorNums[1]", 7).bind("param", "J%Doe").execute()
myColl.modify("name like :param").array_append("favorNums", 99).bind("param", "J%Doe").execute()
myColl.modify("name like :param").unset("favorNums[2]").bind("param", "J%Doe").execute()

doc = myColl.find('name like :param').limit(1).bind('param', 'J%Doe').execute()

print(doc.fetch_one())

# The output looks like:
# {"Standing": "Bad", "_id": "0000626718c10000000000000005", "favorNums": [1, 7, 3, 4, 5, 99], "name": "Jane Doe"}

有关add()在 EBNF 中的语法，请参见 CollectionModifyFunction。