Implement index creation

Author: l0nax

client.go

@@ -0,0 +1,35 @@
+package zinc
+
+import (
+	"encoding/json"
+
+	"github.com/go-resty/resty/v2"
+	// "github.com/goccy/go-json"
+)
+
+// Client is a ZincSearch client.
+type Client struct {
+	c *resty.Client
+}
+
+// NewClient returns a fully initialized client.
+func NewClient(opts ...clientOpt) *Client {
+	c := &Client{}
+
+	c.c = resty.New().
+		SetHeader("Accept", "application/json")
+
+	c.c.JSONMarshal = json.Marshal
+	c.c.JSONUnmarshal = json.Unmarshal
+
+	for _, opt := range opts {
+		opt(c)
+	}
+
+	return c
+}
+
+// IndexService returns a new IndexService object.
+func (c *Client) IndexService() *IndexService {
+	return NewIndexService(c)
+}

error.go

@@ -0,0 +1,3 @@
+package zinc
+
+// TODO: Add errors

example/create_index/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/fabmation-gmbh/zinc-go"
+	"github.com/fabmation-gmbh/zinc-go/pkg/meta"
+)
+
+func main() {
+	const user = "admin"
+	const passwd = "admin"
+
+	cli := zinc.NewClient(
+		zinc.SetZincServer("http://localhost:4080"),
+		zinc.SetBasicAuth(user, passwd),
+	)
+
+	idx := cli.IndexService().
+		Name("test_index").
+		IndexStorageType(meta.IndexStorageDisk).
+		AddMappingProperty(meta.NewIndexMappingProperty("@timestamp", meta.IdxPropertyDate)).
+		AddMappingProperty(meta.NewIndexMappingProperty("text", meta.IdxPropertyText))
+
+	resp, err := idx.Create(context.Background())
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	fmt.Printf("==> %+v\n", resp)
+}

go.mod

@@ -0,0 +1,7 @@
+module github.com/fabmation-gmbh/zinc-go
+
+go 1.18
+
+require github.com/go-resty/resty/v2 v2.7.0
+
+require golang.org/x/net v0.0.0-20211029224645-99673261e6eb // indirect

go.sum

@@ -0,0 +1,9 @@
+github.com/go-resty/resty/v2 v2.7.0 h1:me+K9p3uhSmXtrBZ4k9jcEAfJmuC8IivWHwaLZwPrFY=
+github.com/go-resty/resty/v2 v2.7.0/go.mod h1:9PWDzw47qPphMRFfhsyk0NnSgvluHcljSMVIq3w7q0I=
+golang.org/x/net v0.0.0-20211029224645-99673261e6eb h1:pirldcYWx7rx7kE5r+9WsOXPXK0+WH5+uZ7uPmJ44uM=
+golang.org/x/net v0.0.0-20211029224645-99673261e6eb/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

index.go

@@ -0,0 +1,84 @@
+package zinc
+
+import (
+	"context"
+
+	"github.com/fabmation-gmbh/zinc-go/pkg/meta"
+)
+
+// IndexService provides methods to manage indicies.
+type IndexService struct {
+	cli *Client
+
+	// name is the index name.
+	name        string
+	storageType meta.IndexStorageType
+	props       map[string]meta.IndexMappingProperty
+}
+
+// NewIndexService returns a fully initialized IndexService.
+func NewIndexService(cli *Client) *IndexService {
+	return &IndexService{
+		cli:   cli,
+		props: make(map[string]meta.IndexMappingProperty),
+	}
+}
+
+// Name sets the name of the index.
+//
+// The IndexService object is returned to allow stacking method calls.
+func (i *IndexService) Name(name string) *IndexService {
+	i.name = name
+
+	return i
+}
+
+// IndexStorageType sets the storage type of the index.
+//
+// The IndexService object is returned to allow stacking method calls.
+func (i *IndexService) IndexStorageType(storage meta.IndexStorageType) *IndexService {
+	i.storageType = storage
+
+	return i
+}
+
+// AddMappingProperty adds the given index property to the index.
+//
+// The IndexService object is returned to allow stacking method calls.
+func (i *IndexService) AddMappingProperty(prop meta.IndexMappingProperty) *IndexService {
+	i.props[prop.Name] = prop
+
+	return i
+}
+
+// Create creates the index.
+func (i *IndexService) Create(ctx context.Context) (IndexCreateResponse, error) {
+	type props struct {
+		Props map[string]meta.IndexMappingProperty `json:"properties"`
+	}
+	type idxCreateReq struct {
+		Name        string `json:"name"`
+		StorageType string `json:"storage_type"`
+		Mappings    props  `json:"mappings,omitempty"`
+	}
+
+	data := idxCreateReq{
+		Name:        i.name,
+		StorageType: i.storageType.String(),
+		Mappings: props{
+			Props: i.props,
+		},
+	}
+
+	var resp IndexCreateResponse
+
+	_, err := i.cli.c.R().
+		SetResult(&resp).
+		SetBody(data).
+		Post("/index")
+	if err != nil {
+		return IndexCreateResponse{}, err
+	}
+
+	return resp, nil
+}

opts.go

@@ -0,0 +1,18 @@
+package zinc
+
+// clientOpt is a Client option function.
+type clientOpt func(*Client)
+
+// SetZincServer sets the Zinc server URL.
+func SetZincServer(url string) clientOpt {
+	return clientOpt(func(c *Client) {
+		c.c.SetHostURL(url + "/api")
+	})
+}
+
+// SetBasicAuth configures the client to authenticate with Basic Auth.
+func SetBasicAuth(username, password string) clientOpt {
+	return clientOpt(func(c *Client) {
+		c.c.SetBasicAuth(username, password)
+	})
+}

pkg/meta/analyzer.go

@@ -0,0 +1,22 @@
+package meta
+
+// Analyzer is a single text analyzer or token generator.
+type Analyzer int16
+
+//go:generate enumer -type=Analyzer -json -trimprefix=Analyzer -transform=lower
+
+// TODO: Support remaining analyzer and filter.
+
+const (
+	// AnalyzerUnset indicates that no analyzer is set.
+	AnalyzerUnset Analyzer = iota
+	// AnalyzerStandard is the standard analyzer.
+	AnalyzerStandard
+	// AnalyzerSimple is the simple analyzer.
+	AnalyzerSimple
+	AnalyzerKeyword
+	AnalyzerWeb
+	AnalyzerRegexp
+	AnalyzerStop
+	AnalyzerWhitespace
+)