Skip to content

Kafka Protocol

Bases: ABC

Interface for Kafka connection Protocol classes.

.. versionadded:: 0.9.0

Source code in onetl/connection/db_connection/kafka/kafka_protocol.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class KafkaProtocol(ABC):
    """
    Interface for Kafka connection Protocol classes.

    .. versionadded:: 0.9.0
    """

    @abstractmethod
    def get_options(self, kafka: Kafka) -> dict:
        """
        Get options for Kafka connection

        Parameters
        ----------
        kafka : :obj:`Kafka <onetl.connection.db_connection.kafka.connection.Kafka>`
            Connection instance

        Returns
        -------
        dict:
            Kafka client options
        """
        ...

    @abstractmethod
    def cleanup(self, kafka: Kafka) -> None:
        """
        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
        """
        ...

cleanup(kafka) abstractmethod

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

Source code in onetl/connection/db_connection/kafka/kafka_protocol.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
@abstractmethod
def cleanup(self, kafka: Kafka) -> None:
    """
    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) abstractmethod

Get options for Kafka connection

Parameters

kafka : :obj:Kafka <onetl.connection.db_connection.kafka.connection.Kafka> Connection instance

Returns

dict: Kafka client options

Source code in onetl/connection/db_connection/kafka/kafka_protocol.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@abstractmethod
def get_options(self, kafka: Kafka) -> dict:
    """
    Get options for Kafka connection

    Parameters
    ----------
    kafka : :obj:`Kafka <onetl.connection.db_connection.kafka.connection.Kafka>`
        Connection instance

    Returns
    -------
    dict:
        Kafka client options
    """
    ...