Logo Deedle

VirtualCsvSource Module

Functions and values

Function or value Description

createColumnSource lineIndex columnName stringLookupRange

Full Usage: createColumnSource lineIndex columnName stringLookupRange

Parameters:
Returns: IVirtualVectorSource

Create a value column source for a CSV file (type inferred from sample rows).

lineIndex : CsvLineIndex
columnName : string
stringLookupRange : LookupRangeMode<string> option
Returns: IVirtualVectorSource

createConcatenatedFrame csvPaths options

Full Usage: createConcatenatedFrame csvPaths options

Parameters:
Returns: Frame<int64, string>

Concatenate CSV files as one ordinal virtual frame (sorted paths). Shared schema required. Uses linear 0..N-1 addressing so existing [`OrdinalVirtualSource`] LookupRange applies as-is.

csvPaths : string[]
options : VirtualReadCsvOptions
Returns: Frame<int64, string>

createFrame csvPath options

Full Usage: createFrame csvPath options

Parameters:
Returns: objnull

Build a virtual frame from a CSV file (boxed; unbox at the API boundary). With `IndexColumn = None`, uses ordinal rows `0 .. N-1`. With `IndexColumn = Some name`, uses that column when strictly increasing and unique in file order; otherwise ordinal with a trace warning.

csvPath : string
options : VirtualReadCsvOptions
Returns: objnull

createIndexSource lineIndex columnName

Full Usage: createIndexSource lineIndex columnName

Parameters:
Returns: IVirtualVectorSource
lineIndex : CsvLineIndex
columnName : string
Returns: IVirtualVectorSource

createOrdinalFrame csvPath options

Full Usage: createOrdinalFrame csvPath options

Parameters:
Returns: Frame<int64, string>

Build a virtual frame with ordinal row index `0 .. N-1`.

csvPath : string
options : VirtualReadCsvOptions
Returns: Frame<int64, string>

resolveIndexColumnName header options

Full Usage: resolveIndexColumnName header options

Parameters:
Returns: string

Resolve the configured index column name, if any.

header : string[]
options : VirtualReadCsvOptions
Returns: string

Type something to start searching.