api

package

v0.0.0-...-56f2276 Latest Latest Go to latest Published: May 14, 2020 License: Apache-2.0 Imports: 10 Imported by: 3

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/zenoss/elastigo

Documentation ¶

Index ¶

Constants
Variables
func DoCommand(method string, url string, data interface{}) ([]byte, error)
func Pretty(pretty bool) string
func Scan(scan int) string
func Scroll(duration string) string
type BaseResponse
- func Exists(pretty bool, index string, _type string, id string) (BaseResponse, error)
type ESError
- func (e ESError) Error() string
type Explaination
type ExtendedStatus
type Facets
type Filter
type Match
type Query
type Request
- func ElasticSearchRequest(method, path string) (*Request, error)
- func (r *Request) Do(v interface{}) (int, []byte, error)
- func (r *Request) DoResponse(v interface{}) (*http.Response, []byte, error)
- func (r *Request) SetBody(body io.Reader)
- func (r *Request) SetBodyJson(data interface{}) error
- func (r *Request) SetBodyString(body string)
type SearchRequest
type Status
type Term
type Terms

Constants ¶

View Source

const (
	Version         = "0.0.2"
	DefaultProtocol = "http"
	DefaultDomain   = "localhost"
	DefaultPort     = "9200"
)

Variables ¶

View Source

var (
	Protocol       string    = DefaultProtocol
	Domain         string    = DefaultDomain
	ClusterDomains [1]string = [1]string{DefaultDomain}
	Port           string    = DefaultPort
	HttpClient               = &http.Client{}
)

Functions ¶

func DoCommand ¶

func DoCommand(method string, url string, data interface{}) ([]byte, error)

func Pretty ¶

func Pretty(pretty bool) string

func Scan ¶

func Scan(scan int) string

func Scroll ¶

func Scroll(duration string) string

Types ¶

type BaseResponse ¶

type BaseResponse struct {
	Ok      bool        `json:"ok"`
	Index   string      `json:"_index,omitempty"`
	Type    string      `json:"_type,omitempty"`
	Id      string      `json:"_id,omitempty"`
	Source  interface{} `json:"_source,omitempty"` // depends on the schema you've defined
	Version int         `json:"_version,omitempty"`
	Found   bool        `json:"found,omitempty"`
	Exists  bool        `json:"exists,omitempty"`
}

func Exists ¶

func Exists(pretty bool, index string, _type string, id string) (BaseResponse, error)

Exists allows the caller to check for the existance of a document using HEAD This appears to be broken in the current version of elasticsearch 0.19.10, currently returning nothing

type ESError ¶

type ESError struct {
	When time.Time
	What string
	Code int
}

ESError is an error implementation that includes a time, message, and code.

func (ESError) Error ¶

func (e ESError) Error() string

type Explaination ¶

type Explaination struct {
	Value       float32        `json:"value"`
	Description string         `json:"description"`
	Details     []Explaination `json:"details,omitempty"`
}

type ExtendedStatus ¶

type ExtendedStatus struct {
	Ok           bool   `json:"ok"`
	ShardsStatus Status `json:"_shards"`
}

type Facets struct {
	Tag Terms `json:"tag"`
}

type Filter ¶

type Filter struct {
	Term Term `json:"term"`
}

type Match ¶

type Match struct {
	OK           bool         `json:"ok"`
	Matches      []string     `json:"matches"`
	Explaination Explaination `json:"explaination,omitempty"`
}

type Query ¶

type Query struct {
	Query Term `json:"query"`
}

type Request ¶

type Request http.Request

func ElasticSearchRequest ¶

func ElasticSearchRequest(method, path string) (*Request, error)

func (*Request) Do ¶

func (r *Request) Do(v interface{}) (int, []byte, error)

func (*Request) DoResponse ¶

func (r *Request) DoResponse(v interface{}) (*http.Response, []byte, error)

func (*Request) SetBody ¶

func (r *Request) SetBody(body io.Reader)

func (*Request) SetBodyJson ¶

func (r *Request) SetBodyJson(data interface{}) error

func (*Request) SetBodyString ¶

func (r *Request) SetBodyString(body string)

type SearchRequest ¶

type SearchRequest struct {
	From   int    `json:"from,omitempty"`
	Size   int    `json:"size,omitempty"`
	Query  Query  `json:"query,omitempty"`
	Filter Filter `json:"filter,omitempty"`
}

type Status ¶

type Status struct {
	Total      int `json:"total"`
	Successful int `json:"successful"`
	Failed     int `json:"failed"`
}

type Term ¶

type Term struct {
	Term string `json:"term"`
}

type Terms ¶

type Terms struct {
	Terms string `json:"terms"`
}

Source Files ¶

View all Source files

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