tsclient

package module

Go to main page

Versions in this module

v0

v0.2.0

Jun 23, 2022

Changes in this version

type CreateFieldData

+ Infix bool

type Field

+ Infix bool

type SearchData

+ Infix []string

+ Prefix []bool

v0.1.0

Aug 9, 2021

Changes in this version

+ const ErrAlreadyExists

+ const ErrBadRequest

+ const ErrNotFound

+ const ErrNotSlice

+ const ErrUnauthorized

+ const ErrUnavailable

+ const ErrUnprocessable

+ const VERSION

+ func WithBody(r io.Reader) func(*http.Request) error

+ func WithHeader(header http.Header) func(*http.Request) error

+ func WithJSONBody(v interface{}) func(*http.Request) error

+ func WithURLValues(values url.Values) func(*http.Request) error

+ type Client struct

+ Client *http.Client

+ Debug func(tmpl string, args ...interface{})

+ UserAgent string

+ func New(url, apiKey string) (*Client, error)

+ func (c *Client) Collection(name string) (col Collection, err error)

+ func (c *Client) Collections() (cols []Collection, err error)

+ func (c *Client) CreateCollection(name, defaultSortingField string, fields []CreateFieldData) (col Collection, err error)

+ func (c *Client) DeleteCollection(name string) (col Collection, err error)

+ func (c *Client) DeleteDocument(collection, id string, out interface{}) error

+ func (c *Client) DeleteQuery(collection, filter string, batchSize int) (deleted int, err error)

+ func (c *Client) Document(collection, id string, out interface{}) (string, error)

+ func (c *Client) Health() (ok bool, err error)

+ func (c *Client) Import(collection, action string, s interface{}) (ok []bool, err error)

+ func (c *Client) ImportSlice(collection, action string, s []interface{}) (ok []bool, err error)

+ func (c *Client) Insert(collection string, doc interface{}, out interface{}) (err error)

+ func (c *Client) Request(method, endpoint string, opts ...RequestOption) (response []byte, err error)

+ func (c *Client) Search(collection string, data SearchData) (res SearchResult, err error)

+ func (c *Client) UpdateDocument(collection, id string, doc, out interface{}) error

+ func (c *Client) Upsert(collection string, doc interface{}, out interface{}) (err error)

+ type Collection struct

+ DefaultSortingField string

+ Fields []Field

+ Name string

+ NumDocuments int

+ type CreateFieldData struct

+ Facet bool

+ Name string

+ NoIndex bool

+ Type string

+ type Field struct

+ Facet bool

+ Index bool

+ Name string

+ Type string

+ type Highlight struct

+ Field string

+ Indices []int

+ MatchedTokens jsonutil.Raw

+ Snippet string

+ Snippets []string

+ type RequestOption func(*http.Request) error

+ type SearchData struct

+ DisableOverrides bool

+ DropTokensThreshold *int

+ ExcludeFields []string

+ FacetBy []string

+ FacetQuery string

+ FilterBy string

+ GroupBy []string

+ GroupLimit int

+ HiddenHits []string

+ HighlightAffixNumTokens int

+ HighlightEndTag *string

+ HighlightFields []string

+ HighlightFullFields []string

+ HighlightStartTag *string

+ IncludeFields []string

+ LimitHits int

+ MaxFacetValues int

+ NoPreSegmentedQuery bool

+ NoPrefix bool

+ NoPrioritizeExactMatch bool

+ NumTypos int

+ Page int

+ PerPage int

+ PinnedHits []string

+ Query string

+ QueryBy []string

+ QueryByWeights []int

+ SnippetThreshold int

+ SortBy []string

+ TypoTokensThreshold *int

+ type SearchHit struct

+ Document jsonutil.Raw

+ Highlights []Highlight

+ TextMatch int

+ func (s SearchHit) Map() (map[string]interface{}, error)

+ func (s SearchHit) UnmarshalTo(v interface{}) error

+ type SearchResult struct

+ FacetCounts []int

+ Found int

+ Hits []SearchHit

+ OutOf int

+ Page int

+ SearchTime int

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