nodejs-polars
    Preparing search index...

    Interface ScanJsonOptions

    interface ScanJsonOptions {
        batchSize: number;
        cloudOptions: Record<string, string | number | boolean>;
        ignoreErrors: boolean;
        includeFilePaths: string;
        inferSchemaLength: number | null;
        lowMemory: boolean;
        nRows: number;
        rechunk: boolean;
        rowIndexName: string;
        rowIndexOffset: number;
        schema: unknown;
        schemaOverrides: unknown;
    }
    Index
    batchSize cloudOptions ignoreErrors includeFilePaths inferSchemaLength lowMemory nRows rechunk rowIndexName rowIndexOffset schema schemaOverrides
    batchSize: number

    Number of rows to read in each batch.

    cloudOptions: Record<string, string | number | boolean>

    Options that indicate how to connect to a cloud provider.

    The cloud providers currently supported are AWS, GCP, and Azure. See supported keys here:

    • aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>_
    • gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>_
    • azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>_

    If not provided, Polars will try to infer the information from environment variables.

    ignoreErrors: boolean

    Return null if parsing fails because of a schema mismatch.

    includeFilePaths: string

    Include the path of the source file(s) as a column with this name.

    inferSchemaLength: number | null

    Maximum number of rows to scan for schema inference. Set to null for a full scan (slow). Default -> 100

    lowMemory: boolean

    Reduce memory pressure at the expense of performance.

    nRows: number

    Stop reading after nRows rows.

    rechunk: boolean

    Reallocate to contiguous memory when all chunks/files are parsed.

    rowIndexName: string

    Insert a row index column with this name.

    rowIndexOffset: number

    Offset to start the row index column at (only used if rowIndexName is set).

    schema: unknown

    Declare the schema of the frame. Types that are not given are inferred.

    schemaOverrides: unknown

    Override the dtype of one or more columns; takes precedence over schema.

    Settings
    Member Visibility

    On This Page
    Properties