Skip to main content

terafoundation_kafka_connector / client

client

Functions

createClient()

Call Signature

createClient(config, logger, settings): Promise<KafkaConsumerResult>

Defined in: client/index.ts:28

settings contains a list of options to configure on the client.

{ options: {} // Options for the connector rdkafka_options: {} // Options for the node-rdkafka object. Valid options here are as defined by rdkafka topic_options: {} // Options as defined for rdkafka that are topic specific autoconnect: true // Whether the client should autoconnect or not. }

rdkafka settings: https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md

Parameters
ParameterType
configKafkaConnectorConfig
loggerLogger
settingsKafkaConsumerSettings
Returns

Promise<KafkaConsumerResult>

Call Signature

createClient(config, logger, settings): Promise<KafkaProducerResult>

Defined in: client/index.ts:33

settings contains a list of options to configure on the client.

{ options: {} // Options for the connector rdkafka_options: {} // Options for the node-rdkafka object. Valid options here are as defined by rdkafka topic_options: {} // Options as defined for rdkafka that are topic specific autoconnect: true // Whether the client should autoconnect or not. }

rdkafka settings: https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md

Parameters
ParameterType
configKafkaConnectorConfig
loggerLogger
settingsKafkaProducerSettings
Returns

Promise<KafkaProducerResult>

Call Signature

createClient(config, logger, settings): Promise<KafkaAdminResult>

Defined in: client/index.ts:38

settings contains a list of options to configure on the client.

{ options: {} // Options for the connector rdkafka_options: {} // Options for the node-rdkafka object. Valid options here are as defined by rdkafka topic_options: {} // Options as defined for rdkafka that are topic specific autoconnect: true // Whether the client should autoconnect or not. }

rdkafka settings: https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md

Parameters
ParameterType
configKafkaConnectorConfig
loggerLogger
settingsKafkaAdminSettings
Returns

Promise<KafkaAdminResult>