Cloud Firestore

Technical Preview

Overview

Client-mode REST API connectors for Firebase: write device state, append events, and query history in the Realtime Database, and upsert, merge, and query Cloud Firestore documents from MQTT. This is one of the templates in the Firebase Realtime Database and Cloud Firestore REST API app (firebase-realtime-database-and-cloud-firestore). Deploy it alongside the other connectors of that app when they depend on each other (for example a token connector plus an API connector). See Firebase Realtime Database and Cloud Firestore for the package overview.

Not yet verified against the live vendor API: Needs a lab Firebase project: project id, RTDB instance URL (https://<db>-default-rtdb.firebaseio.com or <region>.firebasedatabase.app), and a Google OAuth2 access token from a service account (scopes userinfo.email + firebase.database for RTDB; roles/datastore.user with datastore or cloud-platform scope for Firestore), Hub secret FIREBASE_ACCESS_TOKEN. Gate: RTDB PUT devices/press-01/state.json 200 + POST events.json 200 + GET 200; Firestore PATCH documents/devices/press-01 200 + runQuery 200. No Firebase/Google credentials on the factory box. Emulator smoke 13/13 (11 events + 2 rules denials) and real-endpoint probes (public RTDB GET 200; writes 401; Firestore invalid token 401) are partial evidence only.

Auth

Bearer {value.json.access_token} on both connectors. RTDB: Google OAuth2 SA token (userinfo.email + firebase.database); alt ?access_token= or Firebase ID token via ?auth=. Firestore: Google OAuth2 SA token (roles/datastore.user) or Firebase ID token (rules apply). Hub secret FIREBASE_ACCESS_TOKEN. Auth headers used by the template: Authorization: Bearer {value.json.access_token}.

Template parameters

Placeholder	Type	Description	Required
`RouteName`	string	Name of the Cloud Firestore connector	no
`BaseUrl`	string	Cloud Firestore base URL without trailing slash (e.g. https://firestore.googleapis.com)	yes

BASE_ADDRESS default: https://firestore.googleapis.com.

Events

Event	Method	Endpoint	Request topic	Response topic	Payload fields
`UpsertDocument`	PATCH	`/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.document_path}`	`data/firebase/firestore/document/upsert`	`data/firebase/firestore/document/upsert/response`	`access_token`, `document`, `document_path`, `project_id`
`MergeFields`	PATCH	`/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.document_path}?{value.json.update_mask}`	`data/firebase/firestore/document/merge`	`data/firebase/firestore/document/merge/response`	`access_token`, `document`, `document_path`, `project_id`, `update_mask`
`CreateDocument`	POST	`/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.collection}`	`data/firebase/firestore/document/create`	`data/firebase/firestore/document/create/response`	`access_token`, `collection`, `document`, `project_id`
`GetDocument`	GET	`/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.document_path}`	`data/firebase/firestore/document/get`	`data/firebase/firestore/document/get/response`	`access_token`, `document_path`, `project_id`
`ListDocuments`	GET	`/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.collection}?pageSize={value.json.page_size}`	`data/firebase/firestore/documents/list`	`data/firebase/firestore/documents/list/response`	`access_token`, `collection`, `page_size`, `project_id`
`RunQuery`	POST	`/v1/projects/{value.json.project_id}/databases/(default)/documents:runQuery`	`data/firebase/firestore/documents/query`	`data/firebase/firestore/documents/query/response`	`access_token`, `project_id`, `query`

Deploy

Get the template card (JSON with template and metadata) from the broker, then deploy the connector:

mosquitto_pub -t '$SYS/Coreflux/Command' -m "-routeCode CLOUD_FIRESTORE"

The deployable connector from the REST API app, with BASE_ADDRESS already filled in:

DEFINE ROUTE CloudFirestoreRestApi WITH TYPE REST_API
    ADD REST_API_CONFIG
        WITH BASE_ADDRESS "https://firestore.googleapis.com"
        WITH ENABLE_CLIENT "true"
        WITH USE_SSL "true"
        WITH REQUEST_TIMEOUT '60'
        WITH DEFAULT_CONTENT_TYPE "application/json"
    ADD EVENT UpsertDocument
        WITH SOURCE_TOPIC "data/firebase/firestore/document/upsert"
        WITH DESTINATION_TOPIC "data/firebase/firestore/document/upsert/response"
        WITH METHOD "PATCH"
        WITH ENDPOINT "/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.document_path}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.access_token}"
        WITH BODY "{value.json.document}"
    ADD EVENT MergeFields
        WITH SOURCE_TOPIC "data/firebase/firestore/document/merge"
        WITH DESTINATION_TOPIC "data/firebase/firestore/document/merge/response"
        WITH METHOD "PATCH"
        WITH ENDPOINT "/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.document_path}?{value.json.update_mask}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.access_token}"
        WITH BODY "{value.json.document}"
    ADD EVENT CreateDocument
        WITH SOURCE_TOPIC "data/firebase/firestore/document/create"
        WITH DESTINATION_TOPIC "data/firebase/firestore/document/create/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.collection}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.access_token}"
        WITH BODY "{value.json.document}"
    ADD EVENT GetDocument
        WITH SOURCE_TOPIC "data/firebase/firestore/document/get"
        WITH DESTINATION_TOPIC "data/firebase/firestore/document/get/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.document_path}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Authorization" "Bearer {value.json.access_token}"
    ADD EVENT ListDocuments
        WITH SOURCE_TOPIC "data/firebase/firestore/documents/list"
        WITH DESTINATION_TOPIC "data/firebase/firestore/documents/list/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/v1/projects/{value.json.project_id}/databases/(default)/documents/{value.json.collection}?pageSize={value.json.page_size}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Authorization" "Bearer {value.json.access_token}"
    ADD EVENT RunQuery
        WITH SOURCE_TOPIC "data/firebase/firestore/documents/query"
        WITH DESTINATION_TOPIC "data/firebase/firestore/documents/query/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/v1/projects/{value.json.project_id}/databases/(default)/documents:runQuery"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.access_token}"
        WITH BODY "{value.json.query}"

Deploy it with -addRoute (do not include ADD METADATA).

Usage example

Call UpsertDocument by publishing a JSON payload to its request topic, and read the reply on the response topic:

mosquitto_sub -t 'data/firebase/firestore/document/upsert/response' &
mosquitto_pub -t 'data/firebase/firestore/document/upsert' -m '{"access_token": "<access_token>", "document": "<document>", "document_path": "<document_path>", "project_id": "<project_id>"}'

Quick Start

Coreflux MQTT Broker

LoT Language

Coreflux HUB

VS Code - LoT Notebooks

Coreflux Portal

Using AI with Coreflux

Product Updates

Overview

Auth

Template parameters

Events

Deploy

Usage example

​Overview

​Auth

​Template parameters

​Events

​Deploy

​Usage example

​Related

Overview

Auth

Template parameters

Events

Deploy

Usage example

Related