Skip to content

POSTINSTALL.md

Latest commit

 

History

History
37 lines (23 loc) · 1.86 KB

POSTINSTALL.md

File metadata and controls

37 lines (23 loc) · 1.86 KB

Post-installation Notes

Now that you've installed the extension, changes from your configured Firestore collection(s) will be synced to the configured Typesense collection(s) on ${param:TYPESENSE_HOSTS}.

If you installed the legacy single-collection params (${param:FIRESTORE_COLLECTION_PATH} and ${param:TYPESENSE_COLLECTION_NAME}), the extension will still work, but it will log a deprecation warning. Plan to migrate to FIRESTORE_COLLECTION_PATHS and TYPESENSE_COLLECTION_NAMES in a future release.

Pre-requisites

As a reminder in case you haven't already done this, make sure that you have setup a Typesense Collection in one of the following ways:

  • Through the Typesense Cloud Dashboard or
  • Through the API.

This extension expects a Typesense Cloud collection to already be created and does not create it for you.

Backfilling Data

This extension only syncs data that was created or changed after it was installed. In order to backfill data that already exists in your Firestore collection to your Typesense Collection:

  1. Create a new Firestore collection called typesense_sync through the Firestore UI.
  2. Create a new document with the ID backfill and contents of {trigger: true}

This will trigger the backfill background function, which will read data from your Firestore collection and create equivalent documents in your Typesense collection.

See the Extension in Action

Try adding or updating a Firestore document in your configured Firestore collection through the Firestore UI. You should see the change reflected in your Typesense collection.

Monitoring

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