Skip to content

Connect to Kafka

Connect to kafka using the KafkaStreamingClient class provided by the library. This is a Kafka specific client implementation that requires some explicit configuration but allows you to connect to any Kafka cluster even outside Quix SaaS.

When your broker requires no authentication, you can use the following code to create a client to connect to it:

from quixstreams import KafkaStreamingClient

client = KafkaStreamingClient('')
var client = new QuixStreams.Streaming.KafkaStreamingClient("");

If your broker is secured, the library provides easy authentication when using username and password with an optional certificate to validate server identity. The following code shows you how to set up the SecurityOptions for your connection and how to create a KafkaStreamingClient instance to start subscribing to topics and publishing time series data:

Set up the SecurityOptions for your connection

from quixstreams import SecurityOptions, KafkaStreamingClient

client = KafkaStreamingClient('', security)  # additional details can be set using `properties=`
var security = new SecurityOptions(CERTIFICATES_FOLDER, QUIX_USER, QUIX_PASSWORD);
var client = new QuixStreams.Streaming.KafkaStreamingClient("", security);

Connect to Quix

Quix Streams comes with a streaming client that enables you to connect to Quix SaaS topics easily. The streaming client manages the connections between your application and Quix and makes sure that the data is delivered reliably to and from your application. You can still use KafkaStreamingClient and manually set details, but QuixStreamingClient is a much easier way to connect.

Using QuixStreamingClient

QuixStreamingClient handles the cumbersome part of setting up your streaming credentials using the Quix API. When you’re running the app in our online IDE or as a Quix deployment, all you have to do is the following:

Initialize the Client

from quixstreams import QuixStreamingClient

client = QuixStreamingClient()
var client = new QuixStreams.Streaming.QuixStreamingClient();

If you wish to run the same code locally, you’ll have to provide an OAuth2.0 bearer token. We have created a purpose made token for this, called SDK token. Once you have the token you will have to provide it as an argument to QuixStreamingClient or set Quix__Sdk__Token environment variable.

Initialize the Client with a token

from quixstreams import QuixStreamingClient

client = QuixStreamingClient('your_token')
var client = new QuixStreams.Streaming.QuixStreamingClient("your_token");