nodejs-polars
    Preparing search index...

    Interface ScanCastOptions

    Cast options applied when scanning files. Options for

    ScanParquetOptions.castOptions

    interface ScanCastOptions {
        categoricalToString?: "forbid" | "allow";
        datetimeCast?: DatetimeCastOption | DatetimeCastOption[];
        extraStructFields?: "raise" | "ignore";
        floatCast?: FloatCastOption | FloatCastOption[];
        integerCast?: IntegerCastOption | IntegerCastOption[];
        missingStructFields?: "raise" | "insert";
    }
    Index
    categoricalToString? datetimeCast? extraStructFields? floatCast? integerCast? missingStructFields?
    categoricalToString?: "forbid" | "allow"

    Whether to allow casting categoricals to string. Default -> 'forbid'

    datetimeCast?: DatetimeCastOption | DatetimeCastOption[]

    Configuration for casting from datetime types:

    • nanosecond-downcast: Allow nanosecond precision datetime to be downcasted to any lower precision.
    • microsecond-downcast: Allow microsecond precision datetime to be downcasted to millisecond precision.
    • downcast: Allow downcasting to any lower precision (convenience aggregate of nanosecond-downcast and microsecond-downcast).
    • convert-timezone: Allow casting to a different timezone.
    • forbid: Raises an error if dtypes do not match (default).
    extraStructFields?: "raise" | "ignore"

    Behavior when extra struct fields outside the defined schema are encountered. Default -> 'raise'

    floatCast?: FloatCastOption | FloatCastOption[]

    Configuration for casting from float types:

    • upcast: Allow casting to higher precision float types.
    • downcast: Allow casting to lower precision float types.
    • forbid: Raises an error if dtypes do not match (default).
    integerCast?: IntegerCastOption | IntegerCastOption[]

    Configuration for casting from integer types:

    • upcast: Allow lossless casting to wider integer types.
    • allow-float: Allow casting integers to float types.
    • forbid: Raises an error if dtypes do not match (default).
    missingStructFields?: "raise" | "insert"

    Behavior when struct fields defined in the schema are missing from the data. Default -> 'raise'

    Settings
    Member Visibility

    On This Page
    Properties