Skip to content

Commit

Permalink
Add new component template APIs
Browse files Browse the repository at this point in the history
This commit implements the new Component Template APIs which come with the new
Index Template APIs as described in
https://www.elastic.co/guide/en/elasticsearch/reference/7.9/index-templates.html.

Close #1414

Signed-off-by: Yann Soubeyrand <yann.soubeyrand@camptocamp.com>
  • Loading branch information
yann-soubeyrand committed Feb 4, 2021
1 parent 21064b9 commit e3d81ff
Show file tree
Hide file tree
Showing 5 changed files with 702 additions and 1 deletion.
26 changes: 25 additions & 1 deletion client.go
Expand Up @@ -1816,7 +1816,31 @@ func (c *Client) IndexDeleteIndexTemplate(name string) *IndicesDeleteIndexTempla
return NewIndicesDeleteIndexTemplateService(c).Name(name)
}

// -- TODO Component templates --
// -- Component templates --

// IndexPutComponentTemplate creates or updates a component template (available since 7.8).
//
// This service implements the component templates as described
// on https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-component-template.html.
func (c *Client) IndexPutComponentTemplate(name string) *IndicesPutComponentTemplateService {
return NewIndicesPutComponentTemplateService(c).Name(name)
}

// IndexGetComponentTemplate returns a component template (available since 7.8).
//
// This service implements the component templates as described
// on https://www.elastic.co/guide/en/elasticsearch/reference/7.10/getting-component-templates.html.
func (c *Client) IndexGetComponentTemplate(name string) *IndicesGetComponentTemplateService {
return NewIndicesGetComponentTemplateService(c).Name(name)
}

// IndexDeleteComponentTemplate deletes a component template (available since 7.8).
//
// This service implements the component templates as described
// on https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-delete-component-template.html.
func (c *Client) IndexDeleteComponentTemplate(name string) *IndicesDeleteComponentTemplateService {
return NewIndicesDeleteComponentTemplateService(c).Name(name)
}

// GetMapping gets a mapping.
func (c *Client) GetMapping() *IndicesGetMappingService {
Expand Down
67 changes: 67 additions & 0 deletions indices_component_templates_test.go
@@ -0,0 +1,67 @@
// 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"
"testing"
)

func TestComponentTemplatesLifecycle(t *testing.T) {
client := setupTestClientAndCreateIndex(t)

const templateName = "template_1"

// Always make sure the component template is deleted
defer func() {
_, _ = client.IndexDeleteComponentTemplate(templateName).Pretty(true).Do(context.Background())
}()

// Create an component template
{
resp, err := client.IndexPutComponentTemplate(templateName).Pretty(true).BodyString(`{
"template": {
"settings": {
"number_of_shards": 2,
"number_of_replicas": 0
},
"mappings": {
"_source": { "enabled": true }
}
}
}`).Do(context.Background())
if err != nil {
t.Fatalf("expected to successfully create component template, got %v", err)
}
if resp == nil {
t.Fatal("expected response on creating component template")
}
if want, have := true, resp.Acknowledged; want != have {
t.Errorf("expected Acknowledged=%v, got %v", want, have)
}
}

// Get the component template
{
resp, err := client.IndexGetComponentTemplate(templateName).Pretty(true).Do(context.Background())
if err != nil {
t.Fatalf("expected to successfully get component template, got %v", err)
}
if resp == nil {
t.Fatal("expected response on getting component template")
}
}

// Delete the component template
{
resp, err := client.IndexDeleteComponentTemplate(templateName).Pretty(true).Do(context.Background())
if err != nil {
t.Fatalf("expected to successfully delete component template, got %v", err)
}
if resp == nil {
t.Fatal("expected response on deleting component template")
}
}
}
182 changes: 182 additions & 0 deletions indices_delete_component_template.go
@@ -0,0 +1,182 @@
// 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"
)

// IndicesDeleteComponentTemplateService deletes component templates.
//
// See https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-delete-component-template.html
// for more details.
type IndicesDeleteComponentTemplateService 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
}

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

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

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

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

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

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

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

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

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

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

// buildURL builds the URL for the operation.
func (s *IndicesDeleteComponentTemplateService) buildURL() (string, url.Values, error) {
// Build URL
path, err := uritemplates.Expand("/_component_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 *IndicesDeleteComponentTemplateService) 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 *IndicesDeleteComponentTemplateService) Do(ctx context.Context) (*IndicesDeleteComponentTemplateResponse, 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(IndicesDeleteComponentTemplateResponse)
if err := s.client.decoder.Decode(res.Body, ret); err != nil {
return nil, err
}
return ret, nil
}

// IndicesDeleteComponentTemplateResponse is the response of IndicesDeleteComponentTemplateService.Do.
type IndicesDeleteComponentTemplateResponse struct {
Acknowledged bool `json:"acknowledged"`
ShardsAcknowledged bool `json:"shards_acknowledged"`
Index string `json:"index,omitempty"`
}

0 comments on commit e3d81ff

Please sign in to comment.