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 または execute_pages が呼び出されるまで、HTTP 要求は行われません。

OData ビルダー エンドポイントで表現できない SQL-JOIN シナリオ、集計クエリ、またはその他の操作に使用します。

例：

   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:
   #   {"parentcustomerid_account@odata.bind": "/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 するナビゲーション プロパティ名を返します。

リレーションシップ メタデータを使用して検出します。 expand= パラメーターの正確な PascalCase 文字列を返します。

例：

   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"
   )

集計を使用した JOIN:

   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 で使用できる列の簡略化された一覧を返します。

各 dict には、 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]]

パラメーター

キーワードのみのパラメーター

返品