models Paquete
Modelos de datos y definiciones de tipos para el SDK de Dataverse.
Proporciona clases de datos y asistentes para entidades de Dataverse:
- QueryBuilder: Generador de consultas fluent.
- filters: expresiones de filtro de OData que se pueden componer a través col de y raw.
- QueryResult: contenedor de resultados iterable.
- Record: registro de entidad de Dataverse.
- UpsertItem: elemento de operación Upsert.
- FetchXmlQuery: objeto de consulta FetchXML.
- DataverseModel: protocolo de modelo con tipo.
Módulos
| batch |
Tipos de resultados públicos para operaciones por lotes. |
| fetchxml_query |
FetchXmlQuery: objeto de consulta inert devuelto por QueryOperations.fetchxml(). |
| filters |
Expresiones de filtro de OData redactables para el SDK de Dataverse. Proporciona un árbol de expresiones que se compila en cadenas de OData Ejemplo::
|
| labels |
Etiquetar modelos para metadatos de Dataverse. |
| protocol |
Protocolo estructural de DataverseModel para la integración de entidades con tipo. |
| query_builder |
Generador de consultas fluent para construir consultas OData. Proporciona una interfaz detectable y segura para tipos para crear consultas complejas en tablas de Dataverse con encadenamiento de métodos. Ejemplo::
|
| record |
Registre modelos para datos de Dataverse. |
| relationship |
Modelos de relación para Dataverse (entrada y salida). |
| table_info |
Modelos de metadatos de tabla y columna para Dataverse. |
| upsert |
Modelos de datos upsert para el SDK de Dataverse. |
Clases
| AlternateKeyInfo |
Metadatos de clave alternativos para una tabla de Dataverse. |
| BatchItemResponse |
Respuesta de una sola operación dentro de una solicitud por lotes. Las respuestas se devuelven en orden de envío. En el caso de las operaciones agregadas a un conjunto de cambios, las respuestas aparecen en la posición del conjunto de cambios en ese orden. Ejemplo:
|
| BatchResult |
Resultado de ejecutar una solicitud por lotes. Contiene una BatchItemResponse por operación HTTP enviada.
Las operaciones que se expanden a varias solicitudes HTTP (por ejemplo, Ejemplo:
|
| CascadeConfiguration |
Define el comportamiento en cascada para las operaciones de relación. Valores válidos para cada parámetro:
|
| ColumnInfo |
Metadatos de columna de una definición de tabla de Dataverse. |
| ColumnProxy |
Proxy fluent para compilar expresiones de filtro de OData a partir de un nombre de columna. Devuelto por col. Las sobrecargas de operador y los métodos generan FilterExpression instancias que se pueden pasar a Ejemplo:
|
| DataverseModel |
Protocolo estructural que permite pasar instancias de entidad con tipo a Implemente este protocolo en cualquier clase de entidad (dataclass, modelo Pydantic, inscrito manualmente) para permitir que se pase directamente a operaciones CRUD sin especificar el nombre de la tabla ni convertir en dict manualmente. Variables de clase necesarias:
Métodos de instancia necesarios:
Ejemplo:
Nota: Envío directo (client.records.create(entity) sin un nombre de tabla o dict) aún no se admite y se agregará en una versión futura. |
| ExpandOption |
Opciones estructuradas para una Permite especificar opciones anidadas Ejemplo:
|
| FetchXmlQuery |
Objeto de consulta Inert FetchXML. No se realiza ninguna solicitud HTTP hasta execute que se llama a o execute_pages . Obtenido a través de |
| FilterExpression |
Clase base para expresiones de filtro de OData que se pueden componer. Admite sobrecargas de operador de Python para la composición lógica:
|
| Label |
Representa una etiqueta que puede tener varias versiones localizadas. |
| LocalizedLabel |
Representa una etiqueta localizada con un código de idioma. |
| LookupAttributeMetadata |
Metadatos de un atributo de búsqueda. Valores de required_level válidos:
|
| ManyToManyRelationshipMetadata |
Metadatos de una relación de entidad de varios a varios. |
| OneToManyRelationshipMetadata |
Metadatos de una relación de entidad uno a varios. |
| QueryBuilder |
Interfaz fluent para compilar y ejecutar consultas de OData en un cliente de sincronización. Proporciona encadenamiento de métodos para construir consultas complejas con expresiones de filtro compuestas. Se puede usar independiente (a través |
| QueryParams |
Diccionario con tipo devuelto por Proporciona autocompletar del IDE al pasar los resultados de compilación a |
| QueryResult |
Contenedor iterable alrededor de una lista de Record objetos. Devuelto por execute (modo plano) y list. Compatible con versiones anteriores: |
| RelationshipInfo |
Modelo de valor devuelto con tipo para metadatos de relación. Devuelto por create_one_to_many_relationship, create_many_to_many_relationship, get_relationshipy create_lookup_field. Ejemplo:
|
| TableInfo |
Metadatos de tabla con compatibilidad con versiones anteriores de tipo dict. Admite tanto el acceso a atributos nuevos ( Ejemplo:
|
| UpsertItem |
Representa una sola operación upsert que tiene como destino un registro mediante su clave alternativa. Se usa con upsert para upsert uno o varios registros identificados por claves alternativas en lugar de GUID principales. Ejemplo:
|
Funciones
col
Devuelve un ColumnProxy para compilar expresiones de filtro.
Esta es la expresión de disponibilidad general preferida para construir expresiones de filtro:
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
Parámetros
| Nombre | Description |
|---|---|
|
name
Requerido
|
Nombre lógico de columna (sin distinción entre mayúsculas y minúsculas, se reducirá). |
Devoluciones
| Tipo | Description |
|---|---|
|
ColumnProxy Enlazado a la columna. |
Excepciones
| Tipo | Description |
|---|---|
|
Si |
raw
Expresión de filtro de OData textual (pasada sin cambios).
Esta función no está en desuso: es el sombreado de escape OData sin reemplazo con tipo.
Ejemplo:
raw("Microsoft.Dynamics.CRM.Today(PropertyName='createdon')")
raw(filter_string: str) -> FilterExpression
Parámetros
| Nombre | Description |
|---|---|
|
filter_string
Requerido
|
Cadena de filtro OData sin formato. |
Devoluciones
| Tipo | Description |
|---|---|
|
Un objeto FilterExpression. |