Orientação gerada a partir de informações públicas. Apenas para referência.
Flutter Mimir é um banco de dados NoSQL reativo projetado para aplicativos Flutter, oferecendo poderosas pesquisas de texto completo com tolerância a erros ortográficos e sintaxe declarativa de consultas. Permite sincronização em tempo real de dados e armazenamento local eficiente em múltiplas plataformas. Com sua API intuitiva e recursos integrados de busca, simplifica o gerenciamento de conjuntos de dados dinâmicos, mantendo desempenho e responsividade. Ideal para aplicações que exigem manipulação rápida, pesquisável e reativa de dados.
Casos de uso
Aplicativos de anotações em tempo real
Gerenciadores de tarefas pesquisáveis
Aplicativos móveis com conteúdo intenso
Aplicações com foco em offline
Sistemas de recomendação personalizados
Principais recursos
Busca de texto completo tolerante a erros ortográficos
Sintaxe de consulta declarativa
Atualizações de dados reativas
Suporte multiplataforma
Armazenamento persistente local
Indicado para
Desenvolvedores construindo aplicativos reativos
Aplicativos que precisam de funcionalidade de busca robusta
Projetos que exigem persistência de dados offline
Equipes procurando integração simples do NoSQL
Aplicativos Flutter com conteúdo dinâmico
Considerações
Pode ser necessário aprender novos padrões de consulta
Grandes conjuntos de dados podem afetar o desempenho
Documentação limitada em comparação com bancos de dados maduros
Não adequado para operações relacionais complexas
A configuração inicial pode precisar de ajustes de configuração
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
A batteries-included NoSQL database for Dart & Flutter based on an embedded
Meilisearch instance.
Features
🔎 Typo tolerant and relevant full-text search with no extra configuration needed
🔥 Blazingly fast search and reads (written in Rust)
🤝 Flutter friendly with a super easy-to-use API (see demo below!)
With Flutter, you can get started with as little as:
// Get an "index" to store our moviesfinal instance = awaitMimir.defaultInstance;
final index = instance.getIndex('movies');
// Add movies to our indexawait index.addDocuments(myMovies);
// Perform a search!final results = await index.search(query: 'jarrassic par'); // returns Jurassic Park!
A collection of commonly used APIs ready for copy-paste into your application.
Note: unless otherwise stated, all asynchronous methods exposed in Mimir are fallible
and synchronous methods are infallible.
The methods are fail-fast, so you should be aware of any issues early on during development.
Getting & Creating an Index
// With Flutter (flutter_mimir)final instance = awaitMimir.defaultInstance;
// Dart-only (just mimir)final instance = awaitMimir.getInstance(path: instanceDirectory);
// Get an index (creates one lazily if not already created)final index = instance.getIndex('movies');
// Or, specify some default settings and open the index eagerly// If you have some settings you want to specify in advance, use openIndex!final index = await instance.openIndex('movies', primaryKey: 'CustomIdField');
Configuring an Index
await index.updateSettings(
// The primary key (PK) is the "ID field" of documents added to mimir.// When null, it is automatically inferred for you, but sometimes you may// need to specify it manually. See the Important Caveats section for more.
primaryKey: null,
// Fields in documents that are included in full-text search.// Use null, the default, to search all fields
searchableFields: <String>[],
// Fields in documents that can be queried/filtered by.// You probably don't need to change this; it is automatically// updated for you.
filterableFields: <String>[],
// Fields in documents that can be sorted by in searches/queries.// You probably don't need to change this; it is automatically// updated for you.
sortableFields: <String>[],
// The ranking rules of this index, see:// https://docs.meilisearch.com/reference/api/settings.html#ranking-rules
rankingRules: <String>[],
// The stop words of this index, see:// https://docs.meilisearch.com/reference/api/settings.html#stop-words
stopWords: <String>[],
// A list of synonyms to link words with the same meaning together.// Note: in most cases, you probably want to add synonyms both ways, like below:
synonyms: <Synonyms>[
(
word: 'automobile',
synonyms: ['vehicle'],
),
(
word: 'vehicle',
synonyms: ['automobile'],
),
],
// Whether to enable typo tolerance in searches.
typosEnabled: true,
// The minimum size of a word that can have 1 typo.// See minWordSizeForTypos.oneTypo here:// https://docs.meilisearch.com/reference/api/settings.html#typo-tolerance-object
minWordSizeForOneTypo: 5,
// The minimum size of a word that can have 2 typos.// See minWordSizeForTypos.twoTypos here:// https://docs.meilisearch.com/reference/api/settings.html#typo-tolerance-object
minWordSizeForTwoTypos: 9,
// Words that disallow typos. See disableOnWords here:// https://docs.meilisearch.com/reference/api/settings.html#typo-tolerance-object
disallowTyposOnWords: <String>[],
// Fields that disallow typos. See disableOnAttributes here:// https://docs.meilisearch.com/reference/api/settings.html#typo-tolerance-object
disallowTyposOnFields: <String>[],
);
Manipulating Documents
// Adding documents (replaces any documents with the same id)await index.addDocument(document);
await index.addDocuments(documents);
// Replacing all documentsawait index.setDocuments(documents);
// Deleting documentsawait index.deleteDocument(id);
await index.deleteDocuments(ids);
await index.deleteAllDocuments();
// Getting documents (not querying--see next section!)final docOrNull = await index.getDocument(someId);
final allDocs = await index.getAllDocuments();
final allDocsStream = index.documents;
Searching/Querying
// Getting a stream of results (very useful in Flutter!)// Same arguments as index.search; see belowfinal documentsStream = index.searchStream(...);
// Performing a search/query (using movies here)!final movies = index.search(
// The string to use for full-text search. Can be user-supplied.// To do a regular database query without full-text search, leave this null.
query: 'some wordz with typoes to saerch for',
// The filter used to filter results in a full-text search or query.// See the next section; this is a very handy feature in mimir.// Set to null to not filter out any documents.
filter: Mimir.where('director', isEqualTo: 'Alfred Hitchcock'),
// The fields to sort by (in ascending or descending order).// Can be left as null to sort by relevance (to the query text)!
sortBy: [
// Sort by year, newest to oldestSortBy.desc('year'),
// In case 2+ documents share the same year, sort by increasing profit nextSortBy.asc('profit'),
],
// If you want to limit the number of results you get, use the resultsLimit.// Defaults to null, which means return all matches.
resultsLimit: null,
// Defaults to null, see https://docs.meilisearch.com/reference/api/search.html#matching-strategy
matchingStrategy: null,
);
Filtering Search/Query Results
Here are the methods you need to be aware of:
Mimir.or(subFilters) creates an "or" filter (like ||) of the sub-filters
Mimir.and(subFilters) creates an "and" filter (like &&) of the sub-filters
Mimir.not(subFilter) creates a "not" filter (like !someCondition) of the sub-filter
Mimir.where(condition) creates a single filter from a given condition.
The above can be composed together to create powerful, declarative queries!
Say our Dart boolean logic is (formatted to show intent):