跳到主内容

How to use Pulsar connectors

This guide describes how to use Pulsar connectors.

Install a connector

Pulsar bundles several builtin connectors used to move data in and out of commonly used systems (such as database and messaging system). Optionally, you can create and use your desired non-builtin connectors.

note

When using a non-builtin connector, you need to specify the path of a archive file for the connector.

To set up a builtin connector, follow the instructions here.

After the setup, the builtin connector is automatically discovered by Pulsar brokers (or function-workers), so no additional installation steps are required.

Configure a connector

You can configure the following information:

Configure a default storage location for a connector

To configure a default folder for builtin connectors, set the connectorsDirectory parameter in the ./conf/functions_worker.yml configuration file.

Example

Set the ./connectors folder as the default storage location for builtin connectors.


########################
# Connectors
########################

connectorsDirectory: ./connectors

Configure a connector with a YAML file

To configure a connector, you need to provide a YAML configuration file when creating a connector.

The YAML configuration file tells Pulsar where to locate connectors and how to connect connectors with Pulsar topics.

Example 1

Below is a YAML configuration file of a Cassandra sink, which tells Pulsar:

  • Which Cassandra cluster to connect

  • What is the keyspace and columnFamily to be used in Cassandra for collecting data

  • How to map Pulsar messages into Cassandra table key and columns


tenant: public
namespace: default
name: cassandra-test-sink
...
# cassandra specific config
configs:
roots: "localhost:9042"
keyspace: "pulsar_test_keyspace"
columnFamily: "pulsar_test_table"
keyname: "key"
columnName: "col"

Example 2

Below is a YAML configuration file of a Kafka source.


configs:
bootstrapServers: "pulsar-kafka:9092"
groupId: "test-pulsar-io"
topic: "my-topic"
sessionTimeoutMs: "10000"
autoCommitEnabled: "false"

Example 3

Below is a YAML configuration file of a PostgreSQL JDBC sink.


configs:
userName: "postgres"
password: "password"
jdbcUrl: "jdbc:postgresql://localhost:5432/test_jdbc"
tableName: "test_jdbc"

Get available connectors

Before starting using connectors, you can perform the following operations:

reload

If you add or delete a nar file in a connector folder, reload the available builtin connector before using it.

Source

Use the reload subcommand.


$ pulsar-admin sources reload

For more information, see here.

Sink

Use the reload subcommand.


$ pulsar-admin sinks reload

For more information, see here.

available

After reloading connectors (optional), you can get a list of available connectors.

Source

Use the available-sources subcommand.


$ pulsar-admin sources available-sources

Sink

Use the available-sinks subcommand.


$ pulsar-admin sinks available-sinks

Run a connector

To run a connector, you can perform the following operations:

create

You can create a connector using Admin CLI, REST API or JAVA admin API.f

Source

Create a source connector.

Use the create subcommand.


$ pulsar-admin sources create options

For more information, see here.

Sink

Create a sink connector.

Use the create subcommand.


$ pulsar-admin sinks create options

For more information, see here.

start

You can start a connector using Admin CLI or REST API.

Source

Start a source connector.

Use the start subcommand.


$ pulsar-admin sources start options

For more information, see here.

Sink

Start a sink connector.

Use the start subcommand.


$ pulsar-admin sinks start options

For more information, see here.

localrun

You can run a connector locally rather than deploying it on a Pulsar cluster using Admin CLI.

Source

Run a source connector locally.

Use the localrun subcommand.


$ pulsar-admin sources localrun options

For more information, see here.

Sink

Run a sink connector locally.

Use the localrun subcommand.


$ pulsar-admin sinks localrun options

For more information, see here.

Monitor a connector

To monitor a connector, you can perform the following operations:

get

You can get the information of a connector using Admin CLI, REST API or JAVA admin API.

Source

Get the information of a source connector.

Use the get subcommand.


$ pulsar-admin sources get options

For more information, see here.

Sink

Get the information of a sink connector.

Use the get subcommand.


$ pulsar-admin sinks get options

For more information, see here.

list

You can get the list of all running connectors using Admin CLI, REST API or JAVA admin API.

Source

Get the list of all running source connectors.

Use the list subcommand.


$ pulsar-admin sources list options

For more information, see here.

Sink

Get the list of all running sink connectors.

Use the list subcommand.


$ pulsar-admin sinks list options

For more information, see here.

status

You can get the current status of a connector using Admin CLI, REST API or JAVA admin API.

Source

Get the current status of a source connector.

Use the status subcommand.


$ pulsar-admin sources status options

For more information, see here.

Sink

Get the current status of a Pulsar sink connector.

Use the status subcommand.


$ pulsar-admin sinks status options

For more information, see here.

Update a connector

update

You can update a running connector using Admin CLI, REST API or JAVA admin API.

Source

Update a running Pulsar source connector.

Use the update subcommand.


$ pulsar-admin sources update options

For more information, see here.

Sink

Update a running Pulsar sink connector.

Use the update subcommand.


$ pulsar-admin sinks update options

For more information, see here.

Stop a connector

stop

You can stop a connector using Admin CLI, REST API or JAVA admin API.

Source

Stop a source connector.

Use the stop subcommand.


$ pulsar-admin sources stop options

For more information, see here.

Sink

Stop a sink connector.

Use the stop subcommand.


$ pulsar-admin sinks stop options

For more information, see here.

Restart a connector

restart

You can restart a connector using Admin CLI, REST API or JAVA admin API.

Source

Restart a source connector.

Use the restart subcommand.


$ pulsar-admin sources restart options

For more information, see here.

Sink

Restart a sink connector.

Use the restart subcommand.


$ pulsar-admin sinks restart options

For more information, see here.

Delete a connector

delete

You can delete a connector using Admin CLI, REST API or JAVA admin API.

Source

Delete a source connector.

Use the delete subcommand.


$ pulsar-admin sources delete options

For more information, see here.

Sink

Delete a sink connector.

Use the delete subcommand.


$ pulsar-admin sinks delete options

For more information, see here.