首页
/ Shiba:智能SQL审查助手,为生产保驾护航

Shiba:智能SQL审查助手,为生产保驾护航

2024-05-22 00:29:02作者:翟萌耘Ralph

build-status

Shiba 是一个处于alpha阶段的工具,它在SQL查询进入生产环境之前进行自动审查,以防止潜在问题的发生。它利用生产环境的统计信息来进行现实世界中的查询分析,能捕捉到缺失索引、过宽索引以及返回数据过多的查询。

安装与使用

在Ruby on Rails或ActiveRecord项目中,可以通过Bundler安装Shiba,并将其配置在测试环境中。确保在运行测试时Shiba已被正确加载:

# Gemfile
gem 'shiba', group: :test, require: 'shiba/setup'

# 如果你的应用懒加载宝石,你需要手动引入
# config/environments/test.rb 或 test/test_helper.rb
require 'shiba/setup'

然后运行bundle来安装,接下来,尝试本地运行Shiba,通过设置SHIBA_DEBUG=true来查看详细的查询报告:

# 安装
bundle

# 运行测试并生成SQL报告
rake test:functional
rails test test/controllers/users_controller_test.rb
SHIBA_DEBUG=true ruby test/controllers/users_controller_test.rb

技术特性

Shiba目前支持Postgres(尚处在开发阶段),为了获得可靠的检测结果,建议测试表至少有1000行数据。

生产数据统计

要更精确地捕获可能导致性能问题的情况,如除缺少索引外的其他问题,Shiba需要获取生产环境的数据统计信息,如表的数量和列的唯一性等。你可以通过执行bin/dump_stats命令在生产环境中收集这些信息,并将结果保存到Rails项目的配置文件中。

自动化代码审核

Shiba可以与GitHub的Pull Request集成,当代码变更引入查询问题时,自动在PR上添加评论。这需要一个具有仓库访问权限的GitHub API Token,可以在这里生成。在你的CI服务器上配置好环境变量SHIBA_GITHUB_TOKEN后,根据你的CI服务商(如Travis CI或CircleCI)进行相应的集成设置。

应用场景

Shiba适用于需要严格控制SQL查询质量的任何Web应用程序,特别是在数据库操作密集型的应用中,比如大型电商平台、数据分析平台或者实时监控系统。它可以有效地帮助开发者预防因SQL查询不当引发的生产环境问题。

项目亮点

  • 实时检测:在代码提交前就能发现可能的问题,减少生产故障。
  • 智能分析:基于生产数据提供真实的查询性能评估。
  • 自动化集成:轻松与Git仓库和持续集成服务集成,实现代码审核自动化。
  • 多语言支持:不仅限于Ruby/Rails,也可分析其他语言产生的SQL日志。

总之,Shiba是一个强大的SQL查询审查工具,旨在提高代码质量,提升数据库性能,是每个开发者或DevOps团队值得拥有的得力助手。

热门项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
266
55
国产编程语言蓝皮书国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区
65
17
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
196
45
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
53
44
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
268
69
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
333
27
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
896
0
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
419
108
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
144
24
HarmonyOS-Cangjie-CasesHarmonyOS-Cangjie-Cases
参考 HarmonyOS-Cases/Cases,提供仓颉开发鸿蒙 NEXT 应用的案例集
Cangjie
58
4