Meilisearch | Meilisearch Cloud | Documentation | Discord | Roadmap | Website | FAQ
⚡ The Meilisearch API client written in Dart
Meilisearch Dart is the Meilisearch API client for Dart and Flutter developers.
Meilisearch is an open-source search engine. Learn more about Meilisearch.
- 📖 Documentation
- ⚡ Supercharge your Meilisearch experience
- 🔧 Installation
- 🚀 Getting started
- Advanced Configuration
- 🤖 Compatibility with Meilisearch
- 💡 Learn more
- ⚙️ Contributing
This readme contains all the documentation you need to start using this Meilisearch SDK.
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our main documentation website.
Say goodbye to server deployment and manual updates with Meilisearch Cloud. Get started with a 14-day free trial! No credit card required.
You can install the meilisearch package by adding a few lines into pubspec.yaml
file.
dependencies:
meilisearch: ^0.16.0
Then open your terminal and update dart packages.
pub get
There are many easy ways to download and run a Meilisearch instance.
For example, using the curl
command in your Terminal:
#Install Meilisearch
curl -L https://install.meilisearch.com | sh
# Launch Meilisearch
./meilisearch --master-key=masterKey
NB: you can also download Meilisearch from Homebrew or APT or even run it using Docker.
import 'package:meilisearch/meilisearch.dart';
void main() async {
var client = MeiliSearchClient('http://127.0.0.1:7700', 'masterKey');
// An index is where the documents are stored.
var index = client.index('movies');
const documents = [
{ 'id': 1, 'title': 'Carol', 'genres': ['Romance', 'Drama'] },
{ 'id': 2, 'title': 'Wonder Woman', 'genres': ['Action', 'Adventure'] },
{ 'id': 3, 'title': 'Life of Pi', 'genres': ['Adventure', 'Drama'] },
{ 'id': 4, 'title': 'Mad Max: Fury Road', 'genres': ['Adventure', 'Science Fiction'] },
{ 'id': 5, 'title': 'Moana', 'genres': ['Fantasy', 'Action']},
{ 'id': 6, 'title': 'Philadelphia', 'genres': ['Drama'] },
]
// If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
var task = await index.addDocuments(documents); // => { "uid": 0 }
}
With the uid
, you can check the status (enqueued
, canceled
, processing
, succeeded
or failed
) of your documents addition using the task.
// Meilisearch is typo-tolerant:
var result = await index.search('carlo');
print(result.hits);
JSON Output:
[
{
"id": 1,
"title": "Carol",
"genres": ["Romance", "Drama"]
}
]
All the supported options are described in the search parameters section of the documentation.
var result = await index.search(
'carol',
attributesToHighlight: ['title'],
);
JSON output:
{
"hits": [
{
"id": 1,
"title": "Carol",
"_formatted": {
"id": 1,
"title": "<em>Carol</em>"
}
}
],
"offset": 0,
"limit": 20,
"processingTimeMs": 0,
"query": "carol"
}
If you want to enable filtering, you must add your attributes to the filterableAttributes
index setting.
await index.updateFilterableAttributes(['id', 'genres']);
You only need to perform this operation once.
Note that MeiliSearch will rebuild your index whenever you update filterableAttributes
.
Depending on the size of your dataset, this might take time. You can track the process using the task status.
Then, you can perform the search:
await index.search('wonder', filter: ['id > 1 AND genres = Action']);
{
"hits": [
{
"id": 2,
"title":