config

Documentation

Index

• func AskExportConfig(opts *ExportOptions) error
• func AskImportConfig(opts *ImportOptions) error
• func GetConfigFileName(path string, indiceName string, appId string) string
• func ValidateExportConfigFlags(opts ExportOptions) error
• func ValidateImportConfigFlags(opts *ImportOptions) error
• type ExportOptions
• type ImportConfigJson
• type ImportOptions
• type Synonym

Functions

func AskExportConfig

func AskExportConfig(opts *ExportOptions) error

func AskImportConfig

func AskImportConfig(opts *ImportOptions) error

func GetConfigFileName

func GetConfigFileName(path string, indiceName string, appId string) string

Matching Algolia Dashboard file naming https://github.com/algolia/AlgoliaWeb/blob/develop/_client/src/routes/explorer/components/Explorer/IndexExportSettingsModal.tsx#L88

func ValidateExportConfigFlags

func ValidateExportConfigFlags(opts ExportOptions) error

func ValidateImportConfigFlags

func ValidateImportConfigFlags(opts *ImportOptions) error

Types

type ExportOptions

type ExportOptions struct {
	Config config.IConfig
	IO     *iostreams.IOStreams

	ExistingIndices []string
	Indice          string
	Scope           []string
	Directory       string

	SearchClient func() (*search.Client, error)
}

type ImportConfigJson

type ImportConfigJson struct {
	Settings *search.Settings `json:"settings,omitempty"`
	Rules    []search.Rule    `json:"rules,omitempty"`
	Synonyms []Synonym        `json:"synonyms,omitempty"`
}

type ImportOptions

type ImportOptions struct {
	Config config.IConfig
	IO     *iostreams.IOStreams

	SearchClient func() (*search.Client, error)

	ImportConfig ImportConfigJson

	Indice                string
	FilePath              string
	Scope                 []string
	ClearExistingSynonyms bool
	ClearExistingRules    bool

	ForwardSettingsToReplicas bool
	ForwardSynonymsToReplicas bool
	ForwardRulesToReplicas    bool

	DoConfirm bool
}

type Synonym

type Synonym struct {
	Type                                string
	ObjectID, Word, Input, Placeholder  string
	Corrections, Synonyms, Replacements []string
}