larksuite-cli/skills/lark-base/references/lark-base-data-query-guide.md

Base data-query guide

This guide is the entry point for +data-query. Use it for common aggregation fewshots and command selection. For the complete DSL fields, operators, limits, and response details, use lark-base-data-query.md as the DSL SSOT.

Before using +data-query, also follow lark-base-data-analysis-sop.md to confirm that the task really needs aggregation instead of record listing or a temporary view.

When to use

Use +data-query when the user asks for server-side:

• group by / aggregation
• sum, average, min, max, count, distinct count
• filtered aggregation
• sorted Top N or Bottom N
• global statistical conclusions

Do not use +data-query for raw record details. Use record commands for row-level output.

Common Fewshots

Count records by a category field:

lark-cli base +data-query \
  --base-token <base_token> \
  --dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Status","alias":"status"}],"measures":[{"field_name":"Status","aggregation":"count","alias":"count"}],"shaper":{"format":"flat"}}'

Sum a number field by category and return Top 10:

lark-cli base +data-query \
  --base-token <base_token> \
  --dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Region","alias":"region"}],"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"sort":[{"field_name":"total_amount","order":"desc"}],"pagination":{"limit":10},"shaper":{"format":"flat"}}'

Aggregate only records matching a filter:

lark-cli base +data-query \
  --base-token <base_token> \
  --dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Owner","alias":"owner"}],"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"filters":{"type":1,"conjunction":"and","conditions":[{"field_name":"Status","operator":"is","value":["Done"]}]},"shaper":{"format":"flat"}}'

Use tableName when the table ID is unavailable but the table name is known:

lark-cli base +data-query \
  --base-token <base_token> \
  --dsl '{"datasource":{"type":"table","table":{"tableName":"Orders"}},"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"shaper":{"format":"flat"}}'

Routing to the DSL SSOT

Read lark-base-data-query.md when you need:

• the full DSL field reference
• supported aggregations and field types
• filter operator details
• pagination and result limits
• response shape and error recovery