Streams

You can use the information_schema.streams view to return information about each stream in your Firebolt account: Kafka streams as well as Postgres and MongoDB change data capture streams. The view contains one row for each stream. Use a SELECT query to return information about each stream as shown in the example below.

SELECT
  stream_name,
  stream_schema,
  stream_type,
  consumer_group,
  stream_owner,
  created
FROM
  information_schema.streams;

Columns in information_schema.streams

Each row has the following columns with information about each stream:

Column Name	Data Type	Description
stream_catalog	TEXT	The name of the database that contains the stream.
stream_schema	TEXT	The name of the schema that contains the stream.
stream_name	TEXT	The name of the stream.
stream_type	TEXT	The type of the stream source.
stream_owner	TEXT	The owner of the stream.
created	TIMESTAMPTZ	The timestamp when the stream was created.
ddl	TEXT	The `CREATE STREAM` statement used to create this stream, with credentials masked for security.
description	TEXT	Optional metadata describing the stream’s purpose.
consumer_group	TEXT	The Kafka consumer group identifier used by this stream. Kafka streams only.
offsets	TEXT	A JSON array of per-partition consumer offsets, for example `[{"partition_id":0,"offset":42}]`. Kafka streams only; Postgres streams track their position in the source replication slot, and MongoDB streams store a resume token. This column is only populated when explicitly selected.

Examples

View all streams

SELECT
  stream_name,
  stream_schema,
  stream_type,
  consumer_group,
  stream_owner,
  created
FROM
  information_schema.streams;

View stream offsets

The offsets column returns a JSON array with per-partition consumer offset positions. It is only populated when explicitly selected:

SELECT
  stream_name,
  offsets
FROM
  information_schema.streams
WHERE stream_name = 'my_stream';

Example output:

stream_name | offsets
------------|-------------------------------------------
my_stream   | [{"partition_id":0,"offset":150},{"partition_id":1,"offset":200}]

View stream DDL

The ddl column contains the original CREATE STREAM statement with credentials masked:

SELECT
  stream_name,
  ddl
FROM
  information_schema.streams;

Filter streams by schema

SELECT
  stream_name,
  stream_type,
  consumer_group,
  created
FROM
  information_schema.streams
WHERE stream_schema = 'public'
ORDER BY created DESC;

Notes

All identifiers are case-insensitive unless enclosed in double-quotes.
The offsets column is lazily evaluated and only populated when explicitly included in the SELECT list.
The ddl column masks credential values for security.
For more information about object identifiers, see Object identifiers.

Overview

Performance and Observability

Security

Self-Managed

Managed service

Guides

SQL reference

Release notes

API reference

Legal

Columns in information_schema.streams

Examples

View all streams

View stream offsets

View stream DDL

Filter streams by schema

Notes

​Columns in information_schema.streams

​Examples

​View all streams

​View stream offsets

​View stream DDL

​Filter streams by schema

​Notes

Columns in information_schema.streams

Examples

View all streams

View stream offsets

View stream DDL

Filter streams by schema

Notes