Skip to main content
Version: 3.3.x

Set up Pulsar Go client library

To set up Go client library in Pulsar, complete the following steps.

Step 1: Install Go client library​

You can install the pulsar library by using either go get or go module.

Use go get​

  1. Download the library of Go client to your local environment:

    go get -u "github.com/apache/pulsar-client-go/pulsar"
  2. Import it into your project:

    import "github.com/apache/pulsar-client-go/pulsar"

Use go module​

  1. Create a directory named test_dir and change your working directory to it.

    mkdir test_dir && cd test_dir
  2. Write a sample script (such as test_example.go) in the test_dir directory and write package main at the beginning of the file.

    go mod init test_dir
    go mod tidy && go mod download
    go build test_example.go
    ./test_example

Step 2: Connect to Pulsar cluster​

To connect to Pulsar using client libraries, you need to specify a Pulsar protocol URL.

You can assign Pulsar protocol URLs to specific clusters and use the pulsar scheme. The following is an example of localhost with the default port 6650:

pulsar://localhost:6650

If you have multiple brokers, separate IP:port by commas:

pulsar://localhost:6550,localhost:6651,localhost:6652

If you use mTLS authentication, add +ssl in the scheme:

pulsar+ssl://pulsar.us-west.example.com:6651