16.10 - Initialization Strings - Access Module

Teradata Tools and Utilities Access Module Reference

prodname
Access Module
vrm_release
16.10
created_date
July 2017
category
Programming Reference
featnum
B035-2425-077K

Following are the initialization strings for loading and exporting data using the Teradata Access Module for Kafka.

An initialization string consists of a series of keyword and value pairs separated by blanks. Each keyword is preceded by a hyphen, and is not case-sensitive. The value is either an integer or a string.

Initialization Strings

where the following is true:

-WAIT
The number of seconds KAFKA AXSMOD will wait to read data when it receives an end of message error from the Kafka Server.
-TRACELEVEL
Sets the level of detail to be posted to the log file, where the following is true:
  • 0 : Disabled – No logging. This is the default if tracelevel is not specified.
  • 1 : Events – Events/Requests received by Kafka Axsmod from application.
  • 2 : Info – Provides the imported or exported message lengths and performance-related information.
  • 3 : ALL – Provides the hexadecimal dump of data which passed through the Teradata Access Module for Kafka.
-TOPIC
Takes a name of Topic or Feed maintained by the Kafka Server.
-TIMEOUT
Sets the timeout time of APIs provided by the Librdkafka library. The default value is 100ms.
-SYNCMODE
This parameter is applicable in export scenario. If -SYNCMODE=Y then Kafka Axsmod will be a synchronous producer else it will be an asynchronous producer.
-SHOWP
Displays the server properties. It will create a file named props in the working directory. The props file contains the configuration properties and their descriptions. The configuration properties listed in the props file can be set using the -CONFIG option of the Teradata Access Module for Kafka.
-PARTITION
Message queues are maintained under Topic, and referred as partitions. This parameter takes the partition numbers. For example, if -PARTITION 0 is specified in the initialization string, Kafka Axsmod will read only from partition 0. Or, if -PARTITION 0,1,2,3 is specified, Kafka Axsmod will read form partition 0, partition 1, partition 2, and partition 3 under the Topic.
An alternative syntax can also be used, specifying -PARTITION [0-3] to instruct Kafka Axsmod to read from partition 0,partition 1, partition 2, and partition 3 under the Topic.
-MODE
An application can be a consumer of data or producer of data. -MODE specifies the application category. It accepts two values:
  • P – represents producer
  • C – represents consumer
-CONFIG
Using this parameter, you can set the configuration properties at server side. For example, if -CONFIG compression.codec=gzip is specified in the initialization string, then gzip message compression will be enabled in the export scenario and message decompression from gzip compression will be enabled in the import scenario.
-BROKERS
Kafka is a cluster of one or more servers. Each server is called a broker. This parameter takes the broker_ip_address:port of the leader broker. You can specify multiple brokers using a "," separator in a multi-broker environment. For example: broker1_ip_address:port,broker2_ip_address:port,broker3_ip_address:port is a valid value for the -BROKERS keyword.
-BLOCKSIZE
The block size, in bytes, of the data transfer operation, where n can be between 1000 bytes to 16MB. The default, if you do not specify the block_size parameter, is 1MB.
-BATCHMODE
This parameter is applicable in the import scenario. If -BATCHMODE=Y, then Kafka Axsmod will fetch messages in batches. Otherwise, it will fetch a single message in every read request.