QueryOperations 类

为指定的表创建 Fluent 查询生成器。

返回一个 QueryBuilder 可以链接的筛选器、选择和排序方法，然后直接通过 .execute()。

builder(table: str) -> QueryBuilder

参数

返回

示例

以 Fluently 生成和执行查询：

   from PowerPlatform.Dataverse.models.filters import col

   for record in (client.query.builder("account")
                  .select("name", "revenue")
                  .where(col("statecode") == 0)
                  .where(col("revenue") > 1_000_000)
                  .order_by("revenue", descending=True)
                  .top(100)
                  .page_size(50)
                  .execute()):
       print(record["name"])

使用可组合表达式树：

   from PowerPlatform.Dataverse.models.filters import col

   for record in (client.query.builder("account")
                  .where((col("statecode") == 0) | (col("statecode") == 1))
                  .where(col("revenue") > 100_000)
                  .execute()):
       print(record["name"])

返回一个插入 FetchXmlQuery 对象。

在返回的对象上调用或execute_pages调用之前execute，不会发出 HTTP 请求。

用于 SQL-JOIN 方案、聚合查询或其他 OData 生成器终结点无法表达的操作。

示例：

   query = client.query.fetchxml("""
     <fetch top="50">
       <entity name="account">
         <attribute name="name" />
         <link-entity name="contact" from="parentcustomerid"
                      to="accountid" alias="c" link-type="inner">
           <attribute name="fullname" />
         </link-entity>
       </entity>
     </fetch>
   """)

   # Eager — collect all pages:
   result = query.execute()
   df = result.to_dataframe()

   # Lazy — process one page at a time:
   for page in query.execute_pages():
       process(page.to_dataframe())

fetchxml(xml: str) -> FetchXmlQuery

参数

返回

例外

生成用于 @odata.bind 设置查阅字段的条目。

从元数据自动发现导航属性名称和实体集名称。 返回可以合并到创建或更新有效负载中的单条目听写。

示例：

   # Instead of manually constructing:
   #   {"[email protected]": "/accounts(guid)"}
   # Just do:
   bind = client.query.odata_bind("contact", "account", acct_id)
   client.records.create("contact", {
       "firstname": "Jane",
       "lastname": "Doe",
       **bind,
   })

odata_bind(from_table: str, to_table: str, target_id: str) -> Dict[str, str]

参数

返回

例外

将导航属性名称 $expand 从一个表返回到另一个表。

通过关系元数据发现。 返回参数的确切 PascalCase 字符串 expand= 。

示例：

   nav = client.query.odata_expand("contact", "account")
   # Returns e.g. "parentcustomerid_account"
   for page in client.records.get("contact",
                                  select=["fullname"],
                                  expand=[nav],
                                  top=5):
       for r in page:
           acct = r.get(nav) or {}
           print(f"{r['fullname']} -> {acct.get('name', 'N/A')}")

odata_expand(from_table: str, to_table: str) -> str

参数

返回

例外

发现表中的所有 $expand 导航属性。

返回每个传出查找（单值导航属性）的条目。 每个条目都包含所需的$expand@odata.bind确切 PascalCase 导航属性名称，以及目标实体集名称。

示例：

   expands = client.query.odata_expands("contact")
   for e in expands:
       print(f"expand={e['nav_property']}  -> {e['target_table']}")

   # Use in a query
   e = next(e for e in expands if e['target_table'] == 'account')
   for page in client.records.get("contact",
                                  select=["fullname"],
                                  expand=[e['nav_property']]):
       ...

odata_expands(table: str) -> List[Dict[str, Any]]

参数

返回

返回适合 $select的列逻辑名称的列表。

可以直接传递给 client.records.get(table, select=...)。

示例：

   cols = client.query.odata_select("account")
   for page in client.records.get("account", select=cols, top=10):
       for r in page:
           print(r)

odata_select(table: str, *, include_system: bool = False) -> List[str]

参数

仅限关键字的参数

返回

使用 Dataverse Web API 执行只读 SQL 查询。

Dataverse SQL 终结点支持广泛的 T-SQL 子集：

   SELECT / SELECT DISTINCT / SELECT TOP N (0-5000)
   FROM table [alias]
   INNER JOIN / LEFT JOIN (multi-table, no depth limit)
   WHERE (=, !=, >, <, >=, <=, LIKE, IN, NOT IN, IS NULL,
          IS NOT NULL, BETWEEN, AND, OR, nested parentheses)
   GROUP BY column
   ORDER BY column [ASC|DESC]
   OFFSET n ROWS FETCH NEXT m ROWS ONLY
   COUNT(*), SUM(), AVG(), MIN(), MAX()

SELECT * 不支持 – 显式指定列名。 用于 sql_columns 发现表的可用列名。

不支持：SELECT >>*<<， 子查询， CTE， HAVING， UNION， RIGHT/FULL/CROSS JOIN， CASE， COALESCE， 窗口函数， 字符串/日期/数学函数， INSERT/UPDATE/DELETE。 对于写入，请使用 client.records 方法。

sql(sql: str) -> List[Record]

参数

返回

例外

示例

基本查询：

   rows = client.query.sql(
       "SELECT TOP 10 name FROM account ORDER BY name"
   )

联接与聚合：

   rows = client.query.sql(
       "SELECT a.name, COUNT(c.contactid) as cnt "
       "FROM account a "
       "JOIN contact c ON a.accountid = c.parentcustomerid "
       "GROUP BY a.name"
   )

返回表的 SQL 可用列的简化列表。

每个听写内容都包含 name （SQL 的逻辑名称）、 type （Dataverse 属性类型）、 is_pk （主键标志）和 label （显示名称）。 始终排除虚拟列，因为 SQL 终结点无法查询它们。

示例：

   cols = client.query.sql_columns("account")
   for c in cols:
       print(f"{c['name']:30s} {c['type']:20s} PK={c['is_pk']}")

sql_columns(table: str, *, include_system: bool = False) -> List[Dict[str, Any]]

参数

仅限关键字的参数

返回