Pipeline settings

When creating or updating a file pipeline through the Krenalis APIs, you must provide the settings specific for that format.

CSV

Source

When creating or updating CSV (source) pipelines through the API, the following must be provided in the formatSettings field, in a JSON Object:

  • separator

    string Required : Separator.

  • numberOfColumns

    int : Number of columns.

  • trimLeadingSpace

    boolean : Trim leading space.

  • hasColumnNames

    boolean : Has column names.

Destination

When creating or updating CSV (destination) pipelines through the API, the following must be provided in the formatSettings field, in a JSON Object:

  • separator

    string Required : Separator.

  • useCRLF

    boolean : Use CRLF.

Excel

Source

When creating or updating Excel (source) pipelines through the API, the following must be provided in the formatSettings field, in a JSON Object:

  • hasColumnNames

    boolean : Indicates whether or not the first row of the file contains column names.

Destination

When creating or updating Excel (destination) pipelines through the API, there are no settings that must be passed through the formatSettings field, so it must be omitted or set to null.

JSON

Source

When creating or updating JSON (source) pipelines through the API, the following must be provided in the formatSettings field, in a JSON Object:

  • properties

    Array of JSON Objects Required : JSON properties, specified as an Array of JSON Objects with two keys: key and value.

Destination

When creating or updating JSON (destination) pipelines through the API, the following must be provided in the formatSettings field, in a JSON Object:

  • indent

    boolean : Indent.

  • generateASCII

    boolean : Generate ASCII.

  • allowSpecialFloats

    boolean : Allow special floats.

Parquet

When creating or updating Parquet pipelines through the API, there are no settings that must be passed through the formatSettings field, so it must be omitted or set to null.