How to use Pulsar connectors

This guide describes how to use Pulsar connectors.

Install a connector

Pulsar bundles several built-in 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-built-in connectors.

Use - 图1note

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

To set up a built-in connector, follow the instructions.

After the setup, the built-in 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 built-in connector

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

Example

Set the ./connectors folder as the default storage location for built-in connectors.

  1. ########################
  2. # Connectors
  3. ########################
  4. 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

  1. tenant: public
  2. namespace: default
  3. name: cassandra-test-sink
  4. ...
  5. # cassandra specific config
  6. configs:
  7. roots: "localhost:9042"
  8. keyspace: "pulsar_test_keyspace"
  9. columnFamily: "pulsar_test_table"
  10. keyname: "key"
  11. columnName: "col"

Example 2

Below is a YAML configuration file of a Kafka source.

  1. configs:
  2. bootstrapServers: "pulsar-kafka:9092"
  3. groupId: "test-pulsar-io"
  4. topic: "my-topic"
  5. sessionTimeoutMs: "10000"
  6. autoCommitEnabled: "false"

Example 3

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

  1. configs:
  2. userName: "postgres"
  3. password: "password"
  4. jdbcUrl: "jdbc:postgresql://localhost:5432/test_jdbc"
  5. tableName: "test_jdbc"

Prepare a connector

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 built-in connector before using it.

Source

To reload source connectors, you can use the reload subcommand.

  1. pulsar-admin sources reload

For the latest and complete information, see Pulsar admin docs.

Sink

To reload sink connectors, you can use the reload subcommand.

  1. pulsar-admin sinks reload

For the latest and complete information, see Pulsar admin docs.

available

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

Source

To get a list of source connectors, you can use the available-sources subcommand.

  1. pulsar-admin sources available-sources

Sink

To get a list of sink connectors, you can use the available-sinks subcommand.

  1. pulsar-admin sinks available-sinks

Run a connector

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

create

To create a connector, you can use Admin CLI, REST API or JAVA admin API.

Source

To create a source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the create subcommand.

  1. pulsar-admin sources create options

For the latest and complete information, see Pulsar admin docs.

Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}

  • Create a source connector with a local file.

    1. void createSource(SourceConfig sourceConfig,
    2. String fileName)
    3. throws PulsarAdminException

    Parameter

    NameDescription
    sourceConfigThe source configuration object

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see createSource.

  • Create a source connector using a remote file with a URL from which fun-pkg can be downloaded.

    1. void createSourceWithUrl(SourceConfig sourceConfig,
    2. String pkgUrl)
    3. throws PulsarAdminException

    Supported URLs are http and file.

    Example

    Parameter

    ParameterDescription
    sourceConfigThe source configuration object
    pkgUrlURL from which pkg can be downloaded

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see createSourceWithUrl.

Sink

To create a sink connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the create subcommand.

  1. pulsar-admin sinks create options

For the latest and complete information, see Pulsar admin docs.

Send a POST request to this endpoint: POST /admin/v3/sinks/{tenant}/{namespace}/{sinkName}

  • Create a sink connector with a local file.

    1. void createSink(SinkConfig sinkConfig,
    2. String fileName)
    3. throws PulsarAdminException

    Parameter

    NameDescription
    sinkConfigThe sink configuration object

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see createSink.

  • Create a sink connector using a remote file with a URL from which fun-pkg can be downloaded.

    1. void createSinkWithUrl(SinkConfig sinkConfig,
    2. String pkgUrl)
    3. throws PulsarAdminException

    Supported URLs are http and file.

    Example

    Parameter

    ParameterDescription
    sinkConfigThe sink configuration object
    pkgUrlURL from which pkg can be downloaded

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see createSinkWithUrl.

start

To start a connector, you can use Admin CLI or REST API.

Source

To start a source connector, you can use the following commands.

  • Admin CLI
  • REST API

Use the start subcommand.

  1. pulsar-admin sources start options

For the latest and complete information, see Pulsar admin docs.

Sink

To start a sink connector, you can use the following commands:

  • Admin CLI
  • REST API

Use the start subcommand.

  1. pulsar-admin sinks start options

For the latest and complete information, see Pulsar admin docs.

localrun

To run a connector locally rather than deploying it on a Pulsar cluster, you can use Admin CLI

Source

To run a source connector locally, you can use the following command:

  • Admin CLI

Use the localrun subcommand.

  1. pulsar-admin sources localrun options

For the latest and complete information, see Pulsar admin docs.

Sink

To run a sink connector locally, you can use the following command:

  • Admin CLI

Use the localrun subcommand.

  1. pulsar-admin sinks localrun options

For the latest and complete information, see Pulsar admin docs.

Run a Pulsar Function before a sink connector

You can run a Pulsar Function in memory before a sink connector. For details, see PIP 193: Sink preprocessing Function. Running a Pulsar Function in memory before a sink connector provides lower latency, less I/O, and disk consumption than going through an intermediate topic. Use the --transform-function, --transform-function-classname and --transform-function-config options when creating the sink connector to configure the transform Function to run.

For the latest and complete information, see Pulsar admin sinks command docs.

Monitor a connector

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

get

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

Source

To get the information of a source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the get subcommand.

  1. pulsar-admin sources get options

For the latest and complete information, see Pulsar admin docs.

Send a GET request to this endpoint: GET /admin/v3/sources/{tenant}/{namespace}/{sourceName}

  1. SourceConfig getSource(String tenant,
  2. String namespace,
  3. String source)
  4. throws PulsarAdminException

Example

This is a sourceConfig.

  1. {
  2. "tenant": "tenantName",
  3. "namespace": "namespaceName",
  4. "name": "sourceName",
  5. "className": "className",
  6. "topicName": "topicName",
  7. "configs": {},
  8. "parallelism": 1,
  9. "processingGuarantees": "ATLEAST_ONCE",
  10. "resources": {
  11. "cpu": 1.0,
  12. "ram": 1073741824,
  13. "disk": 10737418240
  14. }
  15. }

This is a sourceConfig example.

  1. {
  2. "tenant": "public",
  3. "namespace": "default",
  4. "name": "debezium-mysql-source",
  5. "className": "org.apache.pulsar.io.debezium.mysql.DebeziumMysqlSource",
  6. "topicName": "debezium-mysql-topic",
  7. "configs": {
  8. "database.user": "debezium",
  9. "database.server.id": "184054",
  10. "database.server.name": "dbserver1",
  11. "database.port": "3306",
  12. "database.hostname": "localhost",
  13. "database.password": "dbz",
  14. "database.history.pulsar.service.url": "pulsar://127.0.0.1:6650",
  15. "value.converter": "org.apache.kafka.connect.json.JsonConverter",
  16. "database.whitelist": "inventory",
  17. "key.converter": "org.apache.kafka.connect.json.JsonConverter",
  18. "database.history": "org.apache.pulsar.io.debezium.PulsarDatabaseHistory",
  19. "pulsar.service.url": "pulsar://127.0.0.1:6650",
  20. "database.history.pulsar.topic": "history-topic2"
  21. },
  22. "parallelism": 1,
  23. "processingGuarantees": "ATLEAST_ONCE",
  24. "resources": {
  25. "cpu": 1.0,
  26. "ram": 1073741824,
  27. "disk": 10737418240
  28. }
  29. }

Exception

Exception nameDescription
PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
PulsarAdminException.NotFoundExceptionCluster doesn’t exist
PulsarAdminExceptionUnexpected error

For more information, see getSource.

Sink

To get the information of a sink connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the get subcommand.

  1. pulsar-admin sinks get options

For the latest and complete information, see Pulsar admin docs.

Send a GET request to this endpoint: GET /admin/v3/sinks/{tenant}/{namespace}/{sinkName}

  1. SinkConfig getSink(String tenant,
  2. String namespace,
  3. String sink)
  4. throws PulsarAdminException

Example

This is a sinkConfig.

  1. {
  2. "tenant": "tenantName",
  3. "namespace": "namespaceName",
  4. "name": "sinkName",
  5. "className": "className",
  6. "inputSpecs": {
  7. "topicName": {
  8. "isRegexPattern": false
  9. }
  10. },
  11. "configs": {},
  12. "parallelism": 1,
  13. "processingGuarantees": "ATLEAST_ONCE",
  14. "retainOrdering": false,
  15. "autoAck": true
  16. }

This is a sinkConfig example.

  1. {
  2. "tenant": "public",
  3. "namespace": "default",
  4. "name": "pulsar-postgres-jdbc-sink",
  5. "className": "org.apache.pulsar.io.jdbc.PostgresJdbcAutoSchemaSink",
  6. "inputSpecs": {
  7. "pulsar-postgres-jdbc-sink-topic": {
  8. "isRegexPattern": false
  9. }
  10. },
  11. "configs": {
  12. "password": "password",
  13. "jdbcUrl": "jdbc:postgresql://localhost:5432/pulsar_postgres_jdbc_sink",
  14. "userName": "postgres",
  15. "tableName": "pulsar_postgres_jdbc_sink"
  16. },
  17. "parallelism": 1,
  18. "processingGuarantees": "ATLEAST_ONCE",
  19. "retainOrdering": false,
  20. "autoAck": true
  21. }

Parameter description

NameDescription
tenantTenant name
namespaceNamespace name
sinkSink name

For more information, see getSink.

list

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

Source

To get the list of all running source connectors, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the list subcommand.

  1. pulsar-admin sources list options

For the latest and complete information, see Pulsar admin docs.

Send a GET request to this endpoint: GET /admin/v3/sources/{tenant}/{namespace}

  1. List<String> listSources(String tenant,
  2. String namespace)
  3. throws PulsarAdminException

Response example

  1. ["f1", "f2", "f3"]

Exception

Exception nameDescription
PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
PulsarAdminExceptionUnexpected error

For more information, see listSource.

Sink

To get the list of all running sink connectors, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the list subcommand.

  1. pulsar-admin sinks list options

For the latest and complete information, see Pulsar admin docs.

Send a GET request to this endpoint: GET /admin/v3/sinks/{tenant}/{namespace}

  1. List<String> listSinks(String tenant,
  2. String namespace)
  3. throws PulsarAdminException

Response example

  1. ["f1", "f2", "f3"]

Exception

Exception nameDescription
PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
PulsarAdminExceptionUnexpected error

For more information, see listSource.

status

To get the current status of a connector, you can use Admin CLI, REST API or JAVA admin API.

Source

To get the current status of a source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the status subcommand.

  1. pulsar-admin sources status options

For the latest and complete information, see Pulsar admin docs.

  • Get the current status of all source connectors.

    Send a GET request to this endpoint: GET /admin/v3/sources/{tenant}/{namespace}/{sourceName}/status

  • Gets the current status of a specified source connector.

    Send a GET request to this endpoint: GET /admin/v3/sources/{tenant}/{namespace}/{sourceName}/status

  • Get the current status of all source connectors.

    1. SourceStatus getSourceStatus(String tenant,
    2. String namespace,
    3. String source)
    4. throws PulsarAdminException

    Parameter

    ParameterDescription
    tenantTenant name
    namespaceNamespace name
    sinkSource name

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see getSourceStatus.

  • Gets the current status of a specified source connector.

    1. SourceStatus.SourceInstanceStatus.SourceInstanceStatusData getSourceStatus(String tenant,
    2. String namespace,
    3. String source,
    4. int id)
    5. throws PulsarAdminException

    Parameter

    ParameterDescription
    tenantTenant name
    namespaceNamespace name
    sinkSource name
    idSource instanceID

    Exception

    Exception nameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see getSourceStatus.

Sink

To get the current status of a Pulsar sink connector, you can use the following commads:

  • Admin CLI
  • REST API
  • Java Admin API

Use the status subcommand.

  1. pulsar-admin sinks status options

For the latest and complete information, see Pulsar admin docs.

  • Get the current status of all sink connectors.

    Send a GET request to this endpoint: GET /admin/v3/sinks/{tenant}/{namespace}/{sinkName}/status

  • Gets the current status of a specified sink connector.

    Send a GET request to this endpoint: GET /admin/v3/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/status

  • Get the current status of all sink connectors.

    1. SinkStatus getSinkStatus(String tenant,
    2. String namespace,
    3. String sink)
    4. throws PulsarAdminException

    Parameter

    ParameterDescription
    tenantTenant name
    namespaceNamespace name
    sinkSource name

    Exception

    Exception nameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see getSinkStatus.

  • Gets the current status of a specified source connector.

    1. SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkStatus(String tenant,
    2. String namespace,
    3. String sink,
    4. int id)
    5. throws PulsarAdminException

    Parameter

    ParameterDescription
    tenantTenant name
    namespaceNamespace name
    sinkSource name
    idSink instanceID

    Exception

    Exception nameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see getSinkStatusWithInstanceID.

Update a connector

update

To update a running connector, you can use Admin CLI, REST API or JAVA admin API.

Source

To update a running Pulsar source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the update subcommand.

  1. pulsar-admin sources update options

For the latest and complete information, see Pulsar admin docs.

Send a PUT request to this endpoint: PUT /admin/v3/sources/{tenant}/{namespace}/{sourceName}

  • Update a running source connector with a local file.

    1. void updateSource(SourceConfig sourceConfig,
    2. String fileName)
    3. throws PulsarAdminException

    Parameter

    NameDescription
    sourceConfigThe source configuration object

    Exception

    NameDescription
    PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
    PulsarAdminException.NotFoundExceptionCluster doesn’t exist
    PulsarAdminExceptionUnexpected error

    For more information, see updateSource.

  • Update a source connector using a remote file with a URL from which fun-pkg can be downloaded.

    1. void updateSourceWithUrl(SourceConfig sourceConfig,
    2. String pkgUrl)
    3. throws PulsarAdminException

    Supported URLs are http and file.

    Example

    Parameter

    NameDescription
    sourceConfigThe source configuration object
    pkgUrlURL from which pkg can be downloaded

    Exception

    NameDescription
    PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
    PulsarAdminException.NotFoundExceptionCluster doesn’t exist
    PulsarAdminExceptionUnexpected error

For more information, see createSourceWithUrl.

Sink

To update a running Pulsar sink connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the update subcommand.

  1. pulsar-admin sinks update options

For the latest and complete information, see Pulsar admin docs.

Send a PUT request to this endpoint: PUT /admin/v3/sinks/{tenant}/{namespace}/{sinkName}

  • Update a running sink connector with a local file.

    1. void updateSink(SinkConfig sinkConfig,
    2. String fileName)
    3. throws PulsarAdminException

    Parameter

    NameDescription
    sinkConfigThe sink configuration object

    Exception

    NameDescription
    PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
    PulsarAdminException.NotFoundExceptionCluster doesn’t exist
    PulsarAdminExceptionUnexpected error

    For more information, see updateSink.

  • Update a sink connector using a remote file with a URL from which fun-pkg can be downloaded.

    1. void updateSinkWithUrl(SinkConfig sinkConfig,
    2. String pkgUrl)
    3. throws PulsarAdminException

    Supported URLs are http and file.

    Example

    Parameter

    NameDescription
    sinkConfigThe sink configuration object
    pkgUrlURL from which pkg can be downloaded

    Exception

    NameDescription
    PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
    PulsarAdminException.NotFoundExceptionCluster doesn’t exist
    PulsarAdminExceptionUnexpected error

For more information, see updateSinkWithUrl.

Stop a connector

stop

To stop a connector, you can use Admin CLI, REST API or JAVA admin API.

Source

To stop a source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the stop subcommand.

  1. pulsar-admin sources stop options

For the latest and complete information, see Pulsar admin docs.

  • Stop all source connectors.

    Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}/stop

  • Stop a specified source connector.

    Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/stop

  • Stop all source connectors.

    1. void stopSource(String tenant,
    2. String namespace,
    3. String source)
    4. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see stopSource.

  • Stop a specified source connector.

    1. void stopSource(String tenant,
    2. String namespace,
    3. String source,
    4. int instanceId)
    5. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name
    instanceIdSource instanceID

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see stopSource.

Sink

To stop a sink connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the stop subcommand.

  1. pulsar-admin sinks stop options

For the latest and complete information, see Pulsar admin docs.

  • Stop all sink connectors.

    Send a POST request to this endpoint: POST /admin/v3/sinks/{tenant}/{namespace}/{sinkName}/stop

  • Stop a specified sink connector.

    Send a POST request to this endpoint: POST /admin/v3/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/stop

  • Stop all sink connectors.

    1. void stopSink(String tenant,
    2. String namespace,
    3. String sink)
    4. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see stopSink.

  • Stop a specified sink connector.

    1. void stopSink(String tenant,
    2. String namespace,
    3. String sink,
    4. int instanceId)
    5. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name
    instanceIdSource instanceID

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see stopSink.

Restart a connector

restart

To restart a connector, you can use Admin CLI, REST API or JAVA admin API.

Source

To restart a source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the restart subcommand.

  1. pulsar-admin sources restart options

For the latest and complete information, see Pulsar admin docs.

  • Restart all source connectors.

    Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}/restart

  • Restart a specified source connector.

    Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/restart

  • Restart all source connectors.

    1. void restartSource(String tenant,
    2. String namespace,
    3. String source)
    4. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see restartSource.

  • Restart a specified source connector.

    1. void restartSource(String tenant,
    2. String namespace,
    3. String source,
    4. int instanceId)
    5. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name
    instanceIdSource instanceID

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see restartSource.

Sink

To restart a sink connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the restart subcommand.

  1. pulsar-admin sinks restart options

For the latest and complete information, see Pulsar admin docs.

  • Restart all sink connectors.

    Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}/restart

  • Restart a specified sink connector.

    Send a POST request to this endpoint: POST /admin/v3/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/restart

  • Restart all Pulsar sink connectors.

    1. void restartSink(String tenant,
    2. String namespace,
    3. String sink)
    4. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sinkSink name

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see restartSink.

  • Restart a specified sink connector.

    1. void restartSink(String tenant,
    2. String namespace,
    3. String sink,
    4. int instanceId)
    5. throws PulsarAdminException

    Parameter

    NameDescription
    tenantTenant name
    namespaceNamespace name
    sourceSource name
    instanceIdSink instanceID

    Exception

    NameDescription
    PulsarAdminExceptionUnexpected error

    For more information, see restartSink.

Delete a connector

delete

To delete a connector, you can use Admin CLI, REST API or JAVA admin API.

Source

To delete a source connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the delete subcommand.

  1. pulsar-admin sources delete options

For the latest and complete information, see Pulsar admin docs.

Delete al Pulsar source connector.

Send a DELETE request to this endpoint: DELETE /admin/v3/sources/{tenant}/{namespace}/{sourceName}

Delete a source connector.

  1. void deleteSource(String tenant,
  2. String namespace,
  3. String source)
  4. throws PulsarAdminException

Parameter

NameDescription
tenantTenant name
namespaceNamespace name
sourceSource name

Exception

NameDescription
PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
PulsarAdminException.NotFoundExceptionCluster doesn’t exist
PulsarAdminException.PreconditionFailedExceptionCluster is not empty
PulsarAdminExceptionUnexpected error

For more information, see deleteSource.

Sink

To delete a sink connector, you can use the following commands:

  • Admin CLI
  • REST API
  • Java Admin API

Use the delete subcommand.

  1. pulsar-admin sinks delete options

For the latest and complete information, see Pulsar admin docs.

Delete a sink connector.

Send a DELETE request to this endpoint: DELETE /admin/v3/sinks/{tenant}/{namespace}/{sinkName}

Delete a Pulsar sink connector.

  1. void deleteSink(String tenant,
  2. String namespace,
  3. String source)
  4. throws PulsarAdminException

Parameter

NameDescription
tenantTenant name
namespaceNamespace name
sinkSink name

Exception

NameDescription
PulsarAdminException.NotAuthorizedExceptionYou don’t have the admin permission
PulsarAdminException.NotFoundExceptionCluster doesn’t exist
PulsarAdminException.PreconditionFailedExceptionCluster is not empty
PulsarAdminExceptionUnexpected error

For more information, see deleteSource.