confluent load

Description

Load a bundled connector with a predefined name or a custom connector.

Usage

confluent load [<connector-name> [-d <connector-config-file>]]

Tip

For usage information, enter confluent help load.

Options

Name, shorthand Default Description
-d <connector-config-file>   Specify a custom connector.

Positional arguments

Name, shorthand Default Description
<connector-config-file>   The configuration file. The file must be formatted as a valid JSON or Java properties file and must contain a correct configuration for a connector whose name matches the one specified in the command-line.
<connector-name>   The connector name. If only the connector name is specified, the connector configuration is printed.

Example

Load a predefined connector:

confluent load s3-sink

Your output should resemble:

{
  "name": "s3-sink",
  "config": {
    "connector.class": "io.confluent.connect.s3.S3SinkConnector",
    "tasks.max": "1",
    "topics": "s3_topic",
    "s3.region": "us-west-2",
    "s3.bucket.name": "confluent-kafka-connect-s3-testing",
    "s3.part.size": "5242880",
    "flush.size": "3",
    "storage.class": "io.confluent.connect.s3.storage.S3Storage",
    "format.class": "io.confluent.connect.s3.format.avro.AvroFormat",
    "schema.generator.class": "io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator",
    "partitioner.class": "io.confluent.connect.storage.partitioner.DefaultPartitioner",
    "schema.compatibility": "NONE",
    "name": "s3-sink"
  },
  "tasks": [],
  "type": null
}

Tip

You can view all available connectors with the confluent list command. For more information, see the connectors documentation.