Skip to content

Kafka PlaintextProtocol

KafkaPlaintextProtocol

Bases: KafkaProtocol, FrozenModel

Connect to Kafka using PLAINTEXT or SASL_PLAINTEXT security protocols.

.. warning::

Not recommended to use on production environments.
Prefer :obj:`SSLProtocol <onetl.connection.db_connection.kafka.kafka_ssl_protocol.KafkaSSLProtocol>`.

.. versionadded:: 0.9.0

Examples:

.. code:: python

# No options
protocol = Kafka.PlaintextProtocol()

cleanup(kafka)

This method is called while closing Kafka connection.

Implement it to cleanup resources like temporary files.

Parameters:

  • kafka (:obj:Kafka <onetl.connection.db_connection.kafka.connection.Kafka>) –

    Connection instance

get_options(kafka)

Get options for Kafka connection

Parameters:

  • kafka (:obj:Kafka <onetl.connection.db_connection.kafka.connection.Kafka>) –

    Connection instance

Returns:

  • dict ( dict ) –

    Kafka client options