.. _connect_teradata:

Teradata Connector (Source and Sink) for |cp|
=============================================

You can use the |kconnect-long| Teradata Source and Sink connectors to import
data from Teradata into |ak-tm| and export data from |ak| topics to Teradata.

Install the Teradata Connector
------------------------------

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

If you are running a multi-node |kconnect| cluster, the Teradata connector and
JDBC driver JAR must be installed on every |kconnect| worker in the cluster. See
below for details.

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

.. codewithvars:: bash

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

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

.. codewithvars:: bash

   confluent-hub install confluentinc/kafka-connect-teradata:1.0.0-preview

--------------------------
Install Connector Manually
--------------------------

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

License
-------

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

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


.. _teradata-jdbc-driver-setup:

Installing JDBC Drivers
-----------------------

The Teradata source and sink connectors use the
`Java Database Connectivity (JDBC) API <https://www.oracle.com/technetwork/java/javase/jdbc/index.html>`__ that enables applications to connect to and use a wide range of database systems. In order for this to work, the connectors must have a *JDBC Driver* for Teradata.

#. Navigate to the `Teradata Downloads page <https://downloads.teradata.com/download/connectivity/jdbc-driver>`_
#. Log in with your Teradata account if you are not signed in already.
#. Download the JDBC driver corresponding to your Teradata version.
#. Extract the archive to get a ``terajdbc4.jar`` file.
#. Place this JAR file into the ``share/confluent-hub-components/confluentinc-kafka-connect-teradata/lib`` directory in
   your |cp| installation on each of the |kconnect| worker nodes.
#. Restart all of the |kconnect| worker nodes.

The rest of this section outlines the specific steps for more common database management systems.

------------------
General Guidelines
------------------

The following are additional guidelines to consider:

* The ``share/confluent-hub-components/confluentinc-kafka-connect-teradata/lib`` directory mentioned above is for |cp|.
  If you are using a different installation, find the location where the Confluent Teradata source and sink connector
  JAR files are located, and place the JDBC driver JAR file(s) for the target databases into the same directory.

* If the JDBC driver is not installed correctly, the Teradata source or sink connector will fail on startup.
  Typically, the system throws the error ``No suitable driver found``.
  If this happens, install the JDBC driver again by following the instructions.

* The connector must be run on a connect worker with a default timezone which does not observe daylight savings.
  If daylight savings is observed in your timezone, then the connector will fail to configure or start.
  You can manually override the worker timezone by setting the `TZ` environment variable before starting the worker, or on the command line with the JVM argument `-Duser.timezone=UTC`


Documentation
-------------

.. toctree::
   :maxdepth: 1

   source-connector/index
   sink-connector/index
   tde_setup
   changelog