models Paket

Metadata kunci alternatif untuk tabel Dataverse.

Respons dari satu operasi dalam permintaan batch.

Respons dikembalikan dalam urutan pengiriman. Untuk operasi yang ditambahkan ke set perubahan, respons muncul di posisi changeset dalam urutan tersebut.

Example:

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

Hasil menjalankan permintaan batch.

Berisi satu BatchItemResponse per operasi HTTP yang dikirimkan. Operasi yang meluas ke beberapa permintaan HTTP (misalnya add_columns dengan tiga kolom) berkontribusi tiga entri.

Example:

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

Menentukan perilaku kaskade untuk operasi hubungan.

Nilai yang valid untuk setiap parameter:

• "Cascade": Lakukan operasi pada semua rekaman terkait

• "NoCascade": Jangan lakukan operasi pada rekaman terkait

• "RemoveLink": Hapus tautan hubungan tetapi pertahankan rekaman

• "Batasi": Mencegah operasi jika ada rekaman terkait

Metadata kolom dari definisi tabel Dataverse.

Proksi fasih untuk membangun ekspresi filter OData dari nama kolom.

Dikembalikan oleh col. Operator kelebihan beban dan metode menghasilkan FilterExpression instans yang dapat diteruskan ke QueryBuilder.where().

Example:

   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

Protokol Struktural yang memungkinkan instans entitas yang ditik untuk diteruskan ke records.create() dan records.update().

Terapkan Protokol ini pada kelas entitas apa pun (kelas data, model Pydantic, hand-rolled) untuk memungkinkannya diteruskan langsung ke operasi CRUD tanpa menentukan nama tabel atau mengonversi ke dict secara manual.

Variabel kelas yang diperlukan:

• __entity_logical_name__ — Nama entitas logis dataverse (misalnya "account")

• __entity_set_name__ — Nama set entitas OData (misalnya "accounts")

Metode instans yang diperlukan:

• to_dict() — mengembalikan payload rekaman sebagai dict

• from_dict(data) — classmethod untuk rekonstruksi dari respons dict

Example:

   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)

Opsi terstruktur untuk $expand properti navigasi.

Memungkinkan menentukan opsi berlapis , , $orderby, dan $top untuk ekspansi properti navigasi tunggal, mengikuti sintaks OData$expand. $filter$select

Example:

   # 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())

Objek kueri Inert FetchXML. Tidak ada permintaan HTTP yang dibuat sampai execute atau execute_pages dipanggil.

Diperoleh melalui client.query.fetchxml(xml).

Kelas dasar untuk ekspresi filter OData yang dapat disusun.

Mendukung kelebihan operator Python untuk komposisi logis:

• expr1 & expr2 Menghasilkan (expr1 and expr2)

• expr1 | expr2 Menghasilkan (expr1 or expr2)

• ~expr Menghasilkan not (expr)

Mewakili label yang dapat memiliki beberapa versi yang dilokalkan.

Mewakili label yang dilokalkan dengan kode bahasa.

Metadata untuk atribut pencarian.

Nilai required_level yang valid:

• "None": Atribut bersifat opsional

• "Disarankan": Atribut disarankan

• "ApplicationRequired": Atribut diperlukan

Metadata untuk hubungan entitas banyak ke banyak.

Metadata untuk hubungan entitas satu ke banyak.

Antarmuka yang fasih untuk membangun dan menjalankan kueri OData terhadap klien sinkronisasi.

Menyediakan penautan metode untuk membuat kueri kompleks dengan ekspresi filter yang dapat disusun. Dapat digunakan mandiri (melalui build()) atau terikat ke klien (melalui execute).

Kamus yang dititik dikembalikan oleh QueryBuilder.build().

Menyediakan pelengkapan otomatis IDE saat meneruskan hasil build ke client.records.list() secara manual.

Pembungkus yang dapat diulang di sekitar daftar Record objek.

Dikembalikan oleh execute (mode datar) dan list.

Kompatibel mundur: for r in result terus berfungsi tanpa perubahan.

Model pengembalian yang di ketik untuk metadata hubungan.

Dikembalikan oleh create_one_to_many_relationship, create_many_to_many_relationship, get_relationship, dan create_lookup_field.

Example:

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

Metadata tabel dengan kompatibilitas mundur seperti dict.

Mendukung akses atribut baru (info.schema_name) dan akses dict-key warisan (info["table_schema_name"]) untuk kompatibilitas mundur dengan kode yang ditulis terhadap API dict mentah.

Example:

   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

Mewakili operasi upsert tunggal yang menargetkan rekaman dengan kunci alternatifnya.

Digunakan dengan upsert untuk meningkatkan satu atau beberapa rekaman yang diidentifikasi oleh kunci alternatif daripada GUID utama.

Example:

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