JSQLParserAdapter (ddal-jsqlparser 1.1.1-RELEASE API)

java.lang.Object
- net.sf.jsqlparser.util.TablesNamesFinder
- - org.hellojavaer.ddal.jsqlparser.JSQLBaseVisitor
  - - org.hellojavaer.ddal.jsqlparser.JSQLParserAdapter

All Implemented Interfaces:

net.sf.jsqlparser.expression.ExpressionVisitor, net.sf.jsqlparser.expression.operators.relational.ItemsListVisitor, net.sf.jsqlparser.statement.select.FromItemVisitor, net.sf.jsqlparser.statement.select.SelectItemVisitor, net.sf.jsqlparser.statement.select.SelectVisitor, net.sf.jsqlparser.statement.StatementVisitor
```
public class JSQLParserAdapter
extends JSQLBaseVisitor
```
JSQLParserAdapter sql解析适配器 1.支持解析insert,update,delete,select 4种类型的sql解析,支持子语句嵌套和union all语法; 2.如果sql匹配到分表信息 2.1 分表select会被自动添加别名; 2.2 分表非select操作不会被自动添加别名,如果column有表名前缀,前缀会根据路由信息动态被替换; 2.3 分表路由值的获取 2.3.1 如果路由规则中配置了分片字段,则检查sql参数及jdbc参数是否命中路由 2.3.1.1 如果分表字段是不含'not'修饰符的'=','between'或'in()'操作,则命中分表路由; 2.3.1.2 between和in操作允许混合使用sql参数和jdbc参数(eg:'id between(1 and ?)' 或者 'id in(1,2,?)'); 2.3.2 如果路由规则中未配置分片字段或(2.3.1)未命中路由值则通过ShardRoute注解或ShardRouteContext设置的路由信息进行路由, 若ShardRouteContext中也未获取到匹配的路由信息则抛异常; (注:在指定分表字段后支持ShardRouteContext方式是为了能够提供'扫表'功能) 3.如果解析过程如果没有匹配到分表配置,sql语句中的关键字格式化后返回(关键字大写);

Author:

Kaiming Zou,created on 12/11/2016.

Constructor Summary

Constructors
Constructor and Description

JSQLParserAdapter(String sql, ShardRouter shardRouter, boolean enableLimitCheck)

Constructors
Constructor and Description
`JSQLParserAdapter(String sql, ShardRouter shardRouter, boolean enableLimitCheck)`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`checkCompatibilityWithJSqlParser()`
`static void`	`checkJSqlParserFeature()` To make ddal-jsqlparser work well, JSqlParser should include the feature of 'support getting jdbc parameter index'.
`SQLParsedState`	`parse()`
`void`	`visit(net.sf.jsqlparser.expression.operators.relational.Between between)`
`void`	`visit(net.sf.jsqlparser.statement.delete.Delete delete)` mysql 'delete' doesn't support alais
`void`	`visit(net.sf.jsqlparser.expression.operators.relational.EqualsTo equalsTo)`
`void`	`visit(net.sf.jsqlparser.expression.operators.relational.InExpression inExpression)`
`void`	`visit(net.sf.jsqlparser.statement.insert.Insert insert)`
`void`	`visit(net.sf.jsqlparser.statement.select.Select select)`
`void`	`visit(net.sf.jsqlparser.statement.select.SubSelect subSelect)`
`void`	`visit(net.sf.jsqlparser.schema.Table table)`
`void`	`visit(net.sf.jsqlparser.statement.update.Update update)`

Methods inherited from class org.hellojavaer.ddal.jsqlparser.JSQLBaseVisitor
init, init, visit, visit

Methods inherited from class net.sf.jsqlparser.util.TablesNamesFinder
getTableList, getTableList, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitBinaryExpression

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JSQLParserAdapter
```
public JSQLParserAdapter(String sql,
                 ShardRouter shardRouter,
                 boolean enableLimitCheck)
```
- Method Detail
  - checkJSqlParserFeature
```
public static void checkJSqlParserFeature()
                                   throws net.sf.jsqlparser.JSQLParserException
```
    To make ddal-jsqlparser work well, JSqlParser should include the feature of 'support getting jdbc parameter index'. And this feature is provided on the version of 0.9.7. This method is designed to check the necessary feature.
    
    Throws:
    
    net.sf.jsqlparser.JSQLParserException
  - checkCompatibilityWithJSqlParser
```
public static void checkCompatibilityWithJSqlParser()
```
  - parse
```
public SQLParsedState parse()
```
  - visit
```
public void visit(net.sf.jsqlparser.statement.insert.Insert insert)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.statement.StatementVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.statement.delete.Delete delete)
```
    mysql 'delete' doesn't support alais
    
    Specified by:
    
    visit in interface net.sf.jsqlparser.statement.StatementVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.statement.update.Update update)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.statement.StatementVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.statement.select.Select select)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.statement.StatementVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.statement.select.SubSelect subSelect)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.expression.ExpressionVisitor
    
    Specified by:
    
    visit in interface net.sf.jsqlparser.expression.operators.relational.ItemsListVisitor
    
    Specified by:
    
    visit in interface net.sf.jsqlparser.statement.select.FromItemVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.expression.operators.relational.InExpression inExpression)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.expression.ExpressionVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.expression.operators.relational.Between between)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.expression.ExpressionVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.expression.operators.relational.EqualsTo equalsTo)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.expression.ExpressionVisitor
    
    Overrides:
    
    visit in class net.sf.jsqlparser.util.TablesNamesFinder
  - visit
```
public void visit(net.sf.jsqlparser.schema.Table table)
```
    Specified by:
    
    visit in interface net.sf.jsqlparser.statement.select.FromItemVisitor
    
    Overrides:
    
    visit in class JSQLBaseVisitor

Class JSQLParserAdapter

Constructor Summary

Method Summary

Methods inherited from class org.hellojavaer.ddal.jsqlparser.JSQLBaseVisitor

Methods inherited from class net.sf.jsqlparser.util.TablesNamesFinder

Methods inherited from class java.lang.Object

Constructor Detail

JSQLParserAdapter

Method Detail

checkJSqlParserFeature

checkCompatibilityWithJSqlParser

parse

visit

visit

visit

visit

visit

visit

visit

visit

visit