algoliautil

README

Algolia Util

CLI and SDK utilities for Algolia.

Documentation

Index

• Constants
• func NewClient(c Credentials) (*search.Client, error)
• func NewClientJSON(jsonData []byte) (*search.Client, error)
• type Credentials
  • func NewCredentials(jsonData []byte) (Credentials, error)
  • func (c *Credentials) TrimSpace()
• type GostorClient
  • func NewGostorClient(client *search.Client, indexName string) GostorClient
  • func (c GostorClient) GetString(key string) (string, error)
  • func (c GostorClient) MustGetString(key string) string
  • func (c GostorClient) SetString(key, val string) error

Constants

const EnvVarAppCredentialsJSON = "ALGOLIA_APP_CREDENTIALS_JSON" // #nosec G101

Functions

func NewClient

func NewClient(c Credentials) (*search.Client, error)

func NewClientJSON

func NewClientJSON(jsonData []byte) (*search.Client, error)

Types

type Credentials

type Credentials struct {
	ApplicationID    string `json:"applicationId"`
	SearchOnlyAPIKey string `json:"searchOnlyApiKey"`
	AdminAPIKey      string `json:"adminApiKey"`
	AnalyticsAPIKey  string `json:"analyticsApiKey"`
	MonitoringAPIKey string `json:"monitoringApiKey"`
}

func NewCredentials

func NewCredentials(jsonData []byte) (Credentials, error)

func (*Credentials) TrimSpace

func (c *Credentials) TrimSpace()

type GostorClient

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

GostorClient is a client that satisfies the grokify/gostor.Client interface.

func NewGostorClient

func NewGostorClient(client *search.Client, indexName string) GostorClient

func (GostorClient) GetString

func (c GostorClient) GetString(key string) (string, error)

func (GostorClient) MustGetString

func (c GostorClient) MustGetString(key string) string

func (GostorClient) SetString

func (c GostorClient) SetString(key, val string) error