the best elasticsearch highlevel java rest api-----bboss
bboss 提供一组 sql 和fetchQuery API,可替代es jdbc模块;采用bboss即可拥有bboss的客户端自动发现和容灾能力、对es、jdk、spring boot的兼容性能力,又可以拥有es jdbc的所有功能,同时还解决了因为引入es jdbc导致项目对es版本的强依赖和兼容性问题,参考demo:
orm查询
https://gitee.com/bbossgroups/eshelloword-booter/blob/master/src/test/java/org/bboss/elasticsearchtest/sql/SQLOrmTest.java分页查询
https://gitee.com/bbossgroups/eshelloword-booter/blob/master/src/test/java/org/bboss/elasticsearchtest/sql/SQLPagineTest.java本文详细说明上面的案例(目前es sql提供的功能有限):
package org.bboss.elasticsearchtest.sql; import com.frameworkset.orm.annotation.Column; import java.util.Date; public class DocObject { private int isnew; private Date createtime; private String content; private int documentId; private int channelId; /** * 通过column指定索引文档和对象属性的映射关系 * 通过column注解还可以指定日期格式和时区信息 * @Column(name="docInfo.author",dataformat = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",timezOne= "Etc/UTC",locale = "zh") * */ @Column(name="docInfo.author") private String docInfoAuthor; public int getIsnew() { return isnew; } public void setIsnew(int isnew) { this.isnew = isnew; } public Date getCreatetime() { return createtime; } public void setCreatetime(Date createtime) { this.createtime = createtime; } public String getContent() { return content; } public void setContent(String content) { this.cOntent= content; } public int getDocumentId() { return documentId; } public void setDocumentId(int documentId) { this.documentId = documentId; } public int getChannelId() { return channelId; } public void setChannelId(int channelId) { this.channelId = channelId; } public String getDocInfoAuthor() { return docInfoAuthor; } public void setDocInfoAuthor(String docInfoAuthor) { this.docInfoAuthor = docInfoAuthor; } }
实体定义说明:
通过column指定索引文档和对象属性的映射关系,指定日期格式和时区信息,示例如下:
@Column(name="docInfo.author") private String docInfoAuthor;
指定属性的映射关系、日期格式和时区信息,示例如下:
@Column(name="docInfo.author",dataformat = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",timezOne= "Etc/UTC",locale = "zh")
以rest sql api为例来介绍es 6.3.0的sql orm查询功能
package org.bboss.elasticsearchtest.sql; import org.frameworkset.elasticsearch.ElasticSearchHelper; import org.frameworkset.elasticsearch.client.ClientInterface; import org.frameworkset.elasticsearch.entity.sql.SQLRestResponse; import org.frameworkset.elasticsearch.entity.sql.SQLRestResponseHandler; import org.junit.Test; import java.util.HashMap; import java.util.List; import java.util.Map; /** * 以rest sql api为例来介绍es 6.3.0的sql orm查询功能 */ public class SQLOrmTest { /** * 代码中的sql检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testDemoQuery(){ ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil(); List
上面每个orm查询方法的都有功能说明,可以根据需要选择。
下面是上面用到的sql dsl检索配置文件及内容:esmapper/sql.xml
我们将配置文件放到工程resources目录下面即可。sql配置说明:
sql中特定的字符串参数语法
{"query": "SELECT * FROM dbclobdemo where channelId=#[channelId] and docTitle='#[channelId,quoted=false]'"}
我们使用#[xxx]类型变量传递sql参数时,如果是字符串内容会自动在值的两边带上双引号,但是在sql语句是字符串值是用单引号'来标识的,所以通过qutoed=false来指示解析引擎不要在值的两边加双引号,然后在外部手动添加单引号:
'#[channelId,quoted=false]'
如果sql语句比较长,可能要换行,es暂时不支持多行sql语句的执行,bboss通过下面特定的语法,来包围多行sql,sql解析引擎在第一次解析sql的时候讲其中的多行sql解析为一行:
#"""
...
...
"""
例如:
{ ## 指示sql语句中的回车换行符会被替换掉开始符,注意dsl注释不能放到sql语句中,否则会有问题,因为sql中的回车换行符会被去掉,导致回车换行符后面的语句变道与注释一行 ## 导致dsl模板解析的时候部分sql段会被去掉 "query": #""" SELECT * FROM dbclobdemo where channelId=#[channelId] """, ## 指示sql语句中的回车换行符会被替换掉结束符 "fetch_size": #[fetchSize] }
package org.bboss.elasticsearchtest.sql; import org.frameworkset.elasticsearch.ElasticSearchHelper; import org.frameworkset.elasticsearch.client.ClientInterface; import org.frameworkset.elasticsearch.entity.sql.SQLResult; import org.junit.Test; import java.util.HashMap; import java.util.List; import java.util.Map; public class SQLPagineTest { /** * 代码中的sql检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testMapQuery(){ ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil(); SQLResultsqlResult = clientUtil.fetchQuery(Map.class,"{\"query\": \"SELECT * FROM dbclobdemo\",\"fetch_size\": 1}"); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ break; } else{ System.out.println(datas.size());//处理数据 sqlResult = sqlResult.nextPage();//获取下一页数据 } }while(true); } /** * 配置文件中的sql dsl检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testMapSQLQueryFromDSL(){ ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/sql.xml");//初始化一个加载sql配置文件的es客户端接口 //设置sql查询的参数 Map params = new HashMap(); params.put("channelId",1); params.put("fetchSize",1); SQLResult sqlResult = clientUtil.fetchQuery(Map.class,"sqlPagineQuery",params); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ break; } else{ System.out.println(datas.size());//处理数据 sqlResult = sqlResult.nextPage();//获取下一页数据 } }while(true); } /** * 代码中的sql检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testObjectListQuery(){ ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil(); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"{\"query\": \"SELECT * FROM dbclobdemo\",\"fetch_size\": 1}"); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ break; } else{ System.out.println(datas.size());//处理数据 sqlResult = sqlResult.nextPage();//获取下一页数据 } }while(true); } /** * 配置文件中的sql dsl检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testObjectSQLQueryFromDSL(){ ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/sql.xml");//初始化一个加载sql配置文件的es客户端接口 //设置sql查询的参数 Map params = new HashMap(); params.put("channelId",1); params.put("fetchSize",1); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"sqlPagineQuery",params); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ System.out.println(0);//处理数据 break; } else{ System.out.println(datas.size());//处理数据 sqlResult = sqlResult.nextPage();//获取下一页数据 } }while(true); } /** * 配置文件中的sql dsl检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testObjectSQLQueryFromDSL1(){ ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/sql.xml");//初始化一个加载sql配置文件的es客户端接口 //设置sql查询的参数 Map params = new HashMap(); params.put("channelId",1); params.put("fetchSize",1); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"sqlPagineQuery",params); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ System.out.println(0);//处理数据 break; } else{ System.out.println(datas.size());//处理数据 sqlResult = clientUtil.fetchQueryByCursor(DocObject.class,sqlResult);//获取下一页数据,通过api获取下一页数据 } }while(true); } /** * 配置文件中的sql dsl检索,返回Map类型集合,亦可以返回自定义的对象集合 * 测试没有返回数据的情况 */ @Test public void testNodataSQLQueryFromDSL1(){ ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/sql.xml");//初始化一个加载sql配置文件的es客户端接口 //设置sql查询的参数 Map params = new HashMap(); params.put("channelId",2); params.put("fetchSize",1); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"sqlPagineQuery",params); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ System.out.println(0);//处理数据 break; } else{ System.out.println(datas.size());//处理数据 sqlResult = clientUtil.fetchQueryByCursor(DocObject.class,sqlResult);//获取下一页数据,通过api获取下一页数据 } }while(true); } /** * 配置文件中的sql dsl检索,返回Map类型集合,亦可以返回自定义的对象集合 */ @Test public void testObjectSQLQueryFromDSL2(){ ClientInterface clientUtil = ElasticSearchHelper.getConfigRestClientUtil("esmapper/sql.xml");//初始化一个加载sql配置文件的es客户端接口 //设置sql查询的参数 Map params = new HashMap(); params.put("channelId",1); params.put("fetchSize",1); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"sqlPagineQuery",params); do{ List datas = sqlResult.getDatas(); if(datas == null || datas.size() == 0){ System.out.println(0);//处理数据 break; } else{ System.out.println(datas.size());//处理数据 sqlResult = clientUtil.fetchQueryByCursor(DocObject.class,sqlResult.getCursor(),sqlResult.getColumns());//获取下一页数据,通过api获取下一页数据 } }while(true); } /** * 代码中的sql检索,返回 DocObject类型集合 */ @Test public void testCloseCursor(){ ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil(); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"{\"query\": \"SELECT * FROM dbclobdemo\",\"fetch_size\": 1}"); List datas = sqlResult.getDatas(); System.out.println(datas.size());//处理数据 System.out.println(sqlResult.closeCursor());//只处理第一页数据,就主动关闭分页游标 } /** * 代码中的sql检索,返回DocObject类型集合 */ @Test public void testCloseCursor1(){ ClientInterface clientUtil = ElasticSearchHelper.getRestClientUtil(); SQLResult sqlResult = clientUtil.fetchQuery(DocObject.class,"{\"query\": \"SELECT * FROM dbclobdemo\",\"fetch_size\": 1}"); List datas = sqlResult.getDatas(); System.out.println(datas.size());//处理数据 String ret = clientUtil.closeSQLCursor(sqlResult.getCursor()); System.out.println(ret);//只处理第一页数据,就主动关闭分页游标 } }
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 我们