models 包

Dataverse 表的备用键元数据。

批处理请求中单个操作的响应。

响应按提交顺序返回。 对于添加到变更集的操作，响应按该顺序显示在更改集的位置。

示例：

   for item in result.responses:
       if item.is_success:
           print(f"[OK] {item.status_code} entity_id={item.entity_id}")
       else:
           print(f"[ERR] {item.status_code}: {item.error_message}")

执行批处理请求的结果。

每个提交的 HTTP 操作都包含一个 BatchItemResponse 。 扩展到多个 HTTP 请求的操作（例如 add_columns 包含三列）贡献了三个条目。

示例：

   result = client.batch.new().execute()
   print(f"Succeeded: {len(result.succeeded)}, Failed: {len(result.failed)}")
   for guid in result.entity_ids:
       print(f"[OK] entity_id: {guid}")

定义关系操作的级联行为。

每个参数的有效值：

• “Cascade”：对所有相关记录执行操作

• “NoCascade”：不要对相关记录执行操作

• “RemoveLink”：删除关系链接，但保留记录

• “Restrict”：如果存在相关记录，则阻止操作

Dataverse 表定义的列元数据。

用于从列名称生成 OData 筛选器表达式的 Fluent 代理。

返回者 col。 运算符重载和方法生成 FilterExpression 可传递给 QueryBuilder.where()的实例。

示例：

   from PowerPlatform.Dataverse.models.filters import col

   expr = col("statecode") == 0               # equality
   expr = col("revenue") > 1_000_000          # comparison
   expr = col("name").like("Contoso%")        # startswith
   expr = col("name").is_null()               # null check
   expr = col("statecode").in_([0, 1])        # in

结构协议允许将类型化实体实例传递给和records.update()传递records.create()。

在任何实体类（dataclass、Pydantic 模型、手动滚动）上实现此协议，使其可以直接传递到 CRUD 操作，而无需指定表名称或手动转换为听写。

必需的类变量：

• __entity_logical_name__ — Dataverse 逻辑实体名称（例如 "account"）

• __entity_set_name__ — OData 实体集名称（例如 "accounts"）

必需的实例方法：

• to_dict() — 将记录有效负载返回为 dict

• from_dict(data) — 从响应中重新构造的 classmethod dict

示例：

   from dataclasses import dataclass
   from PowerPlatform.Dataverse import DataverseModel

   @dataclass
   class Account:
       __entity_logical_name__ = "account"
       __entity_set_name__ = "accounts"
       name: str = ""
       telephone1: str = ""

       def to_dict(self) -> dict:
           return {"name": self.name, "telephone1": self.telephone1}

       @classmethod
       def from_dict(cls, data: dict) -> "Account":
           return cls(
               name=data.get("name", ""),
               telephone1=data.get("telephone1", ""),
           )

   # isinstance() works today — Protocol is runtime_checkable:
   assert isinstance(Account(), DataverseModel)

   # Type your own helpers against the Protocol now:
   def save(entity: DataverseModel) -> None:
       data = entity.to_dict()
       client.records.create(entity.__entity_logical_name__, data)

导航属性的结构化选项 $expand 。

允许在 OData $expand 语法之后指定单个导航属性扩展的嵌套$filter$select、$orderby和$top选项。

示例：

   # Expand Account_Tasks with nested options
   opt = (ExpandOption("Account_Tasks")
          .select("subject", "createdon")
          .filter("contains(subject,'Task')")
          .order_by("createdon", descending=True)
          .top(5))

   query = (client.query.builder("account")
            .select("name")
            .expand(opt)
            .execute())

Inert FetchXML 查询对象。 在调用或execute_pages调用之前execute，不会发出 HTTP 请求。

通过 client.query.fetchxml(xml). 获取。

可组合 OData 筛选器表达式的基类。

支持逻辑组合的Python运算符重载：

• expr1 & expr2 生产 (expr1 and expr2)

• expr1 | expr2 生产 (expr1 or expr2)

• ~expr 生产 not (expr)

表示可具有多个本地化版本的标签。

表示具有语言代码的本地化标签。

查找属性的元数据。

有效的required_level值：

• “None”：属性是可选的

• “建议”：建议使用属性

• “ApplicationRequired”：属性是必需的

多对多实体关系的元数据。

一对多实体关系的元数据。

Fluent 接口，用于针对同步客户端生成和执行 OData 查询。

提供用于使用可组合筛选器表达式构造复杂查询的方法链。 可以使用独立（通过 build()）或绑定到客户端（通过 execute）。

由 QueryBuilder.build(). 返回的类型化字典。

将生成结果传递给 client.records.list() 手动时，提供 IDE 自动完成。

围绕对象列表 Record 的可迭代包装器。

返回者 execute （平面模式）和 list。

向后兼容： for r in result 在不更改的情况下继续工作。

关系元数据的类型化返回模型。

返回者 create_one_to_many_relationship、 create_many_to_many_relationship、 get_relationship和 create_lookup_field。

示例：

   result = client.tables.create_one_to_many_relationship(lookup, relationship)
   print(result.relationship_schema_name)
   print(result.lookup_schema_name)

具有类似于听写的向后兼容性的表元数据。

支持新的属性访问（info.schema_name）和旧式听写密钥访问（info["table_schema_name"]），以便向后兼容针对原始听写 API 编写的代码。

示例：

   info = client.tables.create("new_Product", {"new_Price": "decimal"})
   print(info.schema_name)              # new attribute access
   print(info["table_schema_name"])     # legacy dict-key access

表示单个向上插入操作，该操作以记录的备用键为目标。

用于 upsert 更新插入由备用键而不是主要 GUID 标识的一个或多个记录。

示例：

   item = UpsertItem(
       alternate_key={"accountnumber": "ACC-001", "address1_postalcode": "98052"},
       record={"name": "Contoso Ltd", "telephone1": "555-0100"},
   )