CartoDB Analytics Toolbox Core 开发规范与文档编写指南
2025-06-04 16:25:45作者:滕妙奇
项目概述
CartoDB Analytics Toolbox Core 是一个提供地理空间分析功能的工具集,支持多种云平台(BigQuery、Snowflake、Redshift、PostgreSQL等)。本文将详细介绍该项目的开发规范和文档编写标准。
代码提交规范
提交请求格式要求
所有变更必须通过提交请求进行,合并时将采用压缩提交(squash)方式,最终在主分支上形成单个提交记录。
提交请求的命名和描述需要遵循以下规范:
- 使用约定式提交(Conventional Commits)格式
- 主要类型包括:
feat
: 新功能fix
: 错误修复docs
: 文档更新test
: 测试相关chore
: 构建过程或辅助工具变更refactor
: 代码重构
作用域规范
作用域用于标识影响的云平台和模块,格式如下:
(<云平台>|<模块>)
云平台标识:
bq
: BigQuerysf
: Snowflakers
: Redshiftpg
: PostgreSQL
模块示例:
h3
: H3地理索引模块lds
: 线性参考系统模块quadbin
: Quadbin空间索引模块
文档编写指南
文档结构
文档采用Markdown格式,并扩展了元数据和特殊标记功能。标准目录结构如下:
clouds/<云平台>/modules/doc/<模块>/
- _INTRO.md (模块介绍)
- FUNCTION_A.md (函数文档)
- PROCEDURE_B.md (存储过程文档)
模块介绍文档
_INTRO.md
文件包含模块的整体介绍,支持YAML格式的元数据头:
---
badges: # 标识模块状态
- advanced
- beta
order: # 自定义排序
- PROCEDURE_B
- FUNCTION_A
---
# 模块名称
模块功能描述...
函数文档规范
## 函数名称
```sql:signature
函数名(参数1, 参数2)
```
**描述**
函数功能详细说明。
* `参数1`: `类型` 参数说明。
* `参数2` (可选): `类型` 参数说明。
**返回类型**
`返回值类型`
**示例**
```sql
SELECT 函数调用示例;
-- 预期输出
```
存储过程文档规范
## 存储过程名称
```sql:signature
存储过程名(参数1, 参数2)
```
**描述**
存储过程功能详细说明。
* `参数1`: `类型` 参数说明。
* `参数2` (可选): `类型` 参数说明。
**输出**
描述输出表结构...
**示例**
```sql
CALL 存储过程调用示例;
```
文档辅助元素
-
提示块:用于显示额外信息或警告
````hint:info **标题** 提示内容...
-
内部链接:引用其他函数/存储过程
[`函数名`](模块名#函数名)
-
图片引用:图片需存放在
common/assets/
目录
命名规范要求
BigQuery平台
-
函数/存储过程调用:
SELECT `@@BQ_DATASET@@.函数名`(); CALL `@@BQ_DATASET@@.存储过程名`();
-
函数定义:
CREATE OR REPLACE FUNCTION `@@BQ_DATASET@@.函数名` ( 参数 类型 )
其他平台(Snowflake/Redshift/PostgreSQL)
-
函数/存储过程调用:
SELECT @@XX_SCHEMA@@.函数名(); CALL @@XX_SCHEMA@@.存储过程名();
-
函数定义:
CREATE OR REPLACE FUNCTION @@XX_SCHEMA@@.函数名 ( 参数 类型 ) RETURNS 返回类型
动态依赖声明
当函数名在代码中动态生成时,需要在文件中添加注释声明可能的依赖:
/*
额外依赖:
`@@BQ_DATASET@@.依赖函数`()
*/
平台特定限制
Snowflake平台限制
由于Snowflake原生应用当前限制,存储过程中不能使用临时表(TEMPORARY tables)。解决方案是创建普通表并确保在使用后删除。
最佳实践建议
- 代码可读性:保持一致的缩进和格式,SQL关键字使用大写
- 文档完整性:每个函数/存储过程都应提供完整的参数说明和示例
- 测试覆盖:新增功能应包含相应的测试用例
- 性能考虑:大数据量操作应考虑分批处理
- 错误处理:提供清晰的错误提示信息
通过遵循这些规范,可以确保Analytics Toolbox Core项目的代码质量和文档一致性,便于团队协作和后续维护。
登录后查看全文
热门项目推荐
PaddleOCR-VL
PaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
openPangu-Ultra-MoE-718B-V1.1
昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0134AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile011
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
最新内容推荐
JavaWeb企业门户网站源码 - 企业级门户系统开发指南 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案 IEC61850建模工具及示例资源:智能电网自动化配置的完整指南 海能达HP680CPS-V2.0.01.004chs写频软件:专业对讲机配置管理利器 WebVideoDownloader:高效网页视频抓取工具全面使用指南 Python开发者的macOS终极指南:VSCode安装配置全攻略 瀚高迁移工具migration-4.1.4:企业级数据库迁移的智能解决方案 TJSONObject完整解析教程:Delphi开发者必备的JSON处理指南 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 电脑PC网易云音乐免安装皮肤插件使用指南:个性化音乐播放体验
项目优选
收起

deepin linux kernel
C
23
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
231
2.31 K

仓颉编译器源码及 cjdb 调试工具。
C++
112
76

React Native鸿蒙化仓库
JavaScript
216
290

暂无简介
Dart
532
117

仓颉编程语言运行时与标准库。
Cangjie
122
93

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
991
587

Ascend Extension for PyTorch
Python
74
103

仓颉编程语言测试用例。
Cangjie
34
60

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
401