Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.22 KB

POSTINSTALL.md

File metadata and controls

40 lines (24 loc) · 2.22 KB

See it in action

You can test out this extension right away!

  1. Go to your Cloud Firestore dashboard in the Firebase console

  2. If it doesn't already exist, create the collection you specified during installation: ${param:COLLECTION_PATH}

  3. Create, update, or delete a document in the collection called ${param:COLLECTION_PATH} that contains any fields with any values that you'd like.

  4. You can check the status of tasks in your Meilisearch instance using the following query:

    curl \
  -X GET '${param:MEILISEARCH_HOST}/tasks'

    You can read more on tasks in the documentation.

Using the extension

Whenever a document is created, updated, or deleted in the specified collection ${param:COLLECTION_PATH}, this extension sends that update to your Meilisearch instance.

This extension:

  • Indexes a document in Meilisearch and sends all the fields or configured fields defined in the extension
  • Updates a document in your Meilisearch index
  • Deletes a document from your Meilisearch index

(Optional) Import existing documents

This extension does not export your existing document dataset in Meilisearch. It will only export the documents that have been modified or created after installation. To populate your Meilisearch database with all the documents in your Firestore collection, you need to run the import script provided by this extension.

The import script reads all existing documents in a Cloud Firestore collection or group collection and indexes them into Meilisearch.

Important: Run the import script over the entire collection after installing this extension; otherwise, you may lose the current writes in your database during the import.

Learn more about using the import script to backfill your existing collection.

Monitoring

As a best practice, you can monitor the activity of your installed extension, including checks on its health, usage, and logs.