Skip to main content
Version: 2.3.1

How to manage data streams with queries

The following page instructs how to manage streams using queries. Streams can also be managed through the Stream section in the Memgraph Lab.

If you need a Kafka stream to play around with, we've provided some at Awesome Data Stream!

Related - Reference Guide Related -
Tutorial

How to create and load a transformation module into Memgraph?

A transformation module is a set of user-defined transformation procedures written in C or Python that act on data received from a streaming engine. Transformation procedures instruct Memgraph on how to transform the incoming messages to consume them correctly.

To create a transformation module, you need to:

  1. Create a Python or a shared library file (module).
  2. Save the file into the Memgraph's query_modules or internal_modules directory (default: /usr/lib/memgraph/query_modules and /var/lib/memgraph/internal_modules/).
  3. Load the file into Memgraph either on startup (automatically) or by running a CALL mg.load_all(); query.

If you are using Docker to run Memgraph, check how to transfer the file into the container.

If you are using Memgraph Lab you can create transformation module within the application.

How to create a Kafka or Redpanda stream?

In order to create a stream with a query, first you need to load the transformation module into Memgraph. The most basic query for creating a stream is:

CREATE KAFKA STREAM streamName
TOPICS topic1[, <topic2>, ...]
TRANSFORM transModule.transProcedure
BOOTSTRAP_SERVERS bootstrapServers;

Additional options for creating a stream are explained in the reference guide.

How to create a Pulsar stream?

In order to create a stream with a query, first you need to load the transformation module into Memgraph. The most basic query for creating a stream is:

CREATE PULSAR STREAM streamName
TOPICS topic1[,topic2, ...]
TRANSFORM transModule.transProcedure
SERVICE_URL serviceURL;

Additional options for creating a stream are explained in the reference guide.

How to get information about a stream?

You can get the basic stream information with:

SHOW STREAMS;

How to check the transformed incoming data?

To see the results of the transformation module use the CHECK STREAM clause. It will consume the message from the last committed offset but won't commit the offsets. There is no committed offset coming from a newly created stream, so by default, the query will wait 30000 milliseconds (30 seconds) for new messages and after that, it will throw a timeout exception. You can change the timeout by adding the TIMEOUT sub-clause and adding a custom time to the query.

The following query will transform new messages that come from the stream within 60 seconds:

CHECK STREAM myStream TIMEOUT 60000;

To consume more batches, increase the BATCH_LIMIT:

CHECK STREAM myStream BATCH_LIMIT 3 TIMEOUT 60000;

How to start, stop or delete a stream?

To start a stream:

START STREAM streamName;

To stop a stream:

STOP STREAM streamName;

To delete a stream:

DROP STREAM streamName;

For more options, check the reference guide.

How to change Kafka stream offset?

Use the following query to change Kafka stream offset:

CALL mg.kafka_set_stream_offset(streamName, offset)

An offset of -1 denotes the beginning offset available for the given topic/partition.

An offset of -2 denotes the end of the stream and only the next produced message will be consumed.