Datadata Query Language (DQL) 脚本编写
DQL 是基于 Starlark 的自定义脚本语言,扩展了 Starlark 的语法和标准库,提供数据处理、HTTP 网络调用等能力。
🔴 核心规则
1. 脚本必须有 return 语句
DQL 脚本实际是一个函数的 body,最后必须有 return 语句返回数据,否则执行结果为空。
# ✅ 正确
df = query("SELECT * FROM users")
return df
# ❌ 错误:没有 return,结果为空
df = query("SELECT * FROM users")
2. 编写前必须先阅读 grammar.txt(语法规范)
DQL 基于 Starlark。编写任何 DQL 脚本前,必须先阅读 grammar.txt(Starlark EBNF 语法),严格按其允许的语法结构编写,不得套用 grammar.txt 未定义的语法。
3. 必须先阅读对应的 References 文档
禁止仅凭本文档就编写 DQL 代码。 本文档只是索引,实际 API 签名、参数、返回值以 references 为准。
两类"必读"分工:grammar.txt 管语法(所有脚本都要先读,见上一条);各 .md 管 API(按场景读)。
编写代码前至少阅读以下对应文档:
4. 关于 API 文档的权威来源
所有函数/类的完整签名定义以 builtins.pyi 为准,各 .md 文件仅为快速参考和示例说明。
5. 所有 DQL 扩展均为内置全局名称
query、fetch、concat、throw、json、math、time、canvas、DataFrame、Series 都是内置的全局名称,无需 import。
6. 不确定时先问用户,不要自行猜测
当遇到以下情况时,必须先向用户确认,而不是自行假设:
- 外部 API 返回的数据结构或字段含义不明确
- 用户需求中的业务逻辑模糊(如:什么是"异常"、阈值是多少)
- 数据字段顺序不确定(如 K 线的
[开, 高, 低, 收] 还是 [开, 收, 低, 高])
- 用户提到的表名、列名在上下文中不存在或不确定
# ❌ 错误:自行猜测字段顺序,导致结果错误
data = resp.body["klines"]
df = DataFrame(data, columns=["time", "open", "high", "low", "close"]) # 猜错了
# ✅ 正确:先输出类型和数据给用户确认
return {"type": type(resp.body), "data": resp.body} # 让用户确认类型和数据结构
# 然后根据用户反馈再写处理逻辑
工作流程
- 阅读语法规范 — 编写前先读 grammar.txt,确认可用语法(见核心规则第 2 条)
- 理解用户需求 — 确定脚本的目标(数据转换、数据清洗、数据生成、可视化、HTTP 调用等)
- 查询数据 — 使用
query() 或 fetch() 获取数据
- 先验证数据再处理 — 用
return 临时返回原始数据确认结构,不要凭猜测写代码
- 数据处理 — 使用 Series/DataFrame 的方法进行数据操作(过滤、转换、聚合等)
- 生成结果 — 返回处理后的数据或结果对象
- 逐步验证 — 每步操作后及时
return 临时返回中间结果来检查,确认后再继续
核心概念
- DataFrame:二维表格,可访问列 (
df['col'])、行 (df[0]),支持分组、排序、合并等操作
- Series:一维列数据,支持映射 (
.map())、过滤、统计聚合等
- Timestamp:时间戳类型,用于时间序列的滚动窗口和重采样(详见 time.md)
- DType:数据类型包括
int, float, string, date, timestamp 等
模块和函数速查
以下均为内置全局名称,无需 import,直接使用:
使用场景
各模块参考文档中均包含实用示例:
输出规则
- 脚本最后必须有
return 语句,DQL 脚本是函数的 body,无 return 则结果为空
- 可返回 DataFrame、dict、list 或其他可序列化的数据结构
- 返回值会自动转换为 JSON 并发送给前端
- 避免返回过大的数据结构(> 1MB),必要时加入 LIMIT 限制
Starlark 基础
DQL 基于 Starlark,支持:
# 基本类型
x = 42 # 整数
s = "hello" # 字符串
lst = [1, 2, 3] # 列表
d = {"key": "value"} # 字典
# 控制流
if x > 0:
print("positive")
for i in range(5):
print(i)
# 函数和 Lambda
def add(a, b):
return a + b
square = lambda x: x * x
详见 Starlark 官方文档。
References
本 skill 包含以下参考文档:
外部资源
1---2name: datadata-dql3description: 本技能包含了 Datadata DQL 查询脚本语言的完整参考文档,当使用 Datadata DQL 脚本时,**必须先加载本技能**。 Write DQL data processing scripts for the Datadata platform — a Starlark-based extended scripting language supporting DataFrame/Series operations, SQL queries, HTTP requests, and more. Use when the user needs to write data transformation, data cleaning, data generation, or custom data processing logic.4---56# Datadata Query Language (DQL) 脚本编写78DQL 是基于 Starlark 的自定义脚本语言,扩展了 Starlark 的语法和标准库,提供数据处理、HTTP 网络调用等能力。910## 🔴 核心规则1112### 1. 脚本必须有 `return` 语句1314DQL 脚本实际是一个函数的 body,**最后必须有 `return` 语句**返回数据,否则执行结果为空。1516```python17# ✅ 正确18df = query("SELECT * FROM users")19return df2021# ❌ 错误:没有 return,结果为空22df = query("SELECT * FROM users")23```2425### 2. 编写前必须先阅读 grammar.txt(语法规范)2627DQL 基于 Starlark。**编写任何 DQL 脚本前,必须先阅读 [grammar.txt](./references/grammar.txt)**(Starlark EBNF 语法),严格按其允许的语法结构编写,**不得套用 grammar.txt 未定义的语法**。2829### 3. 必须先阅读对应的 References 文档3031**禁止仅凭本文档就编写 DQL 代码。** 本文档只是索引,实际 API 签名、参数、返回值以 references 为准。3233> **两类"必读"分工**:[grammar.txt](./references/grammar.txt) 管**语法**(所有脚本都要先读,见上一条);各 `.md` 管 **API**(按场景读)。3435编写代码前至少阅读以下对应文档:3637| 场景 | 必读文档 |38| ---------------------- | ------------------------------------------------------------------------------------------------- |39| SQL 查询 | [query.md](./references/query.md) |40| HTTP 请求 | [fetch.md](./references/fetch.md) |41| 数据转换 / DataFrame | [dataframe.md](./references/dataframe.md) |42| Series 操作 | [series.md](./references/series.md) |43| 时间处理 / 数学 / JSON | [time.md](./references/time.md)、[math.md](./references/math.md)、[json.md](./references/json.md) |44| concat / throw / print | [builtins.md](./references/builtins.md) |45| 2D 绘图 | [canvas_drawing.md](./references/canvas_drawing.md) |4647### 4. 关于 API 文档的权威来源4849所有函数/类的完整签名定义以 [**builtins**.pyi](./references/builtins.pyi) 为准,各 `.md` 文件仅为快速参考和示例说明。5051### 5. 所有 DQL 扩展均为内置全局名称5253`query`、`fetch`、`concat`、`throw`、`json`、`math`、`time`、`canvas`、`DataFrame`、`Series` **都是内置的全局名称,无需 `import`**。5455### 6. 不确定时先问用户,不要自行猜测5657当遇到以下情况时,**必须**先向用户确认,而不是自行假设:5859- 外部 API 返回的数据结构或字段含义不明确60- 用户需求中的业务逻辑模糊(如:什么是"异常"、阈值是多少)61- 数据字段顺序不确定(如 K 线的 `[开, 高, 低, 收]` 还是 `[开, 收, 低, 高]`)62- 用户提到的表名、列名在上下文中不存在或不确定6364```python65# ❌ 错误:自行猜测字段顺序,导致结果错误66data = resp.body["klines"]67df = DataFrame(data, columns=["time", "open", "high", "low", "close"]) # 猜错了6869# ✅ 正确:先输出类型和数据给用户确认70return {"type": type(resp.body), "data": resp.body} # 让用户确认类型和数据结构71# 然后根据用户反馈再写处理逻辑72```7374## 工作流程75760. **阅读语法规范** — 编写前先读 [grammar.txt](./references/grammar.txt),确认可用语法(见核心规则第 2 条)771. **理解用户需求** — 确定脚本的目标(数据转换、数据清洗、数据生成、可视化、HTTP 调用等)782. **查询数据** — 使用 `query()` 或 `fetch()` 获取数据793. **先验证数据再处理** — 用 `return` 临时返回原始数据确认结构,**不要凭猜测写代码**804. **数据处理** — 使用 Series/DataFrame 的方法进行数据操作(过滤、转换、聚合等)815. **生成结果** — 返回处理后的数据或结果对象826. **逐步验证** — 每步操作后及时 `return` 临时返回中间结果来检查,确认后再继续8384## 核心概念8586- **DataFrame**:二维表格,可访问列 (`df['col']`)、行 (`df[0]`),支持分组、排序、合并等操作87- **Series**:一维列数据,支持映射 (`.map()`)、过滤、统计聚合等88- **Timestamp**:时间戳类型,用于时间序列的滚动窗口和重采样(详见 [time.md](./references/time.md))89- **DType**:数据类型包括 `int`, `float`, `string`, `date`, `timestamp` 等9091## 模块和函数速查9293以下均为内置全局名称,**无需 `import`**,直接使用:9495| 名称 | 用途 | 详见 |96| --------------------- | --------- | --------------------------------------------------- |97| `query(sql, ...)` | SQL 查询 | [query.md](./references/query.md) |98| `fetch(url, ...)` | HTTP 请求 | [fetch.md](./references/fetch.md) |99| `DataFrame()` | 二维表格 | [dataframe.md](./references/dataframe.md) |100| `Series()` | 一维列 | [series.md](./references/series.md) |101| `math.ceil(x)` 等 | 数学函数 | [math.md](./references/math.md) |102| `time.time()` 等 | 时间处理 | [time.md](./references/time.md) |103| `json.dumps(x)` 等 | JSON 处理 | [json.md](./references/json.md) |104| `concat([df1, df2])` | 连接数据 | [builtins.md](./references/builtins.md) |105| `throw(err)` | 抛出错误 | [builtins.md](./references/builtins.md) |106| `print(...)` 等 | 内置函数 | [builtins.md](./references/builtins.md) |107| `canvas.Context(w,h)` | 2D 绘图 | [canvas_drawing.md](./references/canvas_drawing.md) |108109## 使用场景110111各模块参考文档中均包含实用示例:112113- **数据清洗、聚合、合并、异常检测、RFM 分析** → [dataframe.md](./references/dataframe.md)114- **月度对比、每日活跃用户** → [query.md](./references/query.md)115- **外部 API 集成、发送数据到外部服务** → [fetch.md](./references/fetch.md)116- **时间处理与时间戳** → [time.md](./references/time.md)117- **JSON 序列化与格式化** → [json.md](./references/json.md)118- **数学计算** → [math.md](./references/math.md)119- **错误处理与数据验证** → [builtins.md](./references/builtins.md)120- **Canvas 基础图形绘制** → [canvas_drawing.md](./references/canvas_drawing.md)121- **调试技巧、性能优化、常见陷阱** → [faq_best_practices.md](./references/faq_best_practices.md)(脚本出错或性能不佳时查阅)122123## 输出规则124125- **脚本最后必须有 `return` 语句**,DQL 脚本是函数的 body,无 `return` 则结果为空126- 可返回 DataFrame、dict、list 或其他可序列化的数据结构127- 返回值会自动转换为 JSON 并发送给前端128- 避免返回过大的数据结构(> 1MB),必要时加入 LIMIT 限制129130## Starlark 基础131132DQL 基于 Starlark,支持:133134```135# 基本类型136x = 42 # 整数137s = "hello" # 字符串138lst = [1, 2, 3] # 列表139d = {"key": "value"} # 字典140141# 控制流142if x > 0:143 print("positive")144for i in range(5):145 print(i)146147# 函数和 Lambda148def add(a, b):149 return a + b150square = lambda x: x * x151```152153详见 [Starlark 官方文档](https://github.com/bazelbuild/starlark/blob/master/spec.md)。154155## References156157本 skill 包含以下参考文档:158159| 文档 | 说明 |160| --------------------------------------------------- | --------------------------------------- |161| [grammar.txt](./references/grammar.txt) | Starlark EBNF 语法规范(编写前必读) |162| [dataframe.md](./references/dataframe.md) | DataFrame 完整 API 参考 |163| [series.md](./references/series.md) | Series 完整 API 参考 |164| [query.md](./references/query.md) | SQL 查询(query)参考 |165| [fetch.md](./references/fetch.md) | HTTP 请求(fetch)参考 |166| [math.md](./references/math.md) | 数学函数(math)参考 |167| [time.md](./references/time.md) | 时间处理(time)参考 |168| [json.md](./references/json.md) | JSON 处理(json)参考 |169| [builtins.md](./references/builtins.md) | 内置函数(concat, throw, print 等)参考 |170| [canvas_drawing.md](./references/canvas_drawing.md) | Canvas 2D 绘图 API + 示例 |171172### 外部资源173174- **语法规范**:[grammar.txt](./references/grammar.txt) — Starlark EBNF 语法(编写前必读,权威来源)175- **Starlark 官方文档**:[Starlark 官方文档](https://github.com/bazelbuild/starlark/blob/master/spec.md)176- **完整 API 签名**:[**builtins**.pyi](./references/builtins.pyi) — 所有类型提示(权威来源)177- **Starlark 语言**:https://github.com/bazelbuild/starlark/blob/master/spec.md — 官方 Starlark 语言规范