Skip to content

Commit

Permalink
Add new index template APIs (olivere#1415)
Browse files Browse the repository at this point in the history
This commit implements the new Index Template APIs as described in
https://www.elastic.co/guide/en/elasticsearch/reference/7.9/index-templates.html.

They replace the legacy/v1 APIs and were implemented in 7.8.

In general, use `client.IndexXXXIndexTemplate(...)` instead of
`client.IndexXXXTemplate(...)` (with `XXX` being `Get`, `Put`, or
`Delete`) to use the newer versions.

Notice that this commit only implements the new Index Template APIs, not
the Component Template APIs.

Close olivere#1393
  • Loading branch information
olivere committed Nov 6, 2020
1 parent 5e27e42 commit 1e4b412
Show file tree
Hide file tree
Showing 9 changed files with 792 additions and 17 deletions.
68 changes: 60 additions & 8 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -1742,30 +1742,82 @@ func (c *Client) Aliases() *AliasesService {
return NewAliasesService(c)
}

// IndexGetTemplate gets an index template.
// Use XXXTemplate funcs to manage search templates.
// -- Legacy templates --

// IndexGetTemplate gets an index template (v1/legacy version before 7.8).
//
// This service implements the legacy version of index templates as described
// in https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates-v1.html.
//
// See e.g. IndexPutIndexTemplate and IndexPutComponentTemplate for the new version(s).
func (c *Client) IndexGetTemplate(names ...string) *IndicesGetTemplateService {
return NewIndicesGetTemplateService(c).Name(names...)
}

// IndexTemplateExists gets check if an index template exists.
// Use XXXTemplate funcs to manage search templates.
// IndexTemplateExists gets check if an index template exists (v1/legacy version before 7.8).
//
// This service implements the legacy version of index templates as described
// in https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates-v1.html.
//
// See e.g. IndexPutIndexTemplate and IndexPutComponentTemplate for the new version(s).
func (c *Client) IndexTemplateExists(name string) *IndicesExistsTemplateService {
return NewIndicesExistsTemplateService(c).Name(name)
}

// IndexPutTemplate creates or updates an index template.
// Use XXXTemplate funcs to manage search templates.
// IndexPutTemplate creates or updates an index template (v1/legacy version before 7.8).
//
// This service implements the legacy version of index templates as described
// in https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates-v1.html.
//
// See e.g. IndexPutIndexTemplate and IndexPutComponentTemplate for the new version(s).
func (c *Client) IndexPutTemplate(name string) *IndicesPutTemplateService {
return NewIndicesPutTemplateService(c).Name(name)
}

// IndexDeleteTemplate deletes an index template.
// Use XXXTemplate funcs to manage search templates.
// IndexDeleteTemplate deletes an index template (v1/legacy version before 7.8).
//
// This service implements the legacy version of index templates as described
// in https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-templates-v1.html.
//
// See e.g. IndexPutIndexTemplate and IndexPutComponentTemplate for the new version(s).
func (c *Client) IndexDeleteTemplate(name string) *IndicesDeleteTemplateService {
return NewIndicesDeleteTemplateService(c).Name(name)
}

// -- Index templates --

// IndexPutIndexTemplate creates or updates an index template (new version after 7.8).
//
// This service implements the new version of index templates as described
// on https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-put-template.html.
//
// See e.g. IndexPutTemplate for the v1/legacy version.
func (c *Client) IndexPutIndexTemplate(name string) *IndicesPutIndexTemplateService {
return NewIndicesPutIndexTemplateService(c).Name(name)
}

// IndexGetIndexTemplate returns an index template (new version after 7.8).
//
// This service implements the new version of index templates as described
// on https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-get-template.html.
//
// See e.g. IndexPutTemplate for the v1/legacy version.
func (c *Client) IndexGetIndexTemplate(name string) *IndicesGetIndexTemplateService {
return NewIndicesGetIndexTemplateService(c).Name(name)
}

// IndexDeleteIndexTemplate deletes an index template (new version after 7.8).
//
// This service implements the new version of index templates as described
// on https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-delete-template.html.
//
// See e.g. IndexPutTemplate for the v1/legacy version.
func (c *Client) IndexDeleteIndexTemplate(name string) *IndicesDeleteIndexTemplateService {
return NewIndicesDeleteIndexTemplateService(c).Name(name)
}

// -- TODO Component templates --

// GetMapping gets a mapping.
func (c *Client) GetMapping() *IndicesGetMappingService {
return NewIndicesGetMappingService(c)
Expand Down
186 changes: 186 additions & 0 deletions indices_delete_index_template.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
// 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"
)

// IndicesDeleteIndexTemplateService deletes index templates.
//
// Index templates have changed during in 7.8 update of Elasticsearch.
// This service implements the new version (7.8 or later). If you want
// the old version, please use the IndicesDeleteTemplateService.
//
// See https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-delete-template.html
// for more details.
type IndicesDeleteIndexTemplateService 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

name string
timeout string
masterTimeout string
}

// NewIndicesDeleteIndexTemplateService creates a new IndicesDeleteIndexTemplateService.
func NewIndicesDeleteIndexTemplateService(client *Client) *IndicesDeleteIndexTemplateService {
return &IndicesDeleteIndexTemplateService{
client: client,
}
}

// Pretty tells Elasticsearch whether to return a formatted JSON response.
func (s *IndicesDeleteIndexTemplateService) Pretty(pretty bool) *IndicesDeleteIndexTemplateService {
s.pretty = &pretty
return s
}

// Human specifies whether human readable values should be returned in
// the JSON response, e.g. "7.5mb".
func (s *IndicesDeleteIndexTemplateService) Human(human bool) *IndicesDeleteIndexTemplateService {
s.human = &human
return s
}

// ErrorTrace specifies whether to include the stack trace of returned errors.
func (s *IndicesDeleteIndexTemplateService) ErrorTrace(errorTrace bool) *IndicesDeleteIndexTemplateService {
s.errorTrace = &errorTrace
return s
}

// FilterPath specifies a list of filters used to reduce the response.
func (s *IndicesDeleteIndexTemplateService) FilterPath(filterPath ...string) *IndicesDeleteIndexTemplateService {
s.filterPath = filterPath
return s
}

// Header adds a header to the request.
func (s *IndicesDeleteIndexTemplateService) Header(name string, value string) *IndicesDeleteIndexTemplateService {
if s.headers == nil {
s.headers = http.Header{}
}
s.headers.Add(name, value)
return s
}

// Headers specifies the headers of the request.
func (s *IndicesDeleteIndexTemplateService) Headers(headers http.Header) *IndicesDeleteIndexTemplateService {
s.headers = headers
return s
}

// Name is the name of the template.
func (s *IndicesDeleteIndexTemplateService) Name(name string) *IndicesDeleteIndexTemplateService {
s.name = name
return s
}

// Timeout is an explicit operation timeout.
func (s *IndicesDeleteIndexTemplateService) Timeout(timeout string) *IndicesDeleteIndexTemplateService {
s.timeout = timeout
return s
}

// MasterTimeout specifies the timeout for connection to master.
func (s *IndicesDeleteIndexTemplateService) MasterTimeout(masterTimeout string) *IndicesDeleteIndexTemplateService {
s.masterTimeout = masterTimeout
return s
}

// buildURL builds the URL for the operation.
func (s *IndicesDeleteIndexTemplateService) buildURL() (string, url.Values, error) {
// Build URL
path, err := uritemplates.Expand("/_index_template/{name}", map[string]string{
"name": s.name,
})
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.timeout != "" {
params.Set("timeout", s.timeout)
}
if s.masterTimeout != "" {
params.Set("master_timeout", s.masterTimeout)
}
return path, params, nil
}

// Validate checks if the operation is valid.
func (s *IndicesDeleteIndexTemplateService) Validate() error {
var invalid []string
if s.name == "" {
invalid = append(invalid, "Name")
}
if len(invalid) > 0 {
return fmt.Errorf("missing required fields: %v", invalid)
}
return nil
}

// Do executes the operation.
func (s *IndicesDeleteIndexTemplateService) Do(ctx context.Context) (*IndicesDeleteIndexTemplateResponse, error) {
// Check pre-conditions
if err := s.Validate(); err != nil {
return nil, err
}

// Get URL for request
path, params, err := s.buildURL()
if err != nil {
return nil, err
}

// Get HTTP response
res, err := s.client.PerformRequest(ctx, PerformRequestOptions{
Method: "DELETE",
Path: path,
Params: params,
Headers: s.headers,
})
if err != nil {
return nil, err
}

// Return operation response
ret := new(IndicesDeleteIndexTemplateResponse)
if err := s.client.decoder.Decode(res.Body, ret); err != nil {
return nil, err
}
return ret, nil
}

// IndicesDeleteIndexTemplateResponse is the response of IndicesDeleteIndexTemplateService.Do.
type IndicesDeleteIndexTemplateResponse struct {
Acknowledged bool `json:"acknowledged"`
ShardsAcknowledged bool `json:"shards_acknowledged"`
Index string `json:"index,omitempty"`
}
10 changes: 8 additions & 2 deletions indices_delete_template.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,14 @@ import (
"github.com/olivere/elastic/v7/uritemplates"
)

// IndicesDeleteTemplateService deletes index templates.
// See https://www.elastic.co/guide/en/elasticsearch/reference/7.0/indices-templates.html.
// IndicesDeleteTemplateService deletes templates.
//
// Index templates have changed during in 7.8 update of Elasticsearch.
// This service implements the legacy version (7.7 or lower). If you want
// the new version, please use the IndicesDeleteIndexTemplateService.
//
// See https://www.elastic.co/guide/en/elasticsearch/reference/7.9/indices-delete-template-v1.html
// for more details.
type IndicesDeleteTemplateService struct {
client *Client

Expand Down
16 changes: 13 additions & 3 deletions indices_exists_template.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ type IndicesExistsTemplateService struct {
filterPath []string // list of filters used to reduce the response
headers http.Header // custom request-level HTTP headers

name string
local *bool
name string
local *bool
masterTimeout string
}

// NewIndicesExistsTemplateService creates a new IndicesExistsTemplateService.
Expand Down Expand Up @@ -90,6 +91,12 @@ func (s *IndicesExistsTemplateService) Local(local bool) *IndicesExistsTemplateS
return s
}

// MasterTimeout specifies the timeout for connection to master.
func (s *IndicesExistsTemplateService) MasterTimeout(masterTimeout string) *IndicesExistsTemplateService {
s.masterTimeout = masterTimeout
return s
}

// buildURL builds the URL for the operation.
func (s *IndicesExistsTemplateService) buildURL() (string, url.Values, error) {
// Build URL
Expand All @@ -115,7 +122,10 @@ func (s *IndicesExistsTemplateService) buildURL() (string, url.Values, error) {
params.Set("filter_path", strings.Join(s.filterPath, ","))
}
if s.local != nil {
params.Set("local", fmt.Sprintf("%v", *s.local))
params.Set("local", fmt.Sprint(*s.local))
}
if s.masterTimeout != "" {
params.Set("master_timeout", s.masterTimeout)
}
return path, params, nil
}
Expand Down
Loading

0 comments on commit 1e4b412

Please sign in to comment.