summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/olivere/elastic/update.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/olivere/elastic/update.go')
-rw-r--r--vendor/github.com/olivere/elastic/update.go327
1 files changed, 327 insertions, 0 deletions
diff --git a/vendor/github.com/olivere/elastic/update.go b/vendor/github.com/olivere/elastic/update.go
new file mode 100644
index 000000000..5507fae4c
--- /dev/null
+++ b/vendor/github.com/olivere/elastic/update.go
@@ -0,0 +1,327 @@
+// 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"
+
+ "github.com/olivere/elastic/uritemplates"
+)
+
+// UpdateService updates a document in Elasticsearch.
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-update.html
+// for details.
+type UpdateService struct {
+ client *Client
+ index string
+ typ string
+ id string
+ routing string
+ parent string
+ script *Script
+ fields []string
+ fsc *FetchSourceContext
+ version *int64
+ versionType string
+ retryOnConflict *int
+ refresh string
+ waitForActiveShards string
+ upsert interface{}
+ scriptedUpsert *bool
+ docAsUpsert *bool
+ detectNoop *bool
+ doc interface{}
+ timeout string
+ pretty bool
+}
+
+// NewUpdateService creates the service to update documents in Elasticsearch.
+func NewUpdateService(client *Client) *UpdateService {
+ builder := &UpdateService{
+ client: client,
+ fields: make([]string, 0),
+ }
+ return builder
+}
+
+// Index is the name of the Elasticsearch index (required).
+func (b *UpdateService) Index(name string) *UpdateService {
+ b.index = name
+ return b
+}
+
+// Type is the type of the document (required).
+func (b *UpdateService) Type(typ string) *UpdateService {
+ b.typ = typ
+ return b
+}
+
+// Id is the identifier of the document to update (required).
+func (b *UpdateService) Id(id string) *UpdateService {
+ b.id = id
+ return b
+}
+
+// Routing specifies a specific routing value.
+func (b *UpdateService) Routing(routing string) *UpdateService {
+ b.routing = routing
+ return b
+}
+
+// Parent sets the id of the parent document.
+func (b *UpdateService) Parent(parent string) *UpdateService {
+ b.parent = parent
+ return b
+}
+
+// Script is the script definition.
+func (b *UpdateService) Script(script *Script) *UpdateService {
+ b.script = script
+ return b
+}
+
+// RetryOnConflict specifies how many times the operation should be retried
+// when a conflict occurs (default: 0).
+func (b *UpdateService) RetryOnConflict(retryOnConflict int) *UpdateService {
+ b.retryOnConflict = &retryOnConflict
+ return b
+}
+
+// Fields is a list of fields to return in the response.
+func (b *UpdateService) Fields(fields ...string) *UpdateService {
+ b.fields = make([]string, 0, len(fields))
+ b.fields = append(b.fields, fields...)
+ return b
+}
+
+// Version defines the explicit version number for concurrency control.
+func (b *UpdateService) Version(version int64) *UpdateService {
+ b.version = &version
+ return b
+}
+
+// VersionType is e.g. "internal".
+func (b *UpdateService) VersionType(versionType string) *UpdateService {
+ b.versionType = versionType
+ return b
+}
+
+// Refresh the index after performing the update.
+func (b *UpdateService) Refresh(refresh string) *UpdateService {
+ b.refresh = refresh
+ return b
+}
+
+// WaitForActiveShards sets the number of shard copies that must be active before
+// proceeding with the update operation. Defaults to 1, meaning the primary shard only.
+// Set to `all` for all shard copies, otherwise set to any non-negative value less than
+// or equal to the total number of copies for the shard (number of replicas + 1).
+func (b *UpdateService) WaitForActiveShards(waitForActiveShards string) *UpdateService {
+ b.waitForActiveShards = waitForActiveShards
+ return b
+}
+
+// Doc allows for updating a partial document.
+func (b *UpdateService) Doc(doc interface{}) *UpdateService {
+ b.doc = doc
+ return b
+}
+
+// Upsert can be used to index the document when it doesn't exist yet.
+// Use this e.g. to initialize a document with a default value.
+func (b *UpdateService) Upsert(doc interface{}) *UpdateService {
+ b.upsert = doc
+ return b
+}
+
+// DocAsUpsert can be used to insert the document if it doesn't already exist.
+func (b *UpdateService) DocAsUpsert(docAsUpsert bool) *UpdateService {
+ b.docAsUpsert = &docAsUpsert
+ return b
+}
+
+// DetectNoop will instruct Elasticsearch to check if changes will occur
+// when updating via Doc. It there aren't any changes, the request will
+// turn into a no-op.
+func (b *UpdateService) DetectNoop(detectNoop bool) *UpdateService {
+ b.detectNoop = &detectNoop
+ return b
+}
+
+// ScriptedUpsert should be set to true if the referenced script
+// (defined in Script or ScriptId) should be called to perform an insert.
+// The default is false.
+func (b *UpdateService) ScriptedUpsert(scriptedUpsert bool) *UpdateService {
+ b.scriptedUpsert = &scriptedUpsert
+ return b
+}
+
+// Timeout is an explicit timeout for the operation, e.g. "1000", "1s" or "500ms".
+func (b *UpdateService) Timeout(timeout string) *UpdateService {
+ b.timeout = timeout
+ return b
+}
+
+// Pretty instructs to return human readable, prettified JSON.
+func (b *UpdateService) Pretty(pretty bool) *UpdateService {
+ b.pretty = pretty
+ return b
+}
+
+// FetchSource asks Elasticsearch to return the updated _source in the response.
+func (s *UpdateService) FetchSource(fetchSource bool) *UpdateService {
+ if s.fsc == nil {
+ s.fsc = NewFetchSourceContext(fetchSource)
+ } else {
+ s.fsc.SetFetchSource(fetchSource)
+ }
+ return s
+}
+
+// FetchSourceContext indicates that _source should be returned in the response,
+// allowing wildcard patterns to be defined via FetchSourceContext.
+func (s *UpdateService) FetchSourceContext(fetchSourceContext *FetchSourceContext) *UpdateService {
+ s.fsc = fetchSourceContext
+ return s
+}
+
+// url returns the URL part of the document request.
+func (b *UpdateService) url() (string, url.Values, error) {
+ // Build url
+ path := "/{index}/{type}/{id}/_update"
+ path, err := uritemplates.Expand(path, map[string]string{
+ "index": b.index,
+ "type": b.typ,
+ "id": b.id,
+ })
+ if err != nil {
+ return "", url.Values{}, err
+ }
+
+ // Parameters
+ params := make(url.Values)
+ if b.pretty {
+ params.Set("pretty", "true")
+ }
+ if b.routing != "" {
+ params.Set("routing", b.routing)
+ }
+ if b.parent != "" {
+ params.Set("parent", b.parent)
+ }
+ if b.timeout != "" {
+ params.Set("timeout", b.timeout)
+ }
+ if b.refresh != "" {
+ params.Set("refresh", b.refresh)
+ }
+ if b.waitForActiveShards != "" {
+ params.Set("wait_for_active_shards", b.waitForActiveShards)
+ }
+ if len(b.fields) > 0 {
+ params.Set("fields", strings.Join(b.fields, ","))
+ }
+ if b.version != nil {
+ params.Set("version", fmt.Sprintf("%d", *b.version))
+ }
+ if b.versionType != "" {
+ params.Set("version_type", b.versionType)
+ }
+ if b.retryOnConflict != nil {
+ params.Set("retry_on_conflict", fmt.Sprintf("%v", *b.retryOnConflict))
+ }
+
+ return path, params, nil
+}
+
+// body returns the body part of the document request.
+func (b *UpdateService) body() (interface{}, error) {
+ source := make(map[string]interface{})
+
+ if b.script != nil {
+ src, err := b.script.Source()
+ if err != nil {
+ return nil, err
+ }
+ source["script"] = src
+ }
+
+ if b.scriptedUpsert != nil {
+ source["scripted_upsert"] = *b.scriptedUpsert
+ }
+
+ if b.upsert != nil {
+ source["upsert"] = b.upsert
+ }
+
+ if b.doc != nil {
+ source["doc"] = b.doc
+ }
+ if b.docAsUpsert != nil {
+ source["doc_as_upsert"] = *b.docAsUpsert
+ }
+ if b.detectNoop != nil {
+ source["detect_noop"] = *b.detectNoop
+ }
+ if b.fsc != nil {
+ src, err := b.fsc.Source()
+ if err != nil {
+ return nil, err
+ }
+ source["_source"] = src
+ }
+
+ return source, nil
+}
+
+// Do executes the update operation.
+func (b *UpdateService) Do(ctx context.Context) (*UpdateResponse, error) {
+ path, params, err := b.url()
+ if err != nil {
+ return nil, err
+ }
+
+ // Get body of the request
+ body, err := b.body()
+ if err != nil {
+ return nil, err
+ }
+
+ // Get response
+ res, err := b.client.PerformRequest(ctx, PerformRequestOptions{
+ Method: "POST",
+ Path: path,
+ Params: params,
+ Body: body,
+ })
+ if err != nil {
+ return nil, err
+ }
+
+ // Return result
+ ret := new(UpdateResponse)
+ if err := b.client.decoder.Decode(res.Body, ret); err != nil {
+ return nil, err
+ }
+ return ret, nil
+}
+
+// UpdateResponse is the result of updating a document in Elasticsearch.
+type UpdateResponse struct {
+ Index string `json:"_index,omitempty"`
+ Type string `json:"_type,omitempty"`
+ Id string `json:"_id,omitempty"`
+ Version int64 `json:"_version,omitempty"`
+ Result string `json:"result,omitempty"`
+ Shards *shardsInfo `json:"_shards,omitempty"`
+ SeqNo int64 `json:"_seq_no,omitempty"`
+ PrimaryTerm int64 `json:"_primary_term,omitempty"`
+ Status int `json:"status,omitempty"`
+ ForcedRefresh bool `json:"forced_refresh,omitempty"`
+ GetResult *GetResult `json:"get,omitempty"`
+}
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-05-20 18:51:40 +0000