RAPIDS
    Preparing search index...

    Interface ReadCSVOptionsCommon<T>

    interface ReadCSVOptionsCommon<T extends TypeMap = any> {
        allowDoubleQuoting?: boolean;
        autoDetectNullValues?: boolean;
        byteOffset?: number;
        byteRange?: number;
        columnsToReturn?: string[];
        comment?: string;
        compression?: "infer" | "snappy" | "gzip" | "bz2" | "brotli" | "zip" | "xz";
        dataTypes?: T;
        datetimeColumns?: string[];
        decimalCharacter?: string;
        delimiter?: string;
        falseValues?: string[];
        header?: number | "infer" | null;
        inferDatesWithDayFirst?: boolean;
        keepDefaultNA?: boolean;
        lineTerminator?: string;
        nullValues?: string[];
        numRows?: number;
        prefix?: string;
        quoteCharacter?: string;
        quoteStyle?: "all" | "none" | "nonnumeric" | "minimal";
        renameDuplicateColumns?: boolean;
        skipBlankLines?: boolean;
        skipHead?: number;
        skipInitialSpaces?: boolean;
        skipTail?: number;
        thousands?: string;
        trueValues?: string[];
        whitespaceAsDelimiter?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    allowDoubleQuoting? autoDetectNullValues? byteOffset? byteRange? columnsToReturn? comment? compression? dataTypes? datetimeColumns? decimalCharacter? delimiter? falseValues? header? inferDatesWithDayFirst? keepDefaultNA? lineTerminator? nullValues? numRows? prefix? quoteCharacter? quoteStyle? renameDuplicateColumns? skipBlankLines? skipHead? skipInitialSpaces? skipTail? thousands? trueValues? whitespaceAsDelimiter?

    Properties

    allowDoubleQuoting?: boolean

    Whether a quote inside a value is double-quoted

    autoDetectNullValues?: boolean

    Whether to disable null filter; disabling can improve performance

    byteOffset?: number

    The number of bytes to skip from source start

    byteRange?: number

    The number of bytes to read

    columnsToReturn?: string[]

    Names of columns to read; empty/null is all columns

    comment?: string

    Comment line start character

    compression?: "infer" | "snappy" | "gzip" | "bz2" | "brotli" | "zip" | "xz"

    The compression format of the source, or infer from file extension

    dataTypes?: T

    Names and types of all the columns; if empty then names and types are inferred/auto-generated

    datetimeColumns?: string[]

    Names of columns to read as datetime

    decimalCharacter?: string

    Decimal point character; cannot match delimiter

    delimiter?: string

    Field delimiter

    falseValues?: string[]

    Additional values to recognize as boolean false values

    header?: number | "infer" | null

    Header row index

    inferDatesWithDayFirst?: boolean

    Whether to parse dates as DD/MM versus MM/DD

    keepDefaultNA?: boolean

    Whether to keep the built-in default NA values

    lineTerminator?: string

    Line terminator

    nullValues?: string[]

    Additional values to recognize as null values

    numRows?: number

    Rows to read; -1 is all

    prefix?: string

    String used as prefix for each column name if no header or names are provided.

    quoteCharacter?: string

    Quoting character (if allowDoubleQuoting is true)

    quoteStyle?: "all" | "none" | "nonnumeric" | "minimal"

    Treatment of quoting behavior

    renameDuplicateColumns?: boolean

    Whether to rename duplicate column names

    skipBlankLines?: boolean

    Ignore empty lines or parse line values as invalid

    skipHead?: number

    Rows to skip from the start

    skipInitialSpaces?: boolean

    Whether to skip whitespace after the delimiter

    skipTail?: number

    Rows to skip from the end

    thousands?: string

    Numeric data thousands separator; cannot match delimiter

    trueValues?: string[]

    Additional values to recognize as boolean true values

    whitespaceAsDelimiter?: boolean

    Treat whitespace as field delimiter; overrides character delimiter

    Settings

    Member Visibility

    On This Page

    Properties