TableOperations Classe

Ajoutez une ou plusieurs colonnes à une table existante.

Exemple :

   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]

Paramètres

Retours

Exceptions

Créez une table personnalisée avec les colonnes spécifiées.

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Exemples

Créez une table avec des colonnes simples :

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

Créez une autre clé sur une table.

Les autres clés permettent aux opérations upsert d’identifier les enregistrements par une ou plusieurs colonnes au lieu du GUID principal. Une fois la clé créée, mise en file d’attente pour la génération d’index ; son status passage à une "Pending""Active" fois l’index prêt.

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Exemples

Créez une autre clé à colonne unique pour 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}")

Créez une relation de champ de recherche simple.

Il s’agit d’une méthode pratique qui encapsule create_one_to_many_relationship le cas courant d’ajout d’un champ de recherche à une table existante.

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Exemples

Créez un champ de recherche simple :

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

Créez une relation plusieurs-à-plusieurs entre les tables.

Cette opération crée une relation plusieurs-à-plusieurs et une table croisée pour gérer la relation.

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Exemples

Créer une relation plusieurs-à-plusieurs : Employé <-> Projet :

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

Créez une relation un-à-plusieurs entre les tables.

Cette opération crée à la fois la relation et l’attribut de recherche sur la table de référencement.

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Exemples

Créer une relation un-à-plusieurs : Département (1) -> Employé (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}")

Supprimez une table personnalisée par nom de schéma.

Exemple :

   client.tables.delete("new_MyTestTable")

delete(table: str) -> None

Paramètres

Exceptions

Supprimez une autre clé par son ID de métadonnées.

Exemple :

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

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

Paramètres

Exceptions

Supprimez une relation par son ID de métadonnées.

Exemple :

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

delete_relationship(relationship_id: str) -> None

Paramètres

Exceptions

Obtenez les métadonnées de base d’une table s’il existe.

Exemple :

   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

Paramètres

Retours

Répertorier toutes les clés alternatives définies sur une table.

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

Paramètres

Retours

Exceptions

Exemples

Répertoriez les autres clés et imprimez leur état :

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

Récupérer les métadonnées de relation par nom de schéma.

Exemple :

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

get_relationship(schema_name: str) -> RelationshipInfo | None

Paramètres

Retours

Exceptions

Répertorier toutes les tables non privées dans l’environnement Dataverse.

Par défaut, chaque table renvoie chaque table où IsPrivate eq false. Fournissez une expression OData $filter facultative pour affiner davantage les résultats. L’expression est combinée à la clause par défaut IsPrivate eq false à l’aide andde .

Exemple :

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

Paramètres

Paramètres de mot clé uniquement

Retours

Répertorier toutes les définitions d’attribut (colonne) d’une table.

Exemple :

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Répertorier toutes les définitions de relation dans l’environnement.

Exemple :

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Répertorier toutes les relations pour une table spécifique.

Combine des relations un-à-plusieurs, plusieurs-à-un et plusieurs-à-plusieurs pour la table donnée en interrogeant EntityDefinitions({id})/OneToManyRelationships, EntityDefinitions({id})/ManyToOneRelationshipset EntityDefinitions({id})/ManyToManyRelationships.

Exemple :

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

Paramètres

Paramètres de mot clé uniquement

Retours

Exceptions

Supprimez une ou plusieurs colonnes d’une table.

Exemple :

   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]

Paramètres

Retours

Exceptions