es

package

v0.10.3 Latest Latest Go to latest Published: Feb 28, 2020 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/CSCfi/qvain-api

Links

Open Source Insights

Documentation ¶

Overview ¶

Package es contains a minimal API client to query Elastic Search and export complete indexes.

As of now, it can only return all results for a given index.

Index ¶

Constants
func Filter(json []byte) []byte
func FilterAndCount(json []byte) ([]byte, int64)
type ESClient
- func NewClient(url string) *ESClient
- func (es *ESClient) All(index, doctype string) ([]byte, error)

Constants ¶

View Source

const (
	HttpClientTimeout = time.Duration(5 * time.Second)
	HttpUserAgent     = "qvain"
	HttpQueryString   = "_search?size=10000"
)

Configuration for http client

View Source

const (
	FilterSourcesPath = "hits.hits.#._source"
	FilterCountPath   = "hits.hits.#"
)

Configuration for json path getter

Variables ¶

This section is empty.

Functions ¶

func Filter ¶

func Filter(json []byte) []byte

Filter returns the contents of the Json _sources key from the Elastic Search response, effectively filtering out some ES noise.

func FilterAndCount ¶

func FilterAndCount(json []byte) ([]byte, int64)

FilterAndCount returns the contents of the _sources key just like Filter(), but also returns a count of the number of elements to facilitate sanity checks. It is twice as slow as Filter().

Types ¶

type ESClient ¶

type ESClient struct {
	// contains filtered or unexported fields
}

ESClient describes the parameters needed to query an Elastic Search instance.

func NewClient ¶

func NewClient(url string) *ESClient

NewClient creates a new client for Elastic Search. It takes a url parameter pointing to the root of the ES API endpoint.

func (*ESClient) All ¶

func (es *ESClient) All(index, doctype string) ([]byte, error)

AllForIndex does a _search query without search parameters for the specified index, returning all results.

Source Files ¶

View all Source files

es.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL