ElasticSearch Java api 詳解_V1.0

/×××××××××××××××××××××××××××××××××××××××××/

Author：xxx0624

HomePage：http://www.cnblogs.com/xxx0624/

/×××××××××××××××××××××××××××××××××××××××××/

 

原英文文檔:http://www.elasticsearch.org/guide/en/elasticsearch/client/java-api/index.html (各個版本的api)

這里有一個簡單的使用search的官方文檔：http://www.elastic.co/guide/en/elasticsearch/client/java-api/current/search.html#java-search-template

這是另外一個作者有關es api的翻譯：http://blog.csdn.net/woshiyexinjie/article/details/41088705

Search部分:

查詢有兩種方法:query Java API和filter Java API

首先看一個例子:

import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.action.search.SearchType;
import org.elasticsearch.index.query.FilterBuilders.*;
import org.elasticsearch.index.query.QueryBuilders.*;

SearchResponse response = client.prepareSearch("index1", "index2")
         //設置要查詢的索引(index)
        .setTypes("type1", "type2")
         //設置type, 這個在建立索引的時候同時設置了, 或者可以使用head工具查看
        .setSearchType(SearchType.DFS_QUERY_THEN_FETCH)
        .setQuery(QueryBuilders.termQuery("multi", "test"))             
        // Query 查詢之一. 對於QueryBuilders接下來會解釋. 在這里"multi"是要查詢的field,"test"是要查詢的內容
        .setFilter(FilterBuilders.rangeFilter("age").from(12).to(18))   
        // Filter 查詢之二, FilterBuilders接下來會解釋. 在這里"age"是要查詢的field, 后面的數字是查詢的條件范圍
        .setFrom(0).setSize(60).setExplain(true)
        //0-60 表示顯示數量
        .execute()
        .actionGet();

提示:以上所有參數都是可選的. 

最小的查詢如下所示:

// MatchAll on the whole cluster with all default options
SearchResponse response = client.prepareSearch().execute().actionGet();

 

1.query Java API

為了使用QueryBuilders必須先import下面的類:

import org.elasticsearch.index.query.QueryBuilders.*;

第一種:Match Query (鏈接內有詳細解釋)

QueryBuilder qb = QueryBuilders.matchQuery("name", "kimchy elasticsearch");
//name是field,kimchy elasticsearch是要查詢的字符串

第二種:MultiMatch Query (鏈接內有詳細解釋)

QueryBuilder qb = QueryBuilders.multiMatchQuery(
    "kimchy elasticsearch",     // Text you are looking for
     //kimchy elasticsearch是要查詢的字符串
    "user", "message"           // Fields you query on
     //user 和 message都是field
    );

第三種: Boolean Query (鏈接內有詳細解釋)

QueryBuilder qb = QueryBuilders
                    .boolQuery()
                    .must(termQuery("content", "test1"))
                    .must(termQuery("content", "test4"))
                    .mustNot(termQuery("content", "test2"))
                    .should(termQuery("content", "test3"));
//content為field,test為查詢內容.
//其中must表示必須滿足,mustNot表示必須不滿足,should表示可有可無

如果bool查詢語句中不存在must,則必須至少有一個should查詢,同時可以通過minimum_should_match參數來設置至少需要滿足的should個數.

Boosting Query

略...

IDs Query

QueryBuilders.idsQuery().ids("1", "2");
//通過id來查詢

Custom Score Query

略...

Custom Boost Factor Query

略...

Constant Score Query

略...

Disjunction Max Query

略...

Field Query

QueryBuilders.fieldQuery("name", "+kimchy -dadoonet");

// Note that you can write the same query using queryString query.
QueryBuilders.queryString("+kimchy -dadoonet").field("name");
//+表示必須有的 -表示一定沒有的 name表示查詢的filed

Fuzzy Like This Query * Fuzzy Like This Field Query

略....不懂.....

Fuzzy Query

QueryBuilder qb = QueryBuilders.fuzzyQuery("name", "kimzhy");
//根據提供的字符串作為前綴進行查詢

Has Child Query * Has Parent

略....不懂.....

Match All Query

QueryBuilder qb = QueryBuilders.matchAllQuery();
//顯示所有的記錄

* More Like This Query * More Like This Field Query

略...不懂......

Prefix Query

QueryBuilders.prefixQuery("brand", "heine");
//brand是field, heine是前綴查詢字符串

QueryString Query

QueryBuilder qb = QueryBuilders.queryString("+kimchy -elasticsearch");

略....不懂.....

Range Query

QueryBuilder qb = QueryBuilders
                    .rangeQuery("price")
                    .from(5)
                    .to(10)
                    .includeLower(true)
                    .includeUpper(false);
//price是field, 數字代表范圍.除了from to還有lt gt等等...

* Span First Query * Span Near Query * Span Not Query * Span Or Query * Span Term Quer// Span First

 

QueryBuilders.spanFirstQuery(
                QueryBuilders.spanTermQuery("user", "kimchy"),  // Query
                3                                               // Max End position
        );
//只匹配在Field開頭出現的, 數字表示從開頭起的幾個單詞內查詢, 則此查詢意思是:user中的開頭3個單詞內,kimchy是否能查詢到


// Span Near
QueryBuilders.spanNearQuery()
    .clause(QueryBuilders.spanTermQuery("field","value1"))  // Span Term Queries
    .clause(QueryBuilders.spanTermQuery("field","value2"))
    .clause(QueryBuilders.spanTermQuery("field","value3"))
    .slop(12)                                               // Slop factor
    .inOrder(false)
    .collectPayloads(false);
//匹配距離相近的, inOrder表示:true表示按照value1/2/3的順序來計算距離(兩個單詞中間夾一個單詞 距離為1). 舉例: a b c d.  {a,b,c}中a,c的距離為1.
//則此查詢的意思是:在field中,如果value1/2/3的距離是在12以內的,那么可以查詢到.反之不能.


// Span Not
QueryBuilders.spanNotQuery()
    .include(QueryBuilders.spanTermQuery("field","value1"))
    .exclude(QueryBuilders.spanTermQuery("field","value2"));
//匹配不重疊的,即除那些兩個SpanQuery相互重疊的結果
//例如有兩個Document：”the quick brown fox jump over a lazy dog”和”the quick red fox jumps over the sleepy cat”
//SpanNearQuery quick_fox =new SpanNearQuery(new SpanQuery[]{quick, fox}, 1, true);  //基礎的SpanQuery，默認匹配2個Document
//匹配的這兩個結果的中間重疊部分為：red/brown
//SpanNotQuery quick_fox_dog = new SpanNotQuery(quick_fox, dog);//因為dog不是red或者brown，所以仍為兩個
//SpanNotQuery no_quick_red_fox =      new SpanNotQuery(quick_fox, red);   //現在只剩下brown那個doc了
//這種Query經常用於連接的時候。

// Span Or
QueryBuilders.spanOrQuery()
    .clause(QueryBuilders.spanTermQuery("field","value1"))
    .clause(QueryBuilders.spanTermQuery("field","value2"))
    .clause(QueryBuilders.spanTermQuery("field","value3"));
//SpanQuery的合集


// Span Term
QueryBuilders.spanTermQuery("user","kimchy");


//該部分詳見:http://www.coder4.com/archives/774

 

Term Query

略...

Terms Query

略...

Top Children Query

略...

Wildcard Query

略...

Nested Query

略...

Custom Filters Score Query

略...

Indices Query

略...

GeoShape Query

略...

2.filter Java API

 

 

 

附上一個自己寫的小型Test, 簡單易懂.

import java.io.IOException;

import org.elasticsearch.action.index.IndexResponse;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.action.search.SearchType;
import org.elasticsearch.client.Client;
import org.elasticsearch.client.transport.TransportClient;
import org.elasticsearch.common.transport.InetSocketTransportAddress;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentFactory;
import org.elasticsearch.index.query.FilterBuilders;
import org.elasticsearch.index.query.QueryBuilder;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.SearchHits;

import user.User;


public class First_ES_Test {

    private Client client;
    
    public void init()
    {
        //ip可以在http://localhost:9200/_plugin/head/中自行查詢
        client = new TransportClient().addTransportAddress(new InetSocketTransportAddress("192.168.1.103", 9300));
    }
    
    public void close()
    {
        client.close();
    }
    
    /*
     * create index
     **/
    public void createIndex() {
        for (int i = 0; i < 1000; i++) {
            User user = new User();
            user.setId(new Long(i));
            user.setName("xxx0624 " + i);
            user.setAge(i % 100);
            System.out.println("ok:"+i);
            client.prepareIndex("users", "user").setSource(generateJson(user))
                    .execute().actionGet();
        }
    }
 
    /*
     * 轉換成json對象
     *
     * @param user
     * @return json(String)
     **/
    private String generateJson(User user) {
        String json = "";
        try {
            XContentBuilder contentBuilder = XContentFactory.jsonBuilder()
                    .startObject();
            contentBuilder.field("id", user.getId() + "");
            contentBuilder.field("name", user.getName());
            contentBuilder.field("age", user.getAge() + "");
            json = contentBuilder.endObject().string();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return json;
    }
    
    public void search() {
        QueryBuilder qb = QueryBuilders
                .boolQuery()
                .must(QueryBuilders.termQuery("age", "0"))
                .should(QueryBuilders.termQuery("id", "0"))
                //.mustNot(QueryBuilders.termQuery("content", "test2"))
                //.should(QueryBuilders.termQuery("content", "test3"))
                ;
        
        SearchResponse response = client.prepareSearch("users")
                .setTypes("user")
                .setSearchType(SearchType.DFS_QUERY_THEN_FETCH)
                .setQuery(qb) // Query
                //.setFilter(FilterBuilders.rangeFilter("age").from(0).to(100)) // Filter
                .setFrom(0).setSize(100).setExplain(true)
                .execute().actionGet();
        SearchHits hits = response.getHits();
        System.out.println(hits.getTotalHits());
        for (int i = 0; i < hits.getHits().length; i++) {
            System.out.println(hits.getHits()[i].getSourceAsString());
        }
    }    
 
    public static void main(String[] args) {
        
        First_ES_Test client = new First_ES_Test();
        client.init();
        client.createIndex();
        client.search();
        client.close();

    }
    
    public void print(String output)
    {
        System.out.print(output);
    }
    public void println(String output)
    {
        System.out.println(output);
    }

}

 

待續...