haroenv/algolia-firebase-extension

Search with Algolia

Author: Algolia (https://www.algolia.com)

Description: Enable full text search of your Cloud Firestore data with Algolia.

---

🧩 Install this experimental extension

⚠️ Experimental: This extension is available for testing as an experimental release. It has not been as thoroughly tested as the officially released extensions, and future updates might introduce breaking changes. If you use this extension, please report bugs and make feature requests in our GitHub repository.

Firebase CLI

firebase ext:install aloglia-firebase/firestore-algolia-search --project=<your-project-id>

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

---

Details:

Use this extension to index your Cloud Firestore collection. The extension is applied and configured on a collection.

This extension listens for changes to the specified collection. If a document is added, updated, or deleted, this extension will:

• Add/Update - document will be indexed into Algolia. The fields defined in the extension configuration will be used to send to Algolia. The document Id will be used as the object id in Algolia.
• Delete - the Algolia record associate to document id will be removed.

Additional setup

Before installing this extension, make sure that you've set up:

• Cloud Firestore database in your Firebase project.
• Algolia account.

Billing

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

• You will be charged around $0.01 per month for each instance of this extension you install.
• This extension uses other Firebase and Google Cloud Platform services, which have associated charges if you exceed the service's free tier:
  • Cloud Functions (Node.js 10+ runtime. See FAQs.)
  • Cloud Firestore

Configuration Parameters:

• Cloud Functions Location: Where do you want to deploy the functions created for this extension? You usually want a location close to your database. For help selecting a location, refer to the location selection guide.

• Collection Path: What is the path to the collection that you want to index?

• Fields: What are fields in the document do you want to index?

NOTE: This configuration can be left empty if you want to index all the fields in this document.

• Algolia Application ID: What is the Algolia application id that contains the index?

• Algolia API Key: What is the Algolia API key with addObject, deleteObject, listIndexes, deleteIndex, editSettings, and settings permissions.

• Algolia Index Name: What is the Algolia index name that will contain the collection document records.

Cloud Functions:

• executeIndexOperation: Listens for create, update, and delete triggers on a document in the specified collection.