Add support for Count requests (#8)
This commit adds initial support for Count requests, which are simple search requests asking to get the number of matches for a query. The functionality is provided by the Count() function, which accepts a query object (implementing the Mappable interface), and can be executed just like a search request. res, err := esquery. Count(esquery.Match("user", "someone")). Run(es)
This commit is contained in:
parent
8e5dea816b
commit
7fa767fc28
|
@ -0,0 +1,62 @@
|
||||||
|
package esquery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
|
||||||
|
"github.com/elastic/go-elasticsearch/v7"
|
||||||
|
"github.com/elastic/go-elasticsearch/v7/esapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CountRequest represents a request to get the number of matches for a search
|
||||||
|
// query, as described in:
|
||||||
|
// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
|
||||||
|
type CountRequest struct {
|
||||||
|
query Mappable
|
||||||
|
}
|
||||||
|
|
||||||
|
// Count creates a new count request with the provided query.
|
||||||
|
func Count(q Mappable) *CountRequest {
|
||||||
|
return &CountRequest{
|
||||||
|
query: q,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Map returns a map representation of the request, thus implementing the
|
||||||
|
// Mappable interface.
|
||||||
|
func (req *CountRequest) Map() map[string]interface{} {
|
||||||
|
return map[string]interface{}{
|
||||||
|
"query": req.query.Map(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the request using the provided ElasticCount client. Zero or
|
||||||
|
// more search options can be provided as well. It returns the standard Response
|
||||||
|
// type of the official Go client.
|
||||||
|
func (req *CountRequest) Run(
|
||||||
|
api *elasticsearch.Client,
|
||||||
|
o ...func(*esapi.CountRequest),
|
||||||
|
) (res *esapi.Response, err error) {
|
||||||
|
return req.RunCount(api.Count, o...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunCount is the same as the Run method, except that it accepts a value of
|
||||||
|
// type esapi.Count (usually this is the Count field of an elasticsearch.Client
|
||||||
|
// object). Since the ElasticCount client does not provide an interface type
|
||||||
|
// for its API (which would allow implementation of mock clients), this provides
|
||||||
|
// a workaround. The Count function in the ES client is actually a field of a
|
||||||
|
// function type.
|
||||||
|
func (req *CountRequest) RunCount(
|
||||||
|
count esapi.Count,
|
||||||
|
o ...func(*esapi.CountRequest),
|
||||||
|
) (res *esapi.Response, err error) {
|
||||||
|
var b bytes.Buffer
|
||||||
|
err = json.NewEncoder(&b).Encode(req.Map())
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
opts := append([]func(*esapi.CountRequest){count.WithBody(&b)}, o...)
|
||||||
|
|
||||||
|
return count(opts...)
|
||||||
|
}
|
|
@ -0,0 +1,17 @@
|
||||||
|
package esquery
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestCount(t *testing.T) {
|
||||||
|
runMapTests(t, []mapTest{
|
||||||
|
{
|
||||||
|
"a simple count request",
|
||||||
|
Count(MatchAll()),
|
||||||
|
map[string]interface{}{
|
||||||
|
"query": map[string]interface{}{
|
||||||
|
"match_all": map[string]interface{}{},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
Loading…
Reference in New Issue