QueryOperations Clase

Cree un generador de consultas fluida para la tabla especificada.

Devuelve un QueryBuilder que se puede encadenar con los métodos filter, select y order y, a continuación, se ejecuta directamente a través de .execute().

builder(table: str) -> QueryBuilder

Parámetros

Devoluciones

Ejemplos

Compile y ejecute una consulta con fluidez:

   from PowerPlatform.Dataverse.models.filters import col

   for record in (client.query.builder("account")
                  .select("name", "revenue")
                  .where(col("statecode") == 0)
                  .where(col("revenue") > 1_000_000)
                  .order_by("revenue", descending=True)
                  .top(100)
                  .page_size(50)
                  .execute()):
       print(record["name"])

Con árbol de expresiones compuestas:

   from PowerPlatform.Dataverse.models.filters import col

   for record in (client.query.builder("account")
                  .where((col("statecode") == 0) | (col("statecode") == 1))
                  .where(col("revenue") > 100_000)
                  .execute()):
       print(record["name"])

Devuelve un objeto inert FetchXmlQuery .

No se realiza ninguna solicitud HTTP hasta execute que se llama a o execute_pages en el objeto devuelto.

Se usa para escenarios de SQL-JOIN, consultas de agregado u otras operaciones que el punto de conexión del generador de OData no puede expresar.

Ejemplo:

   query = client.query.fetchxml("""
     <fetch top="50">
       <entity name="account">
         <attribute name="name" />
         <link-entity name="contact" from="parentcustomerid"
                      to="accountid" alias="c" link-type="inner">
           <attribute name="fullname" />
         </link-entity>
       </entity>
     </fetch>
   """)

   # Eager — collect all pages:
   result = query.execute()
   df = result.to_dataframe()

   # Lazy — process one page at a time:
   for page in query.execute_pages():
       process(page.to_dataframe())

fetchxml(xml: str) -> FetchXmlQuery

Parámetros

Devoluciones

Excepciones

Cree una @odata.bind entrada para establecer un campo de búsqueda.

Detecta automáticamente el nombre de la propiedad de navegación y el nombre del conjunto de entidades de los metadatos. Devuelve un dict de entrada única que se puede combinar en una carga de creación o actualización.

Ejemplo:

   # Instead of manually constructing:
   #   {"parentcustomerid_account@odata.bind": "/accounts(guid)"}
   # Just do:
   bind = client.query.odata_bind("contact", "account", acct_id)
   client.records.create("contact", {
       "firstname": "Jane",
       "lastname": "Doe",
       **bind,
   })

odata_bind(from_table: str, to_table: str, target_id: str) -> Dict[str, str]

Parámetros

Devoluciones

Excepciones

Devuelve el nombre de la propiedad de navegación a $expand de una tabla a otra.

Detecta a través de metadatos de relación. Devuelve la cadena PascalCase exacta para el expand= parámetro .

Ejemplo:

   nav = client.query.odata_expand("contact", "account")
   # Returns e.g. "parentcustomerid_account"
   for page in client.records.get("contact",
                                  select=["fullname"],
                                  expand=[nav],
                                  top=5):
       for r in page:
           acct = r.get(nav) or {}
           print(f"{r['fullname']} -> {acct.get('name', 'N/A')}")

odata_expand(from_table: str, to_table: str) -> str

Parámetros

Devoluciones

Excepciones

Descubra todas las $expand propiedades de navegación de una tabla.

Devuelve entradas para cada búsqueda saliente (propiedad de navegación con un solo valor). Cada entrada contiene el nombre exacto de la propiedad de navegación PascalCase necesaria para $expand y @odata.bind, además del nombre del conjunto de entidades de destino.

Ejemplo:

   expands = client.query.odata_expands("contact")
   for e in expands:
       print(f"expand={e['nav_property']}  -> {e['target_table']}")

   # Use in a query
   e = next(e for e in expands if e['target_table'] == 'account')
   for page in client.records.get("contact",
                                  select=["fullname"],
                                  expand=[e['nav_property']]):
       ...

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

Parámetros

Devoluciones

Devuelve una lista de nombres lógicos de columna adecuados para $select.

Se puede pasar directamente a client.records.get(table, select=...).

Ejemplo:

   cols = client.query.odata_select("account")
   for page in client.records.get("account", select=cols, top=10):
       for r in page:
           print(r)

odata_select(table: str, *, include_system: bool = False) -> List[str]

Parámetros

Parámetros de palabra clave únicamente

Devoluciones

Ejecute una consulta SQL de solo lectura mediante la API web de Dataverse.

El punto de conexión de SQL de Dataverse admite un amplio subconjunto de T-SQL:

   SELECT / SELECT DISTINCT / SELECT TOP N (0-5000)
   FROM table [alias]
   INNER JOIN / LEFT JOIN (multi-table, no depth limit)
   WHERE (=, !=, >, <, >=, <=, LIKE, IN, NOT IN, IS NULL,
          IS NOT NULL, BETWEEN, AND, OR, nested parentheses)
   GROUP BY column
   ORDER BY column [ASC|DESC]
   OFFSET n ROWS FETCH NEXT m ROWS ONLY
   COUNT(*), SUM(), AVG(), MIN(), MAX()

SELECT * no se admite: especifique los nombres de columna explícitamente. Use sql_columns para detectar nombres de columna disponibles para una tabla.

No compatible: SELECT >>*<<, subconsultas, CTE, HAVING, UNION, RIGHT/FULL/CROSS JOIN, CASE, COALESCE, window functions, string/date/math functions, INSERT/UPDATE/DELETE. Para escrituras, use client.records métodos.

sql(sql: str) -> List[Record]

Parámetros

Devoluciones

Excepciones

Ejemplos

Consulta básica:

   rows = client.query.sql(
       "SELECT TOP 10 name FROM account ORDER BY name"
   )

JOIN con agregación:

   rows = client.query.sql(
       "SELECT a.name, COUNT(c.contactid) as cnt "
       "FROM account a "
       "JOIN contact c ON a.accountid = c.parentcustomerid "
       "GROUP BY a.name"
   )

Devuelve una lista simplificada de columnas utilizables de SQL para una tabla.

Cada dict contiene name (nombre lógico para SQL), (tipo de atributo Dataverse), typeis_pk (marca de clave principal) y label (nombre para mostrar). Las columnas virtuales siempre se excluyen porque el punto de conexión sql no puede consultarlas.

Ejemplo:

   cols = client.query.sql_columns("account")
   for c in cols:
       print(f"{c['name']:30s} {c['type']:20s} PK={c['is_pk']}")

sql_columns(table: str, *, include_system: bool = False) -> List[Dict[str, Any]]

Parámetros

Parámetros de palabra clave únicamente

Devoluciones