// 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/http" "net/url" "strings" "github.com/olivere/elastic/v7/uritemplates" ) // IndexService adds or updates a typed JSON document in a specified index, // making it searchable. // // See https://www.elastic.co/guide/en/elasticsearch/reference/7.0/docs-index_.html // for details. type IndexService struct { client *Client pretty *bool // pretty format the returned JSON response human *bool // return human readable values for statistics errorTrace *bool // include the stack trace of returned errors filterPath []string // list of filters used to reduce the response headers http.Header // custom request-level HTTP headers id string index string typ string parent string routing string timeout string timestamp string ttl string version interface{} opType string versionType string refresh string waitForActiveShards string pipeline string ifSeqNo *int64 ifPrimaryTerm *int64 bodyJson interface{} bodyString string } // NewIndexService creates a new IndexService. func NewIndexService(client *Client) *IndexService { return &IndexService{ client: client, typ: "_doc", } } // Pretty tells Elasticsearch whether to return a formatted JSON response. func (s *IndexService) Pretty(pretty bool) *IndexService { s.pretty = &pretty return s } // Human specifies whether human readable values should be returned in // the JSON response, e.g. "7.5mb". func (s *IndexService) Human(human bool) *IndexService { s.human = &human return s } // ErrorTrace specifies whether to include the stack trace of returned errors. func (s *IndexService) ErrorTrace(errorTrace bool) *IndexService { s.errorTrace = &errorTrace return s } // FilterPath specifies a list of filters used to reduce the response. func (s *IndexService) FilterPath(filterPath ...string) *IndexService { s.filterPath = filterPath return s } // Header adds a header to the request. func (s *IndexService) Header(name string, value string) *IndexService { if s.headers == nil { s.headers = http.Header{} } s.headers.Add(name, value) return s } // Headers specifies the headers of the request. func (s *IndexService) Headers(headers http.Header) *IndexService { s.headers = headers return s } // Id is the document ID. func (s *IndexService) Id(id string) *IndexService { s.id = id return s } // Index is the name of the index. func (s *IndexService) Index(index string) *IndexService { s.index = index return s } // Type is the type of the document. // // Deprecated: Types are in the process of being removed. func (s *IndexService) Type(typ string) *IndexService { s.typ = typ return s } // WaitForActiveShards sets the number of shard copies that must be active // before proceeding with the index 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 (s *IndexService) WaitForActiveShards(waitForActiveShards string) *IndexService { s.waitForActiveShards = waitForActiveShards return s } // Pipeline specifies the pipeline id to preprocess incoming documents with. func (s *IndexService) Pipeline(pipeline string) *IndexService { s.pipeline = pipeline return s } // Refresh the index after performing the operation. // // See https://www.elastic.co/guide/en/elasticsearch/reference/7.0/docs-refresh.html // for details. func (s *IndexService) Refresh(refresh string) *IndexService { s.refresh = refresh return s } // Ttl is an expiration time for the document. func (s *IndexService) Ttl(ttl string) *IndexService { s.ttl = ttl return s } // TTL is an expiration time for the document (alias for Ttl). func (s *IndexService) TTL(ttl string) *IndexService { s.ttl = ttl return s } // Version is an explicit version number for concurrency control. func (s *IndexService) Version(version interface{}) *IndexService { s.version = version return s } // OpType is an explicit operation type, i.e. "create" or "index" (default). func (s *IndexService) OpType(opType string) *IndexService { s.opType = opType return s } // Parent is the ID of the parent document. func (s *IndexService) Parent(parent string) *IndexService { s.parent = parent return s } // Routing is a specific routing value. func (s *IndexService) Routing(routing string) *IndexService { s.routing = routing return s } // Timeout is an explicit operation timeout. func (s *IndexService) Timeout(timeout string) *IndexService { s.timeout = timeout return s } // Timestamp is an explicit timestamp for the document. func (s *IndexService) Timestamp(timestamp string) *IndexService { s.timestamp = timestamp return s } // VersionType is a specific version type. func (s *IndexService) VersionType(versionType string) *IndexService { s.versionType = versionType return s } // IfSeqNo indicates to only perform the index operation if the last // operation that has changed the document has the specified sequence number. func (s *IndexService) IfSeqNo(seqNo int64) *IndexService { s.ifSeqNo = &seqNo return s } // IfPrimaryTerm indicates to only perform the index operation if the // last operation that has changed the document has the specified primary term. func (s *IndexService) IfPrimaryTerm(primaryTerm int64) *IndexService { s.ifPrimaryTerm = &primaryTerm return s } // BodyJson is the document as a serializable JSON interface. func (s *IndexService) BodyJson(body interface{}) *IndexService { s.bodyJson = body return s } // BodyString is the document encoded as a string. func (s *IndexService) BodyString(body string) *IndexService { s.bodyString = body return s } // buildURL builds the URL for the operation. func (s *IndexService) buildURL() (string, string, url.Values, error) { var err error var method, path string if s.id != "" { // Create document with manual id method = "PUT" path, err = uritemplates.Expand("/{index}/{type}/{id}", map[string]string{ "id": s.id, "index": s.index, "type": s.typ, }) } else { // Automatic ID generation // See https://www.elastic.co/guide/en/elasticsearch/reference/7.0/docs-index_.html#index-creation method = "POST" path, err = uritemplates.Expand("/{index}/{type}/", map[string]string{ "index": s.index, "type": s.typ, }) } if err != nil { return "", "", url.Values{}, err } // Add query string parameters params := url.Values{} if v := s.pretty; v != nil { params.Set("pretty", fmt.Sprint(*v)) } if v := s.human; v != nil { params.Set("human", fmt.Sprint(*v)) } if v := s.errorTrace; v != nil { params.Set("error_trace", fmt.Sprint(*v)) } if len(s.filterPath) > 0 { params.Set("filter_path", strings.Join(s.filterPath, ",")) } if s.waitForActiveShards != "" { params.Set("wait_for_active_shards", s.waitForActiveShards) } if s.refresh != "" { params.Set("refresh", s.refresh) } if s.opType != "" { params.Set("op_type", s.opType) } if s.parent != "" { params.Set("parent", s.parent) } if s.pipeline != "" { params.Set("pipeline", s.pipeline) } if s.routing != "" { params.Set("routing", s.routing) } if s.timeout != "" { params.Set("timeout", s.timeout) } if s.timestamp != "" { params.Set("timestamp", s.timestamp) } if s.ttl != "" { params.Set("ttl", s.ttl) } if s.version != nil { params.Set("version", fmt.Sprintf("%v", s.version)) } if s.versionType != "" { params.Set("version_type", s.versionType) } if v := s.ifSeqNo; v != nil { params.Set("if_seq_no", fmt.Sprintf("%d", *v)) } if v := s.ifPrimaryTerm; v != nil { params.Set("if_primary_term", fmt.Sprintf("%d", *v)) } return method, path, params, nil } // Validate checks if the operation is valid. func (s *IndexService) Validate() error { var invalid []string if s.index == "" { invalid = append(invalid, "Index") } if s.typ == "" { invalid = append(invalid, "Type") } if s.bodyString == "" && s.bodyJson == nil { invalid = append(invalid, "BodyJson") } if len(invalid) > 0 { return fmt.Errorf("missing required fields: %v", invalid) } return nil } // Do executes the operation. func (s *IndexService) Do(ctx context.Context) (*IndexResponse, error) { // Check pre-conditions if err := s.Validate(); err != nil { return nil, err } // Get URL for request method, path, params, err := s.buildURL() if err != nil { return nil, err } // Setup HTTP request body var body interface{} if s.bodyJson != nil { body = s.bodyJson } else { body = s.bodyString } // Get HTTP response res, err := s.client.PerformRequest(ctx, PerformRequestOptions{ Method: method, Path: path, Params: params, Body: body, Headers: s.headers, }) if err != nil { return nil, err } // Return operation response ret := new(IndexResponse) if err := s.client.decoder.Decode(res.Body, ret); err != nil { return nil, err } return ret, nil } // IndexResponse is the result of indexing a document in Elasticsearch. type IndexResponse 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"` }