faststream-sqlbroker

A SQL-backed broker for FastStream. Documentation.

Transactional outbox

Implementing the transactional outbox pattern becomes as simple as the following.

Publish messages transactionally with your other database operations.

from sqlalchemy.ext.asyncio import create_async_engine

from faststream import FastStream
from faststream.kafka import KafkaBroker, KafkaPublishMessage

from faststream_sqlbroker import SqlBroker, SqlBrokerMessage

engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/mydb")
broker_sqlbroker = SqlBroker(engine=engine)
broker_kafka = KafkaBroker("127.0.0.1:9092")
app = FastStream(broker_sqlbroker, on_startup=[broker_kafka.connect])
publisher_sqlbroker = broker_sqlbroker.publisher()


@app.after_startup # just an example
async def publish_examples():
    async with engine.begin() as connection:
        # ... your other database operations using `connection` ...
        await publisher_sqlbroker.publish(
            {"message": "Hello, SqlBroker!"},
            queue="sqlbroker_queue",
            headers={
                "x-test-header": "outbox",
                "x-kafka-key-source": "outbox-key",
            },
            connection=connection,
        )

And relay the messages from the database to another broker.

publisher_kafka = broker_kafka.publisher("kafka_topic")


@publisher_kafka
@broker_sqlbroker.subscriber(
    queues=["sqlbroker_queue"],
    max_fetch_interval=1,
    fetch_batch_size=10,
    flush_interval=3,
)
async def handle_msg(
    msg_body: dict,
    msg: SqlBrokerMessage,
) -> KafkaPublishMessage:
    return KafkaPublishMessage(
        msg_body,
        headers={
            "x-test-header": msg.headers["x-test-header"],
        },
        key=msg.headers["x-kafka-key-source"].encode(),
    )

Origins

Originated as a PR to FastStream.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

faststream_sqlbroker-0.1.0a11.tar.gz (27.6 kB view details)

Uploaded Aug 14, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

faststream_sqlbroker-0.1.0a11-py3-none-any.whl (44.2 kB view details)

Uploaded Aug 14, 2026 Python 3

File details

Details for the file faststream_sqlbroker-0.1.0a11.tar.gz.

File metadata

Download URL: faststream_sqlbroker-0.1.0a11.tar.gz
Upload date: Aug 14, 2026
Size: 27.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for faststream_sqlbroker-0.1.0a11.tar.gz
Algorithm	Hash digest
SHA256	`8e8038268b44d547cc7070ceded4f3f119986450b7391c244068971350920e27`
MD5	`1fa0313f898416c7290482bc2cb4c668`
BLAKE2b-256	`ee241ddb1cb3a2043f670443f9ae938d1da09494ca65b36b3f6e59a1b34f2616`

See more details on using hashes here.

Provenance

The following attestation bundles were made for faststream_sqlbroker-0.1.0a11.tar.gz:

Publisher: release_pypi.yaml on faststream-community/faststream-sqlbroker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: faststream_sqlbroker-0.1.0a11.tar.gz
- Subject digest: 8e8038268b44d547cc7070ceded4f3f119986450b7391c244068971350920e27
- Sigstore transparency entry: 2465949612
- Sigstore integration time: Aug 14, 2026
Source repository:
- Permalink: faststream-community/faststream-sqlbroker@695c6390ba95378fdd4fd298b98b7e8655e4cacb
- Branch / Tag: refs/tags/v0.1.0a11
- Owner: https://github.com/faststream-community
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release_pypi.yaml@695c6390ba95378fdd4fd298b98b7e8655e4cacb
- Trigger Event: release