Important

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

confluent local config¶

Description¶

Use this command to view or set connector configuration properties.

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 config <connector-name> -- [ -d <connector-config-file> ] --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	Default	Description
`-d <connector-config-file>`		Specify a custom connector.
`--path <path-to-confluent>`		Path to Confluent Platform install directory.
`-h, --help`		Print command information.
`-v, --verbose`		Increase verbosity (`-v` for warn, `-vv` for info, `-vvv` for debug, `-vvvv` for trace).

Positional arguments¶

Name, shorthand	Default	Description
`<connector-config-file>`		The configuration file. The file must be formatted as valid JSON or Java 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.
<path-to-confluent>		The relative path to Confluent Platform. You can also define this as an environment variable named `CONFLUENT_HOME`.

Examples¶

Print the current configuration of a connector named s3-sink:
```
confluent local config s3-sink
```

Configure a connector named wikipedia-file-source by passing its configuration properties in JSON format.

confluent local config wikipedia-file-source -d <path-to-connector>/wikipedia-file-source.json \
--path <path-to-confluent>

Configure a connector named wikipedia-file-source by passing its configuration properties as Java properties.

confluent local config wikipedia-file-source -d <path-to-connector>/wikipedia-file-source.properties \
--path <path-to-confluent>