.. _connect-firebase:

Google Firebase Connector (Source and Sink) for |cp|
====================================================

The |kconnect-long| Google Firebase Source connector enables users to read data
from a `Google Firebase Realtime Database <https://firebase.google.com/docs/database>`__  and persist the data in |ak-tm| topics. The |kconnect-long| Google Firebase Sink Connector enables users to read data from multiple |ak| topics and write them to Google Firebase Realtime Database.

Prerequisites
-------------

The following are required to run the |kconnect-long| Firebase Connector:

* |ak| Broker: |cp| 3.3.0 or above, or |ak| 0.11.0 or above
* |kconnect|: |cp| 4.0.0 or above, or |ak| 1.0.0 or above
* Java 1.8
* A GCP service account with role ``Firebase Realtime Database Viewer`` for source connector and ``Firebase Realtime Database Admin`` for sink connector is required. You can create this service account in the `Google Cloud Console <https://console.cloud.google.com/iam-admin>`__. For creating a service account, refer `creating and managing service accounts <https://cloud.google.com/iam/docs/creating-managing-service-accounts>`__.

Install the Google Firebase Connector
--------------------------------------------

.. include:: ../includes/connector-install.rst

.. include:: ../includes/connector-install-hub.rst

.. codewithvars:: bash

   confluent-hub install confluentinc/kafka-connect-firebase:latest

.. include:: ../includes/connector-install-version.rst

.. codewithvars:: bash

   confluent-hub install confluentinc/kafka-connect-firebase:1.1.0-preview


------------------------------
Install the connector manually
------------------------------

`Download and extract the ZIP file <https://www.confluent.io/hub/confluentinc/kafka-connect-firebase>`__ for your connector and then follow the manual connector installation :ref:`instructions <connect_install_connectors>`.


License
-------

.. include:: ../includes/enterprise-license.rst

See :ref:`firebase-source-license-config` for license properties 
and :ref:`firebase-source-license-topic-configuration` for information about the license topic.

Configuration Properties
------------------------

For a complete list of configuration properties for the source connector, see :ref:`firebase-source-connector-config`.

For a complete list of configuration properties for the sink connector, see :ref:`firebase-sink-connector-config`.


Additional Documentation
------------------------

.. toctree::
   :maxdepth: 1

   source/index
   sink/index
   changelog