objectstack-query

Construct ObjectQL query ASTs for filtering, sorting, pagination, and analytics.

22|6|Updated Jan 18, 2026
One-click install
npx skills add https://github.com/objectstack-ai/framework --skill objectstack-query
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: objectstack-query
Source: https://github.com/objectstack-ai/framework/tree/main/skills/objectstack-query
Command: npx skills add https://github.com/objectstack-ai/framework --skill objectstack-query

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill solves the problem of writing correct, performant ObjectQL queries so users can fetch the right data with filters, sorting, pagination, and analytics without guessing the DSL details.

Core Features & Use Cases

  • Filter expression construction: compose declarative where clauses using comparison, set/range, string, null/existence, and logical operators, including nested relation filters and cross-field comparisons via $field.
  • Query shape for listing and search: define fields, orderBy, limit, offset, cursor, and OData-style top to support stable list views and APIs, including full-text search and expand (related records) specs.
  • Analytics-ready queries: build aggregation queries (groupBy, having, filtered aggregations) and window-function queries (e.g., row_number, running totals) for reporting use cases.

Quick Start

Use the objectstack-query skill to design an ObjectQL list query for accounts where status is active, sorted by created_at descending, returning the first 20 records.

Frequently Asked Questions about objectstack-query

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build an ObjectQL query with filters, sorting, and pagination?

To build an ObjectQL query, construct a QueryAST containing the target object and define declarative where clauses, orderBy criteria, and limit or offset parameters to retrieve specific business records. You can also use cursor pagination for stable list views.

What is the correct QueryAST structure for ObjectStack analytics and aggregations?

The correct QueryAST structure for ObjectStack analytics uses an aggregations shape with groupBy and having clauses, alongside a windowFunctions shape to compute reporting patterns like row_number or running totals for your business records.

Can I use full-text search and expand related records in an ObjectQL query?

Yes, ObjectQL queries support full-text search via the search property and allow expanding related records using the expand specification within the QueryAST to retrieve nested data efficiently.

How do I compose nested relation filters and cross-field comparisons in ObjectQL?

Compose nested relation filters in ObjectQL by using declarative where clauses with logical operators, and perform cross-field comparisons by referencing the $field operator to compare attributes across your business records directly within the query.

What are the limitations of ObjectQL query DSL for data retrieval?

ObjectQL query DSL requires the QueryAST structure to have an object property as mandatory, meaning queries without a specified target object are invalid, and all where, orderBy, and expand shapes must strictly conform to the defined DSL specifications.