query_builder モジュール

OData クエリを構築するための Fluent クエリ ビルダー。

メソッド チェーンを使用して Dataverse テーブルに対して複雑なクエリを作成するための、タイプ セーフで検出可能なインターフェイスを提供します。

例::

# Via client (recommended) -- flat iteration over records
from PowerPlatform.Dataverse.models 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)
               .execute()):
    print(record["name"])


# With composable expression tree
from PowerPlatform.Dataverse.models import col, raw


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


# Lazy paged iteration (one QueryResult per HTTP page)
for page in (client.query.builder("account")
             .select("name")
             .execute_pages()):
    process_batch(page)


# Get results as a pandas DataFrame
df = (client.query.builder("account")
      .select("name", "telephone1")
      .where(col("statecode") == 0)
      .top(100)
      .execute()
      .to_dataframe())

クラス

ExpandOption

$expand ナビゲーション プロパティの構造化オプション。

OData $expand構文に従って、単一のナビゲーション プロパティ拡張に対して入れ子になった$select$filter$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())
QueryBuilder

同期クライアントに対して OData クエリを構築および実行するための Fluent インターフェイス。

構成可能なフィルター式を使用して複雑なクエリを構築するためのメソッド チェーンを提供します。 スタンドアロン ( build()経由) またはクライアントにバインド ( execute 経由) で使用できます。

QueryParams

QueryBuilder.build()によって返される型指定されたディクショナリ。

ビルド結果を手動で client.records.list() に渡すときに IDE オートコンプリートを提供します。