Google 致力于为黑人社区推动种族平等。查看具体举措

Search Firestore with Typesense

Typesense
Made by Typesense

Indexes data from Firestore into Typesense for full-text search

此扩展程序的运作方式

Use this extension to sync data from your Firestore collection to Typesense, to be able to do full-text fuzzy search on your Firestore data.

This extension listens to your specified Firestore collection and syncs Firestore documents to Typesense on creation, updates and deletes. It also provides a function to help you backfill data.

Additional setup

Before installing this extension, make sure that you have:

  1. Set up a Cloud Firestore database in your Firebase project.
  2. Setup a Typesense cluster (on Typesense Cloud or a Self-Hosted server).
  3. Setup a Typesense Collection either through the Typesense Cloud dashboard or through the API.

This extension will sync changes that happen after you've installed the extension. You'll be able to run a function to backfill existing data in your Firestore collection. Detailed information for running this backfill function will be provided after you install this extension.

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 and Google Cloud Platform services, which have associated charges if you exceed the service's no-cost tier:
    • Cloud Firestore
    • Cloud Functions (Node.js 14+ runtime. See FAQs)
  • Usage of this extension also requires you to have a running Typesense cluster either on Typesense Cloud or some self-hosted server. You are responsible for any associated costs with these services.

如何安装此扩展程序

使用 Firebase 控制台

要安装和管理扩展程序,您可以使用 Firebase 控制台。

使用控制台安装

使用 Firebase CLI

要安装和管理扩展程序,您还可以使用 Firebase CLI:

步骤 1:运行以下 npm 命令来安装 CLI 或将 CLI 更新到最新版本。

npm install -g firebase-tools
不能运行?请参阅 Firebase CLI 参考文档或者更改您的 npm 权限

第 2 步设置一个新的 Firebase 项目目录或转到现有目录

第 3 步:将此扩展程序添加到扩展程序清单

firebase ext:install typesense/firestore-typesense-search --local --project=projectId_or_alias

第 4 步(可选):使用 Firebase Emulator Suite 在本地测试此扩展程序

firebase emulators:start

第 5 步:将清单中的扩展程序部署到项目中

firebase deploy --only extensions --project=projectId_or_alias
支持
Cloud Firestore
许可
Apache-2.0
版本
0.3.0