The CLI can create, modify, pause, restart and remove Lenses SQL Processors.

View processors

View all processors registered. Optionally filter by name, cluster and namespace.

Create processors

For IN_PROC you only need the name, for KUBERNETES all three. Creating an IN_PROC processor will start it automatically. This is not the case for Kubernetes deployments, a start command (see below) is required once created.

• --id (the processor id, optional)

• --name (optional)

• --cluster-name (should be passed if KUBERNETES)

• --namespace (should be passed if KUBERNETES)

• --runners (number of times to deploy while in KUBERNETES)

From a file:

Stop a processor

For IN_PROC you only need the name, for KUBERNETES all three:

Start a processor

For IN_PROC you only need the name, for KUBERNETES all three:

Update the number of runners

Update a processor from the command line flags or files. Only for KUBERNETES:

From a file.

Delete a processor

Delete a processor by name, cluster and namespace. For IN_PROC you only need the name, and for KUBERNETES all 3 (name, cluster, namespace).

View processors logs

Available only for KUBERNETES.

The CLI can create, modify, pause, restart and remove Apache Kafka Connect connectors.

View connectors

List the currently deployed connectors, optionally filter by name, cluster and namespace:

lenses-cli connectors --cluster-name="dev" 

#[[--names [--unwrap]]

The --names flag displays only the names of the connectors. When used with --unwrap, it will print each connector name on a separate line in the output.

List all the supported connectors

lenses-cli connectors --supported

View the available plugins per cluster

lenses-cli connectors plugins --cluster-name="dev"

Create connectors

lenses-cli connector create \
    --cluster-name="dev" \
    --name="connectorName" \
    --configs="{\"key\": \"value\"}"

From a file:

lenses-cli connector create ./connector.yaml

Example file:

clusterName: development
config:
  connector.class: "org.apache.kafka.connect.file.FileStreamSinkConnector"
  file: "/dev/null"
  tasks.max: "1"
  topics: "reddit_posts"
  name: "nullsink"

Update a connector

# Inline
lenses-cli connector update --name=nullsink --cluster-name=dev \
  --configs="{\"connector.class\":\"org.apache.kafka.connect.file.FileStreamSinkConnector\",\"file\":\"/dev/null\",\"name\":\"nullsink\",\"tasks.max\":\"8\",\"topics\":\"reddit_posts\"}"

# or from file
lenses-cli connector update ./connector.yaml

View the configuration of a connector

lenses-cli connector config \
    --cluster-name="dev" \
    --name="connectorName"

View the status of a connector

lenses-cli connector status \
    --cluster-name="dev" \
    --name="connectorName"

Pause a connector

lenses-cli connector pause \
    --cluster-name="dev" \
    --name="connectorName"

Resume a connector

lenses-cli connector resume \
    --cluster-name="dev" \
    --name="connectorName"