ObjectQL

ObjectQL es el formato de consulta JSON que consume el motor de datos. Es lo que acepta /api/v1/data/:object, lo que compilan las vistas, lo que serializan los informes y lo que produce la herramienta de IA query_data.

Dos formas:

• Lista simple — pasa where, orderBy, limit, expand, etc. como parámetros de cadena de consulta a GET /api/v1/data/:object.
• Consulta avanzada — envía mediante POST el cuerpo completo de la consulta a /api/v1/data/:object/query (obligatorio para groupBy y aggregations).

Forma de la consulta

{
  object:        string,                  // required — target object name
  fields?:       string[],                // projection (default: all visible fields)
  where?:        FilterCondition,         // see Filters
  orderBy?:      SortNode[],              // [{ field, order: 'asc' | 'desc' }]
  limit?:        number,                  // page size
  offset?:       number,                  // offset pagination
  cursor?:       string,                  // cursor pagination (preferred)
  expand?:       string[],                // batch-resolve relation fields
  joins?:        JoinNode[],              // explicit joins (inner | left | right | full)
  groupBy?:      (string | GroupByNode)[],
  aggregations?: AggregationNode[],       // sum/avg/count/min/max/...
  having?:       FilterCondition,         // filter after aggregation
  distinct?:     boolean
}

Origen del esquema: packages/spec/src/data/query.zod.ts.

Filtros

where es un árbol de condiciones. Los operadores de campo llevan el prefijo $; los combinadores lógicos ($and, $or, $not) se ubican en el nivel superior.

Comparación

Todos los operadores de comparación también aceptan una referencia de campo para la comparación entre campos: { end_at: { $gt: { $field: "start_at" } } }.

Conjunto y rango

Cadena

Nulo y existencia

Combinadores lógicos

{
  "$and": [
    { "status": { "$eq": "open" } },
    {
      "$or": [
        { "priority": { "$in": ["high", "urgent"] } },
        { "due_at":   { "$lt": { "$cel": "now()" } } }
      ]
    }
  ]
}

Las expresiones CEL se pueden incrustar con { "$cel": "..." } — útil para filtros "relativos a ahora" que el servidor evalúa en el momento de la consulta.

Ordenación

"orderBy": [
  { "field": "priority", "order": "desc" },
  { "field": "created_at", "order": "asc" }
]

Forma abreviada en cadena de consulta: ?orderBy=-priority,created_at.

Paginación

Cursor (recomendado). La respuesta incluye nextCursor; pásalo de vuelta como cursor en la siguiente solicitud.

GET /api/v1/data/ticket?limit=50&orderBy=-created_at
→ { items: [...], nextCursor: "eyJ..." }

GET /api/v1/data/ticket?limit=50&cursor=eyJ...

Offset. Más sencillo pero se degrada en tablas grandes.

GET /api/v1/data/ticket?limit=50&offset=200

El runtime limita el limit por objeto mediante ObjectSpec.maxPageSize (valor predeterminado 200).

Relaciones — expand

expand resuelve por lotes las claves foráneas para que no incurras en N+1.

{
  "object": "support_ticket",
  "expand": ["assignee", "customer.account"],
  "limit": 20
}

Devuelve cada ticket con assignee y customer.account materializados como objetos anidados en lugar de solo los ID.

Joins

Para joins ad-hoc fuera del grafo de metadatos:

"joins": [
  { "type": "left", "object": "user", "as": "u", "on": "assignee_id = u.id" }
]

type: inner | left | right | full. Las tablas unidas son accesibles en where, orderBy y aggregations mediante el alias as.

Agregación

Solo POST /api/v1/data/:object/query.

{
  "object": "order",
  "where": { "status": { "$ne": "cancelled" } },
  "groupBy": [
    "customer_id",
    { "field": "created_at", "dateGranularity": "month" }
  ],
  "aggregations": [
    { "function": "sum",   "field": "amount", "alias": "total_sales" },
    { "function": "count", "alias": "order_count" }
  ],
  "having": { "total_sales": { "$gt": 10000 } },
  "orderBy": [{ "field": "total_sales", "order": "desc" }],
  "limit": 25
}

Funciones: count, sum, avg, min, max, count_distinct, array_agg, string_agg.

Granularidad de fecha (para agrupaciones por intervalos de tiempo): day | week | month | quarter | year.

Distinct

{ "object": "ticket", "fields": ["status"], "distinct": true }

Búsqueda

La búsqueda de texto completo en los campos con searchable: true se expone en GET /api/v1/search?q=...&object=ticket. Las reglas de puntuación por objeto se configuran en la especificación del objeto.

Dónde aparece ObjectQL

• GET /api/v1/data/:object — forma en cadena de consulta
• POST /api/v1/data/:object/query — cuerpo completo, admite agregaciones
• Definiciones de vistas (filter, sort) — compilan a ObjectQL
• Informes — serializan a ObjectQL
• La herramienta de IA query_data — produce un cuerpo ObjectQL para la cola de aprobación

Véase también

• REST API — endpoints que consumen ObjectQL
• Field types — qué es consultable
• CEL — lenguaje de expresiones usado dentro de los filtros $cel
• @objectstack/spec/data/query.zod.ts — esquema autoritativo