summaryrefslogtreecommitdiffstats
path: root/vendor/gopkg.in/olivere/elastic.v5/mget.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gopkg.in/olivere/elastic.v5/mget.go')
-rw-r--r--vendor/gopkg.in/olivere/elastic.v5/mget.go252
1 files changed, 252 insertions, 0 deletions
diff --git a/vendor/gopkg.in/olivere/elastic.v5/mget.go b/vendor/gopkg.in/olivere/elastic.v5/mget.go
new file mode 100644
index 000000000..0f2894854
--- /dev/null
+++ b/vendor/gopkg.in/olivere/elastic.v5/mget.go
@@ -0,0 +1,252 @@
+// Copyright 2012-present Oliver Eilhard. All rights reserved.
+// Use of this source code is governed by a MIT-license.
+// See http://olivere.mit-license.org/license.txt for details.
+
+package elastic
+
+import (
+ "context"
+ "fmt"
+ "net/url"
+ "strings"
+)
+
+// MgetService allows to get multiple documents based on an index,
+// type (optional) and id (possibly routing). The response includes
+// a docs array with all the fetched documents, each element similar
+// in structure to a document provided by the Get API.
+//
+// See https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-multi-get.html
+// for details.
+type MgetService struct {
+ client *Client
+ pretty bool
+ preference string
+ realtime *bool
+ refresh string
+ routing string
+ storedFields []string
+ items []*MultiGetItem
+}
+
+// NewMgetService initializes a new Multi GET API request call.
+func NewMgetService(client *Client) *MgetService {
+ builder := &MgetService{
+ client: client,
+ }
+ return builder
+}
+
+// Preference specifies the node or shard the operation should be performed
+// on (default: random).
+func (s *MgetService) Preference(preference string) *MgetService {
+ s.preference = preference
+ return s
+}
+
+// Refresh the shard containing the document before performing the operation.
+func (s *MgetService) Refresh(refresh string) *MgetService {
+ s.refresh = refresh
+ return s
+}
+
+// Realtime specifies whether to perform the operation in realtime or search mode.
+func (s *MgetService) Realtime(realtime bool) *MgetService {
+ s.realtime = &realtime
+ return s
+}
+
+// Routing is the specific routing value.
+func (s *MgetService) Routing(routing string) *MgetService {
+ s.routing = routing
+ return s
+}
+
+// StoredFields is a list of fields to return in the response.
+func (s *MgetService) StoredFields(storedFields ...string) *MgetService {
+ s.storedFields = append(s.storedFields, storedFields...)
+ return s
+}
+
+// Pretty indicates that the JSON response be indented and human readable.
+func (s *MgetService) Pretty(pretty bool) *MgetService {
+ s.pretty = pretty
+ return s
+}
+
+// Add an item to the request.
+func (s *MgetService) Add(items ...*MultiGetItem) *MgetService {
+ s.items = append(s.items, items...)
+ return s
+}
+
+// Source returns the request body, which will be serialized into JSON.
+func (s *MgetService) Source() (interface{}, error) {
+ source := make(map[string]interface{})
+ items := make([]interface{}, len(s.items))
+ for i, item := range s.items {
+ src, err := item.Source()
+ if err != nil {
+ return nil, err
+ }
+ items[i] = src
+ }
+ source["docs"] = items
+ return source, nil
+}
+
+// Do executes the request.
+func (s *MgetService) Do(ctx context.Context) (*MgetResponse, error) {
+ // Build url
+ path := "/_mget"
+
+ params := make(url.Values)
+ if s.realtime != nil {
+ params.Add("realtime", fmt.Sprintf("%v", *s.realtime))
+ }
+ if s.preference != "" {
+ params.Add("preference", s.preference)
+ }
+ if s.refresh != "" {
+ params.Add("refresh", s.refresh)
+ }
+ if s.routing != "" {
+ params.Set("routing", s.routing)
+ }
+ if len(s.storedFields) > 0 {
+ params.Set("stored_fields", strings.Join(s.storedFields, ","))
+ }
+
+ // Set body
+ body, err := s.Source()
+ if err != nil {
+ return nil, err
+ }
+
+ // Get response
+ res, err := s.client.PerformRequest(ctx, "GET", path, params, body)
+ if err != nil {
+ return nil, err
+ }
+
+ // Return result
+ ret := new(MgetResponse)
+ if err := s.client.decoder.Decode(res.Body, ret); err != nil {
+ return nil, err
+ }
+ return ret, nil
+}
+
+// -- Multi Get Item --
+
+// MultiGetItem is a single document to retrieve via the MgetService.
+type MultiGetItem struct {
+ index string
+ typ string
+ id string
+ routing string
+ storedFields []string
+ version *int64 // see org.elasticsearch.common.lucene.uid.Versions
+ versionType string // see org.elasticsearch.index.VersionType
+ fsc *FetchSourceContext
+}
+
+// NewMultiGetItem initializes a new, single item for a Multi GET request.
+func NewMultiGetItem() *MultiGetItem {
+ return &MultiGetItem{}
+}
+
+// Index specifies the index name.
+func (item *MultiGetItem) Index(index string) *MultiGetItem {
+ item.index = index
+ return item
+}
+
+// Type specifies the type name.
+func (item *MultiGetItem) Type(typ string) *MultiGetItem {
+ item.typ = typ
+ return item
+}
+
+// Id specifies the identifier of the document.
+func (item *MultiGetItem) Id(id string) *MultiGetItem {
+ item.id = id
+ return item
+}
+
+// Routing is the specific routing value.
+func (item *MultiGetItem) Routing(routing string) *MultiGetItem {
+ item.routing = routing
+ return item
+}
+
+// StoredFields is a list of fields to return in the response.
+func (item *MultiGetItem) StoredFields(storedFields ...string) *MultiGetItem {
+ item.storedFields = append(item.storedFields, storedFields...)
+ return item
+}
+
+// Version can be MatchAny (-3), MatchAnyPre120 (0), NotFound (-1),
+// or NotSet (-2). These are specified in org.elasticsearch.common.lucene.uid.Versions.
+// The default in Elasticsearch is MatchAny (-3).
+func (item *MultiGetItem) Version(version int64) *MultiGetItem {
+ item.version = &version
+ return item
+}
+
+// VersionType can be "internal", "external", "external_gt", "external_gte",
+// or "force". See org.elasticsearch.index.VersionType in Elasticsearch source.
+// It is "internal" by default.
+func (item *MultiGetItem) VersionType(versionType string) *MultiGetItem {
+ item.versionType = versionType
+ return item
+}
+
+// FetchSource allows to specify source filtering.
+func (item *MultiGetItem) FetchSource(fetchSourceContext *FetchSourceContext) *MultiGetItem {
+ item.fsc = fetchSourceContext
+ return item
+}
+
+// Source returns the serialized JSON to be sent to Elasticsearch as
+// part of a MultiGet search.
+func (item *MultiGetItem) Source() (interface{}, error) {
+ source := make(map[string]interface{})
+
+ source["_id"] = item.id
+
+ if item.index != "" {
+ source["_index"] = item.index
+ }
+ if item.typ != "" {
+ source["_type"] = item.typ
+ }
+ if item.fsc != nil {
+ src, err := item.fsc.Source()
+ if err != nil {
+ return nil, err
+ }
+ source["_source"] = src
+ }
+ if item.routing != "" {
+ source["_routing"] = item.routing
+ }
+ if len(item.storedFields) > 0 {
+ source["stored_fields"] = strings.Join(item.storedFields, ",")
+ }
+ if item.version != nil {
+ source["version"] = fmt.Sprintf("%d", *item.version)
+ }
+ if item.versionType != "" {
+ source["version_type"] = item.versionType
+ }
+
+ return source, nil
+}
+
+// -- Result of a Multi Get request.
+
+// MgetResponse is the outcome of a Multi GET API request.
+type MgetResponse struct {
+ Docs []*GetResult `json:"docs,omitempty"`
+}