Skip to content

Add DATABASE_ID parameter #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add DATABASE_ID parameter #80

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
488f2b7
Add DATABASE_ID parameter
adonistseriotis Jun 26, 2024
470da0a
Tweak labels
jasonbosco Jun 26, 2024
6fcc7cf
Merge branch 'master' into patch-1
jasonbosco Jun 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions extension.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: firestore-typesense-search
version: 1.4.1
version: 1.4.2
specVersion: v1beta # Firebase Extensions specification version (do not edit)

displayName: Search Firestore with Typesense
Expand Down Expand Up @@ -27,7 +27,7 @@ resources:
location: ${LOCATION}
eventTrigger:
eventType: providers/cloud.firestore/eventTypes/document.write
resource: projects/${param:PROJECT_ID}/databases/(default)/documents/${param:FIRESTORE_COLLECTION_PATH}/{documentID}
resource: projects/${param:PROJECT_ID}/databases/${param:DATABASE_ID}/documents/${param:FIRESTORE_COLLECTION_PATH}/{documentID}

- name: backfill
description: >-
Expand All @@ -43,7 +43,7 @@ resources:
location: ${LOCATION}
eventTrigger:
eventType: providers/cloud.firestore/eventTypes/document.write
resource: projects/${param:PROJECT_ID}/databases/(default)/documents/typesense_sync/backfill
resource: projects/${param:PROJECT_ID}/databases/${param:DATABASE_ID}/documents/typesense_sync/backfill

roles:
- role: datastore.user
Expand All @@ -56,6 +56,15 @@ externalServices:
PricingUri: https://typesense.org/downloads

params:
- param: DATABASE_ID
label: Firestore Database ID
description: >-
The Firestore Database ID which contains the collection that needs to be indexed into Typesense. Set it to (default) if you're only using a single database.
default: '(default)'
example: (default)
required: true
immutable: true

- param: FIRESTORE_COLLECTION_PATH
label: Firestore Collection Path
description: >-
Expand All @@ -66,13 +75,15 @@ params:
default: path/to/firestore_collection
required: true
immutable: true

- param: FIRESTORE_COLLECTION_FIELDS
label: Firestore Collection Fields
description: >-
A comma separated list of fields that need to be indexed from each Firestore document. Leave blank to index all fields.
example: field1,field2,field3
default: ""
required: false

- param: TYPESENSE_HOSTS
label: Typesense Hosts
description: >-
Expand All @@ -81,6 +92,7 @@ params:
please be sure to mention all hostnames.
example: xyz.a1.typesense.net,xyz-1.a1.typesense.net,xyz-2.a1.typesense.net,xyz-3.a1.typesense.net
required: true

- param: TYPESENSE_API_KEY
label: Typesense API Key
type: secret
Expand All @@ -89,12 +101,14 @@ params:
Click on "Generate API Key" in cluster dashboard in Typesense Cloud
example: ""
required: true

- param: TYPESENSE_COLLECTION_NAME
label: Typesense Collection Name
description: >-
Typesense collection name to index data into. This collection needs to exist before this extension is installed. Please create it via the Typesense Cloud dashboard or API.
default: companies
required: true

- param: FLATTEN_NESTED_DOCUMENTS
label: Flatten Nested Documents
description: >-
Expand All @@ -108,6 +122,7 @@ params:
value: true
default: false
required: false

- param: LOCATION
label: Cloud Functions location
description: >-
Expand Down