TableOperations Class

Add one or more columns to an existing table.

Example:

   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]

Parameters

Returns

Exceptions

Create a custom table with the specified columns.

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

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Create a table with simple columns:

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

Create an alternate key on a table.

Alternate keys allow upsert operations to identify records by one or more columns instead of the primary GUID. After creation the key is queued for index building; its status will transition from "Pending" to "Active" once the index is ready.

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

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Create a single-column alternate key for 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 a simple lookup field relationship.

This is a convenience method that wraps create_one_to_many_relationship for the common case of adding a lookup field to an existing table.

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

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Create a simple lookup field:

   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 a many-to-many relationship between tables.

This operation creates a many-to-many relationship and an intersect table to manage the relationship.

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

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Create a many-to-many relationship: Employee <-> Project:

   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 a one-to-many relationship between tables.

This operation creates both the relationship and the lookup attribute on the referencing table.

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

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Create a one-to-many relationship: Department (1) -> Employee (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}")

Delete a custom table by schema name.

Example:

   client.tables.delete("new_MyTestTable")

delete(table: str) -> None

Parameters

Exceptions

Delete an alternate key by its metadata ID.

Example:

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

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

Parameters

Exceptions

Delete a relationship by its metadata ID.

Example:

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

delete_relationship(relationship_id: str) -> None

Parameters

Exceptions

Get basic metadata for a table if it exists.

Example:

   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

Parameters

Returns

List all alternate keys defined on a table.

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

Parameters

Returns

Exceptions

Examples

List alternate keys and print their status:

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

Retrieve relationship metadata by schema name.

Example:

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

get_relationship(schema_name: str) -> RelationshipInfo | None

Parameters

Returns

Exceptions

List all non-private tables in the Dataverse environment.

By default returns every table where IsPrivate eq false. Supply an optional OData $filter expression to further narrow the results. The expression is combined with the default IsPrivate eq false clause using and.

Example:

   # 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]]

Parameters

Keyword-Only Parameters

Returns

List all attribute (column) definitions for a table.

Example:

   # 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]]

Parameters

Keyword-Only Parameters

Returns

Exceptions

List all relationship definitions in the environment.

Example:

   # 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]]

Parameters

Keyword-Only Parameters

Returns

Exceptions

List all relationships for a specific table.

Combines one-to-many, many-to-one, and many-to-many relationships for the given table by querying EntityDefinitions({id})/OneToManyRelationships, EntityDefinitions({id})/ManyToOneRelationships, and EntityDefinitions({id})/ManyToManyRelationships.

Example:

   # 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]]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Remove one or more columns from a table.

Example:

   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]

Parameters

Returns

Exceptions