kafka-metamorphosis.dev — org.clojars.caioclavico/kafka-metamorphosis 0.4.3

Development utilities and configurations

cluster-info clj

(cluster-info)

Get information about the local Kafka cluster

delete-dev-topic clj

(delete-dev-topic topic-name)

Delete a development topic (use with caution!)

describe-dev-topic clj

(describe-dev-topic topic-name)

Describe a topic with detailed information

get-compose-config clj

(get-compose-config mode)

Get docker-compose configuration based on mode.

Modes: :kraft (default) - Kafka with KRaft (no Zookeeper) + Kafka UI :simple - Simple KRaft setup (single container, faster startup, no UI)

Note: ZooKeeper mode was removed in Kafka 4.x and is no longer supported.

Usage: (get-compose-config :kraft) (get-compose-config :simple)

kafka-dev-setup! clj

(kafka-dev-setup!)

(kafka-dev-setup! mode-or-topics)

(kafka-dev-setup! mode topics)

Complete development setup: start Kafka, wait for it to be ready, and create common topics.

Usage: (kafka-dev-setup!) ; Default: KRaft mode with default topics (kafka-dev-setup! :kraft) ; KRaft mode with default topics (kafka-dev-setup! :simple) ; Simple KRaft mode with default topics (kafka-dev-setup! ["topic1" "topic2"]) ; KRaft mode with custom topics (kafka-dev-setup! :kraft ["topic1" "topic2"]) ; KRaft mode with custom topics

kafka-dev-teardown! clj

(kafka-dev-teardown!)

(kafka-dev-teardown! remove-volumes?)

Complete teardown: stop all services and optionally remove data.

Usage: (kafka-dev-teardown!) ; Stop services, keep data (kafka-dev-teardown! true) ; Stop services and remove all data

kafka-docker-down! clj

(kafka-docker-down!)

(kafka-docker-down! remove-volumes?)

Stop and remove Kafka services using Docker Compose.

Usage: (kafka-docker-down!) ; Stop services (kafka-docker-down! true) ; Stop services and remove volumes

kafka-docker-logs! clj

(kafka-docker-logs!)

(kafka-docker-logs! service)

(kafka-docker-logs! service follow?)

Show logs from Kafka Docker services.

Usage: (kafka-docker-logs!) ; Show all logs (kafka-docker-logs! "kafka") ; Show logs for specific service (kafka-docker-logs! "kafka" true) ; Follow logs for specific service

kafka-docker-restart! clj

(kafka-docker-restart!)

(kafka-docker-restart! service)

Restart Kafka Docker services.

Usage: (kafka-docker-restart!) ; Restart all services (kafka-docker-restart! "kafka") ; Restart specific service

kafka-docker-status clj

(kafka-docker-status)

Check the status of Kafka Docker services.

Usage: (kafka-docker-status)

kafka-docker-up! clj

(kafka-docker-up!)

(kafka-docker-up! mode-or-content)

Start Kafka and related services using Docker Compose. Generates docker-compose.yml if it doesn't exist.

Usage: (kafka-docker-up!) ; Use default (kraft) configuration (kafka-docker-up! :kraft) ; Use KRaft mode (Kafka + UI) (kafka-docker-up! :simple) ; Use simple KRaft mode (kafka-docker-up! custom-compose-content) ; Use custom configuration string

kafka-setup-kraft! clj

(kafka-setup-kraft!)

(kafka-setup-kraft! topics)

Complete setup with KRaft mode (Kafka 4.x).

Usage: (kafka-setup-kraft!) ; Setup with default topics (kafka-setup-kraft! ["topic1"]) ; Setup with custom topics

kafka-setup-simple! clj

(kafka-setup-simple!)

(kafka-setup-simple! topics)

Complete setup with simple KRaft mode. Minimal, fastest setup.

Usage: (kafka-setup-simple!) ; Setup with default topics (kafka-setup-simple! ["topic1"]) ; Setup with custom topics

kafka-up-kraft! clj

(kafka-up-kraft!)

Start Kafka with KRaft mode. Modern Kafka architecture (Kafka 4.x, no Zookeeper).

Usage: (kafka-up-kraft!) ; Start with KRaft + Kafka UI

kafka-up-simple! clj

(kafka-up-simple!)

Start Kafka with simple KRaft mode. Minimal setup, fastest startup, no UI.

Usage: (kafka-up-simple!) ; Start minimal Kafka only

kraft-docker-compose clj

Docker compose configuration for Kafka with KRaft (no Zookeeper)

kraft-simple-docker-compose clj

Simple Kafka KRaft configuration for quick development

list-all-topics clj

(list-all-topics)

List all topics in the local Kafka cluster

local-kafka-config clj

Standard configuration for local Kafka development

quick-admin clj

(quick-admin)

Create an admin client for quick testing

quick-consumer clj

(quick-consumer group-id)

Create a consumer client for quick testing

quick-producer clj

(quick-producer)

Create a producer client for quick testing

read-test-messages clj

(read-test-messages topic-name & [group-id])

Read messages from a topic and print them

send-test-messages clj

(send-test-messages topic-name & [num-messages])

Send a few test messages to a topic

setup-dev-topic clj

(setup-dev-topic topic-name & [options])

Create a development topic with sensible defaults

string-consumer-config clj

Consumer config for string key/value deserialization

string-producer-config clj

Producer config for string key/value serialization

wait-for-kafka clj

(wait-for-kafka)

(wait-for-kafka timeout-seconds)

Wait for Kafka to be ready by checking if we can connect. Returns true if Kafka is ready, false if timeout.

write-docker-compose! clj

(write-docker-compose!)

(write-docker-compose! mode-or-content)

Generate a docker-compose.yml file in the project root.

Usage: (write-docker-compose!) ; Use default (kraft) configuration (write-docker-compose! :kraft) ; Use KRaft mode (Kafka + UI) (write-docker-compose! :simple) ; Use simple KRaft mode (Kafka only) (write-docker-compose! custom-content) ; Use custom configuration string