Load Spec Tool Options

The vkconfig script's load spec tool lets you provide parameters for the COPY statement that loads streaming data. It accepts the following arguments in addition to the Common vkconfig Script Options.

Option	Description
`--load-spec` spec_name	A unique name for this copy load spec.
`--filters` `"`filter_name`"`	A Vertica FILTER chain containing all UDFilters for the COPY statement. For more information on filters, refer to Parsing Custom Formats.
`--message-max-bytes` max_message_size	Specifies the maximum size, in bytes, of a Kafka protocol batch message. Default Value: 25165824 Important: You may need to manually update this value if you created a scheduler using Vertica 9.1.0 or earlier. The meaning of Kafka's max.message.bytes setting changed between version 0.10 and 0.11. See Changes to the message.max.bytes Setting in Kafka Version 0.11 and Later for more information.
`--parser` parser name	Identifies a Vertica UDParser to use with a specified target. This parser is used within the COPY statement that the scheduler runs to load data. If you are using a Vertica native parser, the values supplied to the `--parser-parameters` option are passed through to the COPY statement. Default Value: KafkaParser
`--parser-parameters "` key=value, key=value`"`	A list of parameters to provide to the parser specified in the `--parser` parameter. When you use a Vertica native parser, the scheduler passes these parameters to the COPY statement where they are in turn passed to the parser.
`--new-load-spec` new_name	A new, unique name for an existing load spec. Requires the `--update` parameter.
`--uds-kv-parameters` key=value, key=value	A comma separated list of key value pairs for the user-defined source.
`--load-method` AUTO\|TRICKLE \|DIRECT	The COPY load method to use for all loads with this scheduler. See the COPY statement for more information. Default Value: TRICKLE

Examples

These examples show how you can use the Load Spec utility options.

Create the load spec, Streamspec1:

$ /opt/vertica/packages/kafka/bin/vkconfig load-spec --create --load-spec Streamspec1 --conf myscheduler.conf

Update the load spec, Streamspec1, to the name Streamspec2, and also update the load method to Direct:

$ /opt/vertica/packages/kafka/bin/vkconfig load-spec --update --load-spec Streamspec1 \
                                                     --new-load-spec Streamspec2  --load-method direct \
                                                     --conf myscheduler.conf

Update the load spec, Filterspec, to use the KafkaInsertLengths filter and a custom decryption filter:

$ /opt/vertica/packages/kafka/bin/vkconfig load-spec --update --load-spec Filterspec \
                                                     --filters "KafkaInsertLengths() DecryptFilter(parameter=Key)" \
                                                     --conf myscheduler.conf