MeiliSearch

MeiliSearch Dart (WIP ⚠️)

MeiliSearch | Documentation | Slack | Roadmap | Website | FAQ

Pub Version GitHub Workflow Status License Bors enabled

⚡ The MeiliSearch API client written for Dart

MeiliSearch Dart is the MeiliSearch API client for Dart and Flutter developers.

MeiliSearch is an open-source search engine. Discover what MeiliSearch is!

Table of Contents <!-- omit in toc -->

📖 Documentation

See our Documentation or our API References.

🔧 Installation

You can install the meilisearch package by adding a few lines into pubspec.yaml file.

dependencies:
  meilisearch: ">=0.0.1 <2.0.0"

Then open your terminal and update dart packages.

$ pub get

Run MeiliSearch <!-- omit in toc -->

There are many easy ways to download and run a MeiliSearch instance.

For example, if you use Docker:

$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🚀 Getting Started

Add Documents <!-- omit in toc -->

import 'package:meilisearch/meilisearch.dart';

void main() async {
  var client = MeiliSearchClient('http://127.0.0.1:7700', 'masterKey');

  // An index where books are stored.
  var index = await client.createIndex('books');

  var documents = [
    { 'book_id': 123,  'title': 'Pride and Prejudice' },
    { 'book_id': 456,  'title': 'Le Petit Prince' },
    { 'book_id': 1,    'title': 'Alice In Wonderland' },
    { 'book_id': 1344, 'title': 'The Hobbit' },
    { 'book_id': 4,    'title': 'Harry Potter and the Half-Blood Prince' },
    { 'book_id': 42,   'title': 'The Hitchhiker\'s Guide to the Galaxy' }
  ];

  // Add documents into index we just created.
  var update = await index.addDocuments(documents); // => { "updateId": 0 }
}

With the updateId, you can check the status (enqueued, processed or failed) of your documents addition using the update endpoint.

Basic Search <!-- omit in toc -->

// MeiliSearch is typo-tolerant:
var result = await index.search('harry pottre');

print(result.hits);

JSON Output:

[
  {
    "book_id": 4,
    "title": "Harry Potter and the Half-Blood Prince"
  }
]

Custom Search <!-- omit in toc -->

All the supported options are described in the search parameters section of the documentation.

var result = await index.search(
  'prince',
  attributesToHighlight: ['title'],
  filters: 'book_id > 10',
);

JSON output:

{
    "hits": [
        {
            "book_id": 456,
            "title": "Le Petit Prince",
            "_formatted": {
                "book_id": 456,
                "title": "Le Petit <em>Prince</em>"
            }
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 0,
    "query": "prince"
}

🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the version v0.19.0 of MeiliSearch.

💡 Learn More

The following sections may interest you:

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!


MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.

Libraries

meilisearch