查询审查器（QueryReviewer）使用教程

查询审查器（QueryReviewer）使用教程

query_reviewer An excellent development aid. Will run "EXPLAIN" before each of your select queries in development, and provides a display which makes them easy to browse. In this fork, gemified and compatible with Rails 2 + 3. 项目地址: https://gitcode.com/gh_mirrors/que/query_reviewer

1. 项目介绍

查询审查器（QueryReviewer）是一个高级的SQL查询分析工具。它的主要目标包括：

• 对所有SELECT查询运行"EXPLAIN"，并生成易于浏览的页面。
• 将页面的SQL使用情况分为三种类别：正常（OK）、警告（WARNING）、严重（CRITICAL）。
• 对单个查询和查询集合附加有意义的警告。
• 在页面上显示互动式的摘要。

本项目适用于大多数基于MySQL的Rails项目，是分析和理解生成SQL查询的最好工具之一。

2. 项目快速启动

在您的Rails 2或3项目中安装QueryReviewer非常简单。

首先，使用以下命令安装gem：

gem install query_reviewer

如果您使用Bundler，只需将以下代码添加到您的Gemfile中：

gem "query_reviewer"

或者，如果您想使用GitHub上的最新代码，可以这样写：

gem "query_reviewer", :github => "nesquena/query_reviewer"

如果您不使用Bundler，可以将其作为插件安装：

script/plugin install git://github.com/nesquena/query_reviewer.git

在Rails 2中，rake任务不会自动加载（作为gem），您需要在Rakefile中添加以下内容：

# Rakefile
begin
  require 'query_reviewer/tasks'
rescue LoadError
  STDERR.puts "The query_reviewer gem could not be found!"
end

然后运行以下命令：

$ rake query_reviewer:setup

这将创建config/query_reviewer.yml文件。如果未创建配置文件，gem将使用vendor/plugins/query_reviewer中的默认设置。

3. 应用案例和最佳实践

• 在开发环境中，通过EXPLAIN分析所有SELECT查询，以优化查询性能。
• 使用配置文件自定义警告和严重级别，以适应不同的项目需求。
• 在视图中手动插入查询审查器的输出，以便于查看和分析。

4. 典型生态项目

查询审查器可以与以下典型生态项目配合使用，以提高Rails应用的数据库性能：

• bullet: 避免不必要的数据库查询。
• slim-scrooge: 优化Rails应用的数据库查询。
• slim-attributes: 减少不必要的数据库字段。

通过这些工具的组合使用，可以显著提升应用的性能和响应速度。

query_reviewer An excellent development aid. Will run "EXPLAIN" before each of your select queries in development, and provides a display which makes them easy to browse. In this fork, gemified and compatible with Rails 2 + 3. 项目地址: https://gitcode.com/gh_mirrors/que/query_reviewer