Search with Algolia
Made by Algolia
Enables full text search of your Cloud Firestore data with Algolia.
How this extension works
Use this extension to index your Cloud Firestore data to Algolia and keep it synced. The extension is applied and configured on a Firestore collection.
This extension listens for changes on the specified collection. If you add a document, the extension indexes it as a record in Algolia. The extension only indexes the fields defined in the extension configuration and uses the document Id as the Algolia object Id.
Anytime you update a document, the extension propagates the update to the corresponding Algolia record. If you delete a document, the extension removes the corresponding Algolia record.
Before installing this extension, make sure that you've set up a Cloud Firestore database in your Firebase project.
You must also have an Algolia account set up before installing this extension. You can do so on the Algolia site.
This extension uses the following Firebase services which may have associated charges:
- Cloud Firestore
- Cloud Functions
This extension also uses the following third-party services:
- Algolia (pricing information)
You are responsible for any costs associated with your use of these services.
Note from Firebase
To install this extension, your Firebase project must be on the Blaze (pay-as-you-go) plan. You will only be charged for the resources you use. Most Firebase services offer a no-cost tier for low-volume use. Learn more about Firebase billing.
You will be billed a small amount (typically less than $0.10) when you install or reconfigure this extension. See Cloud Functions under Firebase Pricing for a detailed explanation.
What you can configure
- Collection Path
- Indexable Fields
- Algolia Index Name
- Algolia Application Id
- Algolia API Key
- Transform Function Name (Experimental)
- Cloud Functions location
Type: Cloud Function
Description: Firestore document-triggered function that creates, updates, or deletes data in Algolia.
How to install this extension
Using the Firebase console
To install and manage extensions, you can use the Firebase console.Install using console
Using the Firebase CLI
To install and manage extensions, you can also use the Firebase CLI:
Step 1: Run the following npm command to install the CLI or update to the latest CLI version.
npm install -g firebase-toolsDoesn't work? Take a look at the Firebase CLI reference or change your npm permissions.
Step 2: Set up a new Firebase project directory or navigate to an existing one
Step 3: Add this extension to your extension manifest by running
firebase ext:install algolia/firestore-algolia-search --local --project=projectId_or_alias
Step 4 (Optional): Test this extension locally with the Firebase Emulator Suite
Step 5: Deploy the extensions in your manifest to your project
firebase deploy --only extensions --project=projectId_or_alias