models パッケージ

Dataverse テーブルの代替キー メタデータ。

バッチ要求内の 1 つの操作からの応答。

応答は送信順序で返されます。 変更セットに追加された操作の場合、応答はその順序で変更セットの位置に表示されます。

例:

   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 操作ごとに 1 つの BatchItemResponse が含まれています。 複数の HTTP 要求 (3 つの列を含む add_columns など) に拡張される操作は、3 つのエントリを提供します。

例:

   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によって返されます。 演算子のオーバーロードとメソッドは、QueryBuilder.where()に渡すことができるFilterExpressionインスタンスを生成します。

例:

   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.create() および records.update()に渡す構造プロトコル。

このプロトコルを任意のエンティティ クラス (dataclass、Pydantic モデル、手動ロール) に実装して、テーブル名を指定したり、手動で dict に変換したりせずに 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構文に従って、単一のナビゲーション プロパティ拡張に対して入れ子になった$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())

不活性 FetchXML クエリ オブジェクト。 executeまたはexecute_pagesが呼び出されるまで、HTTP 要求は行われません。

client.query.fetchxml(xml)経由で取得されます。

構成可能な OData フィルター式の基本クラス。

論理コンポジションPython演算子オーバーロードをサポートします。

• expr1 & expr2 生成 (expr1 and expr2)

• expr1 | expr2 生成 (expr1 or expr2)

• ~expr 生成 not (expr)

複数のローカライズされたバージョンを持つラベルを表します。

言語コードを含むローカライズされたラベルを表します。

ルックアップ属性のメタデータ。

有効なrequired_level値:

• "None": 属性は省略可能です

• "Recommended": 属性をお勧めします

• "ApplicationRequired": 属性は必須です

多対多エンティティリレーションシップのメタデータ。

一対多エンティティリレーションシップのメタデータ。

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

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

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

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

Record オブジェクトの一覧を囲む Iterable ラッパー。

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)

dict に似た下位互換性を持つテーブル メタデータ。

未加工の dict API に対して記述されたコードとの下位互換性のために、新しい属性アクセス (info.schema_name) と従来の dict キー アクセス (info["table_schema_name"]) の両方をサポートします。

例:

   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 ではなく代替キーによって識別される 1 つ以上のレコードをアップサートします。

例:

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