Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 3.38 KB

PREINSTALL.md

File metadata and controls

42 lines (27 loc) · 3.38 KB
Raw

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.

Additional setup

Before installing this extension, you'll need to:

Data import format

Documents indexed in Meilisearch must have a unique id. The extension will use Firestore's default field: Document ID for this purpose. Document ID will be renamed to_firestore_id to be used as the document id. If your documents have another field containing the string id, it will not be set as the primary key.

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

Geosearch has a specific format in Meilisearch, your documents must have a valid _geo field with an object composed of lat and lng. If a GeoPoint from Firestore with the name _geo is found, the field latitude is renamed to lat and longitude to lng. If a GeoPoint is found without the name _geo, it is added as an array.

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.