TableOperations 类

向现有表添加一个或多个列。

示例：

   created = client.tables.add_columns(
       "new_MyTestTable",
       {"new_Notes": "string", "new_Active": "bool"},
   )
   print(created)  # ['new_Notes', 'new_Active']

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

参数

返回

例外

使用指定的列创建自定义表。

create(table: str, columns: Dict[str, Any], *, solution: str | None = None, primary_column: str | None = None, display_name: str | None = None) -> TableInfo

参数

仅限关键字的参数

返回

例外

示例

创建包含简单列的表：

   from enum import IntEnum

   class ItemStatus(IntEnum):
       ACTIVE = 1
       INACTIVE = 2

   result = client.tables.create(
       "new_Product",
       {
           "new_Title": "string",
           "new_Price": "decimal",
           "new_Status": ItemStatus,
       },
       solution="MySolution",
       primary_column="new_ProductName",
       display_name="Product",
   )
   print(f"Created: {result['table_schema_name']}")

在表上创建备用键。

备用键允许 upsert 操作按一个或多个列（而不是主 GUID）标识记录。 创建密钥后，将排队用于索引生成;索引准备就绪后，它将 status 从 "Pending" 过渡到 "Active" 该索引。

create_alternate_key(table: str, key_name: str, columns: List[str], *, display_name: str | None = None, language_code: int = 1033) -> AlternateKeyInfo

参数

仅限关键字的参数

返回

例外

示例

为 upsert 创建单列备用键：

   key = client.tables.create_alternate_key(
       "new_Product",
       "new_product_code_key",
       ["new_productcode"],
       display_name="Product Code",
   )
   print(f"Key ID: {key.metadata_id}")
   print(f"Columns: {key.key_attributes}")

创建简单的查阅字段关系。

这是一种方便的方法，用于包装 create_one_to_many_relationship 向现有表添加查阅字段的常见情况。

create_lookup_field(referencing_table: str, lookup_field_name: str, referenced_table: str, *, display_name: str | None = None, description: str | None = None, required: bool = False, cascade_delete: str = 'RemoveLink', solution: str | None = None, language_code: int = 1033) -> RelationshipInfo

参数

仅限关键字的参数

返回

例外

示例

创建简单的查阅字段：

   result = client.tables.create_lookup_field(
       referencing_table="new_order",
       lookup_field_name="new_AccountId",
       referenced_table="account",
       display_name="Account",
       required=True,
       cascade_delete=CASCADE_BEHAVIOR_REMOVE_LINK,
   )
   print(f"Created lookup: {result.lookup_schema_name}")

在表之间创建多对多关系。

此操作将创建一个多对多关系和一个相交表来管理关系。

create_many_to_many_relationship(relationship: ManyToManyRelationshipMetadata, *, solution: str | None = None) -> RelationshipInfo

参数

仅限关键字的参数

返回

例外

示例

创建多对多关系：员工 <-> 项目：

   from PowerPlatform.Dataverse.models import (
       ManyToManyRelationshipMetadata,
   )

   relationship = ManyToManyRelationshipMetadata(
       schema_name="new_employee_project",
       entity1_logical_name="new_employee",
       entity2_logical_name="new_project",
   )

   result = client.tables.create_many_to_many_relationship(relationship)
   print(f"Created: {result.relationship_schema_name}")

在表之间创建一对多关系。

此操作在引用表上创建关系和查找属性。

create_one_to_many_relationship(lookup: LookupAttributeMetadata, relationship: OneToManyRelationshipMetadata, *, solution: str | None = None) -> RelationshipInfo

参数

仅限关键字的参数

返回

例外

示例

创建一对多关系：部门（1） -> 员工（N）：

   from PowerPlatform.Dataverse.models import (
       LookupAttributeMetadata,
       OneToManyRelationshipMetadata,
       Label,
       LocalizedLabel,
       CascadeConfiguration,
   )
   from PowerPlatform.Dataverse.common.constants import (
       CASCADE_BEHAVIOR_REMOVE_LINK,
   )

   lookup = LookupAttributeMetadata(
       schema_name="new_DepartmentId",
       display_name=Label(
           localized_labels=[
               LocalizedLabel(label="Department", language_code=1033)
           ]
       ),
   )

   relationship = OneToManyRelationshipMetadata(
       schema_name="new_Department_Employee",
       referenced_entity="new_department",
       referencing_entity="new_employee",
       referenced_attribute="new_departmentid",
       cascade_configuration=CascadeConfiguration(
           delete=CASCADE_BEHAVIOR_REMOVE_LINK,
       ),
   )

   result = client.tables.create_one_to_many_relationship(lookup, relationship)
   print(f"Created lookup field: {result.lookup_schema_name}")

按架构名称删除自定义表。

示例：

   client.tables.delete("new_MyTestTable")

delete(table: str) -> None

参数

例外

按其元数据 ID 删除备用密钥。

示例：

   client.tables.delete_alternate_key(
       "new_Product",
       "12345678-1234-1234-1234-123456789abc",
   )

delete_alternate_key(table: str, key_id: str) -> None

参数

例外

按其元数据 ID 删除关系。

示例：

   client.tables.delete_relationship(
       "12345678-1234-1234-1234-123456789abc"
   )

delete_relationship(relationship_id: str) -> None

参数

例外

获取表的基本元数据（如果存在）。

示例：

   info = client.tables.get("new_MyTestTable")
   if info:
       print(f"Logical name: {info['table_logical_name']}")
       print(f"Entity set: {info['entity_set_name']}")

get(table: str) -> TableInfo | None

参数

返回

列出表上定义的所有备用键。

get_alternate_keys(table: str) -> List[AlternateKeyInfo]

参数

返回

例外

示例

列出备用键并打印其状态：

   keys = client.tables.get_alternate_keys("new_Product")
   for key in keys:
       print(f"{key.schema_name}: {key.status}")

按架构名称检索关系元数据。

示例：

   rel = client.tables.get_relationship("new_Department_Employee")
   if rel:
       print(f"Found: {rel.relationship_schema_name}")

get_relationship(schema_name: str) -> RelationshipInfo | None

参数

返回

例外

列出 Dataverse 环境中的所有非专用表。

默认情况下，返回每个表，其中 IsPrivate eq false。 提供可选的 OData $filter 表达式以进一步缩小结果范围。 表达式与使用IsPrivate eq false的默认and子句结合使用。

示例：

   # List all non-private tables
   tables = client.tables.list()
   for table in tables:
       print(table["LogicalName"])

   # List only tables whose schema name starts with "new_"
   custom_tables = client.tables.list(
       filter="startswith(SchemaName, 'new_')"
   )

   # List tables with only specific properties
   tables = client.tables.list(
       select=["LogicalName", "SchemaName", "EntitySetName"]
   )

list(*, filter: str | None = None, select: List[str] | None = None) -> List[Dict[str, Any]]

参数

仅限关键字的参数

返回

列出表的所有属性（列）定义。

示例：

   # List all columns on the account table
   columns = client.tables.list_columns("account")
   for col in columns:
       print(f"{col['LogicalName']} ({col.get('AttributeType')})")

   # List only specific properties
   columns = client.tables.list_columns(
       "account",
       select=["LogicalName", "SchemaName", "AttributeType"],
   )

   # Filter to only string attributes
   columns = client.tables.list_columns(
       "account",
       filter="AttributeType eq 'String'",
   )

list_columns(table: str, *, select: List[str] | None = None, filter: str | None = None) -> List[Dict[str, Any]]

参数

仅限关键字的参数

返回

例外

列出环境中的所有关系定义。

示例：

   # List all relationships
   rels = client.tables.list_relationships()
   for rel in rels:
       print(f"{rel['SchemaName']} ({rel.get('@odata.type')})")

   # Filter by type
   one_to_many = client.tables.list_relationships(
       filter="RelationshipType eq Microsoft.Dynamics.CRM.RelationshipType'OneToManyRelationship'"
   )

   # Select specific properties
   rels = client.tables.list_relationships(
       select=["SchemaName", "ReferencedEntity", "ReferencingEntity"]
   )

list_relationships(*, filter: str | None = None, select: List[str] | None = None) -> List[Dict[str, Any]]

参数

仅限关键字的参数

返回

例外

列出特定表的所有关系。

通过查询和组合EntityDefinitions({id})/OneToManyRelationshipsEntityDefinitions({id})/ManyToOneRelationshipsEntityDefinitions({id})/ManyToManyRelationships给定表的一对多、多对一和多对多关系。

示例：

   # List all relationships for the account table
   rels = client.tables.list_table_relationships("account")
   for rel in rels:
       print(f"{rel['SchemaName']} -> {rel.get('@odata.type')}")

list_table_relationships(table: str, *, filter: str | None = None, select: List[str] | None = None) -> List[Dict[str, Any]]

参数

仅限关键字的参数

返回

例外

从表中删除一个或多个列。

示例：

   removed = client.tables.remove_columns(
       "new_MyTestTable",
       ["new_Notes", "new_Active"],
   )
   print(removed)  # ['new_Notes', 'new_Active']

remove_columns(table: str, columns: str | List[str]) -> List[str]

参数

返回

例外