Comment on page
Firestore
Kubemq gcp-firestore target connector allows services using kubemq server to access google firestore server.
The following required to run the gcp-firestore target connector:
- kubemq cluster
- gcp-firestore set up in native mode
- kubemq-source deployment
firestore target connector configuration properties:
Properties Key | Required | Description | Example |
project_id | yes | gcp firestore project_id | "/myproject" |
credentials | yes | gcp credentials files | "<google json credentials" |
Example:
bindings:
- name: kubemq-query-gcp-firestore
source:
kind: kubemq.query
name: kubemq-query
properties:
address: "kubemq-cluster:50000"
client_id: "kubemq-query-gcp-firestore-connector"
auth_token: ""
channel: "query.gcp.firestore"
group: ""
auto_reconnect: "true"
reconnect_interval_seconds: "1"
max_reconnects: "0"
target:
kind: gcp.firestore
name: gcp-firestore
properties:
project_id: "id"
credentials: 'json'
instance: "instance"
add a key under collection
Add Key metadata setting:
Metadata Key | Required | Description | Possible values |
method | yes | type of method | "add" |
collection | yes | the name of the collection to sent to | "collection name" |
Example:
{
"metadata": {
"method": "add",
"collection": "my_collection"
},
"data": "QWRkIFZhbHVl"
}
get values by key under collection
Get Key metadata setting:
Metadata Key | Required | Description | Possible values |
method | yes | type of method | "document_key" |
collection | yes | the name of the collection to sent to | "collection name" |
document_key | yes | the name of the key to get his value | "valid existing key" |
Example:
{
"metadata": {
"method": "documents_all",
"collection": "my_collection",
"item": "<valid existing key>"
},
"data": null
}
get all values under collection
Get all metadata setting:
Metadata Key | Required | Description | Possible values |
method | yes | type of method | "documents_all" |
collection | yes | the name of the collection to sent to | "collection name" |
Example:
{
"metadata": {
"method": "documents_all",
"collection": "my_collection"
},
"data": null
}
delete key in collection
Delete key metadata setting:
Metadata Key | Required | Description | Possible values |
method | yes | type of method | "delete_document_key" |
collection | yes | the name of the collection to sent to | "collection name" |
document_key | yes | the name of the key to delete his value | "valid existing key" |
Example:
{
"metadata": {
"method": "delete_document_key",
"collection": "my_collection",
"item": "valid existing key"
},
"data": null
}
Last modified 2yr ago