# Firebase

## Kubemq firebase target Connector

Kubemq gcp-firebase target connector allows services using kubemq server to access google firebase server.

### Prerequisites

The following required to run the gcp-firebase target connector:

* kubemq cluster
* gcp-firebase set up
* kubemq-source deployment

### Configuration

firebase target connector configuration properties:

| Properties Key    | Required | Description                             | Example                     |
| ----------------- | -------- | --------------------------------------- | --------------------------- |
| project\_id       | yes      | gcp firebase project\_id                | "/myproject"                |
| credentials       | yes      | gcp credentials files                   | "\<google json credentials" |
| db\_client        | no       | initialize db client if true            | true/false                  |
| db\_url           | no       | gcp db full path                        | \<google db url"            |
| auth\_client      | no       | initialize auth client if true          | true/false                  |
| messaging\_client | no       | initialize messaging client             | true/false                  |
| defaultmsg        | no       | default Firebase Cloud Messaging        | json                        |
| defaultmultimsg   | no       | default Firebase Cloud MulticastMessage | json                        |

*defaultmsg - can be used for common message settings* defaultmultimsg - can be used for common message settings

Example:

```yaml
bindings:
  - name: kubemq-query-gcp-firebase
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-gcp-firebase-connector"
        auth_token: ""
        channel: "query.gcp.firebase"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: gcp.firebase
      name: gcp-firebase
      properties:
        project_id: "project_id"
        credentials: 'json'
        db_client: "true"
        db_url: "db_url"
        auth_client: "true"
```

### Usage

### DB:

#### Get DB

Get DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | get\_db         |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
```

#### Set DB

Set DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | set\_db         |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
```

#### Update DB

Update DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | update\_db      |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "delete_db",
    "ref_path": "string"
  },
  "data": "updated_string"
}
```

#### Delete DB

## Kubemq firebase target Connector

Kubemq gcp-firebase target connector allows services using kubemq server to access google firebase server.

### Prerequisites

The following required to run the gcp-firebase target connector:

* kubemq cluster
* gcp-firebase set up
* kubemq-source deployment

### Configuration

firebase target connector configuration properties:

| Properties Key    | Required | Description                             | Example                     |
| ----------------- | -------- | --------------------------------------- | --------------------------- |
| project\_id       | yes      | gcp firebase project\_id                | "/myproject"                |
| credentials       | yes      | gcp credentials files                   | "\<google json credentials" |
| db\_client        | no       | initialize db client if true            | true/false                  |
| db\_url           | no       | gcp db full path                        | \<google db url"            |
| auth\_client      | no       | initialize auth client if true          | true/false                  |
| messaging\_client | no       | initialize messaging client             | true/false                  |
| defaultmsg        | no       | default Firebase Cloud Messaging        | json                        |
| defaultmultimsg   | no       | default Firebase Cloud MulticastMessage | json                        |

*defaultmsg - can be used for common message settings* defaultmultimsg - can be used for common message settings

Example:

```yaml
bindings:
  - name: kubemq-query-gcp-firebase
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-gcp-firebase-connector"
        auth_token: ""
        channel: "query.gcp.firebase"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind:gcp.firebase
      name: gcp-firebase
      properties:
        project_id: "project_id"
        credentials: 'json'
        db_client: "true"
        db_url: "db_url"
        auth_client: "true"
```

### Usage

### DB:

#### Get DB

Get DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | get\_db         |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
```

#### Set DB

Set DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | set\_db         |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
```

#### Update DB

Update DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | update\_db      |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "update_db",
    "ref_path": "string"
  },
  "data": "dXBkYXRlIGRiIHN0cmluZw=="
}
```

#### Delete DB

Delete DB metadata setting:

| Metadata Key | Required | Description             | Possible values |
| ------------ | -------- | ----------------------- | --------------- |
| method       | yes      | method type             | delete\_db      |
| ref\_path    | yes      | ref path for the data   | valid string    |
| child\_ref   | no       | path for child ref data | valid string    |

Example:

```javascript
{
  "metadata": {
    "method": "delete_db",
    "ref_path": "string"
  },
  "data": null
}
```

### User:

#### Create User

Create User metadata setting:

| Metadata Key | Required | Description | Possible values |
| ------------ | -------- | ----------- | --------------- |
| method       | yes      | method type | create\_user    |

Example:

```javascript
{
  "metadata": {
    "method": "create_user"
  },
  "data": "eyJlbWFpbCI6IkpvaG5AZHVlLmNvbSIsICJwYXNzd29yZCI6MzAsICJkaXNwbGF5X25hbWUiOiJKb2huIn0="
}
```

#### Retrieve User

Retrieve User metadata setting:

| Metadata Key | Required | Description         | Possible values              |
| ------------ | -------- | ------------------- | ---------------------------- |
| method       | yes      | method type         | retrieve\_user               |
| retrieve\_by | yes      | type of retrieval   | by\_email ,by\_uid,by\_phone |
| uid          | no       | valid unique string | string                       |
| phone        | no       | valid phone number  | string                       |
| email        | no       | valid email         | string                       |

Example:

```javascript
{
  "metadata": {
    "method": "retrieve_user",
    "retrieve_by": "uid",
    "uid": "1223131"
  },
  "data": null
}
```

#### Delete User

Delete User metadata setting:

| Metadata Key | Required | Description         | Possible values |
| ------------ | -------- | ------------------- | --------------- |
| method       | yes      | method type         | delete\_user    |
| uid          | yes      | valid unique string | string          |

Example:

```javascript
{
  "metadata": {
    "method": "delete_user",
    "uid": "1223131"
  },
  "data": null
}
```

#### Delete Multiple Users

Delete Multiple Users metadata setting:

| Metadata Key | Required | Description | Possible values         |
| ------------ | -------- | ----------- | ----------------------- |
| method       | yes      | method type | delete\_multiple\_users |

Example:

```javascript
{
  "metadata": {
    "method": "delete_multiple_users"
  },
  "data": "WyAidXNlcjEiLCAidXNlcjIiLCAidXNlcjMiIF0="
}
```

#### Update User

Update User metadata setting:

| Metadata Key | Required | Description         | Possible values |
| ------------ | -------- | ------------------- | --------------- |
| method       | yes      | method type         | update\_user    |
| uid          | yes      | valid unique string | string          |

Example:

```javascript
{
  "metadata": {
    "method": "update_user",
    "uid": "1223131"
  },
  "data": "eyJlbWFpbCI6IkpvaG5AZHVlLmNvbSIsICJwYXNzd29yZCI6MzAsICJkaXNwbGF5X25hbWUiOiJKb2huIn0="
}
```

#### List Users

List User metadata setting:

| Metadata Key | Required | Description | Possible values |
| ------------ | -------- | ----------- | --------------- |
| method       | yes      | method type | list\_users     |

Example:

```javascript
{
  "metadata": {
    "method": "list_users"
  },
  "data": null
}
```

### Token:

#### Custom Token

Custom Token metadata setting:

| Metadata Key | Required | Description         | Possible values |   |   |
| ------------ | -------- | ------------------- | --------------- | - | - |
| method       | yes      | method type         | custom\_token   |   |   |
| uid          | yes      | valid unique string | string          |   |   |

Example:

```javascript
{
  "metadata": {
    "method": "custom_token",
    "token_id": "some-uid"
  },
  "data": null
}
```

#### Verify Token

Verify Token metadata setting:

| Metadata Key | Required | Description         | Possible values |   |   |
| ------------ | -------- | ------------------- | --------------- | - | - |
| method       | yes      | method type         | verify\_token   |   |   |
| uid          | yes      | valid unique string | string          |   |   |

Example:

```javascript
{
  "metadata": {
    "method": "verify_token",
    "token_id": "some-uid"
  },
  "data": null
}
```

### Messaging:

Firebase messaging will send a FCM message or send the message to multiple devices.

* message <https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages>
* multi <https://firebase.google.com/docs/cloud-messaging/send-message#go_1>

#### Send Message

Create User metadata setting:

| Metadata Key | Required | Description | Possible values           |
| ------------ | -------- | ----------- | ------------------------- |
| method       | yes      | method type | send\_message/send\_multi |

Example: send\_message

```javascript
{
  "metadata": {
    "method": "send_message"
  },
  "data": "ewoiVG9waWMiOiJ0ZXN0IiwKImRhdGEiOiB7ImtleTEiOiJ2YWx1ZTEifQp9"
}

* data value is base64  {
  "Topic":"test",
  "data": {"key1":"value1"}
  }
```

Example: send\_multi

```javascript
{
  "metadata": {
    "method": "send_multi"
  },
  "data": "ewogICAgInRvcGljIjoiYXBwIHRvcGljIiwKICAgICAiZGF0YSI6eyJUb2tlbnMiOlsiMTIzIiwiNDU2Il0sIkRhdGEiOnsia2V5IjoidmFsIn0sIk5vdGlmaWNhdGlvbiI6eyJ0aXRsZSI6InRpdGxlIn19CiB9"
}

* data value is base64  {
    "topic":"app_topic",
     "data":{"Tokens":["123","456"],"Data":{"key":"val"},"Notification":{"title":"title"}}
  }
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kubemq.io/configuration/connectors/kubemq-targets/gcp/firebase.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.