CSV

Handle CSV (Comma Separated Values) payloads

What’s inside

CSV data format

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-csv-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 29 options, which are listed below.

Name	Description	Default	Type
camel.dataformat.csv.allow-missing-column-names	Whether to allow missing column names.	false	Boolean
camel.dataformat.csv.capture-header-record	Whether the unmarshalling should capture the header record and store it in the message header.	false	Boolean
camel.dataformat.csv.comment-marker	Sets the comment marker of the reference format.		String
camel.dataformat.csv.comment-marker-disabled	Disables the comment marker of the reference format.	false	Boolean
camel.dataformat.csv.delimiter	The delimiter to use. The default value is , (comma).		String
camel.dataformat.csv.enabled	Whether to enable auto configuration of the csv data format. This is enabled by default.		Boolean
camel.dataformat.csv.escape	Sets the escape character to use.		String
camel.dataformat.csv.escape-disabled	Whether to disable the escape character.	false	Boolean
camel.dataformat.csv.format	The format to use.	DEFAULT	String
camel.dataformat.csv.header	To configure the CSV headers. Multiple headers can be separated by comma.		String
camel.dataformat.csv.header-disabled	Whether to disable headers.	false	Boolean
camel.dataformat.csv.ignore-empty-lines	Whether to ignore empty lines.	false	Boolean
camel.dataformat.csv.ignore-header-case	Whether to ignore case when accessing header names.	false	Boolean
camel.dataformat.csv.ignore-surrounding-spaces	Whether to ignore surrounding spaces.	false	Boolean
camel.dataformat.csv.lazy-load	Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.	false	Boolean
camel.dataformat.csv.marshaller-factory-ref	Sets the implementation of the CsvMarshallerFactory interface which is able to customize marshalling/unmarshalling behavior.		String
camel.dataformat.csv.null-string	Sets the null string.		String
camel.dataformat.csv.null-string-disabled	Whether to disable null string handling.	false	Boolean
camel.dataformat.csv.quote	The quote character to use. The default is double-quote character.		String
camel.dataformat.csv.quote-disabled	Whether to disable quoting.	false	Boolean
camel.dataformat.csv.quote-mode	Sets the quote mode.		String
camel.dataformat.csv.record-converter-ref	Refers to a custom CsvRecordConverter to lookup from the registry to use.		String
camel.dataformat.csv.record-separator	The record separator (aka new line) which by default is new line characters (CRLF).		String
camel.dataformat.csv.record-separator-disabled	Whether to disable the record separator.	false	Boolean
camel.dataformat.csv.skip-header-record	Whether to skip the header record in the output.	false	Boolean
camel.dataformat.csv.trailing-delimiter	Whether to add a trailing delimiter.	false	Boolean
camel.dataformat.csv.trim	Whether to trim leading and trailing blanks.	false	Boolean
camel.dataformat.csv.use-maps	Whether the unmarshalling should produce maps (HashMap) for the lines values instead of lists. It requires to have header (either defined or collected).	false	Boolean
camel.dataformat.csv.use-ordered-maps	Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists. It requires to have header (either defined or collected).	false	Boolean

Name

Description

Default

Type

camel.dataformat.csv.allow-missing-column-names

Whether to allow missing column names.

false

Boolean

camel.dataformat.csv.capture-header-record

Whether the unmarshalling should capture the header record and store it in the message header.

false

Boolean

camel.dataformat.csv.comment-marker

Sets the comment marker of the reference format.

String

camel.dataformat.csv.comment-marker-disabled

Disables the comment marker of the reference format.

false

Boolean

camel.dataformat.csv.delimiter

The delimiter to use. The default value is , (comma).

String

camel.dataformat.csv.enabled

Whether to enable auto configuration of the csv data format. This is enabled by default.

Boolean

camel.dataformat.csv.escape

Sets the escape character to use.

String

camel.dataformat.csv.escape-disabled

Whether to disable the escape character.

false

Boolean

camel.dataformat.csv.format

The format to use.

DEFAULT

String

camel.dataformat.csv.header

To configure the CSV headers. Multiple headers can be separated by comma.

String

camel.dataformat.csv.header-disabled

Whether to disable headers.

false

Boolean

camel.dataformat.csv.ignore-empty-lines

Whether to ignore empty lines.

false

Boolean

camel.dataformat.csv.ignore-header-case

Whether to ignore case when accessing header names.

false

Boolean

camel.dataformat.csv.ignore-surrounding-spaces

Whether to ignore surrounding spaces.

false

Boolean

camel.dataformat.csv.lazy-load

Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.

false

Boolean

camel.dataformat.csv.marshaller-factory-ref

Sets the implementation of the CsvMarshallerFactory interface which is able to customize marshalling/unmarshalling behavior.

String

camel.dataformat.csv.null-string

Sets the null string.

String

camel.dataformat.csv.null-string-disabled

Whether to disable null string handling.

false

Boolean

camel.dataformat.csv.quote

The quote character to use. The default is double-quote character.

String

camel.dataformat.csv.quote-disabled

Whether to disable quoting.

false

Boolean

camel.dataformat.csv.quote-mode

Sets the quote mode.

String

camel.dataformat.csv.record-converter-ref

Refers to a custom CsvRecordConverter to lookup from the registry to use.

String

camel.dataformat.csv.record-separator

The record separator (aka new line) which by default is new line characters (CRLF).

String

camel.dataformat.csv.record-separator-disabled

Whether to disable the record separator.

false

Boolean

camel.dataformat.csv.skip-header-record

Whether to skip the header record in the output.

false

Boolean

camel.dataformat.csv.trailing-delimiter

Whether to add a trailing delimiter.

false

Boolean

camel.dataformat.csv.trim

Whether to trim leading and trailing blanks.

false

Boolean

camel.dataformat.csv.use-maps

Whether the unmarshalling should produce maps (HashMap) for the lines values instead of lists. It requires to have header (either defined or collected).

false

Boolean

camel.dataformat.csv.use-ordered-maps

Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists. It requires to have header (either defined or collected).

false

Boolean