Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

confluent local unload

Description

Unload a connector.

Important

The confluent local commands are intended for a single-node development environment and are not suitable for a production environment. The data that are produced are transient and are intended to be temporary. For production-ready workflows, see Install and Upgrade Confluent Platform.

confluent local unload -- [<connector-name>] --path <path-to-confluent>

Caution

You must include a double dash (--) between the topic name and your flag. For more information, see this post.

Flags

Tip

You must either specify the path for each Confluent CLI confluent local command invocation, export the path as an environment variable for each terminal session, or set the path to your Confluent Platform installation in your shell profile. For example:

cat ~/.bash_profile
export CONFLUENT_HOME=<path-to-confluent>
export PATH="${CONFLUENT_HOME}/bin:$PATH"
Name, shorthand Description
--path <path-to-confluent> Path to Confluent Platform install directory.
-h, --help Print command information.

Positional arguments

Name, shorthand Default Description
<connector-name>   The connector name.

Examples

Run this command to unload the s3-sink connector:

confluent local unload s3-sink