Sql Support within Solr-类Sql的solr搜索实现

原文  http://rdc.taobao.com/team/jm/archives/2289
Solrflux 开源code google 地址 http://code.google.com/p/solrflux/

1.Solrflux 概述

   Solrflux 主要工作是完成 Sql
语法到solr语法的转换，并执行查询，保存结果。

  
当前solrflux已经停止更新了，还是2010.Mar
antlr3.2.jar 、1.4solrj的版本。

   Solrflux支持
select|update|delete|optimze|commit|rollback| 其中在select语法上，

不支持hl、facet、function等高级用法。就目前solrflux代码，基本满足80%的场景。

   并且支持直接完整solr原始query
语法，此时不做解析，直接视作完整串，弥补了复杂query 串的处理，

也兼容solr语法。



2.Solrflux 工作原理、流程

 
solrflux工作原理：对sql语句执行语法分析，对生产的语法树做语句映射，拼接为solr语法，执行查询。

  solrflux工作流程:

(1)将用户输入的sql语法（部分语法带有solr本身query特征，例如commit、optimize），按照自定义的词法、语法、抽象语法定义规则，执行词法分析、语法分析、生成抽象语法树，

主要依赖 /grammar/Solrq.g

net.moraleboost.flux.lang包中的 SolrqLexer.java
SolrqParser.java

(2)然后对抽象语法树进行遍历，根据node type
生成对应类型的statement，例如selectstatment、updatestatement等模板对象。

net.moraleboost.flux.lang 包中的StatementListBuilder
这是上层管理对象，然后调用

net.moraleboost.flux.eval.stmt
包中的各种statment。

BaseStatement、CommitStatement、DeleteStatement、InsertStatement、OptimizeStatement、RollbackStatement

SelectStatement\UseStement

其中，UseStatement 主要任务是 server对象的初始化，构建与solrj
client端，自然整个solrflux是基于http 协议。非embeded方式工作，是solrj client中http
client方式。

所有Statement extends baseStatement，抽象的baseStatement
实现接口Statement



(3)对生成的statement集合遍历，调用各自的execute方法，执行查询并保存结果。

各statement中保存了各自对应语句的上下文参数，execute方法中执行查询。



3.扩展使用方法

对于语句类型，select、update、commit、delete、optimize、rollback等已经定型了框架。

扩展过程，主要是select过程中，例如hl、facet、 function 、boost等参数支持。扩展方法

(1)扩展Solrq.g 语法规则

(2)生成Lexer、Parser

(3)修改Statement方法

具体细节有：

在对应的语句类型下，修改Solrq.g的tokens、词法、语法、抽象树规则，使用

antlrworks-1.4.3.jar 来查看语法结构图、测试语法。

下载antlrworks-1.4.3.jar  from http://www.antlr.org/download.html

windows下双击，弹出窗口，选择语法文件。点击debug选项。

input 中输入待测试语句、AST中选择语法规则、Parse Tree整个语法树构图




如果测试并没有出错，基本上语法扩充是ok的。

solrflux依赖的是antlr.3.2.runtime.jar，如果下载antlr-3.4-complete-no-antlrv2.jar
会出现，那么报错

无法找到server问题。

StatementListBuilder.buildSelectStatement 中在
T_FROM中将soucre注入到statment中，对比两个jar

发现树形输出不一样，然后没有注入这个souce。具体问题有待进一步分析。



当词法、语法、抽象树没有问题后，采取anltrwork
字段生成Lexer、Parser代码，将相关代码替换原来的lexer\Parser,分别是SolrqLexer、SolrqParser



至此，再修改对应statement中的新参数的set、get方法，以及excute中的query 拼接。



难点：扩展词法、语法规则并debug。复杂sql语法规则，可以参考antlr
mainlist上的mysql语法规则，基本可以直接引用了。