Shared Utility Options

These utility options are available across the functional areas of the streaming data configuration utility.

Option Description
--config-schema schema_name

Identifier for the Vertica schema. This value is the same name as the scheduler. You use this name to identify the scheduler during configuration.

Default Value:

stream_config

--help Prints out a help menu listing available options with a description.
--version Displays the version number of the scheduler.
--dbhosthost name

The host name or IP address of the Vertica node acting as the initiator node for the scheduler.

Default Value:

localhost

--dbportport_number

The port to use to connect to a Vertica database.

Default Value:

5433

--username username

The Vertica database user.

Default Value:

Current user

--password password Password for the database user.
--jdbc-url url A complete JDBC URL that overrides other database connection parameters.
--conf filename

A properties file (.properties) that contains configuration details for the CLI command. The configuration file follows the standard java properties file format.

Using a properties file is helpful for options that do not change across CLI commands.

Any additional options added at the command line override parameters set in the properties file.

The configuration file supports all Kafka properties. For a list of properties, refer to kafka.apache.org/08/configuration.html.

--create Creates a new instance of the supplied type. Renamed from --add.
--update Updates an existing instance of the supplied type. Renamed from --edit.
--delete Delete an instance of the supplied type. Renamed from --remove.

Examples

These examples show how you can use the shared utility options.

Display help for the scheduler utility:

/opt/vertica/packages/kafka/bin/vkconfig scheduler --help
PARAMETER      REQUIRED #ARGS    DESCRIPTION
conf           no       1        Allow the use of a properties file to associate parameter keys and values. This file enables command string reuse and cleaner command strings.
help           no       0        Outputs a help context for the given subutility.
version        no       0        Outputs the current Version of the scheduer.

Use a property file to store parameters for the utility. You can override any stored parameter from the command line:

#config.properties:
username=myuser
password=mypassword
dbhost=localhost
dbport=5433
 
/opt/vertica/packages/kafka/bin/vkconfig source --update --conf config.properties