Important

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

confluent local list¶

Description¶

List all available services or plugins.

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 list [ plugins | connectors ] --path <path-to-confluent>

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
`plugins`	Print all discoverable connector-plugins that are in the current Confluent Platform deployment.
`connectors`	Print connector names that map to predefined connectors. The configuration files are located in the `<path-to-confluent>/etc/` directory in Confluent Platform.
`--path <path-to-confluent>`	Path to Confluent Platform install directory.
`-h, --help`	Print command information.

Examples¶

Print the available services.

confluent local list

Your output should resemble:

Available services:
  zookeeper
  kafka
  schema-registry
  kafka-rest
  connect

Print the available connector plugins (connector classes) that are discoverable at Connect runtime.

confluent local list plugins

Your output should resemble:

Available Connector Plugins:
[
  {
    "class": "io.confluent.connect.elasticsearch.ElasticsearchSinkConnector",
    "type": "sink",
    "version": "5.5.15"
  },
  {
    "class": "io.confluent.connect.hdfs.HdfsSinkConnector",
    "type": "sink",
    "version": "5.5.15"
  },
...

Print a list of predefined connectors.

confluent local list connectors

Your output should resemble:

Bundled Predefined Connectors (edit configuration under etc/):
  elasticsearch-sink
  file-source
  file-sink
  jdbc-source
  jdbc-sink
  hdfs-sink
  s3-sink