suburl

Overview ¶

Package suburl provides a generic URL based interface for obtaining substrate source and sink objects.

Usage ¶

An example of obtaining a nats streaming source is shown below.

source, err := suburl.NewSource("nats-streaming://localhost:4222/my-subject?cluster-id=foo&consumer-id=bar")
if err != nil {
        // error handling
}
defer source.Close()

// use source here

Here is an example of obtaining a kafka sink.

sink, err := suburl.NewSink("kafka://localhost:9092/my-topic/?broker=localhost%3A9092&broker=localhost%3A9092")
if err != nil {
        // error handling
}
defer sink.Close()

// use sink here

To use a particular url scheme, the driver has to be registered, for example:

import _ "github.com/charlie/substrate/kafka"

More complete documentation of options ¶

For a full description of the url options available for each scheme, see the documentation for the particular driver, for example https://godoc.org/github.com/charlie/substrate/kafka or https://godoc.org/github.com/charlie/substrate/natsstreaming.