client.files.post_preprocess_csv

A method of the Files endpoint.

post_preprocess_csv(file_id: int, *, in_place: bool = None, detect_table_columns: bool = None, force_character_set_conversion: bool = None, include_header: bool = None, column_delimiter: str = None, hidden: bool = None) → Response

Create a Preprocess CSV

API URL: POST /files/preprocess/csv

import civis
client = civis.APIClient()
response = client.files.post_preprocess_csv(...)

Parameters:

file_idint

The ID of the file.

in_placebool, optional

If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.

detect_table_columnsbool, optional

If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.

force_character_set_conversionbool, optional

If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).

include_headerbool, optional

A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.

column_delimiterstr, optional

The column delimiter for the file. One of “comma”, “tab”, or “pipe”. If not provided, the column delimiter will be auto-detected.

hiddenbool, optional

The hidden status of the item.

Returns:

civis.Response

• idint

  The ID of the job created.

• file_idint

  The ID of the file.

• in_placebool

  If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.

• detect_table_columnsbool

  If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.

• force_character_set_conversionbool

  If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).

• include_headerbool

  A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.

• column_delimiterstr

  The column delimiter for the file. One of “comma”, “tab”, or “pipe”. If not provided, the column delimiter will be auto-detected.

• hiddenbool

  The hidden status of the item.