models Paquet
Modèles de données et définitions de type pour le Kit de développement logiciel (SDK) Dataverse.
Fournit des classes de données et des helpers pour les entités Dataverse :
- QueryBuilder: Générateur de requêtes Fluent.
- filters: Expressions de filtre OData composables via col et raw.
- QueryResult: wrapper de résultat itérable.
- Record: Enregistrement d’entité Dataverse.
- UpsertItem: élément d’opération Upsert.
- FetchXmlQuery: Objet de requête FetchXML.
- DataverseModel: protocole typé-modèle.
Modules
| batch |
Types de résultats publics pour les opérations de traitement par lots. |
| fetchxml_query |
FetchXmlQuery : objet de requête inert retourné par QueryOperations.fetchxml(). |
| filters |
Expressions de filtre OData composables pour le Kit de développement logiciel (SDK) Dataverse. Fournit une arborescence d’expressions qui se compile sur des chaînes OData Exemple::
|
| labels |
Modèles d’étiquette pour les métadonnées Dataverse. |
| protocol |
DataverseModel structural Protocol pour l’intégration d’entités typées. |
| query_builder |
Générateur de requêtes Fluent pour la construction de requêtes OData. Fournit une interface détectable de type sécurisée pour créer des requêtes complexes sur des tables Dataverse avec chaînage de méthodes. Exemple::
|
| record |
Enregistrer des modèles pour les données Dataverse. |
| relationship |
Modèles de relation pour Dataverse (entrée et sortie). |
| table_info |
Modèles de métadonnées de table et de colonne pour Dataverse. |
| upsert |
Modèles de données Upsert pour le Kit de développement logiciel (SDK) Dataverse. |
Classes
| AlternateKeyInfo |
Métadonnées de clé alternatives pour une table Dataverse. |
| BatchItemResponse |
Réponse d’une seule opération au sein d’une demande de traitement par lots. Les réponses sont retournées dans l’ordre de soumission. Pour les opérations ajoutées à un ensemble de modifications, les réponses apparaissent dans la position du jeu de modifications dans cet ordre. Exemple :
|
| BatchResult |
Résultat de l’exécution d’une demande de lot. Contient une BatchItemResponse par opération HTTP envoyée.
Les opérations qui s’étendent à plusieurs requêtes HTTP (par exemple, Exemple :
|
| CascadeConfiguration |
Définit le comportement en cascade pour les opérations de relation. Valeurs valides pour chaque paramètre :
|
| ColumnInfo |
Métadonnées de colonne à partir d’une définition de table Dataverse. |
| ColumnProxy |
Proxy Fluent pour la création d’expressions de filtre OData à partir d’un nom de colonne. Retourné par col. Les surcharges d’opérateur et les méthodes produisent des FilterExpression instances qui peuvent être passées à Exemple :
|
| DataverseModel |
Protocole structurel permettant aux instances d’entité typées d’être passées à Implémentez ce protocole sur n’importe quelle classe d’entité (dataclass, modèle Pydantic, roulé manuellement) pour lui permettre d’être transmis directement aux opérations CRUD sans spécifier le nom de la table ou convertir manuellement en dict. Variables de classe requises :
Méthodes d’instance requises :
Exemple :
Note Distribution directe (client.records.create(entity) sans nom de table ou dict) n’est pas encore pris en charge et sera ajouté dans une version ultérieure. |
| ExpandOption |
Options structurées pour une Permet de spécifier des options imbriquées Exemple :
|
| FetchXmlQuery |
Objet de requête FetchXML inert. Aucune requête HTTP n’est effectuée tant qu’elle execute n’est pas appelée.execute_pages Obtenu via |
| FilterExpression |
Classe de base pour les expressions de filtre OData composables. Prend en charge les surcharges d’opérateur Python pour la composition logique :
|
| Label |
Représente une étiquette qui peut avoir plusieurs versions localisées. |
| LocalizedLabel |
Représente une étiquette localisée avec un code de langue. |
| LookupAttributeMetadata |
Métadonnées d’un attribut de recherche. Valeurs required_level valides :
|
| ManyToManyRelationshipMetadata |
Métadonnées pour une relation d’entité plusieurs-à-plusieurs. |
| OneToManyRelationshipMetadata |
Métadonnées pour une relation d’entité un-à-plusieurs. |
| QueryBuilder |
Interface Fluent pour la création et l’exécution de requêtes OData sur un client de synchronisation. Fournit un chaînage de méthodes pour construire des requêtes complexes avec des expressions de filtre composables. Peut être utilisé autonome (via |
| QueryParams |
Dictionnaire typé retourné par Fournit la saisie semi-automatique de l’IDE lors de la transmission manuelle des résultats de |
| QueryResult |
Wrapper itérable autour d’une liste d’objets Record . Retourné par execute (mode plat) et list. Rétrocompatible : |
| RelationshipInfo |
Modèle de retour typé pour les métadonnées de relation. Retourné par create_one_to_many_relationship, create_many_to_many_relationship, get_relationshipet create_lookup_field. Exemple :
|
| TableInfo |
Métadonnées de table avec compatibilité descendante de type dicté. Prend en charge l’accès aux nouveaux attributs () et l’accès à la clé de dictée hérité Exemple :
|
| UpsertItem |
Représente une opération upsert unique ciblant un enregistrement par sa clé alternative. Utilisé pour upsert upserter un ou plusieurs enregistrements identifiés par d’autres clés plutôt que par des GUID principaux. Exemple :
|
Functions
col
Retournez un pour générer des ColumnProxy expressions de filtre.
Il s’agit de l’idiome ga préféré pour la construction d’expressions de filtre :
from PowerPlatform.Dataverse.models.filters import col
expr = col("statecode") == 0
expr = col("revenue") > 1_000_000
expr = col("name").like("Contoso%")
expr = col("statecode").in_([0, 1])
expr = col("parentaccountid").is_null()
col(name: str) -> ColumnProxy
Paramètres
| Nom | Description |
|---|---|
|
name
Obligatoire
|
Nom logique de colonne (sans respect de la casse, sera en minuscules). |
Retours
| Type | Description |
|---|---|
|
Lié ColumnProxy à la colonne. |
Exceptions
| Type | Description |
|---|---|
|
S’il |
raw
Expression de filtre OData verbatim (transmise par inchangé).
Cette fonction n’est pas déconseillée : il s’agit de la trappe d’échappement OData sans remplacement typé.
Exemple :
raw("Microsoft.Dynamics.CRM.Today(PropertyName='createdon')")
raw(filter_string: str) -> FilterExpression
Paramètres
| Nom | Description |
|---|---|
|
filter_string
Obligatoire
|
Chaîne de filtre OData brute. |
Retours
| Type | Description |
|---|---|
|
Un FilterExpression. |