Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Connectors

One page per connector: purpose, practical examples, and the same settings in both forms — as a mqb copy URL and as a YAML endpoint for config files and the library. The nested Parameters page under each connector lists every field (type, default, description), generated from the same schema the engine uses.

From URL to config

A URL’s query parameters are config fields of the same name. The scheme picks the config key, and the part before the query string becomes url (or path):

URL schemeConfig keyurl / path in config
kafka://host:9092kafkaurl: "host:9092" (bare host list)
nats://host:4222natsurl: "nats://host:4222"
amqp://, rabbitmq://amqpurl: "amqp://host:5672/%2f"
mqtt://, mqtts://mqtturl: "mqtt://host:1883"
redis://, rediss://, redis+unix://, valkey(s)://, valkey+unix://redis_streamsurl: "redis://host:6379"
postgres://, mysql://, sqlite://sqlxthe connection string as url
postgres-cdc://, pgcdc://postgres_cdcurl: "postgres://…"
mongodb://, mongodb+srv://mongodburl: "mongodb://host:27017"
clickhouse://, clickhouses://clickhouseurl: "http://host:8123" / https://
http-bulk:?config_file=<path>http_bulknested config from a file, or inline with config=<YAML or JSON>
typesense://host:8108/<collection>, elasticsearch://host:9200/<index>, qdrant://host:6333/<collection>the endpoint of that name+https in the scheme for HTTPS; see Typesense, Elasticsearch, Qdrant
openai://host?model=…&prompt=…, openai-embeddings://host?model=…&input=…openai_chat / openai_embeddings+https in the scheme for HTTPS; see OpenAI-compatible APIs
http://, https://httpunchanged
ws://, wss://websocketunchanged
grpc://, grpcs://grpcurl: "http://host:50051" / https://
zeromq://, zmq://zeromqurl: "tcp://host:5555"
ibmmq://host:1414ibmmqurl: "host(1414)"
aws://awsno url; queue_url / topic_arn
file:///pathfilepath: "/path"
dir-spool:///pathdir_spoolpath: "/path"
s3://, gs://, az://, local-store://object_storeurl: "s3://bucket/prefix", "gs://bucket/prefix", "az://container/prefix" (local-store:// → file://); credentials come from the environment

So kafka://localhost:9092?topic=orders&group_id=sync becomes:

kafka: { url: "localhost:9092", topic: "orders", group_id: "sync" }

Transport behaviour shared by all connectors — consumer vs. subscriber, nack support, CDC vs. polling, file formats, plugins — is on Overview & capabilities.

All connectors