==========
Cloud Solr
==========

.. code-block:: text

    com.github.jcustenborder.kafka.connect.solr.CloudSolrSinkConnector


This connector is used to connect to `SolrCloud <https://cwiki.apache.org/confluence/display/solr/SolrCloud>`_ using the Zookeeper based configuration.


.. TIP::
    The target collection for this connector is selected by the topic name. `Transformations <https://kafka.apache.org/documentation/#connect_transforms>`_ like the RegexRouter transformation can be used to change the topic name before it is sent to Solr.



.. toctree::
    :maxdepth: 1
    :caption: Examples:
    :glob:

    examples/CloudSolrSinkConnector.*

-------------
Configuration
-------------
^^^^^^^^^^
Connection
^^^^^^^^^^


""""""""""""""""""""
solr.zookeeper.hosts
""""""""""""""""""""

Zookeeper hosts that are used to store solr configuration.

**Importance:** HIGH

**Type:** LIST



"""""""""""""""""""""
solr.zookeeper.chroot
"""""""""""""""""""""

Chroot within solr for the zookeeper configuration.

**Importance:** HIGH

**Type:** STRING



"""""""""""""""""""""""
solr.connect.timeout.ms
"""""""""""""""""""""""

Set the connect timeout to the solr in ms.

**Importance:** LOW

**Type:** INT

**Default Value:** 15000



""""""""""""""""""""""
solr.socket.timeout.ms
""""""""""""""""""""""

Set the solr read timeout on all sockets in ms.

**Importance:** LOW

**Type:** INT

**Default Value:** 120000



""""""""""""""""""""""""""""""""
solr.zookeeper.client.timeout.ms
""""""""""""""""""""""""""""""""

Set the timeout to the zookeeper ensemble in ms.

**Importance:** LOW

**Type:** INT

**Default Value:** 45000



"""""""""""""""""""""""""""""""""
solr.zookeeper.connect.timeout.ms
"""""""""""""""""""""""""""""""""

Set the connect timeout to the zookeeper ensemble in ms.

**Importance:** LOW

**Type:** INT

**Default Value:** 15000



"""""""""""""""""""""""""""""""""""
solr.zookeeper.retry.expiry.time.ms
"""""""""""""""""""""""""""""""""""

This is the time to wait to refetch the state after getting the same state version from ZK in ms.

**Importance:** LOW

**Type:** INT

**Default Value:** 3000



^^^^^^^^^^^^^^
Authentication
^^^^^^^^^^^^^^


"""""""""""""
solr.password
"""""""""""""

The password to use for basic authentication.

**Importance:** HIGH

**Type:** PASSWORD

**Default Value:** [hidden]



"""""""""""""
solr.username
"""""""""""""

The username to use for basic authentication.

**Importance:** HIGH

**Type:** STRING



^^^^^^^^
Indexing
^^^^^^^^


"""""""""""""""""""""""""""""
solr.delete.documents.enabled
"""""""""""""""""""""""""""""

Flag to determine if the connector should delete documents. General practice in Kafka is to treat a record that contains a key with a null value as a delete.

**Importance:** MEDIUM

**Type:** BOOLEAN

**Default Value:** true



""""""""""""""""""
solr.commit.within
""""""""""""""""""

Configures Solr UpdaterRequest for a commit within the requested number of milliseconds. -1 disables the commit within setting and relies on the standard Solr commit setting.

**Importance:** LOW

**Type:** INT

**Default Value:** -1