MimirInstance class abstract

Represents an instance (essentially a group of indices) of mimir.

You will often only need one instance, but you can make more if you so choose.

mimir is based on Milli (the engine of Meilisearch). While we could embed all of Meilisearch in Flutter, it would hardly make sense; you can just use ffi to access the engine, Milli, directly. With this approach, its easier on constrained resources (no http server) and more simple (no management of the server needed).

Constructors

MimirInstance()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

path → String

The file-system path for the directory of this instance

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getIndex(String name) → MimirIndex

Gets the index with the given name (also acts as its id). One will be created for you if an index with the same name does not yet exist.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openIndex(String name, {String? primaryKey, List<String>? searchableFields, List<String> filterableFields, List<String> sortableFields, List<String> rankingRules, List<String> stopWords, List<Synonyms> synonyms, bool typosEnabled, int minWordSizeForOneTypo, int minWordSizeForTwoTypos, List<String> disallowTyposOnWords, List<String> disallowTyposOnFields}) → Future<MimirIndex>

Eagerly opens an index with the supplied name and settings. If you know the primary key (or any of the other settings) in advance, it is recommended to use openIndex over getIndex. See also getIndex for restrictions on what name can be.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited