Skip to content

Latest commit

 

History

History
136 lines (80 loc) · 7.86 KB

README.md

File metadata and controls

136 lines (80 loc) · 7.86 KB
Raw

firestore-meilisearch

Meilisearch-Firestore

Meilisearch Firestore

Meilisearch | Meilisearch Cloud | Documentation | Discord | Roadmap | Website | FAQ

Test License Bors enabled

⚡ The Meilisearch API extension written for Firebase

Search in your Firestore content with Meilisearch

Author: Meilisearch (https://meilisearch.com)

Description: Full-text Search on Firebase with Meilisearch

Details: Use this extension to synchronize documents from a Cloud Firestore collection to a Meilisearch index. This allows you to use full-text search in your Cloud Firestore documents.

This extension listens to each creation, update, or deletion of your documents to keep them in sync with your Meilisearch index. This ensures that the data in Meilisearch mirrors your content in Cloud Firestore. You can then run queries on this mirrored dataset.

Note that this extension only listens for changes to documents in a specific collection, but not changes in any subcollection. However, you can install additional instances of this extension to listen to other collections in your Firestore database.

⚡ Supercharge your Meilisearch experience

Say goodbye to server deployment and manual updates with Meilisearch Cloud. Get started with a 14-day free trial! No credit card required.

Additional setup

Before installing this extension, you'll need to:

Data import format

Documents indexed in Meilisearch must have an unique id. Meilisearch uses Firestore's default field: Document ID for this purpose, and renames it to_firestore_id.

Important: If your documents contain a field called _firestore_id, it will be ignored.

If you are using GeoPoint, the field should be named _geo to be recognized by Meilisearch for geosearch.

Backfill your Meilisearch data

This extension does not export all existing documents into Meilisearch unless they have been modified or created after its installation. You can run the import script provided by this extension to retrieve your Meilisearch dataset with all the documents present in your Firestore collection

Billing

To install an extension, your project must be on the Blaze (pay as you go) plan

  • You will be charged a small amount (typically around $0.01/month) for the Firebase resources required by this extension, even if it is not used.
  • This extension uses other Firebase or Google Cloud services which may have associated charges if you exceed the service’s free tier:
    • Cloud Firestore
    • Cloud Functions (Node.js 10+ runtime. See FAQs)

When you use Firebase extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling a Google Cloud API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. Learn more about Firebase billing.

Configuration Parameters:

  • Cloud Functions location: Where do you want to deploy the functions created for this extension? If you need help selecting a location, refer to the location selection guide.

  • Collection path: What is the path of the collection you would like to export into Meilisearch?

  • Fields to index in Meilisearch: What fields do you want to index in Meilisearch? Create a comma-separated list of the field names, or leave it blank to include all fields. The id field is always indexed even when omitted from the list.

  • Meilisearch Index Name: What Meilisearch index do you want to index your data in?

  • Meilisearch host: What is the URL of the host of your Meilisearch database? Make sure your URL starts with http:// or https://

  • Meilisearch API key: What is your Meilisearch API key with permission to perform actions on indexes? Both the API keys and the master key are valid choices but we strongly recommend using an API key for security purposes. Check out our guide on security.

Cloud Functions:

  • indexingWorker: Cloud function triggered by document modification in Firestore to import changes into Meilisearch.

🧩 Install this extension

Console

Install this extension in your Firebase project

Firebase CLI

firebase ext:install meilisearch/firestore-meilisearch --project=[your-project-id]

Learn more about installing extensions in the Firebase Extensions documentation: console, CLI

🤖 Compatibility with Meilisearch

This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.

⚙️ 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 wish to contribute, please see 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 wish to contribute, make suggestions, or want to know what's going on right now, visit the integration-guides repository.